Merge pull request #46 from Sage-Bionetworks/snow-79-correct-sql-columns

[SNOW-79] Create V2.19.0__add_table_file_latest_comments.sql

synapse_data_warehouse/synapse/tables/V2.19.0__add_table_file_latest_comments.sql

@@ -0,0 +1,24 @@
+USE SCHEMA {{database_name}}.synapse; --noqa: JJ01,PRS,TMP
+
+ALTER TABLE FILE_LATEST SET COMMENT = 'The latest snapshot of the file.';  
+
+COMMENT ON COLUMN FILE_LATEST.change_type IS 'The type of change that occurred on the file handle, e.g., CREATE, UPDATE, DELETE.';
+COMMENT ON COLUMN FILE_LATEST.change_timestamp IS 'The time when the change (created/updated/deleted) on the file is pushed to the queue for snapshotting.';
+COMMENT ON COLUMN FILE_LATEST.change_user_id IS 'The unique identifier of the user who made the change to the file.';
+COMMENT ON COLUMN FILE_LATEST.snapshot_timestamp IS 'The time when the snapshot was taken (It is usually after the change happened).';
+COMMENT ON COLUMN FILE_LATEST.id IS 'The unique identifier of the file handle.';
+COMMENT ON COLUMN FILE_LATEST.created_by IS 'The unique identifier of the user who created the file handle.';
+COMMENT ON COLUMN FILE_LATEST.created_on IS 'The creation timestamp of the file handle.';
+COMMENT ON COLUMN FILE_LATEST.modified_on IS 'The most recent change time of the file handle.';
+COMMENT ON COLUMN FILE_LATEST.concrete_type IS 'The type of the file handle. Allowed file handles are: S3FileHandle, ProxyFileHandle, ExternalFileHandle, ExternalObjectStoreFileHandle, GoogleCloudFileHandle.';
+COMMENT ON COLUMN FILE_LATEST.content_md5 IS 'The md5 hash (using MD5 algorithm) of the file referenced by the file handle.';
+COMMENT ON COLUMN FILE_LATEST.content_type IS 'Metadata about the content of the file, e.g., application/json, application/zip, application/octet-stream.';
+COMMENT ON COLUMN FILE_LATEST.file_name IS 'The name of the file referenced by the file handle.';
+COMMENT ON COLUMN FILE_LATEST.storage_location_id IS 'The identifier of the environment, where the physical files are stored.';
+COMMENT ON COLUMN FILE_LATEST.content_size IS 'The size of the file referenced by the file handle.';
+COMMENT ON COLUMN FILE_LATEST.bucket IS 'The bucket where the file is physically stored. Applicable for s3 and GCP, otherwise empty.';
+COMMENT ON COLUMN FILE_LATEST.key IS 'The key name uniquely identifies the object (file) in the bucket.';
+COMMENT ON COLUMN FILE_LATEST.preview_id IS 'The identifier of the file handle that contains a preview of the file referenced by this file handle.';
+COMMENT ON COLUMN FILE_LATEST.is_preview IS 'If true, the file referenced by this file handle is a preview of another file.';
+COMMENT ON COLUMN FILE_LATEST.status IS 'The availability status of the file referenced by the file handle. AVAILABLE: accessible via Synapse; UNLINKED: not referenced by Synapse and therefore available for garbage collection; ARCHIVED: the file has been garbage collected.';
+COMMENT ON COLUMN FILE_LATEST.snapshot_date IS 'The data is partitioned for fast and cost effective queries. The snapshot_timestamp field is converted into a date and stored in the snapshot_date field for partitioning. The date should be used as a condition (WHERE CLAUSE) in the queries.';