diff --git a/bindings/java/doxygen/schema/db_schema_8_6.dox b/bindings/java/doxygen/schema/db_schema_8_6.dox index 987e56e31fc6c1c442a7a40dbc4006bad5bdac28..fa2a3f65e61c684a1bc2b3ad94263e15b105ef43 100644 --- a/bindings/java/doxygen/schema/db_schema_8_6.dox +++ b/bindings/java/doxygen/schema/db_schema_8_6.dox @@ -292,9 +292,14 @@ Defines what tag names the user has created and can therefore be applied. - display_name - Display name of tag - description - Description (can be empty string) - color - Color choice for tag (can be empty string) +- knownStatus - Stores whether a tag is notable/bad (as org.sleuthkit.datamodel.TskData.FileKnown enum) +- tag_set_id - Id of the tag set this tag name belongs to (references tag_set_id in tsk_tag_sets, may be null) +- rank - Used to order the tag names for a given tag set for display purposes ## tsk_tag_sets -TODO +Used to group entries from the tag_names table. An object can have only one tag from a tag set at a time. +- tag_set_id - Id of the tag set +- name - Name of the tag set (unique, should be human readable) ## content_tags table One row for each file tagged. @@ -316,42 +321,39 @@ One row for each artifact that is tagged. # Ingest Module Status These tables keep track in Autopsy which modules were run on the data sources. -TODO - ## ingest_module_types table -Defines the types of ingest modules supported. -- type_id -- type_name +Defines the types of ingest modules supported. Must exactly match the names and ordering in the org.sleuthkit.datamodel.IngestModuleInfo.IngestModuleType enum. +- type_id - Id for the ingest module type +- type_name - Internal name for the ingest module type ## ingest_modules -Defines which modules were installed. One row for each module. -- ingest_module_id -- display_name -- unique_name -- type_id -- version +Defines which modules were installed and run on at least one data source. One row for each module. +- ingest_module_id - Id of the ingest module +- display_name - Display name for the ingest module (should be human readable) +- unique_name - Unique name for the ingest module +- type_id - Type of ingest module (references type_id from ingest_module_types) +- version - Version of the ingest module ## ingest_job_status_types table -- type_id -- type_name - +Defines the status options for ingest jobs. Must match the names and ordering in the org.sleuthkit.datamodel.IngestJobInfo.IngestJobStatusType enum. +- type_id - Id for the ingest job status type +- type_name - Internal name for the ingest job status type ## ingest_jobs One row is created each time ingest is started, which is a set of modules in a pipeline. -- ingest_job_id -- obj_id -- host_name -- start_date_time -- end_date_time -- status_id -- settings_dir +- ingest_job_id - Id of the ingest job +- obj_id - Id of the data source ingest is being run on +- host_name - Name of the host that is running this ingest job +- start_date_time - Time the ingest job started (stored in number of milliseconds since Jan 1, 1970 UTC) +- end_date_time - Time the ingest job finished (stored in number of milliseconds since Jan 1, 1970 UTC) +- status_id - Ingest job status (references type_id from ingest_job_status_types) +- settings_dir - Directory of the job's settings (may be an empty string) ## ingest_job_modules Defines the order of the modules in a given pipeline (i.e. ingest_job) -- ingest_job_id -- ingest_module_id -- pipeline_position - +- ingest_job_id - Id for the ingest job (references ingest_job_id in ingest_jobs) +- ingest_module_id - Id of the ingest module (references ingest_module_id in ingest_modules) +- pipeline_position - Order that the ingest module was run */