Merge pull request #274 from stackql/feature/provider-docs

snowflake updates

Author: jeffreyaven

docs/snowflake-docs/providers/snowflake/account/accounts/index.md

@@ -231,32 +231,46 @@ SELECT
       value: string
     - name: name
       value: string
+      description: A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.
     - name: region_group
       value: string
+      description: Region group where the account is located. Note - This column is only displayed for organizations that span multiple region groups.
     - name: region
       value: string
+      description: Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
     - name: edition
       value: string
+      description: Snowflake Edition of the account.
     - name: comment
       value: string
+      description: Optional comment in which to store information related to the account.
     - name: admin_name
       value: string
+      description: Name of the account administrator.
     - name: admin_password
       value: string
+      description: Password for the account administrator.
     - name: admin_rsa_public_key
       value: string
+      description: RSA public key for the account administrator.
     - name: admin_user_type
       value: string
+      description: User type of the account administrator.
     - name: first_name
       value: string
+      description: First name of the account administrator.
     - name: last_name
       value: string
+      description: Last name of the account administrator.
     - name: email
       value: string
+      description: Email address of the account administrator.
     - name: must_change_password
       value: boolean
+      description: Indicates whether the account administrator must change the password at the next login.
     - name: polaris
       value: boolean
+      description: Indicates whether the account is a Polaris account.
 
 ```
 </TabItem>

docs/snowflake-docs/providers/snowflake/alert/alerts/index.md

@@ -217,18 +217,24 @@ SELECT
       value: string
     - name: name
       value: string
+      description: Name of the alert
     - name: comment
       value: string
+      description: user comment associated to an object in the dictionary
     - name: schedule
       value:
         - name: schedule_type
           value: string
+          description: Type of the schedule, can be either CRON_TYPE or MINUTES_TYPE
     - name: warehouse
       value: string
+      description: The warehouse the alert runs in
     - name: condition
       value: string
+      description: The SQL statement that must be evaluated to determine whether to trigger the alert
     - name: action
       value: string
+      description: The SQL statement to execute when the alert is triggered
 
 ```
 </TabItem>

docs/snowflake-docs/providers/snowflake/api_integration/api_integrations/index.md

@@ -182,18 +182,24 @@ SELECT
       value: string
     - name: name
       value: string
+      description: Name of the API integration.
     - name: api_hook
       value:
         - name: type
           value: string
+          description: Type of ApiHook, can be AWS, AZURE, GC or GIT.
     - name: api_allowed_prefixes
       value: array
+      description: A comma-separated list of endpoints and resources that Snowflake can access.
     - name: api_blocked_prefixes
       value: array
+      description: A comma-separated list of endpoints and resources that are not allowed to be called from Snowflake.
     - name: enabled
       value: boolean
+      description: Whether the API integration is enabled.
     - name: comment
       value: string
+      description: Comment for the API integration.
 
 ```
 </TabItem>

docs/snowflake-docs/providers/snowflake/catalog_integration/catalog_integrations/index.md

@@ -182,16 +182,21 @@ SELECT
       value: string
     - name: name
       value: string
+      description: Name of the catalog integration.
     - name: catalog
       value:
         - name: catalog_source
           value: string
+          description: Type of external catalog
     - name: table_format
       value: string
+      description: Table format of the catalog.
     - name: enabled
       value: boolean
+      description: whether this catalog integration is available to use for Iceberg tables.
     - name: comment
       value: string
+      description: Comment.
 
 ```
 </TabItem>

docs/snowflake-docs/providers/snowflake/compute_pool/compute_pools/index.md

@@ -236,18 +236,25 @@ SELECT
       value: string
     - name: name
       value: string
+      description: A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.
     - name: min_nodes
       value: integer
+      description: Minimum number of nodes for the compute pool.
     - name: max_nodes
       value: integer
+      description: Maximum number of nodes for the compute pool.
     - name: instance_family
       value: string
+      description: Instance family for the compute pool.
     - name: auto_resume
       value: boolean
+      description: Whether Snowflake automatically resumes the compute pool when any statement that requires the compute pool is submitted.
     - name: comment
       value: string
+      description: Comment describing the compute pool.
     - name: auto_suspend_secs
       value: integer
+      description: Number of seconds until the compute pool automatically suspends.
 
 ```
 </TabItem>

docs/snowflake-docs/providers/snowflake/database/databases/index.md

@@ -250,30 +250,43 @@ SELECT
       value: string
     - name: name
       value: string
+      description: A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.
     - name: kind
       value: string
+      description: Database type, permanent (default) or transient.
     - name: comment
       value: string
+      description: Optional comment in which to store information related to the database.
     - name: data_retention_time_in_days
       value: integer
+      description: Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database.
     - name: default_ddl_collation
       value: string
+      description: Default collation specification for all schemas and tables added to the database. You an override the default at the schema and individual table levels.
     - name: log_level
       value: string
+      description: Severity level of messages that should be ingested and made available in the active event table. Currently, Snowflake supports only `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL` and `OFF`.
     - name: max_data_extension_time_in_days
       value: integer
+      description: Maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale.
     - name: suspend_task_after_num_failures
       value: integer
+      description: Maximum number of consecutive failed task runs before the current task is suspended automatically.
     - name: trace_level
       value: string
+      description: How trace events are ingested into the event table. Currently, Snowflake supports only `ALWAYS`, `ON_EVENT`, and `OFF`.
     - name: user_task_managed_initial_warehouse_size
       value: string
+      description: Size of the compute resources to provision for the first run of the serverless task, before a task history is available for Snowflake to determine an ideal size.
     - name: serverless_task_min_statement_size
       value: string
+      description: Specifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE.
     - name: serverless_task_max_statement_size
       value: string
+      description: Specifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE.
     - name: user_task_timeout_ms
       value: integer
+      description: Time limit, in milliseconds, for a single run of the task before it times out.
 
 ```
 </TabItem>

docs/snowflake-docs/providers/snowflake/database_role/database_roles/index.md

@@ -143,8 +143,10 @@ SELECT
       value: string
     - name: name
       value: string
+      description: Name of the database role
     - name: comment
       value: string
+      description: User comment associated to an object in the dictionary
 
 ```
 </TabItem>

docs/snowflake-docs/providers/snowflake/database_role/future_grants/index.md

@@ -152,24 +152,33 @@ SELECT
       value:
         - name: database
           value: string
+          description: Database name of the securable if applicable.
         - name: schema
           value: string
+          description: Schema name of the securable if applicable.
         - name: service
           value: string
+          description: Service name of the securable if applicable.
         - name: name
           value: string
+          description: Name of the securable if applicable.
     - name: containing_scope
       value:
         - name: database
           value: string
+          description: Database name of the securable scope if applicable.
         - name: schema
           value: string
+          description: Schema name of the securable scope if applicable.
     - name: securable_type
       value: string
+      description: Type of the securable to be granted.
     - name: grant_option
       value: boolean
+      description: If true, allows the recipient role to grant the privileges to other roles.
     - name: privileges
       value: array
+      description: List of privileges to be granted.
 
 ```
 </TabItem>

docs/snowflake-docs/providers/snowflake/database_role/grants/index.md

@@ -152,24 +152,33 @@ SELECT
       value:
         - name: database
           value: string
+          description: Database name of the securable if applicable.
         - name: schema
           value: string
+          description: Schema name of the securable if applicable.
         - name: service
           value: string
+          description: Service name of the securable if applicable.
         - name: name
           value: string
+          description: Name of the securable if applicable.
     - name: containing_scope
       value:
         - name: database
           value: string
+          description: Database name of the securable scope if applicable.
         - name: schema
           value: string
+          description: Schema name of the securable scope if applicable.
     - name: securable_type
       value: string
+      description: Type of the securable to be granted.
     - name: grant_option
       value: boolean
+      description: If true, allows the recipient role to grant the privileges to other roles.
     - name: privileges
       value: array
+      description: List of privileges to be granted.
 
 ```
 </TabItem>

docs/snowflake-docs/providers/snowflake/dynamic_table/dynamic_tables/index.md

@@ -269,36 +269,51 @@ SELECT
       value: string
     - name: name
       value: string
+      description: Specifies the name for the dynamic table, must be unique for the schema in which the dynamic table is created
     - name: kind
       value: string
+      description: Specifies the dynamic table type, permanent (default) or transient.
     - name: columns
       value:
         - name: name
           value: string
+          description: Column name
         - name: datatype
           value: string
+          description: The data type for the column
         - name: comment
           value: string
+          description: Specifies a comment for the column
     - name: target_lag
       value:
         - name: type
           value: string
+          description: Type of lag, can be either USER_DEFINED or DOWNSTREAM.
+      description: Specifies the schedule for periodically refreshing the dynamic table.
     - name: refresh_mode
       value: string
+      description: Specifies the refresh type for the dynamic table
     - name: initialize
       value: string
+      description: Specifies the behavior of the initial refresh of the dynamic table
     - name: warehouse
       value: string
+      description: Specifies the name of the warehouse that provides the compute resources for refreshing the dynamic table
     - name: cluster_by
       value: array
+      description: Specifies one or more columns or column expressions in the dynamic table as the clustering key
     - name: query
       value: string
+      description: Specifies the query whose results the dynamic table should contain
     - name: data_retention_time_in_days
       value: integer
+      description: Specifies the retention period for the dynamic table so that Time Travel actions (SELECT, CLONE) can be performed on historical data in the dynamic table
     - name: max_data_extension_time_in_days
       value: integer
+      description: Specifies the retention period for the dynamic table so that Time Travel actions (SELECT, CLONE) can be performed on historical data in the dynamic table
     - name: comment
       value: string
+      description: Specifies a comment for the dynamic table.
 
 ```
 </TabItem>