Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"test": "echo \"Error: no test specified\" && exit 1"
},
"dependencies": {
"@stackql/provider-utils": "^0.1.4"
"@stackql/provider-utils": "^0.2.2"
},
"engines": {
"node": ">=14.16.0"
Expand Down
72 changes: 36 additions & 36 deletions website/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,43 +73,43 @@ stackql.exe shell --auth=$Auth
## Services
<div class="row">
<div class="providerDocColumn">
<a href="/account/">account</a><br />
<a href="/alert/">alert</a><br />
<a href="/api_integration/">api_integration</a><br />
<a href="/catalog_integration/">catalog_integration</a><br />
<a href="/compute_pool/">compute_pool</a><br />
<a href="/cortex_analyst/">cortex_analyst</a><br />
<a href="/cortex_inference/">cortex_inference</a><br />
<a href="/cortex_search_service/">cortex_search_service</a><br />
<a href="/database/">database</a><br />
<a href="/database_role/">database_role</a><br />
<a href="/dynamic_table/">dynamic_table</a><br />
<a href="/event_table/">event_table</a><br />
<a href="/external_volume/">external_volume</a><br />
<a href="/function/">function</a><br />
<a href="/grant/">grant</a><br />
<a href="/iceberg_table/">iceberg_table</a><br />
<a href="/image_repository/">image_repository</a><br />
<a href="/managed_account/">managed_account</a><br />
<a href="/services/account/">account</a><br />
<a href="/services/alert/">alert</a><br />
<a href="/services/api_integration/">api_integration</a><br />
<a href="/services/catalog_integration/">catalog_integration</a><br />
<a href="/services/compute_pool/">compute_pool</a><br />
<a href="/services/cortex_analyst/">cortex_analyst</a><br />
<a href="/services/cortex_inference/">cortex_inference</a><br />
<a href="/services/cortex_search_service/">cortex_search_service</a><br />
<a href="/services/database/">database</a><br />
<a href="/services/database_role/">database_role</a><br />
<a href="/services/dynamic_table/">dynamic_table</a><br />
<a href="/services/event_table/">event_table</a><br />
<a href="/services/external_volume/">external_volume</a><br />
<a href="/services/function/">function</a><br />
<a href="/services/grant/">grant</a><br />
<a href="/services/iceberg_table/">iceberg_table</a><br />
<a href="/services/image_repository/">image_repository</a><br />
<a href="/services/managed_account/">managed_account</a><br />
</div>
<div class="providerDocColumn">
<a href="/network_policy/">network_policy</a><br />
<a href="/notebook/">notebook</a><br />
<a href="/notification_integration/">notification_integration</a><br />
<a href="/pipe/">pipe</a><br />
<a href="/procedure/">procedure</a><br />
<a href="/result/">result</a><br />
<a href="/role/">role</a><br />
<a href="/schema/">schema</a><br />
<a href="/service/">service</a><br />
<a href="/sqlapi/">sqlapi</a><br />
<a href="/stage/">stage</a><br />
<a href="/streams/">streams</a><br />
<a href="/table/">table</a><br />
<a href="/task/">task</a><br />
<a href="/user/">user</a><br />
<a href="/user_defined_function/">user_defined_function</a><br />
<a href="/view/">view</a><br />
<a href="/warehouse/">warehouse</a><br />
<a href="/services/network_policy/">network_policy</a><br />
<a href="/services/notebook/">notebook</a><br />
<a href="/services/notification_integration/">notification_integration</a><br />
<a href="/services/pipe/">pipe</a><br />
<a href="/services/procedure/">procedure</a><br />
<a href="/services/result/">result</a><br />
<a href="/services/role/">role</a><br />
<a href="/services/schema/">schema</a><br />
<a href="/services/service/">service</a><br />
<a href="/services/sqlapi/">sqlapi</a><br />
<a href="/services/stage/">stage</a><br />
<a href="/services/streams/">streams</a><br />
<a href="/services/table/">table</a><br />
<a href="/services/task/">task</a><br />
<a href="/services/user/">user</a><br />
<a href="/services/user_defined_function/">user_defined_function</a><br />
<a href="/services/view/">view</a><br />
<a href="/services/warehouse/">warehouse</a><br />
</div>
</div>
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The following fields are returned by `SELECT` queries:
>
<TabItem value="list_accounts">

Snowflake account object.
Successful request.

<table>
<thead>
Expand All @@ -53,7 +53,7 @@ Snowflake account object.
<tr>
<td><CopyableCode code="name" /></td>
<td><code>string</code></td>
<td>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. (pattern: ^&quot;([^&quot;]|&quot;&quot;)+&quot;|[a-zA-Z_][a-zA-Z0-9_$]*$, example: TEST_NAME)</td>
<td>User-defined name that identifies an account within the organization. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$, example: TEST_NAME)</td>
</tr>
<tr>
<td><CopyableCode code="admin_name" /></td>
Expand Down Expand Up @@ -279,7 +279,7 @@ The following methods are available for this resource:
<td><CopyableCode code="delete" /></td>
<td><a href="#parameter-name"><code>name</code></a>, <a href="#parameter-gracePeriodInDays"><code>gracePeriodInDays</code></a>, <a href="#parameter-endpoint"><code>endpoint</code></a></td>
<td><a href="#parameter-ifExists"><code>ifExists</code></a></td>
<td>Deletes the specified account. If you enable the <code>ifExists</code> 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.</td>
<td>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.</td>
</tr>
<tr>
<td><a href="#undrop_account"><CopyableCode code="undrop_account" /></a></td>
Expand Down Expand Up @@ -327,7 +327,7 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
<tr id="parameter-ifExists">
<td><CopyableCode code="ifExists" /></td>
<td><code>boolean</code></td>
<td>Query parameter that specifies how to handle the request for a resource that does not exist: - <code>true</code>: 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. - <code>false</code>: The endpoint throws an error if the resource doesn't exist.</td>
<td>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.</td>
</tr>
<tr id="parameter-like">
<td><CopyableCode code="like" /></td>
Expand Down Expand Up @@ -466,7 +466,7 @@ SELECT
- name: name
value: string
description: >
A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.
User-defined name that identifies an account within the organization.

- name: region_group
value: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ total resources: __1__
## Resources
<div class="row">
<div class="providerDocColumn">
<a href="/account/accounts/">accounts</a>
<a href="/services/account/accounts/">accounts</a>
</div>
<div class="providerDocColumn">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The following fields are returned by `SELECT` queries:
>
<TabItem value="list_alerts">

A Snowflake alert
successful

<table>
<thead>
Expand Down Expand Up @@ -99,7 +99,7 @@ A Snowflake alert
<tr>
<td><CopyableCode code="schedule" /></td>
<td><code>object</code></td>
<td></td>
<td>The schedule the alert runs under</td>
</tr>
<tr>
<td><CopyableCode code="state" /></td>
Expand All @@ -116,7 +116,7 @@ A Snowflake alert
</TabItem>
<TabItem value="fetch_alert">

A Snowflake alert
successful

<table>
<thead>
Expand Down Expand Up @@ -175,7 +175,7 @@ A Snowflake alert
<tr>
<td><CopyableCode code="schedule" /></td>
<td><code>object</code></td>
<td></td>
<td>The schedule the alert runs under</td>
</tr>
<tr>
<td><CopyableCode code="state" /></td>
Expand Down Expand Up @@ -268,7 +268,7 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
<tr id="parameter-database_name">
<td><CopyableCode code="database_name" /></td>
<td><code>string</code></td>
<td>Identifier (i.e. name) for the database to which the resource belongs. You can use the <code>/api/v2/databases</code> GET request to get a list of available databases.</td>
<td>Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases.</td>
</tr>
<tr id="parameter-endpoint">
<td><CopyableCode code="endpoint" /></td>
Expand All @@ -283,7 +283,7 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
<tr id="parameter-schema_name">
<td><CopyableCode code="schema_name" /></td>
<td><code>string</code></td>
<td>Identifier (i.e. name) for the schema to which the resource belongs. You can use the <code>/api/v2/databases/&#123;database&#125;/schemas</code> GET request to get a list of available schemas for the specified database.</td>
<td>Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/&#123;database&#125;/schemas` GET request to get a list of available schemas for the specified database.</td>
</tr>
<tr id="parameter-targetDatabase">
<td><CopyableCode code="targetDatabase" /></td>
Expand All @@ -298,7 +298,7 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
<tr id="parameter-createMode">
<td><CopyableCode code="createMode" /></td>
<td><code>string</code></td>
<td>Query parameter allowing support for different modes of resource creation. Possible values include: - <code>errorIfExists</code>: Throws an error if you try to create a resource that already exists. - <code>orReplace</code>: Automatically replaces the existing resource with the current one. - <code>ifNotExists</code>: Creates a new resource when an alter is requested for a non-existent resource.</td>
<td>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.</td>
</tr>
<tr id="parameter-fromName">
<td><CopyableCode code="fromName" /></td>
Expand All @@ -308,7 +308,7 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
<tr id="parameter-ifExists">
<td><CopyableCode code="ifExists" /></td>
<td><code>boolean</code></td>
<td>Query parameter that specifies how to handle the request for a resource that does not exist: - <code>true</code>: 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. - <code>false</code>: The endpoint throws an error if the resource doesn't exist.</td>
<td>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.</td>
</tr>
<tr id="parameter-like">
<td><CopyableCode code="like" /></td>
Expand Down Expand Up @@ -460,6 +460,9 @@ SELECT

- name: schedule
value: object
description: >
The schedule the alert runs under

- name: warehouse
value: string
description: >
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ total resources: __1__
## Resources
<div class="row">
<div class="providerDocColumn">
<a href="/alert/alerts/">alerts</a>
<a href="/services/alert/alerts/">alerts</a>
</div>
<div class="providerDocColumn">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The following fields are returned by `SELECT` queries:
>
<TabItem value="list_api_integrations">

A Snowflake API integration object.
successful

<table>
<thead>
Expand All @@ -54,7 +54,7 @@ A Snowflake API integration object.
<tr>
<td><CopyableCode code="name" /></td>
<td><code>string</code></td>
<td>Name of the API integration. (pattern: ^&quot;([^&quot;]|&quot;&quot;)+&quot;|[a-zA-Z_][a-zA-Z0-9_$]*$)</td>
<td>Name of the API integration. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)</td>
</tr>
<tr>
<td><CopyableCode code="api_allowed_prefixes" /></td>
Expand Down Expand Up @@ -91,7 +91,7 @@ A Snowflake API integration object.
</TabItem>
<TabItem value="fetch_api_integration">

A Snowflake API integration object.
successful

<table>
<thead>
Expand All @@ -105,7 +105,7 @@ A Snowflake API integration object.
<tr>
<td><CopyableCode code="name" /></td>
<td><code>string</code></td>
<td>Name of the API integration. (pattern: ^&quot;([^&quot;]|&quot;&quot;)+&quot;|[a-zA-Z_][a-zA-Z0-9_$]*$)</td>
<td>Name of the API integration. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)</td>
</tr>
<tr>
<td><CopyableCode code="api_allowed_prefixes" /></td>
Expand Down Expand Up @@ -221,12 +221,12 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
<tr id="parameter-createMode">
<td><CopyableCode code="createMode" /></td>
<td><code>string</code></td>
<td>Query parameter allowing support for different modes of resource creation. Possible values include: - <code>errorIfExists</code>: Throws an error if you try to create a resource that already exists. - <code>orReplace</code>: Automatically replaces the existing resource with the current one. - <code>ifNotExists</code>: Creates a new resource when an alter is requested for a non-existent resource.</td>
<td>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.</td>
</tr>
<tr id="parameter-ifExists">
<td><CopyableCode code="ifExists" /></td>
<td><code>boolean</code></td>
<td>Query parameter that specifies how to handle the request for a resource that does not exist: - <code>true</code>: 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. - <code>false</code>: The endpoint throws an error if the resource doesn't exist.</td>
<td>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.</td>
</tr>
<tr id="parameter-like">
<td><CopyableCode code="like" /></td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ total resources: __1__
## Resources
<div class="row">
<div class="providerDocColumn">
<a href="/api_integration/api_integrations/">api_integrations</a>
<a href="/services/api_integration/api_integrations/">api_integrations</a>
</div>
<div class="providerDocColumn">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The following fields are returned by `SELECT` queries:
>
<TabItem value="list_catalog_integrations">

Catalog integration
successful

<table>
<thead>
Expand All @@ -54,12 +54,12 @@ Catalog integration
<tr>
<td><CopyableCode code="name" /></td>
<td><code>string</code></td>
<td>Name of the catalog integration. (pattern: ^&quot;([^&quot;]|&quot;&quot;)+&quot;|[a-zA-Z_][a-zA-Z0-9_$]*$)</td>
<td>Name of the catalog integration. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)</td>
</tr>
<tr>
<td><CopyableCode code="catalog" /></td>
<td><code>object</code></td>
<td></td>
<td>Type of catalog and its parameters.</td>
</tr>
<tr>
<td><CopyableCode code="category" /></td>
Expand Down Expand Up @@ -96,7 +96,7 @@ Catalog integration
</TabItem>
<TabItem value="fetch_catalog_integration">

Catalog integration
successful

<table>
<thead>
Expand All @@ -110,12 +110,12 @@ Catalog integration
<tr>
<td><CopyableCode code="name" /></td>
<td><code>string</code></td>
<td>Name of the catalog integration. (pattern: ^&quot;([^&quot;]|&quot;&quot;)+&quot;|[a-zA-Z_][a-zA-Z0-9_$]*$)</td>
<td>Name of the catalog integration. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)</td>
</tr>
<tr>
<td><CopyableCode code="catalog" /></td>
<td><code>object</code></td>
<td></td>
<td>Type of catalog and its parameters.</td>
</tr>
<tr>
<td><CopyableCode code="category" /></td>
Expand Down Expand Up @@ -224,12 +224,12 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
<tr id="parameter-createMode">
<td><CopyableCode code="createMode" /></td>
<td><code>string</code></td>
<td>Query parameter allowing support for different modes of resource creation. Possible values include: - <code>errorIfExists</code>: Throws an error if you try to create a resource that already exists. - <code>orReplace</code>: Automatically replaces the existing resource with the current one. - <code>ifNotExists</code>: Creates a new resource when an alter is requested for a non-existent resource.</td>
<td>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.</td>
</tr>
<tr id="parameter-ifExists">
<td><CopyableCode code="ifExists" /></td>
<td><code>boolean</code></td>
<td>Query parameter that specifies how to handle the request for a resource that does not exist: - <code>true</code>: 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. - <code>false</code>: The endpoint throws an error if the resource doesn't exist.</td>
<td>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.</td>
</tr>
<tr id="parameter-like">
<td><CopyableCode code="like" /></td>
Expand Down Expand Up @@ -339,6 +339,9 @@ SELECT

- name: catalog
value: object
description: >
Type of catalog and its parameters.

- name: table_format
value: string
description: >
Expand Down
Loading
Loading