Skip to content

Commit 6bd85f7

Browse files
jeffreyavenjeffreyaven
authored
Merge pull request #260 from stackql/feature/provider-docs
snowflake updates
2 parents 3bc00d6 + 5f56599 commit 6bd85f7

File tree

47 files changed

+261
-63
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+261
-63
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,16 @@ Creates, updates, deletes, gets or lists a <code>accounts</code> resource.
7777
| <CopyableCode code="delete_account" /> | `DELETE` | <CopyableCode code="gracePeriodInDays, name, endpoint" /> | <CopyableCode code="ifExists" /> | 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. |
7878
| <CopyableCode code="undrop_account" /> | `EXEC` | <CopyableCode code="name, endpoint" /> | - | Restores a dropped account that has not yet been permanently deleted (a dropped account that is within its grace period). |
7979

80+
8081
<details>
8182
<summary>Optional Parameter Details</summary>
8283

8384
| Name | Description | Type | Default |
8485
|------|-------------|------|---------|
8586
| <CopyableCode code="history" /> | Optionally includes dropped accounts that have not yet been purged. | `boolean` | `-` |
86-
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
87+
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist:
88+
- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
89+
- `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
8790
| <CopyableCode code="like" /> | Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. | `string` | `-` |
8891
| <CopyableCode code="showLimit" /> | Query parameter to limit the maximum number of rows returned by a command. | `integer` | `-` |
8992

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,20 @@ Creates, updates, deletes, gets or lists a <code>alerts</code> resource.
5353
| <CopyableCode code="clone_alert" /> | `EXEC` | <CopyableCode code="database_name, name, schema_name, targetDatabase, targetSchema, data__name, endpoint" /> | <CopyableCode code="createMode" /> | Create a new alert by cloning from the specified resource |
5454
| <CopyableCode code="execute_alert" /> | `EXEC` | <CopyableCode code="database_name, name, schema_name, endpoint" /> | - | Execute an alert |
5555

56+
5657
<details>
5758
<summary>Optional Parameter Details</summary>
5859

5960
| Name | Description | Type | Default |
6061
|------|-------------|------|---------|
61-
| <CopyableCode code="createMode" /> | Query parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. | `string` | `errorIfExists` |
62+
| <CopyableCode code="createMode" /> | Query parameter allowing support for different modes of resource creation. Possible values include:
63+
- `errorIfExists`: Throws an error if you try to create a resource that already exists.
64+
- `orReplace`: Automatically replaces the existing resource with the current one.
65+
- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. | `string` | `errorIfExists` |
6266
| <CopyableCode code="fromName" /> | Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. | `string` | `-` |
63-
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
67+
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist:
68+
- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
69+
- `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
6470
| <CopyableCode code="like" /> | Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. | `string` | `-` |
6571
| <CopyableCode code="showLimit" /> | Query parameter to limit the maximum number of rows returned by a command. | `integer` | `-` |
6672
| <CopyableCode code="startsWith" /> | Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. | `string` | `-` |

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,19 @@ Creates, updates, deletes, gets or lists a <code>api_integrations</code> resourc
4747
| <CopyableCode code="delete_api_integration" /> | `DELETE` | <CopyableCode code="name, endpoint" /> | <CopyableCode code="ifExists" /> | Delete an API integration |
4848
| <CopyableCode code="create_or_alter_api_integration" /> | `REPLACE` | <CopyableCode code="name, data__api_allowed_prefixes, data__api_hook, data__enabled, data__name, endpoint" /> | - | 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. |
4949

50+
5051
<details>
5152
<summary>Optional Parameter Details</summary>
5253

5354
| Name | Description | Type | Default |
5455
|------|-------------|------|---------|
55-
| <CopyableCode code="createMode" /> | Query parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. | `string` | `errorIfExists` |
56-
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
56+
| <CopyableCode code="createMode" /> | Query parameter allowing support for different modes of resource creation. Possible values include:
57+
- `errorIfExists`: Throws an error if you try to create a resource that already exists.
58+
- `orReplace`: Automatically replaces the existing resource with the current one.
59+
- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. | `string` | `errorIfExists` |
60+
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist:
61+
- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
62+
- `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
5763
| <CopyableCode code="like" /> | Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. | `string` | `-` |
5864

5965
</details>

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,19 @@ Creates, updates, deletes, gets or lists a <code>catalog_integrations</code> res
4747
| <CopyableCode code="create_catalog_integration" /> | `INSERT` | <CopyableCode code="data__catalog, data__enabled, data__name, data__table_format, endpoint" /> | <CopyableCode code="createMode" /> | Create a catalog integration. |
4848
| <CopyableCode code="delete_catalog_integration" /> | `DELETE` | <CopyableCode code="name, endpoint" /> | <CopyableCode code="ifExists" /> | Delete a catalog integration. |
4949

50+
5051
<details>
5152
<summary>Optional Parameter Details</summary>
5253

5354
| Name | Description | Type | Default |
5455
|------|-------------|------|---------|
55-
| <CopyableCode code="createMode" /> | Query parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. | `string` | `errorIfExists` |
56-
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
56+
| <CopyableCode code="createMode" /> | Query parameter allowing support for different modes of resource creation. Possible values include:
57+
- `errorIfExists`: Throws an error if you try to create a resource that already exists.
58+
- `orReplace`: Automatically replaces the existing resource with the current one.
59+
- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. | `string` | `errorIfExists` |
60+
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist:
61+
- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
62+
- `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
5763
| <CopyableCode code="like" /> | Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. | `string` | `-` |
5864

5965
</details>

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,19 @@ Creates, updates, deletes, gets or lists a <code>compute_pools</code> resource.
6666
| <CopyableCode code="stop_all_services_in_compute_pool_deprecated" /> | `EXEC` | <CopyableCode code="name, endpoint" /> | - | Stops all services in the compute pool. Deprecated - use :stop-all-services instead. |
6767
| <CopyableCode code="suspend_compute_pool" /> | `EXEC` | <CopyableCode code="name, endpoint" /> | - | Suspend a compute pool, if active. If the specified compute pool is already suspended, no action is taken. |
6868

69+
6970
<details>
7071
<summary>Optional Parameter Details</summary>
7172

7273
| Name | Description | Type | Default |
7374
|------|-------------|------|---------|
74-
| <CopyableCode code="createMode" /> | Query parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. | `string` | `errorIfExists` |
75-
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
75+
| <CopyableCode code="createMode" /> | Query parameter allowing support for different modes of resource creation. Possible values include:
76+
- `errorIfExists`: Throws an error if you try to create a resource that already exists.
77+
- `orReplace`: Automatically replaces the existing resource with the current one.
78+
- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. | `string` | `errorIfExists` |
79+
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist:
80+
- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
81+
- `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
7682
| <CopyableCode code="initiallySuspended" /> | Specifies whether the compute pool is created initially in the suspended state. | `boolean` | `-` |
7783
| <CopyableCode code="like" /> | Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. | `string` | `-` |
7884
| <CopyableCode code="showLimit" /> | Query parameter to limit the maximum number of rows returned by a command. | `integer` | `-` |

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

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,20 +73,29 @@ Creates, updates, deletes, gets or lists a <code>databases</code> resource.
7373
| <CopyableCode code="refresh_database_replication" /> | `EXEC` | <CopyableCode code="name, endpoint" /> | - | 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. |
7474
| <CopyableCode code="undrop_database" /> | `EXEC` | <CopyableCode code="name, endpoint" /> | - | Undrops database. |
7575

76+
7677
<details>
7778
<summary>Optional Parameter Details</summary>
7879

7980
| Name | Description | Type | Default |
8081
|------|-------------|------|---------|
81-
| <CopyableCode code="createMode" /> | Query parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. | `string` | `errorIfExists` |
82+
| <CopyableCode code="createMode" /> | Query parameter allowing support for different modes of resource creation. Possible values include:
83+
- `errorIfExists`: Throws an error if you try to create a resource that already exists.
84+
- `orReplace`: Automatically replaces the existing resource with the current one.
85+
- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. | `string` | `errorIfExists` |
8286
| <CopyableCode code="fromName" /> | Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. | `string` | `-` |
8387
| <CopyableCode code="history" /> | Optionally includes dropped databases that have not yet been purged. | `boolean` | `-` |
84-
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
85-
| <CopyableCode code="ignore_edition_check" /> | Whether to allow replicating data to accounts on lower editions. Default: `true`. For more information, see the {a href=https://docs.snowflake.com/en/sql-reference/sql/alter-database} ALTER DATABASE{/a} reference. | `boolean` | `-` |
88+
| <CopyableCode code="ifExists" /> | Query parameter that specifies how to handle the request for a resource that does not exist:
89+
- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
90+
- `false`: The endpoint throws an error if the resource doesn't exist. | `boolean` | `false` |
91+
| <CopyableCode code="ignore_edition_check" /> | Whether to allow replicating data to accounts on lower editions. Default: `true`.
92+
For more information, see the <a href=https://docs.snowflake.com/en/sql-reference/sql/alter-database> ALTER DATABASE</a> reference. | `boolean` | `-` |
8693
| <CopyableCode code="kind" /> | Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string). | `string` | `-` |
8794
| <CopyableCode code="like" /> | Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. | `string` | `-` |
88-
| <CopyableCode code="restrict" /> | Whether to drop the database if foreign keys exist that reference any tables in the database. - `true`: Return a warning about existing foreign key references and don't drop the database. - `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables. | `boolean` | `false` |
89-
| <CopyableCode code="share" /> | ID of the share from which to create the database, in the form "{provider_account}.{share_name}". | `string` | `-` |
95+
| <CopyableCode code="restrict" /> | Whether to drop the database if foreign keys exist that reference any tables in the database.
96+
- `true`: Return a warning about existing foreign key references and don't drop the database.
97+
- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables. | `boolean` | `false` |
98+
| <CopyableCode code="share" /> | ID of the share from which to create the database, in the form "<provider_account>.<share_name>". | `string` | `-` |
9099
| <CopyableCode code="showLimit" /> | Query parameter to limit the maximum number of rows returned by a command. | `integer` | `-` |
91100
| <CopyableCode code="startsWith" /> | Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. | `string` | `-` |
92101

0 commit comments

Comments
 (0)