Skip to content

Commit 3de6fb8

Browse files
jeffreyavenjeffreyaven
committed
updated snowflake docs
1 parent 0de47cc commit 3de6fb8

File tree

46 files changed

+2962
-644
lines changed

Some content is hidden

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

46 files changed

+2962
-644
lines changed

‎docs/snowflake-docs/index.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -81,24 +81,24 @@ stackql.exe shell --auth=$Auth
8181
<div class="providerDocColumn">
8282
<a href="/providers/snowflake/account/">account</a><br />
8383
<a href="/providers/snowflake/alert/">alert</a><br />
84-
<a href="/providers/snowflake/api-integration/">api-integration</a><br />
85-
<a href="/providers/snowflake/catalog-integration/">catalog-integration</a><br />
86-
<a href="/providers/snowflake/compute-pool/">compute-pool</a><br />
84+
<a href="/providers/snowflake/api_integration/">api_integration</a><br />
85+
<a href="/providers/snowflake/catalog_integration/">catalog_integration</a><br />
86+
<a href="/providers/snowflake/compute_pool/">compute_pool</a><br />
8787
<a href="/providers/snowflake/database/">database</a><br />
88-
<a href="/providers/snowflake/database-role/">database-role</a><br />
89-
<a href="/providers/snowflake/dynamic-table/">dynamic-table</a><br />
90-
<a href="/providers/snowflake/event-table/">event-table</a><br />
91-
<a href="/providers/snowflake/external-volume/">external-volume</a><br />
88+
<a href="/providers/snowflake/database_role/">database_role</a><br />
89+
<a href="/providers/snowflake/dynamic_table/">dynamic_table</a><br />
90+
<a href="/providers/snowflake/event_table/">event_table</a><br />
91+
<a href="/providers/snowflake/external_volume/">external_volume</a><br />
9292
<a href="/providers/snowflake/function/">function</a><br />
9393
<a href="/providers/snowflake/grant/">grant</a><br />
94-
<a href="/providers/snowflake/iceberg-table/">iceberg-table</a><br />
95-
<a href="/providers/snowflake/image-repository/">image-repository</a><br />
96-
<a href="/providers/snowflake/managed-account/">managed-account</a><br />
97-
<a href="/providers/snowflake/network-policy/">network-policy</a><br />
94+
<a href="/providers/snowflake/iceberg_table/">iceberg_table</a><br />
95+
<a href="/providers/snowflake/image_repository/">image_repository</a><br />
96+
<a href="/providers/snowflake/managed_account/">managed_account</a><br />
97+
<a href="/providers/snowflake/network_policy/">network_policy</a><br />
9898
</div>
9999
<div class="providerDocColumn">
100100
<a href="/providers/snowflake/notebook/">notebook</a><br />
101-
<a href="/providers/snowflake/notification-integration/">notification-integration</a><br />
101+
<a href="/providers/snowflake/notification_integration/">notification_integration</a><br />
102102
<a href="/providers/snowflake/pipe/">pipe</a><br />
103103
<a href="/providers/snowflake/procedure/">procedure</a><br />
104104
<a href="/providers/snowflake/result/">result</a><br />
@@ -110,7 +110,7 @@ stackql.exe shell --auth=$Auth
110110
<a href="/providers/snowflake/table/">table</a><br />
111111
<a href="/providers/snowflake/task/">task</a><br />
112112
<a href="/providers/snowflake/user/">user</a><br />
113-
<a href="/providers/snowflake/user-defined-function/">user-defined-function</a><br />
113+
<a href="/providers/snowflake/user_defined_function/">user_defined_function</a><br />
114114
<a href="/providers/snowflake/view/">view</a><br />
115115
<a href="/providers/snowflake/warehouse/">warehouse</a><br />
116116
</div>

‎docs/snowflake-docs/providers/snowflake/api-integration/api_integrations/index.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

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

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
---
2+
title: api_integrations
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- api_integrations
7+
- api_integration
8+
- snowflake
9+
- infrastructure-as-code
10+
- configuration-as-data
11+
- cloud inventory
12+
description: Query, deploy and manage snowflake resources using SQL
13+
custom_edit_url: null
14+
image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png
15+
---
16+
17+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
18+
import Tabs from '@theme/Tabs';
19+
import TabItem from '@theme/TabItem';
20+
21+
Creates, updates, deletes, gets or lists a <code>api_integrations</code> resource.
22+
23+
## Overview
24+
<table><tbody>
25+
<tr><td><b>Name</b></td><td><code>api_integrations</code></td></tr>
26+
<tr><td><b>Type</b></td><td>Resource</td></tr>
27+
<tr><td><b>Id</b></td><td><CopyableCode code="snowflake.api_integration.api_integrations" /></td></tr>
28+
</tbody></table>
29+
30+
## Fields
31+
| Name | Datatype | Description |
32+
|:-----|:---------|:------------|
33+
| <CopyableCode code="name" /> | `string` | Name of the API integration. |
34+
| <CopyableCode code="api_allowed_prefixes" /> | `array` | A comma-separated list of endpoints and resources that Snowflake can access. |
35+
| <CopyableCode code="api_blocked_prefixes" /> | `array` | A comma-separated list of endpoints and resources that are not allowed to be called from Snowflake. |
36+
| <CopyableCode code="api_hook" /> | `object` | |
37+
| <CopyableCode code="comment" /> | `string` | Comment for the API integration. |
38+
| <CopyableCode code="created_on" /> | `string` | Date and time when the API integration was created. |
39+
| <CopyableCode code="enabled" /> | `boolean` | Whether the API integration is enabled. |
40+
41+
## Methods
42+
| Name | Accessible by | Required Params | Description |
43+
|:-----|:--------------|:----------------|:------------|
44+
| <CopyableCode code="fetch_api_integration" /> | `SELECT` | <CopyableCode code="name, endpoint" /> | Fetch an API integration |
45+
| <CopyableCode code="list_api_integrations" /> | `SELECT` | <CopyableCode code="endpoint" /> | List API integrations |
46+
| <CopyableCode code="create_api_integration" /> | `INSERT` | <CopyableCode code="data__api_allowed_prefixes, data__api_hook, data__enabled, data__name, endpoint" /> | Create an API integration |
47+
| <CopyableCode code="delete_api_integration" /> | `DELETE` | <CopyableCode code="name, endpoint" /> | Delete an API integration |
48+
| <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. |
49+
50+
## `SELECT` examples
51+
52+
List API integrations
53+
54+
55+
```sql
56+
SELECT
57+
name,
58+
api_allowed_prefixes,
59+
api_blocked_prefixes,
60+
api_hook,
61+
comment,
62+
created_on,
63+
enabled
64+
FROM snowflake.api_integration.api_integrations
65+
WHERE endpoint = '{{ endpoint }}';
66+
```
67+
## `INSERT` example
68+
69+
Use the following StackQL query and manifest file to create a new <code>api_integrations</code> resource.
70+
71+
<Tabs
72+
defaultValue="all"
73+
values={[
74+
{ label: 'Required Properties', value: 'required' },
75+
{ label: 'All Properties', value: 'all', },
76+
{ label: 'Manifest', value: 'manifest', },
77+
]
78+
}>
79+
<TabItem value="all">
80+
81+
```sql
82+
/*+ create */
83+
INSERT INTO snowflake.api_integration.api_integrations (
84+
data__name,
85+
data__api_hook,
86+
data__api_allowed_prefixes,
87+
data__api_blocked_prefixes,
88+
data__enabled,
89+
data__comment,
90+
endpoint
91+
)
92+
SELECT
93+
'{{ name }}',
94+
'{{ api_hook }}',
95+
'{{ api_allowed_prefixes }}',
96+
'{{ api_blocked_prefixes }}',
97+
'{{ enabled }}',
98+
'{{ comment }}',
99+
'{{ endpoint }}'
100+
;
101+
```
102+
</TabItem>
103+
104+
<TabItem value="required">
105+
106+
```sql
107+
/*+ create */
108+
INSERT INTO snowflake.api_integration.api_integrations (
109+
data__name,
110+
data__api_hook,
111+
data__api_allowed_prefixes,
112+
data__enabled,
113+
endpoint
114+
)
115+
SELECT
116+
'{{ name }}',
117+
'{{ api_hook }}',
118+
'{{ api_allowed_prefixes }}',
119+
'{{ enabled }}',
120+
'{{ endpoint }}'
121+
;
122+
```
123+
</TabItem>
124+
125+
<TabItem value="manifest">
126+
127+
```yaml
128+
- name: api_integrations
129+
props:
130+
- name: data__api_allowed_prefixes
131+
value: string
132+
- name: data__api_hook
133+
value: string
134+
- name: data__enabled
135+
value: string
136+
- name: data__name
137+
value: string
138+
- name: endpoint
139+
value: string
140+
- name: name
141+
value: string
142+
- name: api_hook
143+
props:
144+
- name: type
145+
value: string
146+
- name: api_allowed_prefixes
147+
value: array
148+
- name: api_blocked_prefixes
149+
value: array
150+
- name: enabled
151+
value: boolean
152+
- name: comment
153+
value: string
154+
155+
```
156+
</TabItem>
157+
</Tabs>
158+
159+
## `REPLACE` example
160+
161+
Replaces all fields in the specified <code>api_integrations</code> resource.
162+
163+
```sql
164+
/*+ update */
165+
REPLACE snowflake.api_integration.api_integrations
166+
SET
167+
name = '{{ name }}',
168+
api_hook = '{{ api_hook }}',
169+
api_allowed_prefixes = '{{ api_allowed_prefixes }}',
170+
api_blocked_prefixes = '{{ api_blocked_prefixes }}',
171+
enabled = true|false,
172+
comment = '{{ comment }}'
173+
WHERE
174+
name = '{{ name }}'
175+
AND data__api_allowed_prefixes = '{{ data__api_allowed_prefixes }}'
176+
AND data__api_hook = '{{ data__api_hook }}'
177+
AND data__enabled = '{{ data__enabled }}'
178+
AND data__name = '{{ data__name }}'
179+
AND endpoint = '{{ endpoint }}';
180+
```
181+
182+
## `DELETE` example
183+
184+
Deletes the specified <code>api_integrations</code> resource.
185+
186+
```sql
187+
/*+ delete */
188+
DELETE FROM snowflake.api_integration.api_integrations
189+
WHERE name = '{{ name }}'
190+
AND endpoint = '{{ endpoint }}';
191+
```

‎docs/snowflake-docs/providers/snowflake/api-integration/index.md renamed to ‎docs/snowflake-docs/providers/snowflake/api_integration/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: api-integration
2+
title: api_integration
33
hide_title: false
44
hide_table_of_contents: false
55
keywords:
6-
- api-integration
6+
- api_integration
77
- snowflake
88
- stackql
99
- infrastructure-as-code
@@ -14,7 +14,7 @@ custom_edit_url: null
1414
image: /img/providers/snowflake/stackql-snowflake-provider-featured-image.png
1515
---
1616

17-
api-integration service documentation.
17+
api_integration service documentation.
1818

1919
:::info Service Summary
2020

@@ -29,7 +29,7 @@ api-integration service documentation.
2929
## Resources
3030
<div class="row">
3131
<div class="providerDocColumn">
32-
<a href="/providers/snowflake/api-integration/api_integrations/">api_integrations</a>
32+
<a href="/providers/snowflake/api_integration/api_integrations/">api_integrations</a>
3333
</div>
3434
<div class="providerDocColumn">
3535

‎docs/snowflake-docs/providers/snowflake/catalog-integration/catalog_integrations/index.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)