diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml index 5d89dc59f..80a107c7c 100644 --- a/.github/workflows/build-docs.yaml +++ b/.github/workflows/build-docs.yaml @@ -104,6 +104,7 @@ jobs: pagerduty homebrew datadog + snowflake ) for i in "${array[@]}" do diff --git a/README.md b/README.md index ea0b6eccf..5958885f2 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ This repository contains documentation for StackQL providers, which is published | Netlify Deploy Confluent | [![Netlify Status](https://api.netlify.com/api/v1/badges/63149c2f-6c3d-43f1-be38-80c55c223ac0/deploy-status)](https://app.netlify.com/sites/stackql-confluent-docs/deploys) | [confluent-docs.stackql.io](https://confluent-docs.stackql.io)
[confluent.stackql.io](https://confluent.stackql.io) | | Netlify Deploy Databricks Account | [![Netlify Status](https://api.netlify.com/api/v1/badges/9250b360-9e36-49dd-8cc8-b8cbe2f8d983/deploy-status)](https://app.netlify.com/sites/stackql-databricks-account-docs/deploys) | [databricks-account-docs.stackql.io](https://databricks-account-docs.stackql.io)
[databricks-account.stackql.io](https://databricks-account.stackql.io) | | Netlify Deploy Databricks Workspace | [![Netlify Status](https://api.netlify.com/api/v1/badges/7456d122-1d4a-445c-b410-7a9aa1bd3f05/deploy-status)](https://app.netlify.com/sites/stackql-databricks-workspace-docs/deploys) | [databricks-workspace-docs.stackql.io](https://databricks-workspace-docs.stackql.io)
[databricks-workspace.stackql.io](https://databricks-workspace.stackql.io) | +| Netlify Deploy Snowflake | [![Netlify Status](https://api.netlify.com/api/v1/badges/e14bf4c8-1dca-4250-a19b-bffaa62fac9a/deploy-status)](https://app.netlify.com/projects/stackql-snowflake-docs/deploys) | [snowflake-docs.stackql.io](https://snowflake-docs.stackql.io)
[snowflake.stackql.io](https://snowflake.stackql.io) | ## Adding Docs for a New Provider diff --git a/ci-scripts/get-providers-to-deploy.js b/ci-scripts/get-providers-to-deploy.js index 07f79327c..ca3742693 100644 --- a/ci-scripts/get-providers-to-deploy.js +++ b/ci-scripts/get-providers-to-deploy.js @@ -32,6 +32,7 @@ const allProviders = [ 'pagerduty', 'datadog', 'homebrew', + 'snowflake', rootName]; const appendToOutput = (providers) => { diff --git a/docs/snowflake-docs/index.md b/docs/snowflake-docs/index.md new file mode 100644 index 000000000..8d143bc96 --- /dev/null +++ b/docs/snowflake-docs/index.md @@ -0,0 +1,117 @@ +--- +title: snowflake +hide_title: false +hide_table_of_contents: false +keywords: + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +id: snowflake-doc +slug: /providers/snowflake + +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + +Snowflake for managing data warehousing, analytics, and secure data sharing with scalable cloud-native architecture and pay-as-you-go pricing. + + +:::info Provider Summary + +
+
+total services: 32
+total resources: 47
+
+
+ +::: + +See also: +[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) +* * * + +## Installation + +To pull the latest version of the `snowflake` provider, run the following command: + +```bash +REGISTRY PULL snowflake; +``` +> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). + +## Authentication + +The following system environment variables are used for authentication by default: + +- - Snowflake Programmatic Access Token (PAT) (see Using a programmatic access token (PAT)) + +These variables are sourced at runtime (from the local machine or as CI variables/secrets). + +
+ +Using different environment variables + +To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: + +```bash + +AUTH='{ "snowflake": { "type": "bearer", "credentialsenvvar": "YOUR_SNOWFLAKE_PAT_VAR" }}' +stackql shell --auth="${AUTH}" + +``` +or using PowerShell: + +```powershell + +$Auth = "{ 'snowflake': { 'type': 'bearer', 'credentialsenvvar': 'YOUR_SNOWFLAKE_PAT_VAR' }}" +stackql.exe shell --auth=$Auth + +``` +
+ + +## Services +
+
+account
+alert
+api_integration
+catalog_integration
+compute_pool
+database
+database_role
+dynamic_table
+event_table
+external_volume
+function
+grant
+iceberg_table
+image_repository
+managed_account
+network_policy
+
+
+notebook
+notification_integration
+pipe
+procedure
+result
+role
+schema
+sqlapi
+stage
+streams
+table
+task
+user
+user_defined_function
+view
+warehouse
+
+
diff --git a/docs/snowflake-docs/providers/snowflake/account/accounts/index.md b/docs/snowflake-docs/providers/snowflake/account/accounts/index.md new file mode 100644 index 000000000..4fd96c8cd --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/account/accounts/index.md @@ -0,0 +1,181 @@ +--- +title: accounts +hide_title: false +hide_table_of_contents: false +keywords: + - accounts + - account + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a accounts resource. + +## Overview + + + + +
Nameaccounts
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | 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. | +| | `string` | System-assigned identifier of the acccount. | +| | `string` | Legacy Snowflake account URL syntax that includes the region_name and account_locator. | +| | `string` | If the original account URL was saved when the account was renamed, indicates the last time the account was accessed using the original URL. | +| | `string` | If the original account URL was saved when the account was renamed, provides the date and time when the original account URL was saved. | +| | `string` | Preferred Snowflake account URL that includes the values of organization_name and account_name. | +| | `string` | Name of the account administrator. | +| | `string` | Password for the account administrator. | +| | `string` | RSA public key for the account administrator. | +| | `string` | User type of the account administrator. | +| | `string` | Optional comment in which to store information related to the account. | +| | `string` | Name of the consumption billing entity. | +| | `string` | Date and time the account was created. | +| | `string` | Date and time the account was dropped. | +| | `string` | Snowflake Edition of the account. | +| | `string` | Email address of the account administrator. | +| | `string` | First name of the account administrator. | +| | `boolean` | Indicates whether an account is an events account. For more information, see Set up logging and event sharing for an application. | +| | `boolean` | Indicates whether the ORGADMIN role is enabled in an account. If TRUE, the role is enabled. | +| | `string` | Last name of the account administrator. | +| | `integer` | Indicates how many managed accounts have been created by the account. | +| | `string` | Name of the marketplace consumer billing entity. | +| | `string` | Name of the marketplace provider billing entity. | +| | `string` | Date and time when the account was moved to a different organization. | +| | `string` | If the account was moved to a different organization, provides the name of that organization. | +| | `boolean` | Indicates whether the account administrator must change the password at the next login. | +| | `string` | If the original account URL was saved when the account was renamed, provides the original URL. If the original account URL was dropped, the value is NULL even if the account was renamed | +| | `string` | If the account’s organization was changed in a way that created a new account URL and the original account URL was saved, provides the date and time when the original account URL will be dropped. Dropped URLs cannot be used to access the account. | +| | `string` | Name of the organization. | +| | `string` | If the account’s organization was changed in a way that created a new account URL and the original account URL was saved, provides the original account URL. If the original account URL was dropped, the value is NULL even if the organization changed. | +| | `string` | If the account’s organization was changed in a way that created a new account URL and the original account URL was saved, indicates the last time the account was accessed using the original account URL. | +| | `string` | If the account’s organization was changed in a way that created a new account URL and the original account URL was saved, provides the date and time when the original account URL was saved. | +| | `boolean` | Indicates whether the account is a Polaris account. | +| | `string` | 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). | +| | `string` | Region group where the account is located. Note - This column is only displayed for organizations that span multiple region groups. | +| | `string` | Date and time when the account was last restored. | +| | `integer` | Number of days that historical data is retained for Time Travel. | +| | `string` | Date and time when the account is scheduled to be permanently deleted. Accounts are deleted within one hour after the scheduled time. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists the accessible accounts. | +| | `INSERT` | | Creates a account. You must provide the full account definition when creating a account. | +| | `DELETE` | | Deletes the specified account. If you enable the `ifExists` parameter, the operation succeeds even if the account does not exist. Otherwise, a 404 failure is returned if the account does not exist. if the drop is unsuccessful. | +| | `EXEC` | | Restores a dropped account that has not yet been permanently deleted (a dropped account that is within its grace period). | + +## `SELECT` examples + +Lists the accessible accounts. + + +```sql +SELECT +name, +account_locator, +account_locator_url, +account_old_url_last_used, +account_old_url_saved_on, +account_url, +admin_name, +admin_password, +admin_rsa_public_key, +admin_user_type, +comment, +consumption_billing_entity_name, +created_on, +dropped_on, +edition, +email, +first_name, +is_events_account, +is_org_admin, +last_name, +managed_accounts, +marketplace_consumer_billing_entity_name, +marketplace_provider_billing_entity_name, +moved_on, +moved_to_organization, +must_change_password, +old_account_url, +organization_URL_expiration_on, +organization_name, +organization_old_url, +organization_old_url_last_used, +organization_old_url_saved_on, +polaris, +region, +region_group, +restored_on, +retention_time, +scheduled_deletion_time +FROM snowflake.account.accounts +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new accounts resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.account.accounts ( +data__name, +data__admin_name, +data__email, +endpoint, +data__edition +) +SELECT +'{ email }', +'{ name }', +'{ admin_name }', +'{ endpoint }', +'{ edition }' +; +``` + + + +```yaml +- name: accounts + props: + - name: data__admin_name + value: string + - name: data__edition + value: string + - name: data__email + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified accounts resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.account.accounts +WHERE gracePeriodInDays = '{ gracePeriodInDays }' AND name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/account/index.md b/docs/snowflake-docs/providers/snowflake/account/index.md new file mode 100644 index 000000000..67328a919 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/account/index.md @@ -0,0 +1,37 @@ +--- +title: account +hide_title: false +hide_table_of_contents: false +keywords: + - account + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +account service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+accounts +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/alert/alerts/index.md b/docs/snowflake-docs/providers/snowflake/alert/alerts/index.md new file mode 100644 index 000000000..aabf6f3f5 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/alert/alerts/index.md @@ -0,0 +1,139 @@ +--- +title: alerts +hide_title: false +hide_table_of_contents: false +keywords: + - alerts + - alert + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a alerts resource. + +## Overview + + + + +
Namealerts
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the alert | +| | `string` | The SQL statement to execute when the alert is triggered | +| | `string` | user comment associated to an object in the dictionary | +| | `string` | The SQL statement that must be evaluated to determine whether to trigger the alert | +| | `string` | Date and time when the alert was created. | +| | `string` | Database in which the alert is stored | +| | `string` | Role that owns the alert | +| | `string` | The type of role that owns the alert | +| | `object` | | +| | `string` | Schema in which the alert is stored | +| | `string` | The current state of the alert | +| | `string` | The warehouse the alert runs in | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch an alert | +| | `SELECT` | | List alerts | +| | `INSERT` | | Create an alert | +| | `DELETE` | | Delete an alert | +| | `EXEC` | | Create a new alert by cloning from the specified resource | +| | `EXEC` | | Execute an alert | + +## `SELECT` examples + +List alerts + + +```sql +SELECT +name, +action, +comment, +condition, +created_on, +database_name, +owner, +owner_role_type, +schedule, +schema_name, +state, +warehouse +FROM snowflake.alert.alerts +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alerts resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.alert.alerts ( +data__condition, +data__name, +endpoint, +data__schedule, +database, +schema, +data__action +) +SELECT +'{ database }', +'{ schedule }', +'{ action }', +'{ condition }', +'{ name }', +'{ schema }', +'{ endpoint }' +; +``` + + + +```yaml +- name: alerts + props: + - name: database + value: string + - name: schema + value: string + - name: data__action + value: string + - name: data__condition + value: string + - name: data__name + value: string + - name: data__schedule + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified alerts resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.alert.alerts +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/alert/index.md b/docs/snowflake-docs/providers/snowflake/alert/index.md new file mode 100644 index 000000000..c8cf8c6d8 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/alert/index.md @@ -0,0 +1,37 @@ +--- +title: alert +hide_title: false +hide_table_of_contents: false +keywords: + - alert + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +alert service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+alerts +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/api_integration/api_integrations/index.md b/docs/snowflake-docs/providers/snowflake/api_integration/api_integrations/index.md new file mode 100644 index 000000000..3f583e728 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/api_integration/api_integrations/index.md @@ -0,0 +1,133 @@ +--- +title: api_integrations +hide_title: false +hide_table_of_contents: false +keywords: + - api_integrations + - api_integration + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a api_integrations resource. + +## Overview + + + + +
Nameapi_integrations
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the API integration. | +| | `array` | A comma-separated list of endpoints and resources that Snowflake can access. | +| | `array` | A comma-separated list of endpoints and resources that are not allowed to be called from Snowflake. | +| | `object` | | +| | `string` | Comment for the API integration. | +| | `string` | Date and time when the API integration was created. | +| | `boolean` | Whether the API integration is enabled. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch an API integration | +| | `SELECT` | | List API integrations | +| | `INSERT` | | Create an API integration | +| | `DELETE` | | Delete an API integration | +| | `REPLACE` | | Create an (or alter an existing) API integration. Note that API_KEY is not currently altered by this operation and is supported for a newly-created object only. Unsetting API_BLOCKED_PREFIXES is also unsupported. | + +## `SELECT` examples + +List API integrations + + +```sql +SELECT +name, +api_allowed_prefixes, +api_blocked_prefixes, +api_hook, +comment, +created_on, +enabled +FROM snowflake.api_integration.api_integrations +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new api_integrations resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.api_integration.api_integrations ( +data__name, +data__api_allowed_prefixes, +endpoint, +data__api_hook, +data__enabled +) +SELECT +'{ enabled }', +'{ api_allowed_prefixes }', +'{ name }', +'{ endpoint }', +'{ api_hook }' +; +``` + + + +```yaml +- name: api_integrations + props: + - name: data__api_allowed_prefixes + value: string + - name: data__api_hook + value: string + - name: data__enabled + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `REPLACE` example + +Replaces all fields in the specified api_integrations resource. + +```sql +/*+ update */ +REPLACE snowflake.api_integration.api_integrations +SET + +WHERE +name = '{ name }' AND data__api_allowed_prefixes = '{ data__api_allowed_prefixes }' AND data__api_hook = '{ data__api_hook }' AND data__enabled = '{ data__enabled }' AND data__name = '{ data__name }' AND endpoint = '{ endpoint }'; +``` + +## `DELETE` example + +Deletes the specified api_integrations resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.api_integration.api_integrations +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/api_integration/index.md b/docs/snowflake-docs/providers/snowflake/api_integration/index.md new file mode 100644 index 000000000..e4b85926a --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/api_integration/index.md @@ -0,0 +1,37 @@ +--- +title: api_integration +hide_title: false +hide_table_of_contents: false +keywords: + - api_integration + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +api_integration service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+api_integrations +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/catalog_integration/catalog_integrations/index.md b/docs/snowflake-docs/providers/snowflake/catalog_integration/catalog_integrations/index.md new file mode 100644 index 000000000..945174059 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/catalog_integration/catalog_integrations/index.md @@ -0,0 +1,121 @@ +--- +title: catalog_integrations +hide_title: false +hide_table_of_contents: false +keywords: + - catalog_integrations + - catalog_integration + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a catalog_integrations resource. + +## Overview + + + + +
Namecatalog_integrations
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the catalog integration. | +| | `object` | | +| | `string` | Category of the integration. Always CATALOG. | +| | `string` | Comment. | +| | `string` | Date and time when the catalog integration was created. | +| | `boolean` | whether this catalog integration is available to use for Iceberg tables. | +| | `string` | Table format of the catalog. | +| | `string` | Type of the integration. Always CATALOG. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a catalog integration. | +| | `SELECT` | | List catalog integrations. | +| | `INSERT` | | Create a catalog integration. | +| | `DELETE` | | Delete a catalog integration. | + +## `SELECT` examples + +List catalog integrations. + + +```sql +SELECT +name, +catalog, +category, +comment, +created_on, +enabled, +table_format, +type +FROM snowflake.catalog_integration.catalog_integrations +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new catalog_integrations resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.catalog_integration.catalog_integrations ( +data__name, +data__catalog, +endpoint, +data__enabled, +data__table_format +) +SELECT +'{ enabled }', +'{ name }', +'{ catalog }', +'{ endpoint }', +'{ table_format }' +; +``` + + + +```yaml +- name: catalog_integrations + props: + - name: data__catalog + value: string + - name: data__enabled + value: string + - name: data__name + value: string + - name: data__table_format + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified catalog_integrations resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.catalog_integration.catalog_integrations +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/catalog_integration/index.md b/docs/snowflake-docs/providers/snowflake/catalog_integration/index.md new file mode 100644 index 000000000..18dab082b --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/catalog_integration/index.md @@ -0,0 +1,37 @@ +--- +title: catalog_integration +hide_title: false +hide_table_of_contents: false +keywords: + - catalog_integration + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +catalog_integration service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+catalog_integrations +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/compute_pool/compute_pools/index.md b/docs/snowflake-docs/providers/snowflake/compute_pool/compute_pools/index.md new file mode 100644 index 000000000..6861dc9ad --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/compute_pool/compute_pools/index.md @@ -0,0 +1,167 @@ +--- +title: compute_pools +hide_title: false +hide_table_of_contents: false +keywords: + - compute_pools + - compute_pool + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a compute_pools resource. + +## Overview + + + + +
Namecompute_pools
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | 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. | +| | `integer` | Number of currently active nodes on the compute pool. | +| | `string` | Name of the Snowflake Native App if the compute pool is created exclusively for the app. | +| | `boolean` | Whether Snowflake automatically resumes the compute pool when any statement that requires the compute pool is submitted. | +| | `integer` | Number of seconds until the compute pool automatically suspends. | +| | `string` | The name of the budget monitoring the credit usage of the compute pool. | +| | `string` | Comment describing the compute pool. | +| | `string` | Time the compute pool was created. | +| | `string` | Current error the compute pool hit if any. | +| | `integer` | Number of currently idle nodes on the compute pool. | +| | `string` | Instance family for the compute pool. | +| | `boolean` | Whether a compute pool is created exclusively for a Snowflake Native App. | +| | `integer` | Maximum number of nodes for the compute pool. | +| | `integer` | Minimum number of nodes for the compute pool. | +| | `integer` | Number of jobs on the compute pool. | +| | `integer` | Number of services on the compute pool. | +| | `string` | Identifier for the current owner of the compute pool. | +| | `string` | Time the compute pool was last resumed. | +| | `string` | Current state of the compute pool. Possible values include UNKNOWN, STARTING, IDLE, ACTIVE, STOPPING, SUSPENDED, and RESIZING. | +| | `string` | Current status of the compute pool if any. | +| | `integer` | Number of target nodes on the compute pool. | +| | `string` | Time the compute pool was last updated. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetches a named compute pool. You can get the name of the compute pool from the `/api/v2/compute-pools` GET request. | +| | `SELECT` | | Lists the compute pools under the account. | +| | `INSERT` | | Creates a compute pool, with standard create modifiers as query parameters. See the Compute Pool component definition for what is required to be provided in the request body. | +| | `DELETE` | | Deletes a compute pool with the given name. If you enable the `ifExists` parameter, the operation succeeds even if the object does not exist. Otherwise, a 404 failure is returned if the object does not exist. | +| | `REPLACE` | | Create a (or alter an existing) compute pool. Even if the operation is just an alter, the full property set must be provided. | +| | `EXEC` | | Resume a compute pool, if suspended. If the specified compute pool is already running, no action is taken. | +| | `EXEC` | | Stops all services in the compute pool. | +| | `EXEC` | | Stops all services in the compute pool. Deprecated - use :stop-all-services instead. | +| | `EXEC` | | Suspend a compute pool, if active. If the specified compute pool is already suspended, no action is taken. | + +## `SELECT` examples + +Lists the compute pools under the account. + + +```sql +SELECT +name, +active_nodes, +application, +auto_resume, +auto_suspend_secs, +budget, +comment, +created_on, +error_code, +idle_nodes, +instance_family, +is_exclusive, +max_nodes, +min_nodes, +num_jobs, +num_services, +owner, +resumed_on, +state, +status_message, +target_nodes, +updated_on +FROM snowflake.compute_pool.compute_pools +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new compute_pools resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.compute_pool.compute_pools ( +data__name, +endpoint, +data__instance_family, +data__min_nodes, +data__max_nodes +) +SELECT +'{ instance_family }', +'{ min_nodes }', +'{ name }', +'{ endpoint }', +'{ max_nodes }' +; +``` + + + +```yaml +- name: compute_pools + props: + - name: data__instance_family + value: string + - name: data__max_nodes + value: string + - name: data__min_nodes + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `REPLACE` example + +Replaces all fields in the specified compute_pools resource. + +```sql +/*+ update */ +REPLACE snowflake.compute_pool.compute_pools +SET + +WHERE +name = '{ name }' AND data__instance_family = '{ data__instance_family }' AND data__max_nodes = '{ data__max_nodes }' AND data__min_nodes = '{ data__min_nodes }' AND data__name = '{ data__name }' AND endpoint = '{ endpoint }'; +``` + +## `DELETE` example + +Deletes the specified compute_pools resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.compute_pool.compute_pools +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/compute_pool/index.md b/docs/snowflake-docs/providers/snowflake/compute_pool/index.md new file mode 100644 index 000000000..f0c3a10eb --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/compute_pool/index.md @@ -0,0 +1,37 @@ +--- +title: compute_pool +hide_title: false +hide_table_of_contents: false +keywords: + - compute_pool + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +compute_pool service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+compute_pools +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/database/databases/index.md b/docs/snowflake-docs/providers/snowflake/database/databases/index.md new file mode 100644 index 000000000..4edb46fbc --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/database/databases/index.md @@ -0,0 +1,163 @@ +--- +title: databases +hide_title: false +hide_table_of_contents: false +keywords: + - databases + - database + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a databases resource. + +## Overview + + + + +
Namedatabases
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | 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. | +| | `string` | Budget that defines a monthly spending limit on the compute costs for a Snowflake account or a custom group of Snowflake objects. | +| | `string` | Optional comment in which to store information related to the database. | +| | `string` | Date and time the database was created. | +| | `integer` | 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. | +| | `string` | Default collation specification for all schemas and tables added to the database. You an override the default at the schema and individual table levels. | +| | `string` | Date and time the database was dropped. | +| | `boolean` | Current database for the session. | +| | `boolean` | Whether the database is the default database for a user. | +| | `string` | Database type, permanent (default) or transient. | +| | `string` | 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`. | +| | `integer` | 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. | +| | `string` | | +| | `string` | | +| | `string` | Name of the role that owns the database. | +| | `string` | Type of role that owns the object, either ROLE or DATABASE_ROLE | +| | `integer` | Number of days that historical data is retained for Time Travel. | +| | `string` | Specifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. | +| | `string` | Specifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. | +| | `integer` | Maximum number of consecutive failed task runs before the current task is suspended automatically. | +| | `string` | How trace events are ingested into the event table. Currently, Snowflake supports only `ALWAYS`, `ON_EVENT`, and `OFF`. | +| | `string` | 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. | +| | `integer` | Time limit, in milliseconds, for a single run of the task before it times out. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetches a database. | +| | `SELECT` | | Lists the accessible databases. | +| | `INSERT` | | Creates a database, with modifiers as query parameters. You must provide the full database definition when creating a database. | +| | `DELETE` | | Deletes the specified database. If you enable the `ifExists` parameter, the operation succeeds even if the database does not exist. Otherwise, a 404 failure is returned if the database does not exist. if the drop is unsuccessful. | +| | `REPLACE` | | Creates a new, or alters an existing, database. You must provide the full database definition even when altering an existing database. | +| | `EXEC` | | Clones an existing database, with modifiers as query parameters. You must provide the full database definition when cloning an existing database. | +| | `EXEC` | | Creates a database from a given share. | +| | `EXEC` | | Creates a database from a given share. | +| | `EXEC` | | Disables failover for this primary database, meaning no replica of this database (i.e. secondary database) can be promoted to serve as the primary database. | +| | `EXEC` | | Disables replication for this primary database, meaning no replica of this database (i.e. secondary database) in another account can be refreshed. Any secondary databases remain linked to the primary database, but requests to refresh a secondary database are denied. | +| | `EXEC` | | Specifies a comma-separated list of accounts in your organization where a replica of this primary database can be promoted to serve as the primary database. | +| | `EXEC` | | Promotes a local database to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database. | +| | `EXEC` | | Promotes the specified secondary (replica) database to serve as the primary database. When promoted, the database becomes writeable. At the same time, the previous primary database becomes a read-only secondary database. | +| | `EXEC` | | Refreshes a secondary database from a snapshot of its primary database. A snapshot includes changes to the objects and data. If you call this endpoint while another refresh for the same replica database is running, it fails and returns an error. Snowflake ensures only one refresh is executed at any given time. | +| | `EXEC` | | Undrops database. | + +## `SELECT` examples + +Lists the accessible databases. + + +```sql +SELECT +name, +budget, +comment, +created_on, +data_retention_time_in_days, +default_ddl_collation, +dropped_on, +is_current, +is_default, +kind, +log_level, +max_data_extension_time_in_days, +options, +origin, +owner, +owner_role_type, +retention_time, +serverless_task_max_statement_size, +serverless_task_min_statement_size, +suspend_task_after_num_failures, +trace_level, +user_task_managed_initial_warehouse_size, +user_task_timeout_ms +FROM snowflake.database.databases +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new databases resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.database.databases ( +data__name, +endpoint +) +SELECT +'{ name }', +'{ endpoint }' +; +``` + + + +```yaml +- name: databases + props: + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `REPLACE` example + +Replaces all fields in the specified databases resource. + +```sql +/*+ update */ +REPLACE snowflake.database.databases +SET + +WHERE +name = '{ name }' AND data__name = '{ data__name }' AND endpoint = '{ endpoint }'; +``` + +## `DELETE` example + +Deletes the specified databases resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.database.databases +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/database/index.md b/docs/snowflake-docs/providers/snowflake/database/index.md new file mode 100644 index 000000000..22103f100 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/database/index.md @@ -0,0 +1,37 @@ +--- +title: database +hide_title: false +hide_table_of_contents: false +keywords: + - database + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +database service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+databases +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/database_role/database_roles/index.md b/docs/snowflake-docs/providers/snowflake/database_role/database_roles/index.md new file mode 100644 index 000000000..7667f8092 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/database_role/database_roles/index.md @@ -0,0 +1,113 @@ +--- +title: database_roles +hide_title: false +hide_table_of_contents: false +keywords: + - database_roles + - database_role + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a database_roles resource. + +## Overview + + + + +
Namedatabase_roles
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the database role | +| | `string` | User comment associated to an object in the dictionary | +| | `string` | Date and time when the database role was created | +| | `integer` | How many database roles this database role has been granted | +| | `integer` | How many database roles this database role has been granted to | +| | `integer` | How many roles this database role has been granted to | +| | `string` | Role that owns the database role | +| | `string` | The type of role that owns the database role | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List database roles | +| | `INSERT` | | Create a database role | +| | `DELETE` | | Delete a database role | +| | `EXEC` | | Create a new database role by cloning from the specified resource | + +## `SELECT` examples + +List database roles + + +```sql +SELECT +name, +comment, +created_on, +granted_database_roles, +granted_to_database_roles, +granted_to_roles, +owner, +owner_role_type +FROM snowflake.database_role.database_roles +WHERE database = '{{ database }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new database_roles resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.database_role.database_roles ( +data__name, +endpoint, +database +) +SELECT +'{ endpoint }', +'{ name }', +'{ database }' +; +``` + + + +```yaml +- name: database_roles + props: + - name: database + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified database_roles resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.database_role.database_roles +WHERE database = '{ database }' AND name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/database_role/future_grants/index.md b/docs/snowflake-docs/providers/snowflake/database_role/future_grants/index.md new file mode 100644 index 000000000..be7fa6d84 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/database_role/future_grants/index.md @@ -0,0 +1,114 @@ +--- +title: future_grants +hide_title: false +hide_table_of_contents: false +keywords: + - future_grants + - database_role + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a future_grants resource. + +## Overview + + + + +
Namefuture_grants
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | Date and time when the grant was created | +| | `boolean` | If true, allows the recipient role to grant the privileges to other roles. | +| | `string` | The role that granted this privilege to this grantee | +| | `array` | List of privileges to be granted. | +| | `object` | | +| | `string` | Type of the securable to be granted. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all future grants to the role | +| | `INSERT` | | Grant future privileges to the role | +| | `DELETE` | | Revoke future grants from the role | + +## `SELECT` examples + +List all future grants to the role + + +```sql +SELECT +containing_scope, +created_on, +grant_option, +granted_by, +privileges, +securable, +securable_type +FROM snowflake.database_role.future_grants +WHERE database = '{{ database }}' AND name = '{{ name }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new future_grants resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.database_role.future_grants ( +endpoint, +data__securable_type, +name, +database +) +SELECT +'{ endpoint }', +'{ name }', +'{ database }', +'{ securable_type }' +; +``` + + + +```yaml +- name: future_grants + props: + - name: database + value: string + - name: name + value: string + - name: data__securable_type + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified future_grants resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.database_role.future_grants +WHERE database = '{ database }' AND name = '{ name }' AND data__securable_type = '{ data__securable_type }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/database_role/grants/index.md b/docs/snowflake-docs/providers/snowflake/database_role/grants/index.md new file mode 100644 index 000000000..a9658dac0 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/database_role/grants/index.md @@ -0,0 +1,114 @@ +--- +title: grants +hide_title: false +hide_table_of_contents: false +keywords: + - grants + - database_role + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a grants resource. + +## Overview + + + + +
Namegrants
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | Date and time when the grant was created | +| | `boolean` | If true, allows the recipient role to grant the privileges to other roles. | +| | `string` | The role that granted this privilege to this grantee | +| | `array` | List of privileges to be granted. | +| | `object` | | +| | `string` | Type of the securable to be granted. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all grants to the role | +| | `INSERT` | | Grant privileges to the role | +| | `DELETE` | | Revoke grants from the role | + +## `SELECT` examples + +List all grants to the role + + +```sql +SELECT +containing_scope, +created_on, +grant_option, +granted_by, +privileges, +securable, +securable_type +FROM snowflake.database_role.grants +WHERE database = '{{ database }}' AND name = '{{ name }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new grants resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.database_role.grants ( +endpoint, +data__securable_type, +name, +database +) +SELECT +'{ endpoint }', +'{ name }', +'{ database }', +'{ securable_type }' +; +``` + + + +```yaml +- name: grants + props: + - name: database + value: string + - name: name + value: string + - name: data__securable_type + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified grants resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.database_role.grants +WHERE database = '{ database }' AND name = '{ name }' AND data__securable_type = '{ data__securable_type }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/database_role/index.md b/docs/snowflake-docs/providers/snowflake/database_role/index.md new file mode 100644 index 000000000..b6429eebd --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/database_role/index.md @@ -0,0 +1,38 @@ +--- +title: database_role +hide_title: false +hide_table_of_contents: false +keywords: + - database_role + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +database_role service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources +
+
+database_roles
+future_grants +
+
+grants +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/dynamic_table/dynamic_tables/index.md b/docs/snowflake-docs/providers/snowflake/dynamic_table/dynamic_tables/index.md new file mode 100644 index 000000000..9031c562c --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/dynamic_table/dynamic_tables/index.md @@ -0,0 +1,165 @@ +--- +title: dynamic_tables +hide_title: false +hide_table_of_contents: false +keywords: + - dynamic_tables + - dynamic_table + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a dynamic_tables resource. + +## Overview + + + + +
Namedynamic_tables
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Specifies the name for the dynamic table, must be unique for the schema in which the dynamic table is created | +| | `boolean` | If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the dynamic table. | +| | `string` | Name of the budget if the object is monitored by a budget | +| | `integer` | Number of bytes that will be scanned if the entire table is scanned in a query. Note that this number may be different than the number of actual physical bytes stored on-disk for the table | +| | `array` | Specifies one or more columns or column expressions in the dynamic table as the clustering key | +| | `array` | | +| | `string` | Specifies a comment for the dynamic table. | +| | `string` | Date and time when the dynamic table was created. | +| | `integer` | 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 | +| | `string` | Database in which the dynamic table is stored | +| | `string` | Specifies the behavior of the initial refresh of the dynamic table | +| | `string` | Specifies the dynamic table type, permanent (default) or transient. | +| | `integer` | 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 | +| | `string` | Role that owns the table | +| | `string` | The type of role that owns the object. | +| | `string` | Specifies the query whose results the dynamic table should contain | +| | `string` | Specifies the refresh type for the dynamic table | +| | `integer` | Number of rows in the dynamic table. | +| | `string` | Scheduling state (RUNNING or SUSPENDED) | +| | `string` | Schema in which the dynamic table is stored | +| | `object` | Specifies the schedule for periodically refreshing the dynamic table. | +| | `string` | Specifies the name of the warehouse that provides the compute resources for refreshing the dynamic table | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a Dynamic Table. | +| | `SELECT` | | Lists the dynamic tables under the database and schema. | +| | `INSERT` | | Create a dynamic table, with standard create modifiers as query parameters. See the Dynamic Table component definition for what is required to be provided in the request body. | +| | `DELETE` | | Delete a dynamic table with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful. | +| | `EXEC` | | Create a new dynamic table by cloning from the specified resource | +| | `EXEC` | | Specifies that the dynamic table should be manually refreshed | +| | `EXEC` | | Resume refreshes on the dynamic table | +| | `EXEC` | | Resume recluster of a dynamic table | +| | `EXEC` | | Suspend refreshes on the dynamic table | +| | `EXEC` | | Suspend recluster of a dynamic table | +| | `EXEC` | | Swap with another dynamic table | +| | `EXEC` | | Undrop specified dynamic table | + +## `SELECT` examples + +Lists the dynamic tables under the database and schema. + + +```sql +SELECT +name, +automatic_clustering, +budget, +bytes, +cluster_by, +columns, +comment, +created_on, +data_retention_time_in_days, +database_name, +initialize, +kind, +max_data_extension_time_in_days, +owner, +owner_role_type, +query, +refresh_mode, +rows, +scheduling_state, +schema_name, +target_lag, +warehouse +FROM snowflake.dynamic_table.dynamic_tables +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dynamic_tables resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.dynamic_table.dynamic_tables ( +data__warehouse, +data__name, +data__target_lag, +endpoint, +database, +data__query, +schema +) +SELECT +'{ database }', +'{ name }', +'{ schema }', +'{ target_lag }', +'{ endpoint }', +'{ warehouse }', +'{ query }' +; +``` + + + +```yaml +- name: dynamic_tables + props: + - name: database + value: string + - name: schema + value: string + - name: data__name + value: string + - name: data__query + value: string + - name: data__target_lag + value: string + - name: data__warehouse + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified dynamic_tables resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.dynamic_table.dynamic_tables +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/dynamic_table/index.md b/docs/snowflake-docs/providers/snowflake/dynamic_table/index.md new file mode 100644 index 000000000..c97c3d021 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/dynamic_table/index.md @@ -0,0 +1,37 @@ +--- +title: dynamic_table +hide_title: false +hide_table_of_contents: false +keywords: + - dynamic_table + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +dynamic_table service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+dynamic_tables +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/event_table/event_tables/index.md b/docs/snowflake-docs/providers/snowflake/event_table/event_tables/index.md new file mode 100644 index 000000000..52f450f6f --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/event_table/event_tables/index.md @@ -0,0 +1,140 @@ +--- +title: event_tables +hide_title: false +hide_table_of_contents: false +keywords: + - event_tables + - event_table + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a event_tables resource. + +## Overview + + + + +
Nameevent_tables
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the event table | +| | `boolean` | If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the table. | +| | `integer` | Number of bytes that will be scanned if the entire table is scanned in a query.Note that this number may be different than the number of actual physical bytes stored on-disk for the table | +| | `boolean` | True if change tracking is enabled, allowing streams and CHANGES to be used on the entity. | +| | `array` | Cluster key column(s) or expression | +| | `array` | | +| | `string` | user comment associated to an object in the dictionary | +| | `string` | Date and time when the event table was created. | +| | `integer` | number of days to retain the old version of deleted/updated data | +| | `string` | Database in which the event table is stored | +| | `string` | Collation that is used for all the new columns created by the DDL statements (if not specified) | +| | `integer` | Maximum number of days to extend data retention beyond the retention period to prevent a stream becoming stale. | +| | `string` | Role that owns the event table | +| | `string` | The type of role that owns the event table | +| | `integer` | Number of rows in the table. | +| | `string` | Schema in which the event table is stored | +| | `boolean` | If ON, the table has the search optimization service enabled | +| | `integer` | Number of additional bytes of storage that the search optimization service consumes for this table | +| | `integer` | Percentage of the table that has been optimized for search | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch an event table | +| | `SELECT` | | List event tables | +| | `INSERT` | | Create an event table | +| | `DELETE` | | Delete an event table | +| | `EXEC` | | Rename the event table | + +## `SELECT` examples + +List event tables + + +```sql +SELECT +name, +automatic_clustering, +bytes, +change_tracking, +cluster_by, +columns, +comment, +created_on, +data_retention_time_in_days, +database_name, +default_ddl_collation, +max_data_extension_time_in_days, +owner, +owner_role_type, +rows, +schema_name, +search_optimization, +search_optimization_bytes, +search_optimization_progress +FROM snowflake.event_table.event_tables +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_tables resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.event_table.event_tables ( +data__name, +endpoint, +schema, +database +) +SELECT +'{ endpoint }', +'{ name }', +'{ database }', +'{ schema }' +; +``` + + + +```yaml +- name: event_tables + props: + - name: database + value: string + - name: schema + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified event_tables resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.event_table.event_tables +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/event_table/index.md b/docs/snowflake-docs/providers/snowflake/event_table/index.md new file mode 100644 index 000000000..a4ac34e4b --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/event_table/index.md @@ -0,0 +1,37 @@ +--- +title: event_table +hide_title: false +hide_table_of_contents: false +keywords: + - event_table + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +event_table service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+event_tables +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/external_volume/external_volumes/index.md b/docs/snowflake-docs/providers/snowflake/external_volume/external_volumes/index.md new file mode 100644 index 000000000..ef3c9c445 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/external_volume/external_volumes/index.md @@ -0,0 +1,112 @@ +--- +title: external_volumes +hide_title: false +hide_table_of_contents: false +keywords: + - external_volumes + - external_volume + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a external_volumes resource. + +## Overview + + + + +
Nameexternal_volumes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | String that specifies the identifier (the name) for the external volume; must be unique in your account. | +| | `boolean` | Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog. | +| | `string` | String (literal) that specifies a comment for the external volume. | +| | `string` | Date and time when the external volume was created. | +| | `string` | Role that owns the external volume | +| | `string` | The type of role that owns the external volume | +| | `array` | Set of named cloud storage locations in different regions and, optionally, cloud platforms. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch an external volume | +| | `SELECT` | | List external volumes | +| | `INSERT` | | Create an external volume | +| | `DELETE` | | Delete an external volume | +| | `EXEC` | | Undrop an external volume | + +## `SELECT` examples + +List external volumes + + +```sql +SELECT +name, +allow_writes, +comment, +created_on, +owner, +owner_role_type, +storage_locations +FROM snowflake.external_volume.external_volumes +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new external_volumes resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.external_volume.external_volumes ( +data__name, +endpoint, +data__storage_locations +) +SELECT +'{ endpoint }', +'{ name }', +'{ storage_locations }' +; +``` + + + +```yaml +- name: external_volumes + props: + - name: data__name + value: string + - name: data__storage_locations + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified external_volumes resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.external_volume.external_volumes +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/external_volume/index.md b/docs/snowflake-docs/providers/snowflake/external_volume/index.md new file mode 100644 index 000000000..fa2ed506b --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/external_volume/index.md @@ -0,0 +1,37 @@ +--- +title: external_volume +hide_title: false +hide_table_of_contents: false +keywords: + - external_volume + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +external_volume service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+external_volumes +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/function/functions/index.md b/docs/snowflake-docs/providers/snowflake/function/functions/index.md new file mode 100644 index 000000000..931c9886b --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/function/functions/index.md @@ -0,0 +1,124 @@ +--- +title: functions +hide_title: false +hide_table_of_contents: false +keywords: + - functions + - function + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a functions resource. + +## Overview + + + + +
Namefunctions
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Specifies the name for the function, must be unique for the schema in which the function is created | +| | `array` | | +| | `string` | Function's body. | +| | `string` | Date and time when the function was created. | +| | `string` | | +| | `string` | Function's language. | +| | `integer` | Specifies the max rows for batch operation. | +| | `string` | Specifies the type for the function return value. | +| | `string` | Function's arguments. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a Function using the describe command output. | +| | `SELECT` | | Lists the user functions under the database and schema. | +| | `INSERT` | | Create a function. | +| | `DELETE` | | Delete a function with the given name and args. | +| | `EXEC` | | Execute a Function. | + +## `SELECT` examples + +Lists the user functions under the database and schema. + + +```sql +SELECT +name, +arguments, +body, +created_on, +function_type, +language, +max_batch_rows, +returns, +signature +FROM snowflake.function.functions +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new functions resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.function.functions ( +data__arguments, +data__name, +endpoint, +database, +schema +) +SELECT +'{ database }', +'{ name }', +'{ schema }', +'{ endpoint }', +'{ arguments }' +; +``` + + + +```yaml +- name: functions + props: + - name: database + value: string + - name: schema + value: string + - name: data__arguments + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified functions resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.function.functions +WHERE database = '{ database }' AND nameWithArgs = '{ nameWithArgs }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/function/index.md b/docs/snowflake-docs/providers/snowflake/function/index.md new file mode 100644 index 000000000..d0b9df570 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/function/index.md @@ -0,0 +1,37 @@ +--- +title: function +hide_title: false +hide_table_of_contents: false +keywords: + - function + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +function service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+functions +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/grant/grant_options/index.md b/docs/snowflake-docs/providers/snowflake/grant/grant_options/index.md new file mode 100644 index 000000000..1846b2138 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/grant/grant_options/index.md @@ -0,0 +1,48 @@ +--- +title: grant_options +hide_title: false +hide_table_of_contents: false +keywords: + - grant_options + - grant + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a grant_options resource. + +## Overview + + + + +
Namegrant_options
TypeResource
Id
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `DELETE` | | Endpoint to indicate that the grant option for the privilege listed on the group securable in the given scope should be revoked. | +| | `DELETE` | | Endpoint to indicate that the grant option for the privilege listed in the path should be revoked. | + +## `DELETE` example + +Deletes the specified grant_options resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.grant.grant_options +WHERE granteeName = '{ granteeName }' AND granteeType = '{ granteeType }' AND privilege = '{ privilege }' AND securableName = '{ securableName }' AND securableType = '{ securableType }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/grant/grants_to/index.md b/docs/snowflake-docs/providers/snowflake/grant/grants_to/index.md new file mode 100644 index 000000000..0b8f9ff16 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/grant/grants_to/index.md @@ -0,0 +1,66 @@ +--- +title: grants_to +hide_title: false +hide_table_of_contents: false +keywords: + - grants_to + - grant + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a grants_to resource. + +## Overview + + + + +
Namegrants_to
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | | +| | `boolean` | Can grantee pass this privilege down? | +| | `string` | The role that granted this privilege to this grantee | +| | `string` | Type of role that granted this privilege to this grantee | +| | `string` | Specific name of object being granted to | +| | `string` | Entity type being granted to | +| | `array` | Privilege type | +| | `string` | Name of specific object granted on (not name of privilege!) | +| | `string` | Type of object granted on | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List the roles and privileges granted to the specified grantee using the output of SHOW GRANTS TO | + +## `SELECT` examples + +List the roles and privileges granted to the specified grantee using the output of SHOW GRANTS TO + + +```sql +SELECT +created_on, +grant_option, +granted_by_name, +granted_by_role_type, +grantee_name, +grantee_type, +privileges, +securable_name, +securable_type +FROM snowflake.grant.grants_to +WHERE granteeName = '{{ granteeName }}' AND granteeType = '{{ granteeType }}' AND endpoint = '{{ endpoint }}'; +``` \ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/grant/index.md b/docs/snowflake-docs/providers/snowflake/grant/index.md new file mode 100644 index 000000000..1ad0c6538 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/grant/index.md @@ -0,0 +1,38 @@ +--- +title: grant +hide_title: false +hide_table_of_contents: false +keywords: + - grant + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +grant service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources +
+
+grant_options
+grants_to +
+
+privileges +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/grant/privileges/index.md b/docs/snowflake-docs/providers/snowflake/grant/privileges/index.md new file mode 100644 index 000000000..0827aa9cc --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/grant/privileges/index.md @@ -0,0 +1,95 @@ +--- +title: privileges +hide_title: false +hide_table_of_contents: false +keywords: + - privileges + - grant + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a privileges resource. + +## Overview + + + + +
Nameprivileges
TypeResource
Id
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `INSERT` | | Endpoint to indicate that the privileges listed in the request body should be granted to all securables of this type in the given scope. | +| | `INSERT` | | Endpoint to indicate that the privileges listed in the request body should be granted. | +| | `DELETE` | | Endpoint to indicate that the privilege listed on the group securable in the given scope should be revoked. | +| | `DELETE` | | Endpoint to indicate that the privilege listed in the path should be revoked. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new privileges resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.grant.privileges ( +endpoint, +granteeType, +granteeName, +securableType, +securableName +) +SELECT +'{ granteeType }', +'{ securableName }', +'{ endpoint }', +'{ granteeName }', +'{ securableType }' +; +``` + + + +```yaml +- name: privileges + props: + - name: granteeName + value: string + - name: granteeType + value: string + - name: securableName + value: string + - name: securableType + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified privileges resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.grant.privileges +WHERE granteeName = '{ granteeName }' AND granteeType = '{ granteeType }' AND privilege = '{ privilege }' AND securableName = '{ securableName }' AND securableType = '{ securableType }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/iceberg_table/iceberg_tables/index.md b/docs/snowflake-docs/providers/snowflake/iceberg_table/iceberg_tables/index.md new file mode 100644 index 000000000..a54a05da4 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/iceberg_table/iceberg_tables/index.md @@ -0,0 +1,163 @@ +--- +title: iceberg_tables +hide_title: false +hide_table_of_contents: false +keywords: + - iceberg_tables + - iceberg_table + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a iceberg_tables resource. + +## Overview + + + + +
Nameiceberg_tables
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the iceberg table | +| | `boolean` | Specifies whether to automatically refresh the table metadata | +| | `string` | The path to a directory where Snowflake can write data and metadata files for the table. | +| | `string` | Signifies whether Snowflake can write metadata to the location specified by the file_path. | +| | `string` | Name of the catalog integration to use for iceberg tables | +| | `string` | Catalog namespace for the table. The namespace defined when the table was created. Otherwise, the default namespace associated with the catalog integration used by the table. If you’re syncing the table to Snowflake Open Catalog, the default is null. | +| | `string` | Name of the catalog integration to sync this table | +| | `string` | Name of the table as recognized by the catalog. | +| | `boolean` | True if change tracking is enabled, allowing streams and CHANGES to be used on the entity. | +| | `array` | Specifies one or more columns or column expressions in the table as the clustering key. | +| | `array` | | +| | `string` | user comment associated to an object in the dictionary | +| | `array` | | +| | `string` | Date and time when the iceberg table was created. | +| | `integer` | number of days to retain the old version of deleted/updated data | +| | `string` | Database in which the iceberg table is stored | +| | `string` | Name of an external volume that will be used for persisted Iceberg metadata and data files. | +| | `string` | Type of Iceberg table. UNMANAGED if the table is not managed by Snowflake. NOT ICEBERG otherwise. | +| | `integer` | Maximum number of days to extend data retention beyond the retention period to prevent a stream becoming stale. | +| | `string` | Specifies the relative path of the Iceberg metadata file to use for column definitions. | +| | `string` | Role that owns the iceberg table | +| | `string` | The type of role that owns the iceberg table | +| | `boolean` | Specifies whether to replace invalid characters in the column names | +| | `string` | Schema in which the iceberg table is stored | +| | `string` | Storage serialization policy used for managed Iceberg table. This include encodings and compressions | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Describe an iceberg table | +| | `SELECT` | | Lists the Apache Iceberg™ tables for which you have access privileges. | +| | `INSERT` | | Create a snowflake managed iceberg table (clone and undrop are separate subresources) | +| | `DELETE` | | Drop an iceberg table | +| | `EXEC` | | Clone a snowflake managed iceberg table | +| | `EXEC` | | Convert unmanaged iceberg table to managed iceberg table | +| | `EXEC` | | Create a snowflake managed iceberg table as select | +| | `EXEC` | | Creates a new table with the same column definitions as an existing table, but without copying data from the existing table. | +| | `EXEC` | | Create an unmanaged iceberg table from AWS Glue catalog | +| | `EXEC` | | Create an unmanaged iceberg table from Delta | +| | `EXEC` | | Create an unmanaged iceberg table from Iceberg files | +| | `EXEC` | | Create an unmanaged iceberg table from Iceberg REST | +| | `EXEC` | | Refreshes the metadata for an Apache Iceberg table that uses an external Iceberg catalog | +| | `EXEC` | | Resume recluster of an iceberg table (iceberg tables managed by an external catalog do not allow clustering) | +| | `EXEC` | | Suspend recluster of an iceberg table (iceberg tables managed by an external catalog do not allow clustering) | +| | `EXEC` | | Undrop an iceberg table | + +## `SELECT` examples + +Lists the Apache Iceberg™ tables for which you have access privileges. + + +```sql +SELECT +name, +auto_refresh, +base_location, +can_write_metadata, +catalog, +catalog_namespace, +catalog_sync, +catalog_table_name, +change_tracking, +cluster_by, +columns, +comment, +constraints, +created_on, +data_retention_time_in_days, +database_name, +external_volume, +iceberg_table_type, +max_data_extension_time_in_days, +metadata_file_path, +owner, +owner_role_type, +replace_invalid_characters, +schema_name, +storage_serialization_policy +FROM snowflake.iceberg_table.iceberg_tables +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new iceberg_tables resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.iceberg_table.iceberg_tables ( +data__name, +endpoint, +schema, +database +) +SELECT +'{ endpoint }', +'{ name }', +'{ database }', +'{ schema }' +; +``` + + + +```yaml +- name: iceberg_tables + props: + - name: database + value: string + - name: schema + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified iceberg_tables resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.iceberg_table.iceberg_tables +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/iceberg_table/index.md b/docs/snowflake-docs/providers/snowflake/iceberg_table/index.md new file mode 100644 index 000000000..f97cbb51f --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/iceberg_table/index.md @@ -0,0 +1,37 @@ +--- +title: iceberg_table +hide_title: false +hide_table_of_contents: false +keywords: + - iceberg_table + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +iceberg_table service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+iceberg_tables +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/image_repository/image_repositories/index.md b/docs/snowflake-docs/providers/snowflake/image_repository/image_repositories/index.md new file mode 100644 index 000000000..828fee38b --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/image_repository/image_repositories/index.md @@ -0,0 +1,115 @@ +--- +title: image_repositories +hide_title: false +hide_table_of_contents: false +keywords: + - image_repositories + - image_repository + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a image_repositories resource. + +## Overview + + + + +
Nameimage_repositories
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | 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. | +| | `string` | Time the image repository was created. | +| | `string` | 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. | +| | `string` | Identifier for the current owner of the image repository. | +| | `string` | Role type of the image repository owner. | +| | `string` | Current URL of the image repository. | +| | `string` | 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. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetches a named image repository in a specified database and schema. | +| | `SELECT` | | Lists the image repositories under a specified database and schema. | +| | `INSERT` | | Creates an image repository in the specified database, schema, and create mode. The `createMode` query parameter specifies what action to take based on whether the repository already exists. See the ImageRepository component definition for what is required to be provided in the request body. | +| | `DELETE` | | Deletes an image repository with the given name. If you enable the `ifExists` query parameter, the operation succeeds even if the object does not exist. Otherwise, a 404 failure is returned if the object does not exist. | + +## `SELECT` examples + +Lists the image repositories under a specified database and schema. + + +```sql +SELECT +name, +created_on, +database_name, +owner, +owner_role_type, +repository_url, +schema_name +FROM snowflake.image_repository.image_repositories +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new image_repositories resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.image_repository.image_repositories ( +data__name, +endpoint, +schema, +database +) +SELECT +'{ endpoint }', +'{ name }', +'{ database }', +'{ schema }' +; +``` + + + +```yaml +- name: image_repositories + props: + - name: database + value: string + - name: schema + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified image_repositories resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.image_repository.image_repositories +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/image_repository/images/index.md b/docs/snowflake-docs/providers/snowflake/image_repository/images/index.md new file mode 100644 index 000000000..c3f50a354 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/image_repository/images/index.md @@ -0,0 +1,58 @@ +--- +title: images +hide_title: false +hide_table_of_contents: false +keywords: + - images + - image_repository + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a images resource. + +## Overview + + + + +
Nameimages
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Date and time when the image was uploaded to the image repository. | +| | `string` | SHA256 digest of the image. | +| | `string` | Image name. | +| | `string` | Image path (database_name/schema_name/repository_name/image_name:image_tag). | +| | `string` | Image tags. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List images in the given image repository. | + +## `SELECT` examples + +List images in the given image repository. + + +```sql +SELECT +created_on, +digest, +image_name, +image_path, +tags +FROM snowflake.image_repository.images +WHERE database = '{{ database }}' AND name = '{{ name }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` \ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/image_repository/index.md b/docs/snowflake-docs/providers/snowflake/image_repository/index.md new file mode 100644 index 000000000..dbdb30049 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/image_repository/index.md @@ -0,0 +1,37 @@ +--- +title: image_repository +hide_title: false +hide_table_of_contents: false +keywords: + - image_repository + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +image_repository service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources +
+
+image_repositories +
+
+images +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/managed_account/index.md b/docs/snowflake-docs/providers/snowflake/managed_account/index.md new file mode 100644 index 000000000..3367e9a90 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/managed_account/index.md @@ -0,0 +1,37 @@ +--- +title: managed_account +hide_title: false +hide_table_of_contents: false +keywords: + - managed_account + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +managed_account service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+managed_accounts +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/managed_account/managed_accounts/index.md b/docs/snowflake-docs/providers/snowflake/managed_account/managed_accounts/index.md new file mode 100644 index 000000000..42be71e99 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/managed_account/managed_accounts/index.md @@ -0,0 +1,126 @@ +--- +title: managed_accounts +hide_title: false +hide_table_of_contents: false +keywords: + - managed_accounts + - managed_account + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a managed_accounts resource. + +## Overview + + + + +
Namemanaged_accounts
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | 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. | +| | `string` | Account URL that is used to connect to the account, in the legacy account locator format. | +| | `string` | Type of the account. | +| | `string` | Name of the account administrator. | +| | `string` | Password for the account administrator. | +| | `string` | Cloud in which the managed account is located. For reader accounts, this is always the same as the cloud for the provider account. | +| | `string` | Optional comment in which to store information related to the account. | +| | `string` | Date and time the account was created. | +| | `string` | Legacy identifier for the account. | +| | `string` | Region in which the managed account is located. For reader accounts, this is always the same as the region for the provider account. | +| | `string` | Account URL that is used to connect to the account, in the account name format. The account identifier in this format follows the pattern -. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists the accessible managed accounts. | +| | `INSERT` | | Creates a managed account. You must provide the full managed account definition when creating a managed account. | +| | `DELETE` | | Removes a managed account, including all objects created in the account, and immediately restricts access to the account. Currently used by data providers to create reader accounts for their consumers. For more details, see Manage reader accounts. | + +## `SELECT` examples + +Lists the accessible managed accounts. + + +```sql +SELECT +name, +account_locator_url, +account_type, +admin_name, +admin_password, +cloud, +comment, +created_on, +locator, +region, +url +FROM snowflake.managed_account.managed_accounts +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new managed_accounts resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.managed_account.managed_accounts ( +data__name, +data__admin_name, +endpoint, +data__account_type, +data__admin_password +) +SELECT +'{ name }', +'{ account_type }', +'{ admin_name }', +'{ endpoint }', +'{ admin_password }' +; +``` + + + +```yaml +- name: managed_accounts + props: + - name: data__account_type + value: string + - name: data__admin_name + value: string + - name: data__admin_password + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified managed_accounts resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.managed_account.managed_accounts +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/network_policy/index.md b/docs/snowflake-docs/providers/snowflake/network_policy/index.md new file mode 100644 index 000000000..9235bdeb4 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/network_policy/index.md @@ -0,0 +1,37 @@ +--- +title: network_policy +hide_title: false +hide_table_of_contents: false +keywords: + - network_policy + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +network_policy service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+network_policies +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/network_policy/network_policies/index.md b/docs/snowflake-docs/providers/snowflake/network_policy/network_policies/index.md new file mode 100644 index 000000000..9ee0cc4d7 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/network_policy/network_policies/index.md @@ -0,0 +1,111 @@ +--- +title: network_policies +hide_title: false +hide_table_of_contents: false +keywords: + - network_policies + - network_policy + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a network_policies resource. + +## Overview + + + + +
Namenetwork_policies
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the network policy | +| | `array` | List of allowed IPs in a network policy | +| | `array` | List of names of allowed network rules in a network policy | +| | `array` | List of blocked IPs in a network policy | +| | `array` | List of names of blocked network rules in a network policy | +| | `string` | user comment associated to an object in the dictionary | +| | `string` | Date and time when the network policy was created. | +| | `string` | Role that owns the network policy | +| | `string` | The type of role that owns the network policy | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a network policy | +| | `SELECT` | | List network policies | +| | `INSERT` | | Create a network policy | +| | `DELETE` | | Delete a network policy | + +## `SELECT` examples + +List network policies + + +```sql +SELECT +name, +allowed_ip_list, +allowed_network_rule_list, +blocked_ip_list, +blocked_network_rule_list, +comment, +created_on, +owner, +owner_role_type +FROM snowflake.network_policy.network_policies +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_policies resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.network_policy.network_policies ( +data__name, +endpoint +) +SELECT +'{ name }', +'{ endpoint }' +; +``` + + + +```yaml +- name: network_policies + props: + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified network_policies resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.network_policy.network_policies +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/notebook/index.md b/docs/snowflake-docs/providers/snowflake/notebook/index.md new file mode 100644 index 000000000..75f802017 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/notebook/index.md @@ -0,0 +1,37 @@ +--- +title: notebook +hide_title: false +hide_table_of_contents: false +keywords: + - notebook + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +notebook service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+notebooks +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/notebook/notebooks/index.md b/docs/snowflake-docs/providers/snowflake/notebook/notebooks/index.md new file mode 100644 index 000000000..690777fbc --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/notebook/notebooks/index.md @@ -0,0 +1,157 @@ +--- +title: notebooks +hide_title: false +hide_table_of_contents: false +keywords: + - notebooks + - notebook + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a notebooks resource. + +## Overview + + + + +
Namenotebooks
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the notebook | +| | `string` | Name of the budget if the notebook is monitored by a budget | +| | `string` | user comment associated to an object in the dictionary | +| | `string` | Compute pool name where the snowservice runs | +| | `string` | Date and time when the notebook was created. | +| | `string` | Database in which the notebook is stored | +| | `string` | Default packages of the notebook | +| | `string` | The default version name of a file based entity. | +| | `object` | The version details of a file based entity | +| | `array` | List of external access integrations attached to this function | +| | `string` | Secrets to be used with this function for external access | +| | `string` | Location to copy the file from. This must be a Snowflake stage location. | +| | `integer` | Sets the time in seconds for when to shutdown an idle Notebook. | +| | `array` | List of urls | +| | `object` | The version details of a file based entity | +| | `string` | The current version location | +| | `string` | Name + path of the file for the Notebook | +| | `string` | Role that owns the notebook | +| | `string` | The type of role that owns the notebook | +| | `string` | Warehouse against which the queries issued by the Streamlit app are run against | +| | `string` | The runtime to run the Streamlit or Notebook on. If this is not set, the warehouse is assumed | +| | `string` | Schema in which the notebook is stored | +| | `string` | User facing title of the Streamlit app or an Organization Profile | +| | `string` | Unique ID associated with the notebook object. | +| | `string` | User packages of the notebook | +| | `string` | User specified version alias | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a notebook | +| | `SELECT` | | List notebooks | +| | `INSERT` | | Create a notebook | +| | `DELETE` | | Delete a notebook | +| | `EXEC` | | Adds a LIVE version to the notebook | +| | `EXEC` | | If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository | +| | `EXEC` | | Execute a Notebook | +| | `EXEC` | | Changes the name of the notebook to new name. The new identifier must be unique for the schema. | + +## `SELECT` examples + +List notebooks + + +```sql +SELECT +name, +budget, +comment, +compute_pool, +created_on, +database_name, +default_packages, +default_version, +default_version_details, +external_access_integrations, +external_access_secrets, +fromLocation, +idle_auto_shutdown_time_seconds, +import_urls, +last_version_details, +live_version_location_uri, +main_file, +owner, +owner_role_type, +query_warehouse, +runtime_name, +schema_name, +title, +url_id, +user_packages, +version +FROM snowflake.notebook.notebooks +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new notebooks resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.notebook.notebooks ( +data__name, +endpoint, +schema, +database +) +SELECT +'{ endpoint }', +'{ name }', +'{ database }', +'{ schema }' +; +``` + + + +```yaml +- name: notebooks + props: + - name: database + value: string + - name: schema + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified notebooks resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.notebook.notebooks +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/notification_integration/index.md b/docs/snowflake-docs/providers/snowflake/notification_integration/index.md new file mode 100644 index 000000000..110c2fcaa --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/notification_integration/index.md @@ -0,0 +1,37 @@ +--- +title: notification_integration +hide_title: false +hide_table_of_contents: false +keywords: + - notification_integration + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +notification_integration service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+notification_integrations +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/notification_integration/notification_integrations/index.md b/docs/snowflake-docs/providers/snowflake/notification_integration/notification_integrations/index.md new file mode 100644 index 000000000..843a34f91 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/notification_integration/notification_integrations/index.md @@ -0,0 +1,107 @@ +--- +title: notification_integrations +hide_title: false +hide_table_of_contents: false +keywords: + - notification_integrations + - notification_integration + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a notification_integrations resource. + +## Overview + + + + +
Namenotification_integrations
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the notification. | +| | `string` | Comment for the notification integration. | +| | `string` | Date and time when the notification was created. | +| | `boolean` | Whether the notification integration is enabled. | +| | `object` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a notification integration | +| | `SELECT` | | List notification integrations | +| | `INSERT` | | Create a notification integration | +| | `DELETE` | | Delete a notification integration | + +## `SELECT` examples + +List notification integrations + + +```sql +SELECT +name, +comment, +created_on, +enabled, +notification_hook +FROM snowflake.notification_integration.notification_integrations +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new notification_integrations resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.notification_integration.notification_integrations ( +data__notification_hook, +data__name, +endpoint +) +SELECT +'{ notification_hook }', +'{ name }', +'{ endpoint }' +; +``` + + + +```yaml +- name: notification_integrations + props: + - name: data__name + value: string + - name: data__notification_hook + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified notification_integrations resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.notification_integration.notification_integrations +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/pipe/index.md b/docs/snowflake-docs/providers/snowflake/pipe/index.md new file mode 100644 index 000000000..e75eb8a30 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/pipe/index.md @@ -0,0 +1,37 @@ +--- +title: pipe +hide_title: false +hide_table_of_contents: false +keywords: + - pipe + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +pipe service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+pipes +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/pipe/pipes/index.md b/docs/snowflake-docs/providers/snowflake/pipe/pipes/index.md new file mode 100644 index 000000000..a6f275b36 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/pipe/pipes/index.md @@ -0,0 +1,136 @@ +--- +title: pipes +hide_title: false +hide_table_of_contents: false +keywords: + - pipes + - pipe + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a pipes resource. + +## Overview + + + + +
Namepipes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the pipe | +| | `boolean` | TRUE if all files from stage need to be auto-ingested | +| | `string` | Optional, if provided, auto_ingest pipe will only receive messages from this SNS topic. | +| | `string` | Name of the budget if the pipe is monitored by a budget | +| | `string` | user comment associated to an object in the dictionary | +| | `string` | COPY INTO statement used to load data from queued files into a Snowflake table. This statement serves as the text/definition for the pipe and is displayed in the SHOW PIPES output | +| | `string` | Date and time when the pipe was created. | +| | `string` | Database in which the pipe is stored | +| | `string` | Link to integration object that point to a user provided Azure storage queue / SQS. When present, errors (e.g. ingest failure for Snowpipe or a user task failure or replication failure) will be sent to this queue to notify customers | +| | `string` | Link to integration object that ties a user provided storage queue to an auto_ingest enabled pipe. Required for auto_ingest to work on azure. | +| | `string` | Displays some detailed information for your pipes that may have issues | +| | `string` | Role that owns the pipe | +| | `string` | The type of role that owns the pipe | +| | `string` | PATTERN copy option value in the COPY INTO statement in the pipe definition, if the copy option was specified. | +| | `string` | Schema in which the pipe is stored | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a pipe | +| | `SELECT` | | List pipes | +| | `INSERT` | | Create a pipe | +| | `DELETE` | | Delete a pipe | +| | `EXEC` | | Refresh the pipe | + +## `SELECT` examples + +List pipes + + +```sql +SELECT +name, +auto_ingest, +aws_sns_topic, +budget, +comment, +copy_statement, +created_on, +database_name, +error_integration, +integration, +invalid_reason, +owner, +owner_role_type, +pattern, +schema_name +FROM snowflake.pipe.pipes +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pipes resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.pipe.pipes ( +data__name, +endpoint, +data__copy_statement, +database, +schema +) +SELECT +'{ database }', +'{ name }', +'{ schema }', +'{ copy_statement }', +'{ endpoint }' +; +``` + + + +```yaml +- name: pipes + props: + - name: database + value: string + - name: schema + value: string + - name: data__copy_statement + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified pipes resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.pipe.pipes +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/procedure/index.md b/docs/snowflake-docs/providers/snowflake/procedure/index.md new file mode 100644 index 000000000..93b21eb82 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/procedure/index.md @@ -0,0 +1,37 @@ +--- +title: procedure +hide_title: false +hide_table_of_contents: false +keywords: + - procedure + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +procedure service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+procedures +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/procedure/procedures/index.md b/docs/snowflake-docs/providers/snowflake/procedure/procedures/index.md new file mode 100644 index 000000000..c1b8a24bb --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/procedure/procedures/index.md @@ -0,0 +1,150 @@ +--- +title: procedures +hide_title: false +hide_table_of_contents: false +keywords: + - procedures + - procedure + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a procedures resource. + +## Overview + + + + +
Nameprocedures
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the procedure | +| | `array` | List of arguments for the function/procedure | +| | `string` | Function/procedure definition | +| | `string` | Specifies a comment for the function/procedure | +| | `string` | The date and time when the function/procedure was created | +| | `string` | The name of the database in which the function/procedure exists. | +| | `string` | What permissions should the procedure execution be called with | +| | `boolean` | If the function/procedure is built-in or not (user-defined) | +| | `boolean` | Specifies whether the function/procedure is secure or not | +| | `object` | | +| | `integer` | The maximum number of arguments | +| | `integer` | The minimum number of arguments | +| | `string` | Role that owns the function/procedure | +| | `string` | The type of role that owns the function/procedure | +| | `object` | | +| | `string` | The name of the schema in which the function/procedure exists. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a procedure | +| | `SELECT` | | List procedures | +| | `INSERT` | | Create a procedure | +| | `DELETE` | | Delete a procedure | +| | `EXEC` | | Call a procedure | + +## `SELECT` examples + +List procedures + + +```sql +SELECT +name, +arguments, +body, +comment, +created_on, +database_name, +execute_as, +is_builtin, +is_secure, +language_config, +max_num_arguments, +min_num_arguments, +owner, +owner_role_type, +return_type, +schema_name +FROM snowflake.procedure.procedures +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new procedures resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.procedure.procedures ( +data__arguments, +data__name, +data__return_type, +endpoint, +data__language_config, +schema, +database, +data__body +) +SELECT +'{ database }', +'{ language_config }', +'{ name }', +'{ schema }', +'{ return_type }', +'{ endpoint }', +'{ body }', +'{ arguments }' +; +``` + + + +```yaml +- name: procedures + props: + - name: database + value: string + - name: schema + value: string + - name: data__arguments + value: string + - name: data__body + value: string + - name: data__language_config + value: string + - name: data__name + value: string + - name: data__return_type + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified procedures resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.procedure.procedures +WHERE database = '{ database }' AND nameWithArgs = '{ nameWithArgs }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/result/index.md b/docs/snowflake-docs/providers/snowflake/result/index.md new file mode 100644 index 000000000..724c5e92f --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/result/index.md @@ -0,0 +1,37 @@ +--- +title: result +hide_title: false +hide_table_of_contents: false +keywords: + - result + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +result service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+results +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/result/results/index.md b/docs/snowflake-docs/providers/snowflake/result/results/index.md new file mode 100644 index 000000000..4173eb4ac --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/result/results/index.md @@ -0,0 +1,37 @@ +--- +title: results +hide_title: false +hide_table_of_contents: false +keywords: + - results + - result + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a results resource. + +## Overview + + + + +
Nameresults
TypeResource
Id
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `EXEC` | | Get result status or the result when it is ready. | diff --git a/docs/snowflake-docs/providers/snowflake/role/future_grants/index.md b/docs/snowflake-docs/providers/snowflake/role/future_grants/index.md new file mode 100644 index 000000000..779dfecd5 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/role/future_grants/index.md @@ -0,0 +1,110 @@ +--- +title: future_grants +hide_title: false +hide_table_of_contents: false +keywords: + - future_grants + - role + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a future_grants resource. + +## Overview + + + + +
Namefuture_grants
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | Date and time when the grant was created | +| | `boolean` | If true, allows the recipient role to grant the privileges to other roles. | +| | `string` | The role that granted this privilege to this grantee | +| | `array` | List of privileges to be granted. | +| | `object` | | +| | `string` | Type of the securable to be granted. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all future grants to the role | +| | `INSERT` | | Grant future privileges to the role | +| | `DELETE` | | Revoke future grants from the role | + +## `SELECT` examples + +List all future grants to the role + + +```sql +SELECT +containing_scope, +created_on, +grant_option, +granted_by, +privileges, +securable, +securable_type +FROM snowflake.role.future_grants +WHERE name = '{{ name }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new future_grants resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.role.future_grants ( +endpoint, +data__securable_type, +name +) +SELECT +'{ name }', +'{ endpoint }', +'{ securable_type }' +; +``` + + + +```yaml +- name: future_grants + props: + - name: name + value: string + - name: data__securable_type + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified future_grants resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.role.future_grants +WHERE name = '{ name }' AND data__securable_type = '{ data__securable_type }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/role/grants/index.md b/docs/snowflake-docs/providers/snowflake/role/grants/index.md new file mode 100644 index 000000000..a3ed73b38 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/role/grants/index.md @@ -0,0 +1,110 @@ +--- +title: grants +hide_title: false +hide_table_of_contents: false +keywords: + - grants + - role + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a grants resource. + +## Overview + + + + +
Namegrants
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | Date and time when the grant was created | +| | `boolean` | If true, allows the recipient role to grant the privileges to other roles. | +| | `string` | The role that granted this privilege to this grantee | +| | `array` | List of privileges to be granted. | +| | `object` | | +| | `string` | Type of the securable to be granted. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all grants to the role | +| | `INSERT` | | Grant privileges to the role | +| | `DELETE` | | Revoke grants from the role | + +## `SELECT` examples + +List all grants to the role + + +```sql +SELECT +containing_scope, +created_on, +grant_option, +granted_by, +privileges, +securable, +securable_type +FROM snowflake.role.grants +WHERE name = '{{ name }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new grants resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.role.grants ( +endpoint, +data__securable_type, +name +) +SELECT +'{ name }', +'{ endpoint }', +'{ securable_type }' +; +``` + + + +```yaml +- name: grants + props: + - name: name + value: string + - name: data__securable_type + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified grants resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.role.grants +WHERE name = '{ name }' AND data__securable_type = '{ data__securable_type }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/role/grants_of/index.md b/docs/snowflake-docs/providers/snowflake/role/grants_of/index.md new file mode 100644 index 000000000..b763f098f --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/role/grants_of/index.md @@ -0,0 +1,58 @@ +--- +title: grants_of +hide_title: false +hide_table_of_contents: false +keywords: + - grants_of + - role + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a grants_of resource. + +## Overview + + + + +
Namegrants_of
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Date and time when the grant was created | +| | `string` | The role that granted this role to this grantee | +| | `string` | The type of the grantee, can be USER or ROLE | +| | `string` | The name of the grantee | +| | `string` | The name of the role | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all grants of the role | + +## `SELECT` examples + +List all grants of the role + + +```sql +SELECT +created_on, +granted_by, +granted_to, +grantee_name, +role +FROM snowflake.role.grants_of +WHERE name = '{{ name }}' AND endpoint = '{{ endpoint }}'; +``` \ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/role/grants_on/index.md b/docs/snowflake-docs/providers/snowflake/role/grants_on/index.md new file mode 100644 index 000000000..f2346fd8d --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/role/grants_on/index.md @@ -0,0 +1,66 @@ +--- +title: grants_on +hide_title: false +hide_table_of_contents: false +keywords: + - grants_on + - role + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a grants_on resource. + +## Overview + + + + +
Namegrants_on
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The name of the role | +| | `string` | Date and time when the grant was created | +| | `string` | If true, allows the recipient role to grant the privileges to other roles. | +| | `string` | The role that granted this privilege to this grantee | +| | `string` | Type of the role that granted this privilege to this grantee | +| | `string` | The type of of the role | +| | `string` | The type of the grantee | +| | `string` | The name of the grantee | +| | `string` | The name of the privilege | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all grants on the role | + +## `SELECT` examples + +List all grants on the role + + +```sql +SELECT +name, +created_on, +grant_option, +granted_by, +granted_by_role_type, +granted_on, +granted_to, +grantee_name, +privilege +FROM snowflake.role.grants_on +WHERE name = '{{ name }}' AND endpoint = '{{ endpoint }}'; +``` \ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/role/index.md b/docs/snowflake-docs/providers/snowflake/role/index.md new file mode 100644 index 000000000..d8aaad898 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/role/index.md @@ -0,0 +1,40 @@ +--- +title: role +hide_title: false +hide_table_of_contents: false +keywords: + - role + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +role service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources +
+
+future_grants
+grants
+grants_of +
+
+grants_on
+roles +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/role/roles/index.md b/docs/snowflake-docs/providers/snowflake/role/roles/index.md new file mode 100644 index 000000000..24d1d1965 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/role/roles/index.md @@ -0,0 +1,112 @@ +--- +title: roles +hide_title: false +hide_table_of_contents: false +keywords: + - roles + - role + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a roles resource. + +## Overview + + + + +
Nameroles
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the role. | +| | `integer` | The number of users to whom this role has been assigned. | +| | `string` | Comment of the role. | +| | `string` | Date and time when the role was created. | +| | `integer` | The number of roles that have been granted to this role. | +| | `integer` | The number of roles to which this role has been granted. | +| | `boolean` | Specifies whether the role being fetched is the user's current role. | +| | `boolean` | Specifies whether the role being fetched is the user's default role. | +| | `boolean` | Specifies whether the role used to run the command inherits the specified role. | +| | `string` | Specifies the role that owns this role. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List roles | +| | `INSERT` | | Create a role | +| | `DELETE` | | Delete a role | + +## `SELECT` examples + +List roles + + +```sql +SELECT +name, +assigned_to_users, +comment, +created_on, +granted_roles, +granted_to_roles, +is_current, +is_default, +is_inherited, +owner +FROM snowflake.role.roles +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new roles resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.role.roles ( +data__name, +endpoint +) +SELECT +'{ name }', +'{ endpoint }' +; +``` + + + +```yaml +- name: roles + props: + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified roles resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.role.roles +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/schema/index.md b/docs/snowflake-docs/providers/snowflake/schema/index.md new file mode 100644 index 000000000..c1cffa589 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/schema/index.md @@ -0,0 +1,37 @@ +--- +title: schema +hide_title: false +hide_table_of_contents: false +keywords: + - schema + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +schema service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+schemas +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/schema/schemas/index.md b/docs/snowflake-docs/providers/snowflake/schema/schemas/index.md new file mode 100644 index 000000000..ebf54273d --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/schema/schemas/index.md @@ -0,0 +1,163 @@ +--- +title: schemas +hide_title: false +hide_table_of_contents: false +keywords: + - schemas + - schema + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a schemas resource. + +## Overview + + + + +
Nameschemas
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | 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. | +| | `string` | Budget that defines a monthly spending limit on the compute costs for a Snowflake account or a custom group of Snowflake objects. | +| | `string` | Optional comment in which to store information related to the schema. | +| | `string` | Date and time the schema was created. | +| | `integer` | Number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the schema, as well as specifying the default Time Travel retention time for all tables created in the schema | +| | `string` | Database that the schema belongs to | +| | `string` | Specifies a default collation specification for all tables added to the schema. You an override the default at the schema and individual table levels. | +| | `string` | Date and time the schema was dropped. | +| | `boolean` | Current schema for the session. | +| | `boolean` | Default schema for a user. | +| | `string` | Schema type, permanent (default) or transient. | +| | `string` | 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`. | +| | `boolean` | Whether this schema is a managed access schema that centralizes privilege management with the schema owner. | +| | `integer` | Maximum number of days for which Snowflake can extend the data retention period for tables in the schema to prevent streams on the tables from becoming stale. | +| | `string` | | +| | `string` | Name of the role that owns the schema. | +| | `string` | Type of role that owns the object, either `ROLE` or `DATABASE_ROLE`. | +| | `boolean` | Whether pipe execution is paused. | +| | `integer` | Number of days that historical data is retained for Time Travel. | +| | `string` | Specifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. | +| | `string` | Specifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. | +| | `integer` | Specifies the number of consecutive failed task runs after which the current task is suspended automatically. | +| | `string` | How trace events are ingested into the event table. Currently, Snowflake supports only `ALWAYS`, `ON_EVENT`, and `OFF`. | +| | `string` | 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. | +| | `integer` | Time limit, in milliseconds, for a single run of the task before it times out. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetches a schema. | +| | `SELECT` | | Lists the accessible schemas. | +| | `INSERT` | | Creates a schema, with modifiers as query parameters. You must provide the full schema definition when creating a schema. | +| | `DELETE` | | Deletes the specified schema. If you enable the `ifExists` parameter, the operation succeeds even if the schema does not exist. Otherwise, a 404 failure is returned if the schema does not exist. if the drop is unsuccessful. | +| | `REPLACE` | | Creates a new, or alters an existing, schema. You must provide the full schema definition even when altering an existing schema. | +| | `EXEC` | | Clones an existing schema, with modifiers as query parameters. You must provide the full schema definition when cloning an existing schema. | +| | `EXEC` | | Undrops schema. | + +## `SELECT` examples + +Lists the accessible schemas. + + +```sql +SELECT +name, +budget, +comment, +created_on, +data_retention_time_in_days, +database_name, +default_ddl_collation, +dropped_on, +is_current, +is_default, +kind, +log_level, +managed_access, +max_data_extension_time_in_days, +options, +owner, +owner_role_type, +pipe_execution_paused, +retention_time, +serverless_task_max_statement_size, +serverless_task_min_statement_size, +suspend_task_after_num_failures, +trace_level, +user_task_managed_initial_warehouse_size, +user_task_timeout_ms +FROM snowflake.schema.schemas +WHERE database = '{{ database }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new schemas resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.schema.schemas ( +data__name, +endpoint, +database +) +SELECT +'{ endpoint }', +'{ name }', +'{ database }' +; +``` + + + +```yaml +- name: schemas + props: + - name: database + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `REPLACE` example + +Replaces all fields in the specified schemas resource. + +```sql +/*+ update */ +REPLACE snowflake.schema.schemas +SET + +WHERE +database = '{ database }' AND name = '{ name }' AND data__name = '{ data__name }' AND endpoint = '{ endpoint }'; +``` + +## `DELETE` example + +Deletes the specified schemas resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.schema.schemas +WHERE database = '{ database }' AND name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/sqlapi/index.md b/docs/snowflake-docs/providers/snowflake/sqlapi/index.md new file mode 100644 index 000000000..63d3cbdf8 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/sqlapi/index.md @@ -0,0 +1,37 @@ +--- +title: sqlapi +hide_title: false +hide_table_of_contents: false +keywords: + - sqlapi + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +sqlapi service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+statements +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/sqlapi/statements/index.md b/docs/snowflake-docs/providers/snowflake/sqlapi/statements/index.md new file mode 100644 index 000000000..76c0c422d --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/sqlapi/statements/index.md @@ -0,0 +1,68 @@ +--- +title: statements +hide_title: false +hide_table_of_contents: false +keywords: + - statements + - sqlapi + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a statements resource. + +## Overview + + + + +
Namestatements
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | | +| | `integer` | Timestamp that specifies when the statement execution started.‌ The timestamp is expressed in milliseconds since the epoch.‌ | +| | `array` | Result set data. | +| | `string` | | +| | `object` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `object` | these stats might not be available for each request. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Checks the status of the execution of the statement with the specified statement handle. If the statement was executed successfully, the operation returns the requested partition of the result set. | +| | `SELECT` | | Submits one or more statements for execution. You can specify that the statement should be executed asynchronously. | +| | `EXEC` | | Cancels the execution of the statement with the specified statement handle. | + +## `SELECT` examples + +Submits one or more statements for execution. You can specify that the statement should be executed asynchronously. + + +```sql +SELECT +code, +createdOn, +data, +message, +resultSetMetaData, +sqlState, +statementHandle, +statementStatusUrl, +stats +FROM snowflake.sqlapi.statements +WHERE User-Agent = '{{ User-Agent }}' AND endpoint = '{{ endpoint }}'; +``` \ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/stage/files/index.md b/docs/snowflake-docs/providers/snowflake/stage/files/index.md new file mode 100644 index 000000000..96769e93b --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/stage/files/index.md @@ -0,0 +1,56 @@ +--- +title: files +hide_title: false +hide_table_of_contents: false +keywords: + - files + - stage + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a files resource. + +## Overview + + + + +
Namefiles
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the file. | +| | `string` | Date and time when the file was last modified. | +| | `string` | md5 hash of the file. | +| | `string` | Size of the file. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List files in the stage -- this is equivalent to LIST @stage. | + +## `SELECT` examples + +List files in the stage -- this is equivalent to LIST @stage. + + +```sql +SELECT +name, +last_modified, +md5, +size +FROM snowflake.stage.files +WHERE database = '{{ database }}' AND name = '{{ name }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` \ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/stage/index.md b/docs/snowflake-docs/providers/snowflake/stage/index.md new file mode 100644 index 000000000..64ac98a1c --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/stage/index.md @@ -0,0 +1,38 @@ +--- +title: stage +hide_title: false +hide_table_of_contents: false +keywords: + - stage + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +stage service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources +
+
+files
+presigned_url +
+
+stages +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/stage/presigned_url/index.md b/docs/snowflake-docs/providers/snowflake/stage/presigned_url/index.md new file mode 100644 index 000000000..44a083e3a --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/stage/presigned_url/index.md @@ -0,0 +1,50 @@ +--- +title: presigned_url +hide_title: false +hide_table_of_contents: false +keywords: + - presigned_url + - stage + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a presigned_url resource. + +## Overview + + + + +
Namepresigned_url
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Presigned url for file transfer, only works for Server Side Encrypted Stages. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Generate a presigned url and optionally encryption materials for uploading and downloading files. | + +## `SELECT` examples + +Generate a presigned url and optionally encryption materials for uploading and downloading files. + + +```sql +SELECT +presigned_url +FROM snowflake.stage.presigned_url +WHERE database = '{{ database }}' AND filePath = '{{ filePath }}' AND name = '{{ name }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` \ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/stage/stages/index.md b/docs/snowflake-docs/providers/snowflake/stage/stages/index.md new file mode 100644 index 000000000..a2e9ee9d8 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/stage/stages/index.md @@ -0,0 +1,133 @@ +--- +title: stages +hide_title: false +hide_table_of_contents: false +keywords: + - stages + - stage + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a stages resource. + +## Overview + + + + +
Namestages
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | 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. | +| | `string` | Cloud provider; always NULL for an internal stage. | +| | `string` | Specifies a comment for the stage. | +| | `string` | Date and time when the stage was created. | +| | `object` | Specifies the credentials of the stage. | +| | `object` | Directory table parameters of the stage. | +| | `object` | Encryption parameters of the stage. | +| | `string` | The S3-compatible API endpoint associated with the stage; always NULL for stages that are not S3-compatible. | +| | `boolean` | Indicates that the external stage has access credentials; always false for an internal stage. | +| | `boolean` | Indicates that the external stage contains encrypted files; always false for an internal stage. | +| | `string` | Specifies whether the stage is permanent or temporary. | +| | `string` | Role that owns the stage. | +| | `string` | The type of role that owns the object, either ROLE or DATABASE_ROLE. If a Snowflake Native App owns the object, the value is APPLICATION. Snowflake returns NULL if you delete the object because a deleted object does not have an owner role. | +| | `string` | Region where the stage is located. | +| | `string` | 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. | +| | `string` | URL for the external stage; blank for an internal stage. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a stage using the describe command output. | +| | `SELECT` | | Lists stages under the database and schema, with show options as query parameters. | +| | `INSERT` | | Create a stage, with standard create modifiers as query parameters. See the Stage component definition for what is required to be provided in the request body. | +| | `DELETE` | | Delete a stage with the stage name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful. | + +## `SELECT` examples + +Lists stages under the database and schema, with show options as query parameters. + + +```sql +SELECT +name, +cloud, +comment, +created_on, +credentials, +directory_table, +encryption, +endpoint, +has_credentials, +has_encryption_key, +kind, +owner, +owner_role_type, +region, +storage_integration, +url +FROM snowflake.stage.stages +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stages resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.stage.stages ( +data__name, +endpoint, +schema, +database +) +SELECT +'{ endpoint }', +'{ name }', +'{ database }', +'{ schema }' +; +``` + + + +```yaml +- name: stages + props: + - name: database + value: string + - name: schema + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified stages resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.stage.stages +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/streams/index.md b/docs/snowflake-docs/providers/snowflake/streams/index.md new file mode 100644 index 000000000..a121d0ec2 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/streams/index.md @@ -0,0 +1,37 @@ +--- +title: streams +hide_title: false +hide_table_of_contents: false +keywords: + - streams + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +streams service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+streams +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/streams/streams/index.md b/docs/snowflake-docs/providers/snowflake/streams/streams/index.md new file mode 100644 index 000000000..5234e6832 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/streams/streams/index.md @@ -0,0 +1,134 @@ +--- +title: streams +hide_title: false +hide_table_of_contents: false +keywords: + - streams + - streams + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a streams resource. + +## Overview + + + + +
Namestreams
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the stream | +| | `string` | user comment associated to an object in the dictionary | +| | `string` | Date and time when the stream was created. | +| | `string` | Database in which the stream is stored | +| | `string` | Reason why the stream cannot be queried successfully. This column supports future functionality. Currently, the only value returned is N/A. | +| | `string` | Mode of the stream. Possible values include: APPEND_ONLY, INSERT_ONLY. For streams on tables, the column displays DEFAULT. | +| | `string` | Role that owns the stream | +| | `string` | The type of role that owns the stream | +| | `string` | Schema in which the stream is stored | +| | `boolean` | Specifies whether the stream is stale or not | +| | `string` | Timestamp when the stream became stale or may become stale if not consumed. | +| | `object` | | +| | `string` | Table name whose changes are tracked by the stream | +| | `string` | Type of the stream; currently DELTA only. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a stream | +| | `SELECT` | | List streams | +| | `INSERT` | | Create a stream | +| | `DELETE` | | Delete a stream | +| | `EXEC` | | Clone a stream | + +## `SELECT` examples + +List streams + + +```sql +SELECT +name, +comment, +created_on, +database_name, +invalid_reason, +mode, +owner, +owner_role_type, +schema_name, +stale, +stale_after, +stream_source, +table_name, +type +FROM snowflake.streams.streams +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new streams resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.streams.streams ( +data__name, +endpoint, +data__stream_source, +database, +schema +) +SELECT +'{ database }', +'{ name }', +'{ stream_source }', +'{ schema }', +'{ endpoint }' +; +``` + + + +```yaml +- name: streams + props: + - name: database + value: string + - name: schema + value: string + - name: data__name + value: string + - name: data__stream_source + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified streams resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.streams.streams +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/table/index.md b/docs/snowflake-docs/providers/snowflake/table/index.md new file mode 100644 index 000000000..e12718946 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/table/index.md @@ -0,0 +1,37 @@ +--- +title: table +hide_title: false +hide_table_of_contents: false +keywords: + - table + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +table service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+tables +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/table/tables/index.md b/docs/snowflake-docs/providers/snowflake/table/tables/index.md new file mode 100644 index 000000000..ed7c72e5f --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/table/tables/index.md @@ -0,0 +1,179 @@ +--- +title: tables +hide_title: false +hide_table_of_contents: false +keywords: + - tables + - table + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a tables resource. + +## Overview + + + + +
Nametables
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Specifies the name for the table, must be unique for the schema in which the table is created | +| | `boolean` | If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the table. | +| | `string` | Name of the budget if the object is monitored by a budget | +| | `integer` | Number of bytes that will be scanned if the entire table is scanned in a query. Note that this number may be different than the number of actual physical bytes stored on-disk for the table | +| | `boolean` | Change tracking is enabled or disabled | +| | `array` | Specifies one or more columns or column expressions in the table as the clustering key | +| | `array` | | +| | `string` | Comment for the table | +| | `array` | | +| | `string` | Date and time when the table was created. | +| | `integer` | Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table | +| | `string` | Database in which the table is stored | +| | `string` | Specifies a default collation specification for the columns in the table, including columns added to the table in the future | +| | `string` | Date and time when the table was dropped | +| | `boolean` | Table has schema evolution enabled or disabled | +| | `string` | Table type - permanent, transient, or temporary | +| | `integer` | Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table | +| | `string` | Role that owns the table | +| | `string` | The type of role that owns the object. | +| | `integer` | Number of rows in the table. Returns NULL for external tables. | +| | `string` | Schema in which the table is stored | +| | `boolean` | If ON, the table has the search optimization service enabled | +| | `integer` | Number of additional bytes of storage that the search optimization service consumes for this table | +| | `integer` | Percentage of the table that has been optimized for search. | +| | `string` | Type of the table | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a Table using the describe command output. | +| | `SELECT` | | Lists the tables under the database and schema. | +| | `INSERT` | | Create a table. | +| | `INSERT` | | Create a table as select. | +| | `INSERT` | | Create a new table like the specified resource, but empty | +| | `INSERT` | | Create a new table like the specified resource, but empty | +| | `DELETE` | | Delete a table with the given name. | +| | `REPLACE` | | Create a (or alter an existing) table. Even if the operation is just an alter, the full property set must be provided. | +| | `EXEC` | | Create a new table by cloning from the specified resource | +| | `EXEC` | | Create a table as select. | +| | `EXEC` | | Create a table using template. | +| | `EXEC` | | Create a table using template. | +| | `EXEC` | | Resume recluster of a table | +| | `EXEC` | | Resume recluster of a table | +| | `EXEC` | | Suspend recluster of a table | +| | `EXEC` | | Suspend recluster of a table | +| | `EXEC` | | Swap with another table | +| | `EXEC` | | Swap with another table | +| | `EXEC` | | Undrop specified table | + +## `SELECT` examples + +Lists the tables under the database and schema. + + +```sql +SELECT +name, +automatic_clustering, +budget, +bytes, +change_tracking, +cluster_by, +columns, +comment, +constraints, +created_on, +data_retention_time_in_days, +database_name, +default_ddl_collation, +dropped_on, +enable_schema_evolution, +kind, +max_data_extension_time_in_days, +owner, +owner_role_type, +rows, +schema_name, +search_optimization, +search_optimization_bytes, +search_optimization_progress, +table_type +FROM snowflake.table.tables +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tables resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.table.tables ( +endpoint, +name, +schema, +database +) +SELECT +'{ endpoint }', +'{ name }', +'{ database }', +'{ schema }' +; +``` + + + +```yaml +- name: tables + props: + - name: database + value: string + - name: name + value: string + - name: schema + value: string + - name: endpoint + value: string + +``` + + + +## `REPLACE` example + +Replaces all fields in the specified tables resource. + +```sql +/*+ update */ +REPLACE snowflake.table.tables +SET + +WHERE +database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND data__name = '{ data__name }' AND endpoint = '{ endpoint }'; +``` + +## `DELETE` example + +Deletes the specified tables resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.table.tables +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/task/complete_graphs/index.md b/docs/snowflake-docs/providers/snowflake/task/complete_graphs/index.md new file mode 100644 index 000000000..0fbd14264 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/task/complete_graphs/index.md @@ -0,0 +1,77 @@ +--- +title: complete_graphs +hide_title: false +hide_table_of_contents: false +keywords: + - complete_graphs + - task + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a complete_graphs resource. + +## Overview + + + + +
Namecomplete_graphs
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The time this task run was last completed. | +| | `string` | The name of the current database for the task run. | +| | `integer` | The first error code thrown in the task run. | +| | `string` | The first error message thrown in the task run. | +| | `string` | The name of the first task throwing an error in the task run. | +| | `integer` | The current version of the DAG on the task run. | +| | `string` | The next upcoming time for the task run. | +| | `string` | The start time for the task run query. | +| | `string` | The unique task ID for the root task. | +| | `string` | The name of the root task in the current task run. | +| | `integer` | The unique ID for the current task run. | +| | `string` | The scheduled time for the task run. | +| | `string` | The name of the current schema for the task run. | +| | `string` | The current state of the task run. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | This function returns details for graph runs that are completed. | +| | `SELECT` | | This function returns details for graph runs that are completed. | + +## `SELECT` examples + +This function returns details for graph runs that are completed. + + +```sql +SELECT +completed_time, +database_name, +first_error_code, +first_error_message, +first_error_task_name, +graph_version, +next_scheduled_time, +query_start_time, +root_task_id, +root_task_name, +run_id, +scheduled_time, +schema_name, +state +FROM snowflake.task.complete_graphs +WHERE database = '{{ database }}' AND name = '{{ name }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` \ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/task/current_graphs/index.md b/docs/snowflake-docs/providers/snowflake/task/current_graphs/index.md new file mode 100644 index 000000000..bbb4676cd --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/task/current_graphs/index.md @@ -0,0 +1,77 @@ +--- +title: current_graphs +hide_title: false +hide_table_of_contents: false +keywords: + - current_graphs + - task + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a current_graphs resource. + +## Overview + + + + +
Namecurrent_graphs
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The time this task run was last completed. | +| | `string` | The name of the current database for the task run. | +| | `integer` | The first error code thrown in the task run. | +| | `string` | The first error message thrown in the task run. | +| | `string` | The name of the first task throwing an error in the task run. | +| | `integer` | The current version of the DAG on the task run. | +| | `string` | The next upcoming time for the task run. | +| | `string` | The start time for the task run query. | +| | `string` | The unique task ID for the root task. | +| | `string` | The name of the root task in the current task run. | +| | `integer` | The unique ID for the current task run. | +| | `string` | The scheduled time for the task run. | +| | `string` | The name of the current schema for the task run. | +| | `string` | The current state of the task run. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | This function returns details for graph runs that are currently executing or are next scheduled to run within the next 8 days. | +| | `SELECT` | | This function returns details for graph runs that are currently executing or are next scheduled to run within the next 8 days. | + +## `SELECT` examples + +This function returns details for graph runs that are currently executing or are next scheduled to run within the next 8 days. + + +```sql +SELECT +completed_time, +database_name, +first_error_code, +first_error_message, +first_error_task_name, +graph_version, +next_scheduled_time, +query_start_time, +root_task_id, +root_task_name, +run_id, +scheduled_time, +schema_name, +state +FROM snowflake.task.current_graphs +WHERE database = '{{ database }}' AND name = '{{ name }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` \ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/task/dependents/index.md b/docs/snowflake-docs/providers/snowflake/task/dependents/index.md new file mode 100644 index 000000000..3703d118c --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/task/dependents/index.md @@ -0,0 +1,106 @@ +--- +title: dependents +hide_title: false +hide_table_of_contents: false +keywords: + - dependents + - task + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a dependents resource. + +## Overview + + + + +
Namedependents
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | An ID for the current task. | +| | `string` | 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. | +| | `boolean` | Specifies whether to allow multiple instances of the DAG to run concurrently. | +| | `string` | Specifies a comment for the task. | +| | `string` | Specifies a Boolean SQL expression condition; multiple conditions joined with AND/OR are supported | +| | `object` | Task Config | +| | `string` | The time the task was created on. | +| | `string` | The name of the parent database for the task. | +| | `string` | The SQL definition for the task. Any one of single SQL statement, call to stored procedure, or procedural logic using Snowflake scripting. | +| | `string` | Specifies the name of the notification integration used to communicate with Amazon SNS, MS Azure Event Grid, or Google Pub/Sub. | +| | `string` | Specifies the name of the root task that the finalizer task is associated with. | +| | `string` | The time the task was last committed on. | +| | `string` | The time the task was last suspended on. | +| | `string` | The role that owns the task. | +| | `string` | The role type of the task owner. | +| | `array` | Specifies one or more predecessor tasks for the current task | +| | `object` | Specifies the schedule for periodically running the task. | +| | `string` | The name of the parent schema for the task. | +| | `string` | Specifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. This parameter only applies to serverless tasks. | +| | `string` | Specifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. This parameter only applies to serverless tasks. | +| | `object` | Session Parameters for the task at runtime. | +| | `string` | The state of the task. Must be one of started or suspended. | +| | `integer` | Specifies the number of consecutive failed task runs after which the current task is suspended automatically. | +| | `object` | A schedule for executing a task at specified intervals of minutes. | +| | `integer` | Root task settable only. Specifies the number of automatic task graph retry attempts. Valid range is 0 to 30. When not specified, no retry would happen. | +| | `string` | Displays the relationship between the root task and its corresponding finalizer tasks. | +| | `string` | Specifies the size of the compute resources to provision for the first run of the task. This parameter only applies to serverless tasks. | +| | `integer` | Specifies the time limit on a single run of the task before it times out (in milliseconds). | +| | `string` | 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. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | This operation returns a list of the dependent tasks of the task with identifier {name}. | + +## `SELECT` examples + +This operation returns a list of the dependent tasks of the task with identifier {name}. + + +```sql +SELECT +id, +name, +allow_overlapping_execution, +comment, +condition, +config, +created_on, +database_name, +definition, +error_integration, +finalize, +last_committed_on, +last_suspended_on, +owner, +owner_role_type, +predecessors, +schedule, +schema_name, +serverless_task_max_statement_size, +serverless_task_min_statement_size, +session_parameters, +state, +suspend_task_after_num_failures, +target_completion_interval, +task_auto_retry_attempts, +task_relations, +user_task_managed_initial_warehouse_size, +user_task_timeout_ms, +warehouse +FROM snowflake.task.dependents +WHERE database = '{{ database }}' AND name = '{{ name }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` \ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/task/index.md b/docs/snowflake-docs/providers/snowflake/task/index.md new file mode 100644 index 000000000..c5367bd4d --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/task/index.md @@ -0,0 +1,39 @@ +--- +title: task +hide_title: false +hide_table_of_contents: false +keywords: + - task + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +task service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources +
+
+complete_graphs
+current_graphs +
+
+dependents
+tasks +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/task/tasks/index.md b/docs/snowflake-docs/providers/snowflake/task/tasks/index.md new file mode 100644 index 000000000..e02ece1ce --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/task/tasks/index.md @@ -0,0 +1,180 @@ +--- +title: tasks +hide_title: false +hide_table_of_contents: false +keywords: + - tasks + - task + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a tasks resource. + +## Overview + + + + +
Nametasks
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | An ID for the current task. | +| | `string` | 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. | +| | `boolean` | Specifies whether to allow multiple instances of the DAG to run concurrently. | +| | `string` | Specifies a comment for the task. | +| | `string` | Specifies a Boolean SQL expression condition; multiple conditions joined with AND/OR are supported | +| | `object` | Task Config | +| | `string` | The time the task was created on. | +| | `string` | The name of the parent database for the task. | +| | `string` | The SQL definition for the task. Any one of single SQL statement, call to stored procedure, or procedural logic using Snowflake scripting. | +| | `string` | Specifies the name of the notification integration used to communicate with Amazon SNS, MS Azure Event Grid, or Google Pub/Sub. | +| | `string` | Specifies the name of the root task that the finalizer task is associated with. | +| | `string` | The time the task was last committed on. | +| | `string` | The time the task was last suspended on. | +| | `string` | The role that owns the task. | +| | `string` | The role type of the task owner. | +| | `array` | Specifies one or more predecessor tasks for the current task | +| | `object` | Specifies the schedule for periodically running the task. | +| | `string` | The name of the parent schema for the task. | +| | `string` | Specifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. This parameter only applies to serverless tasks. | +| | `string` | Specifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. This parameter only applies to serverless tasks. | +| | `object` | Session Parameters for the task at runtime. | +| | `string` | The state of the task. Must be one of started or suspended. | +| | `integer` | Specifies the number of consecutive failed task runs after which the current task is suspended automatically. | +| | `object` | A schedule for executing a task at specified intervals of minutes. | +| | `integer` | Root task settable only. Specifies the number of automatic task graph retry attempts. Valid range is 0 to 30. When not specified, no retry would happen. | +| | `string` | Displays the relationship between the root task and its corresponding finalizer tasks. | +| | `string` | Specifies the size of the compute resources to provision for the first run of the task. This parameter only applies to serverless tasks. | +| | `integer` | Specifies the time limit on a single run of the task before it times out (in milliseconds). | +| | `string` | 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. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a task using the describe command output. | +| | `SELECT` | | Lists tasks under the database and schema, with show options as query parameters. | +| | `INSERT` | | Create a task, with standard create modifiers as query parameters. See the Task component definition for what is required to be provided in the request body. | +| | `DELETE` | | Delete a task with the task name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful. | +| | `REPLACE` | | Create a (or alter an existing) task. Even if the operation is just an alter, the full property set must be provided. | +| | `EXEC` | | Execute a task -- this is equivalent to EXECUTE IMMEDIATE. | +| | `EXEC` | | Resumes a suspended task object. This is equivalento an ALTER TASK ... RESUME. | +| | `EXEC` | | Suspends a running task. This is equivalent to an ALTER TASK ... SUSPEND. | + +## `SELECT` examples + +Lists tasks under the database and schema, with show options as query parameters. + + +```sql +SELECT +id, +name, +allow_overlapping_execution, +comment, +condition, +config, +created_on, +database_name, +definition, +error_integration, +finalize, +last_committed_on, +last_suspended_on, +owner, +owner_role_type, +predecessors, +schedule, +schema_name, +serverless_task_max_statement_size, +serverless_task_min_statement_size, +session_parameters, +state, +suspend_task_after_num_failures, +target_completion_interval, +task_auto_retry_attempts, +task_relations, +user_task_managed_initial_warehouse_size, +user_task_timeout_ms, +warehouse +FROM snowflake.task.tasks +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tasks resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.task.tasks ( +data__name, +endpoint, +data__definition, +database, +schema +) +SELECT +'{ definition }', +'{ database }', +'{ name }', +'{ schema }', +'{ endpoint }' +; +``` + + + +```yaml +- name: tasks + props: + - name: database + value: string + - name: schema + value: string + - name: data__definition + value: string + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `REPLACE` example + +Replaces all fields in the specified tasks resource. + +```sql +/*+ update */ +REPLACE snowflake.task.tasks +SET + +WHERE +database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND data__definition = '{ data__definition }' AND data__name = '{ data__name }' AND endpoint = '{ endpoint }'; +``` + +## `DELETE` example + +Deletes the specified tasks resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.task.tasks +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/user/grants/index.md b/docs/snowflake-docs/providers/snowflake/user/grants/index.md new file mode 100644 index 000000000..10b49063e --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/user/grants/index.md @@ -0,0 +1,108 @@ +--- +title: grants +hide_title: false +hide_table_of_contents: false +keywords: + - grants + - user + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a grants resource. + +## Overview + + + + +
Namegrants
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | Date and time when the grant was created | +| | `string` | The role that granted this privilege to this grantee | +| | `array` | List of privileges to be granted. | +| | `object` | | +| | `string` | Type of the securable to be granted. Only ROLE is supported | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all grants to the user | +| | `INSERT` | | Grant a role to the user | +| | `DELETE` | | Revoke grants from the user | + +## `SELECT` examples + +List all grants to the user + + +```sql +SELECT +containing_scope, +created_on, +granted_by, +privileges, +securable, +securable_type +FROM snowflake.user.grants +WHERE name = '{{ name }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new grants resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.user.grants ( +endpoint, +data__securable_type, +name +) +SELECT +'{ name }', +'{ endpoint }', +'{ securable_type }' +; +``` + + + +```yaml +- name: grants + props: + - name: name + value: string + - name: data__securable_type + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified grants resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.user.grants +WHERE name = '{ name }' AND data__securable_type = '{ data__securable_type }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/user/index.md b/docs/snowflake-docs/providers/snowflake/user/index.md new file mode 100644 index 000000000..6f66bff13 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/user/index.md @@ -0,0 +1,37 @@ +--- +title: user +hide_title: false +hide_table_of_contents: false +keywords: + - user + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +user service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources +
+
+grants +
+
+users +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/user/users/index.md b/docs/snowflake-docs/providers/snowflake/user/users/index.md new file mode 100644 index 000000000..7c001843e --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/user/users/index.md @@ -0,0 +1,187 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - user + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a users resource. + +## Overview + + + + +
Nameusers
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | User name | +| | `string` | Comment about the user. | +| | `string` | | +| | `string` | | +| | `boolean` | Whether or not to flush the custom landing page of the user on next UI load | +| | `integer` | How many days until this user expires | +| | `string` | The default namespace to use when this user starts a session | +| | `string` | The default role to use when this user starts a session | +| | `string` | The default secondary roles of this user to use when starting a session. Only valid set values are ALL or NONE. Default is ALL after 2024-07 BCR. | +| | `string` | The default warehouse to use when this user starts a session | +| | `boolean` | Has this user been disabled from the system | +| | `string` | Display name | +| | `string` | Email address | +| | `boolean` | Whether to show unredacted query syntax errors in the query history. | +| | `string` | | +| | `boolean` | | +| | `string` | | +| | `string` | First name | +| | `boolean` | | +| | `boolean` | | +| | `string` | Last name | +| | `string` | | +| | `string` | | +| | `string` | Login name | +| | `string` | Middle name | +| | `integer` | How many minutes until MFA is required again | +| | `integer` | Temporary bypass network policy on the user for a specified number of minutes | +| | `integer` | How many minutes until the account is unlocked after multiple failed logins | +| | `boolean` | Does this user need to change their password (e.g., after assigning a temp password) | +| | `string` | Specifies an existing network policy is active for the user. Otherwise, use account default. | +| | `string` | | +| | `string` | Password | +| | `string` | | +| | `string` | RSA public key of the user | +| | `string` | Second RSA public key of the user | +| | `string` | Fingerprint of the user's second RSA public key | +| | `string` | Fingerprint of the user's RSA public key | +| | `boolean` | Whether the user, account, or organization is locked by Snowflake. | +| | `boolean` | Whether Snowflake Support is allowed to use the user or account | +| | `string` | Indicates the type of user (PERSON \| SERVICE \| LEGACY_SERVICE) | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch user information using the result of the DESCRIBE command | +| | `SELECT` | | Lists the users in the system. | +| | `INSERT` | | Create a user according to the parameters given | +| | `DELETE` | | Delete a user with the given name. | +| | `REPLACE` | | Create a (or alter an existing) user. Even if the operation is just an alter, the full property set must be provided. Note that password is not currently altered by this operation but is supported for a newly-created object. | + +## `SELECT` examples + +Lists the users in the system. + + +```sql +SELECT +name, +comment, +created_on, +custom_landing_page_url, +custom_landing_page_url_flush_next_ui_load, +days_to_expiry, +default_namespace, +default_role, +default_secondary_roles, +default_warehouse, +disabled, +display_name, +email, +enable_unredacted_query_syntax_error, +expires_at, +ext_authn_duo, +ext_authn_uid, +first_name, +has_password, +has_rsa_public_key, +last_name, +last_successful_login, +locked_until, +login_name, +middle_name, +mins_to_bypass_mfa, +mins_to_bypass_network_policy, +mins_to_unlock, +must_change_password, +network_policy, +owner, +password, +password_last_set, +rsa_public_key, +rsa_public_key_2, +rsa_public_key_2_fp, +rsa_public_key_fp, +snowflake_lock, +snowflake_support, +type +FROM snowflake.user.users +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new users resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.user.users ( +data__name, +endpoint +) +SELECT +'{ name }', +'{ endpoint }' +; +``` + + + +```yaml +- name: users + props: + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `REPLACE` example + +Replaces all fields in the specified users resource. + +```sql +/*+ update */ +REPLACE snowflake.user.users +SET + +WHERE +name = '{ name }' AND data__name = '{ data__name }' AND endpoint = '{ endpoint }'; +``` + +## `DELETE` example + +Deletes the specified users resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.user.users +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/user_defined_function/index.md b/docs/snowflake-docs/providers/snowflake/user_defined_function/index.md new file mode 100644 index 000000000..d8d965155 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/user_defined_function/index.md @@ -0,0 +1,37 @@ +--- +title: user_defined_function +hide_title: false +hide_table_of_contents: false +keywords: + - user_defined_function + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +user_defined_function service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+user_defined_functions +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/user_defined_function/user_defined_functions/index.md b/docs/snowflake-docs/providers/snowflake/user_defined_function/user_defined_functions/index.md new file mode 100644 index 000000000..09121d281 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/user_defined_function/user_defined_functions/index.md @@ -0,0 +1,154 @@ +--- +title: user_defined_functions +hide_title: false +hide_table_of_contents: false +keywords: + - user_defined_functions + - user_defined_function + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a user_defined_functions resource. + +## Overview + + + + +
Nameuser_defined_functions
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The name of the UDF | +| | `array` | List of arguments for the function/procedure | +| | `string` | Function/procedure definition | +| | `string` | Specifies a comment for the function/procedure | +| | `string` | The date and time when the function/procedure was created | +| | `string` | The name of the database in which the function/procedure exists. | +| | `boolean` | Specifies whether the UDF is an aggregate function. Applicable only for Python language type | +| | `boolean` | If the function/procedure is built-in or not (user-defined) | +| | `boolean` | Indicates whether the function is memoizable. Applicable only for Python language type. | +| | `boolean` | Specifies whether the function/procedure is secure or not | +| | `boolean` | True if the UDF is a table function; false otherwise. | +| | `boolean` | Specifies whether the UDF is temporary or not | +| | `object` | | +| | `integer` | The maximum number of arguments | +| | `integer` | The minimum number of arguments | +| | `string` | Role that owns the function/procedure | +| | `string` | The type of role that owns the function/procedure | +| | `object` | | +| | `string` | The name of the schema in which the function/procedure exists. | +| | `boolean` | True if the UDF is valid for clustering; false otherwise. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a UDF | +| | `SELECT` | | List UDFs | +| | `INSERT` | | Create a UDF | +| | `DELETE` | | Delete a UDF | +| | `EXEC` | | Rename a UDF | + +## `SELECT` examples + +List UDFs + + +```sql +SELECT +name, +arguments, +body, +comment, +created_on, +database_name, +is_aggregate, +is_builtin, +is_memoizable, +is_secure, +is_table_function, +is_temporary, +language_config, +max_num_arguments, +min_num_arguments, +owner, +owner_role_type, +return_type, +schema_name, +valid_for_clustering +FROM snowflake.user_defined_function.user_defined_functions +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_defined_functions resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.user_defined_function.user_defined_functions ( +data__name, +data__arguments, +data__return_type, +endpoint, +data__language_config, +database, +schema +) +SELECT +'{ database }', +'{ language_config }', +'{ name }', +'{ schema }', +'{ return_type }', +'{ endpoint }', +'{ arguments }' +; +``` + + + +```yaml +- name: user_defined_functions + props: + - name: database + value: string + - name: schema + value: string + - name: data__arguments + value: string + - name: data__language_config + value: string + - name: data__name + value: string + - name: data__return_type + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified user_defined_functions resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.user_defined_function.user_defined_functions +WHERE database = '{ database }' AND nameWithArgs = '{ nameWithArgs }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/view/index.md b/docs/snowflake-docs/providers/snowflake/view/index.md new file mode 100644 index 000000000..5896c9364 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/view/index.md @@ -0,0 +1,37 @@ +--- +title: view +hide_title: false +hide_table_of_contents: false +keywords: + - view + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +view service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+views +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/view/views/index.md b/docs/snowflake-docs/providers/snowflake/view/views/index.md new file mode 100644 index 000000000..f9d8d0d1f --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/view/views/index.md @@ -0,0 +1,133 @@ +--- +title: views +hide_title: false +hide_table_of_contents: false +keywords: + - views + - view + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a views resource. + +## Overview + + + + +
Nameviews
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Name of the view | +| | `array` | The columns of the view | +| | `string` | user comment associated to an object in the dictionary | +| | `string` | Date and time when the view was created. | +| | `string` | Database in which the view is stored | +| | `string` | Kind of the view, permanent (default) or temporary | +| | `string` | Role that owns the view | +| | `string` | The type of role that owns the view | +| | `string` | Query used to create the view | +| | `boolean` | Whether or not this view can refer to itself using recursive syntax withot requiring a CTE (common table expression) | +| | `string` | Schema in which the view is stored | +| | `boolean` | Whether or not this view is secure | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Fetch a view | +| | `SELECT` | | List views | +| | `INSERT` | | Create a view | +| | `DELETE` | | Delete a view | + +## `SELECT` examples + +List views + + +```sql +SELECT +name, +columns, +comment, +created_on, +database_name, +kind, +owner, +owner_role_type, +query, +recursive, +schema_name, +secure +FROM snowflake.view.views +WHERE database = '{{ database }}' AND schema = '{{ schema }}' AND endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new views resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.view.views ( +data__name, +endpoint, +data__columns, +database, +data__query, +schema +) +SELECT +'{ database }', +'{ name }', +'{ schema }', +'{ columns }', +'{ endpoint }', +'{ query }' +; +``` + + + +```yaml +- name: views + props: + - name: database + value: string + - name: schema + value: string + - name: data__columns + value: string + - name: data__name + value: string + - name: data__query + value: string + - name: endpoint + value: string + +``` + + + +## `DELETE` example + +Deletes the specified views resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.view.views +WHERE database = '{ database }' AND name = '{ name }' AND schema = '{ schema }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/providers/snowflake/warehouse/index.md b/docs/snowflake-docs/providers/snowflake/warehouse/index.md new file mode 100644 index 000000000..49b18d0b3 --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/warehouse/index.md @@ -0,0 +1,37 @@ +--- +title: warehouse +hide_title: false +hide_table_of_contents: false +keywords: + - warehouse + - snowflake + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +warehouse service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+warehouses +
+
+ +
+
\ No newline at end of file diff --git a/docs/snowflake-docs/providers/snowflake/warehouse/warehouses/index.md b/docs/snowflake-docs/providers/snowflake/warehouse/warehouses/index.md new file mode 100644 index 000000000..42e16b27c --- /dev/null +++ b/docs/snowflake-docs/providers/snowflake/warehouse/warehouses/index.md @@ -0,0 +1,190 @@ +--- +title: warehouses +hide_title: false +hide_table_of_contents: false +keywords: + - warehouses + - warehouse + - snowflake + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage snowflake resources using SQL +custom_edit_url: null +image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a warehouses resource. + +## Overview + + + + +
Namewarehouses
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | 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. | +| | `string` | Specifies whether to automatically resume a warehouse when a SQL statement is submitted to it | +| | `integer` | time in seconds before auto suspend | +| | `string` | Percentage of the warehouse compute resources that are provisioned and available. | +| | `string` | Comment representing budget for warehouse. | +| | `string` | Specifies a comment for the warehouse | +| | `string` | Date and time when the warehouse was created. | +| | `string` | Specifies whether to enable the query acceleration service for queries that rely on this warehouse for compute resources | +| | `string` | Specifies whether the warehouse is created initially in the Suspended state | +| | `boolean` | Whether the warehouse is in use for the session. Only one warehouse can be in use at a time for a session. To specify or change the warehouse for a session, use the USE WAREHOUSE command. | +| | `boolean` | Whether the warehouse is the default for the current user. | +| | `string` | | +| | `integer` | Specifies the maximum number of clusters for a multi-cluster warehouse | +| | `integer` | Object parameter that specifies the concurrency level for SQL statements executed by a warehouse cluster | +| | `integer` | Specifies the minimum number of clusters for a multi-cluster warehouse | +| | `string` | Percentage of the warehouse compute resources that are in a state other than available, provisioning, or quiescing. | +| | `string` | Role that owns the warehouse. | +| | `string` | The type of role that owns the object. | +| | `string` | Percentage of the warehouse compute resources that are in the process of provisioning. | +| | `integer` | Specifies the maximum scale factor for leasing compute resources for query acceleration. The scale factor is used as a multiplier based on warehouse size | +| | `integer` | Number of SQL statements that are queued for the warehouse. | +| | `string` | Percentage of the warehouse compute resources that are executing SQL statements, but will be shut down once the queries complete. | +| | `string` | 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. | +| | `string` | Date and time when the warehouse was last started or restarted. | +| | `integer` | Number of SQL statements that are being executed by the warehouse. | +| | `string` | Scaling policy of warehouse, possible scaling policies: STANDARD, ECONOMY | +| | `string` | [Deprecated] names of size: X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large, 5X-Large, 6X-Large | +| | `integer` | Number of clusters currently started. | +| | `string` | The state of warehouse, possible states: STARTED, STARTING, DYNAMIC, SUSPENDED, RESIZING, RESUMING, SUSPENDING | +| | `integer` | Object parameter that specifies the time, in seconds, a SQL statement can be queued on a warehouse before it is canceled by the system | +| | `integer` | Object parameter that specifies the time, in seconds, after which a running SQL statement is canceled by the system | +| | `string` | Names of size: X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large, 5X-Large, 6X-Large | +| | `string` | [Deprecated] Type of warehouse, possible types: STANDARD, SNOWPARK-OPTIMIZED | +| | `string` | Date and time when the warehouse was last updated, which includes changing any of the properties of the warehouse or changing the state (STARTED, SUSPENDED, RESIZING) of the warehouse. | +| | `string` | When resizing a warehouse, you can use this parameter to block the return of the ALTER WAREHOUSE command until the resize has finished provisioning all its compute resources | +| | `integer` | Credit limit that are can be executed by the warehouse. | +| | `string` | Size of warehouse, possible sizes: XSMALL, SMALL, MEDIUM, LARGE, XLARGE, XXLARGE, XXXLARGE, X4LARGE, X5LARGE, X6LARGE | +| | `string` | Type of warehouse, possible types: STANDARD, SNOWPARK-OPTIMIZED | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Describes the warehouse, show information of the chosen warehouse. Equivalent to DESCRIBE WAREHOUSE in SQL. | +| | `SELECT` | | Show a list of warehouse filtered by pattern. Equivalent to SHOW WAREHOUSE in SQL. | +| | `INSERT` | | Create a virtual warehouse. Equivalent to CREATE WAREHOUSE in SQL. | +| | `DELETE` | | Removes the specified virtual warehouse from the system. Equivalent to DROP WAREHOUSE in SQL. | +| | `REPLACE` | | Create a (or alter an existing) warehouse. Even if the operation is just an alter, the full property set must be provided. | +| | `EXEC` | | Aborts all the queries currently running or queued on the warehouse. | +| | `EXEC` | | Disable an adaptive warehouse and put the warehouse into a ‘disabled’ state, if the warehouse is not disabled. | +| | `EXEC` | | Enable an adaptive warehouse and put the warehouse into a ‘enabled’ state, if the warehouse is not enabled. | +| | `EXEC` | | Specifies a new identifier for the warehouse; must be unique for current account. | +| | `EXEC` | | Bring current warehouse to a usable ‘Running’ state by provisioning compute resources if current warehouse is suspended. | +| | `EXEC` | | Remove all compute nodes from a warehouse and put the warehouse into a ‘Suspended’ state if current warehouse is not suspended. | +| | `EXEC` | | [Deprecated] Specifies the active/current warehouse for the session. | + +## `SELECT` examples + +Show a list of warehouse filtered by pattern. Equivalent to SHOW WAREHOUSE in SQL. + + +```sql +SELECT +name, +auto_resume, +auto_suspend, +available, +budget, +comment, +created_on, +enable_query_acceleration, +initially_suspended, +is_current, +is_default, +kind, +max_cluster_count, +max_concurrency_level, +min_cluster_count, +other, +owner, +owner_role_type, +provisioning, +query_acceleration_max_scale_factor, +queued, +quiescing, +resource_monitor, +resumed_on, +running, +scaling_policy, +size, +started_clusters, +state, +statement_queued_timeout_in_seconds, +statement_timeout_in_seconds, +target_statement_size, +type, +updated_on, +wait_for_completion, +warehouse_credit_limit, +warehouse_size, +warehouse_type +FROM snowflake.warehouse.warehouses +WHERE endpoint = '{{ endpoint }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new warehouses resource. + + + + +```sql +/*+ create */ +INSERT INTO snowflake.warehouse.warehouses ( +data__name, +endpoint +) +SELECT +'{ name }', +'{ endpoint }' +; +``` + + + +```yaml +- name: warehouses + props: + - name: data__name + value: string + - name: endpoint + value: string + +``` + + + +## `REPLACE` example + +Replaces all fields in the specified warehouses resource. + +```sql +/*+ update */ +REPLACE snowflake.warehouse.warehouses +SET + +WHERE +name = '{ name }' AND data__name = '{ data__name }' AND endpoint = '{ endpoint }'; +``` + +## `DELETE` example + +Deletes the specified warehouses resource. + +```sql +/*+ delete */ +DELETE FROM snowflake.warehouse.warehouses +WHERE name = '{ name }' AND endpoint = '{ endpoint }'; +``` diff --git a/docs/snowflake-docs/stackql-provider-registry.mdx b/docs/snowflake-docs/stackql-provider-registry.mdx new file mode 100644 index 000000000..48883f0f2 --- /dev/null +++ b/docs/snowflake-docs/stackql-provider-registry.mdx @@ -0,0 +1,20 @@ +--- +title: StackQL Provider Registry +hide_title: true +hide_table_of_contents: true +keywords: + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query and Deploy Cloud Infrastructure and Resources using SQL +custom_edit_url: null +image: https://storage.googleapis.com/stackql-web-assets/blog/stackql-blog-post-featured-image.png +slug: / +--- +import RegistryPage from '@site/src/shared/shared-stackql-provider-registry.mdx'; + + + +--- + diff --git a/package.json b/package.json index fbdb99de7..4a052cb77 100644 --- a/package.json +++ b/package.json @@ -30,6 +30,8 @@ "start:homebrew": "export REGISTRY=homebrew && docusaurus start", "start:databricks_account": "export REGISTRY=databricks_account && docusaurus start", "start:databricks_workspace": "export REGISTRY=databricks_workspace && docusaurus start", + "start:snowflake": "export REGISTRY=snowflake && docusaurus start", + "build:snowflake": "export REGISTRY=snowflake && docusaurus build", "build:databricks_account": "export REGISTRY=databricks_account && docusaurus build", "build:databricks_workspace": "export REGISTRY=databricks_workspace && docusaurus build", "build:root": "docusaurus build", diff --git a/sidebars.js b/sidebars.js index ee347bdb9..a5875cf93 100644 --- a/sidebars.js +++ b/sidebars.js @@ -20,7 +20,8 @@ const providers = [ {name: 'googleadmin'}, {name: 'digitalocean'}, {name: 'databricks_account'}, - {name: 'databricks_workspace'}, + {name: 'databricks_workspace'}, + {name: 'snowflake'}, {name: 'confluent'}, {name: 'github'}, {name: 'openai'}, diff --git a/src/configs/providers.ts b/src/configs/providers.ts index f48403a89..febdd0db4 100644 --- a/src/configs/providers.ts +++ b/src/configs/providers.ts @@ -25,7 +25,8 @@ export const providers = [ {name: 'pagerduty', description: 'Incident management platform for real-time operations and response workflows.', title: 'PagerDuty'}, {name: 'datadog', description: 'Monitoring, alerting and reporting platform for cloud platforms and applications.', title: 'Datadog'}, {name: 'godaddy', description: 'Domain name registrations and hosting services.', title: 'Godaddy'}, - {name: 'homebrew', description: 'Open-source package manager for macOS and Linux.', title: 'Homebrew'}, + {name: 'homebrew', description: 'Open-source package manager for macOS and Linux.', title: 'Homebrew'}, + {name: 'snowflake', description: 'Cloud data platform for data warehousing, analytics, and secure data sharing.', title: 'Snowflake'}, ] export const getProviderSiteUrl = (name: string) =>{