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

updated snowflake docs

Author: jeffreyaven

docs/snowflake-docs/index.md

@@ -1,104 +1,104 @@
----
-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.
+---
+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
 
 <div class="row">
 <div class="providerDocColumn">
 <span>total services:&nbsp;<b>32</b></span><br />
-<span>total resources:&nbsp;<b>47</b></span><br />
+<span>total resources:&nbsp;<b>79</b></span><br />
 </div>
 </div>
 
 :::
 
-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:  
-
-- <CopyableCode code="SNOWFLAKE_PAT" /> - Snowflake Programmatic Access Token (PAT) (see <a href="https://docs.snowflake.com/developer-guide/snowflake-rest-api/authentication#using-a-programmatic-access-token-pat">Using a programmatic access token (PAT)</a>)
-
-These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
-
-<details>
-
-<summary>Using different environment variables</summary>
-
-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
-
-```
-</details>
+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:  
+
+- <CopyableCode code="SNOWFLAKE_PAT" /> - Snowflake Programmatic Access Token (PAT) (see <a href="https://docs.snowflake.com/developer-guide/snowflake-rest-api/authentication#using-a-programmatic-access-token-pat">Using a programmatic access token (PAT)</a>)
+
+These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
+
+<details>
+
+<summary>Using different environment variables</summary>
+
+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
+
+```
+</details>
 
 
 ## Services
 <div class="row">
 <div class="providerDocColumn">
 <a href="/providers/snowflake/account/">account</a><br />
 <a href="/providers/snowflake/alert/">alert</a><br />
-<a href="/providers/snowflake/api_integration/">api_integration</a><br />
-<a href="/providers/snowflake/catalog_integration/">catalog_integration</a><br />
-<a href="/providers/snowflake/compute_pool/">compute_pool</a><br />
+<a href="/providers/snowflake/api-integration/">api-integration</a><br />
+<a href="/providers/snowflake/catalog-integration/">catalog-integration</a><br />
+<a href="/providers/snowflake/compute-pool/">compute-pool</a><br />
 <a href="/providers/snowflake/database/">database</a><br />
-<a href="/providers/snowflake/database_role/">database_role</a><br />
-<a href="/providers/snowflake/dynamic_table/">dynamic_table</a><br />
-<a href="/providers/snowflake/event_table/">event_table</a><br />
-<a href="/providers/snowflake/external_volume/">external_volume</a><br />
+<a href="/providers/snowflake/database-role/">database-role</a><br />
+<a href="/providers/snowflake/dynamic-table/">dynamic-table</a><br />
+<a href="/providers/snowflake/event-table/">event-table</a><br />
+<a href="/providers/snowflake/external-volume/">external-volume</a><br />
 <a href="/providers/snowflake/function/">function</a><br />
 <a href="/providers/snowflake/grant/">grant</a><br />
-<a href="/providers/snowflake/iceberg_table/">iceberg_table</a><br />
-<a href="/providers/snowflake/image_repository/">image_repository</a><br />
-<a href="/providers/snowflake/managed_account/">managed_account</a><br />
-<a href="/providers/snowflake/network_policy/">network_policy</a><br />
+<a href="/providers/snowflake/iceberg-table/">iceberg-table</a><br />
+<a href="/providers/snowflake/image-repository/">image-repository</a><br />
+<a href="/providers/snowflake/managed-account/">managed-account</a><br />
+<a href="/providers/snowflake/network-policy/">network-policy</a><br />
 </div>
 <div class="providerDocColumn">
 <a href="/providers/snowflake/notebook/">notebook</a><br />
-<a href="/providers/snowflake/notification_integration/">notification_integration</a><br />
+<a href="/providers/snowflake/notification-integration/">notification-integration</a><br />
 <a href="/providers/snowflake/pipe/">pipe</a><br />
 <a href="/providers/snowflake/procedure/">procedure</a><br />
 <a href="/providers/snowflake/result/">result</a><br />
@@ -110,7 +110,7 @@ stackql.exe shell --auth=$Auth
 <a href="/providers/snowflake/table/">table</a><br />
 <a href="/providers/snowflake/task/">task</a><br />
 <a href="/providers/snowflake/user/">user</a><br />
-<a href="/providers/snowflake/user_defined_function/">user_defined_function</a><br />
+<a href="/providers/snowflake/user-defined-function/">user-defined-function</a><br />
 <a href="/providers/snowflake/view/">view</a><br />
 <a href="/providers/snowflake/warehouse/">warehouse</a><br />
 </div>

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

@@ -129,42 +129,119 @@ WHERE endpoint = '{{ endpoint }}';
 
 Use the following StackQL query and manifest file to create a new <code>accounts</code> resource.
 
-<Tabs     defaultValue="all"    values={[        { label: 'All Properties', value: 'all' }, { label: 'Manifest', value: 'manifest' }    ]}>
+<Tabs
+    defaultValue="all"
+    values={[
+        { label: 'Required Properties', value: 'required' },
+        { label: 'All Properties', value: 'all', },
+        { label: 'Manifest', value: 'manifest', },
+    ]
+}>
 <TabItem value="all">
 
 ```sql
 /*+ create */
 INSERT INTO snowflake.account.accounts (
-endpoint,
-data__admin_name,
+data__name,
+data__region_group,
+data__region,
 data__edition,
+data__comment,
+data__admin_name,
+data__admin_password,
+data__admin_rsa_public_key,
+data__admin_user_type,
+data__first_name,
+data__last_name,
+data__email,
+data__must_change_password,
+data__polaris,
+endpoint
+)
+SELECT 
+'{{ name }}',
+'{{ region_group }}',
+'{{ region }}',
+'{{ edition }}',
+'{{ comment }}',
+'{{ admin_name }}',
+'{{ admin_password }}',
+'{{ admin_rsa_public_key }}',
+'{{ admin_user_type }}',
+'{{ first_name }}',
+'{{ last_name }}',
+'{{ email }}',
+'{{ must_change_password }}',
+'{{ polaris }}',
+'{{ endpoint }}'
+;
+```
+</TabItem>
+
+<TabItem value="required">
+
+```sql
+/*+ create */
+INSERT INTO snowflake.account.accounts (
+data__name,
+data__admin_name,
 data__email,
-data__name
+data__edition,
+endpoint
 )
 SELECT 
-'{ admin_name }',
-'{ name }',
-'{ edition }',
-'{ endpoint }',
-'{ email }'
+'{{ name }}',
+'{{ admin_name }}',
+'{{ email }}',
+'{{ edition }}',
+'{{ endpoint }}'
 ;
 ```
 </TabItem>
+
 <TabItem value="manifest">
 
 ```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
+    - 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
+    - name: name
+      value: string
+    - name: region_group
+      value: string
+    - name: region
+      value: string
+    - name: edition
+      value: string
+    - name: comment
+      value: string
+    - name: admin_name
+      value: string
+    - name: admin_password
+      value: string
+    - name: admin_rsa_public_key
+      value: string
+    - name: admin_user_type
+      value: string
+    - name: first_name
+      value: string
+    - name: last_name
+      value: string
+    - name: email
+      value: string
+    - name: must_change_password
+      value: boolean
+    - name: polaris
+      value: boolean
 
 ```
 </TabItem>
@@ -177,5 +254,7 @@ Deletes the specified <code>accounts</code> resource.
 ```sql
 /*+ delete */
 DELETE FROM snowflake.account.accounts
-WHERE gracePeriodInDays = '{ gracePeriodInDays }' AND name = '{ name }' AND endpoint = '{ endpoint }';
+WHERE gracePeriodInDays = '{{ gracePeriodInDays }}'
+AND name = '{{ name }}'
+AND endpoint = '{{ endpoint }}';
 ```