Skip to content

Commit c76e681

Browse files
authored
Merge pull request #281 from stackql/feature/provider-docs
update snowflake
2 parents f84e024 + 07a04ca commit c76e681

File tree

15 files changed

+51
-194
lines changed

15 files changed

+51
-194
lines changed

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,9 +219,7 @@ SELECT
219219
description: user comment associated to an object in the dictionary
220220
- name: schedule
221221
value:
222-
- name: schedule_type
223-
value: string
224-
description: Type of the schedule, can be either CRON_TYPE or MINUTES_TYPE
222+
schedule_type: string
225223
description: Required parameter for the alerts resource.
226224
- name: warehouse
227225
value: string

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -181,11 +181,7 @@ SELECT
181181
api_integrations resource.)
182182
- name: api_hook
183183
value:
184-
- name: type
185-
value: string
186-
description: >-
187-
Type of ApiHook, can be AWS, AZURE, GC or GIT. (valid values: 'AWS',
188-
'AZURE', 'GC', 'GIT')
184+
type: string
189185
description: Required parameter for the api_integrations resource.
190186
- name: api_allowed_prefixes
191187
value: array

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -181,11 +181,7 @@ SELECT
181181
catalog_integrations resource.)
182182
- name: catalog
183183
value:
184-
- name: catalog_source
185-
value: string
186-
description: >-
187-
Type of external catalog (valid values: 'GLUE', 'OBJECT_STORE',
188-
'POLARIS')
184+
catalog_source: string
189185
description: Required parameter for the catalog_integrations resource.
190186
- name: table_format
191187
value: string

docs/snowflake-docs/providers/snowflake/database_role/future_grants/index.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -152,26 +152,14 @@ SELECT
152152
description: Required parameter for the future_grants resource.
153153
- name: securable
154154
value:
155-
- name: database
156-
value: string
157-
description: Database name of the securable if applicable.
158-
- name: schema
159-
value: string
160-
description: Schema name of the securable if applicable.
161-
- name: service
162-
value: string
163-
description: Service name of the securable if applicable.
164-
- name: name
165-
value: string
166-
description: Name of the securable if applicable.
155+
database: string
156+
schema: string
157+
service: string
158+
name: string
167159
- name: containing_scope
168160
value:
169-
- name: database
170-
value: string
171-
description: Database name of the securable scope if applicable.
172-
- name: schema
173-
value: string
174-
description: Schema name of the securable scope if applicable.
161+
database: string
162+
schema: string
175163
- name: securable_type
176164
value: string
177165
description: >-

docs/snowflake-docs/providers/snowflake/database_role/grants/index.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -152,26 +152,14 @@ SELECT
152152
description: Required parameter for the grants resource.
153153
- name: securable
154154
value:
155-
- name: database
156-
value: string
157-
description: Database name of the securable if applicable.
158-
- name: schema
159-
value: string
160-
description: Schema name of the securable if applicable.
161-
- name: service
162-
value: string
163-
description: Service name of the securable if applicable.
164-
- name: name
165-
value: string
166-
description: Name of the securable if applicable.
155+
database: string
156+
schema: string
157+
service: string
158+
name: string
167159
- name: containing_scope
168160
value:
169-
- name: database
170-
value: string
171-
description: Database name of the securable scope if applicable.
172-
- name: schema
173-
value: string
174-
description: Schema name of the securable scope if applicable.
161+
database: string
162+
schema: string
175163
- name: securable_type
176164
value: string
177165
description: >-

docs/snowflake-docs/providers/snowflake/dynamic_table/dynamic_tables/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -288,9 +288,7 @@ SELECT
288288
description: Specifies a comment for the column
289289
- name: target_lag
290290
value:
291-
- name: type
292-
value: string
293-
description: Type of lag, can be either USER_DEFINED or DOWNSTREAM.
291+
type: string
294292
description: >-
295293
Specifies the schedule for periodically refreshing the dynamic table.
296294
(Required parameter for the dynamic_tables resource.)

docs/snowflake-docs/providers/snowflake/notebook/notebooks/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -285,10 +285,10 @@ SELECT
285285
Warehouse against which the queries issued by the Streamlit app are run
286286
against
287287
- name: default_version_details
288-
value: []
288+
value: {}
289289
description: The version details of a file based entity
290290
- name: last_version_details
291-
value: []
291+
value: {}
292292
description: The version details of a file based entity
293293
```
294294
</TabItem>

docs/snowflake-docs/providers/snowflake/notification_integration/notification_integrations/index.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -172,13 +172,7 @@ SELECT
172172
description: Comment for the notification integration.
173173
- name: notification_hook
174174
value:
175-
- name: type
176-
value: string
177-
description: >-
178-
Type of NotificationHook, can be QUEUE, EMAIL or WEBHOOK (valid
179-
values: 'EMAIL', 'WEBHOOK', 'QUEUE_AWS_SNS_OUTBOUND',
180-
'QUEUE_AZURE_EVENT_GRID_OUTBOUND', 'QUEUE_GCP_PUBSUB_OUTBOUND',
181-
'QUEUE_AZURE_EVENT_GRID_INBOUND', 'QUEUE_GCP_PUBSUB_INBOUND')
175+
type: string
182176
description: Required parameter for the notification_integrations resource.
183177
```
184178
</TabItem>

docs/snowflake-docs/providers/snowflake/procedure/procedures/index.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -260,20 +260,12 @@ SELECT
260260
procedures resource.)
261261
- name: return_type
262262
value:
263-
- name: type
264-
value: string
265-
description: Type of the return, can be either DATATYPE or TABLE
263+
type: string
266264
description: Required parameter for the procedures resource.
267265
- name: language_config
268266
value:
269-
- name: language
270-
value: string
271-
description: >-
272-
Language that the function/procedure is written in. Possible values
273-
include: JAVA, JAVASCRIPT, PYTHON, SCALA, SQL
274-
- name: called_on_null_input
275-
value: boolean
276-
description: Decide if the function/procedure can receive null input
267+
language: string
268+
called_on_null_input: boolean
277269
description: Required parameter for the procedures resource.
278270
- name: comment
279271
value: string

docs/snowflake-docs/providers/snowflake/role/future_grants/index.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -144,26 +144,14 @@ SELECT
144144
description: Required parameter for the future_grants resource.
145145
- name: securable
146146
value:
147-
- name: database
148-
value: string
149-
description: Database name of the securable if applicable.
150-
- name: schema
151-
value: string
152-
description: Schema name of the securable if applicable.
153-
- name: service
154-
value: string
155-
description: Service name of the securable if applicable.
156-
- name: name
157-
value: string
158-
description: Name of the securable if applicable.
147+
database: string
148+
schema: string
149+
service: string
150+
name: string
159151
- name: containing_scope
160152
value:
161-
- name: database
162-
value: string
163-
description: Database name of the securable scope if applicable.
164-
- name: schema
165-
value: string
166-
description: Schema name of the securable scope if applicable.
153+
database: string
154+
schema: string
167155
- name: securable_type
168156
value: string
169157
description: >-

docs/snowflake-docs/providers/snowflake/stage/stages/index.md

Lines changed: 8 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -249,57 +249,20 @@ SELECT
249249
description: Specifies a comment for the stage.
250250
- name: credentials
251251
value:
252-
- name: credential_type
253-
value: string
254-
description: Type of the credential, can be either AWS or AZURE.
252+
credential_type: string
255253
description: Specifies the credentials of the stage.
256254
- name: encryption
257255
value:
258-
- name: type
259-
value: string
260-
description: >-
261-
Specifies the encryption type used. (valid values: 'SNOWFLAKE_FULL',
262-
'SNOWFLAKE_SSE', 'AWS_CSE', 'AWS_SSE_S3', 'AWS_SSE_KMS',
263-
'GCS_SSE_KMS', 'AZURE_CSE', 'NONE')
264-
- name: master_key
265-
value: string
266-
description: >-
267-
Specifies the client-side master key used to encrypt the files in
268-
the bucket. The master key must be a 128-bit or 256-bit key in
269-
Base64-encoded form.
270-
- name: kms_key_id
271-
value: string
272-
description: >-
273-
Optionally specifies the ID for the KMS-managed key used to encrypt
274-
files unloaded into the bucket.
256+
type: string
257+
master_key: string
258+
kms_key_id: string
275259
description: Encryption parameters of the stage.
276260
- name: directory_table
277261
value:
278-
- name: enable
279-
value: boolean
280-
description: >-
281-
Specifies whether to add a directory table to the stage. When the
282-
value is TRUE, a directory table is created with the stage.
283-
default: false
284-
- name: refresh_on_create
285-
value: boolean
286-
description: >-
287-
Specifies whether to automatically refresh the directory table
288-
metadata once, immediately after the stage is created.
289-
default: true
290-
- name: auto_refresh
291-
value: boolean
292-
description: >-
293-
Specifies whether Snowflake should enable triggering automatic
294-
refreshes of the directory table metadata when new or updated data
295-
files are available in the named external stage specified in the URL
296-
value.
297-
default: false
298-
- name: notification_integration
299-
value: string
300-
description: >-
301-
Specifies the name of the notification integration used to
302-
automatically refresh the directory table metadata.
262+
enable: boolean
263+
refresh_on_create: boolean
264+
auto_refresh: boolean
265+
notification_integration: string
303266
description: Directory table parameters of the stage.
304267
```
305268
</TabItem>

docs/snowflake-docs/providers/snowflake/streams/streams/index.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -212,22 +212,10 @@ SELECT
212212
description: Name of the stream (Required parameter for the streams resource.)
213213
- name: stream_source
214214
value:
215-
- name: src_type
216-
value: string
217-
description: 'Type of the source. Possible values include: stream, table, view'
218-
- name: name
219-
value: string
220-
description: Name of the source whose changes are tracked by the stream
221-
- name: database_name
222-
value: string
223-
description: >-
224-
Database name to which stream source type belongs. If not provided,
225-
database name provided in the path param will be used.
226-
- name: schema_name
227-
value: string
228-
description: >-
229-
Schema name to which stream source type belongs. If not provided,
230-
schema name provided in the path param will be used.
215+
src_type: string
216+
name: string
217+
database_name: string
218+
schema_name: string
231219
description: Required parameter for the streams resource.
232220
- name: comment
233221
value: string

docs/snowflake-docs/providers/snowflake/task/tasks/index.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -304,9 +304,7 @@ SELECT
304304
Identifiers enclosed in double quotes are also case-sensitive.
305305
- name: schedule
306306
value:
307-
- name: schedule_type
308-
value: string
309-
description: Type of the schedule, can be either CRON_TYPE or MINUTES_TYPE.
307+
schedule_type: string
310308
description: Specifies the schedule for periodically running the task.
311309
- name: comment
312310
value: string
@@ -344,9 +342,7 @@ SELECT
344342
run of the task. This parameter only applies to serverless tasks.
345343
- name: target_completion_interval
346344
value:
347-
- name: schedule_type
348-
value: string
349-
description: Type of the schedule, can be either CRON_TYPE or MINUTES_TYPE.
345+
schedule_type: string
350346
description: Specifies the schedule for periodically running the task.
351347
- name: serverless_task_min_statement_size
352348
value: string

docs/snowflake-docs/providers/snowflake/user/grants/index.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -139,23 +139,13 @@ SELECT
139139
description: Required parameter for the grants resource.
140140
- name: securable
141141
value:
142-
- name: database
143-
value: string
144-
description: Database name of the securable if applicable.
145-
- name: schema
146-
value: string
147-
description: Schema name of the securable if applicable.
148-
- name: name
149-
value: string
150-
description: Name of the securable if applicable.
142+
database: string
143+
schema: string
144+
name: string
151145
- name: containing_scope
152146
value:
153-
- name: database
154-
value: string
155-
description: Database name of the securable scope if applicable.
156-
- name: schema
157-
value: string
158-
description: Schema name of the securable scope if applicable.
147+
database: string
148+
schema: string
159149
- name: securable_type
160150
value: string
161151
description: >-

docs/snowflake-docs/providers/snowflake/user_defined_function/user_defined_functions/index.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -284,31 +284,13 @@ SELECT
284284
user_defined_functions resource.)
285285
- name: return_type
286286
value:
287-
- name: type
288-
value: string
289-
description: Type of the return, can be either DATATYPE or TABLE
287+
type: string
290288
description: Required parameter for the user_defined_functions resource.
291289
- name: language_config
292290
value:
293-
- name: language
294-
value: string
295-
description: >-
296-
Language that the function/procedure is written in. Possible values
297-
include: JAVA, JAVASCRIPT, PYTHON, SCALA, SQL
298-
- name: called_on_null_input
299-
value: boolean
300-
description: Decide if the function/procedure can receive null input
301-
- name: is_volatile
302-
value: boolean
303-
description: >-
304-
Specifies the behavior of the UDF when returning results. This Field
305-
is deprecated for Procedure. If true, UDF might return different
306-
values for different rows, even for the same input. This field is
307-
deprecated for Procedure. If false, UDF assumes that the function,
308-
when called with the same inputs, will always return the same
309-
result. This guarantee is not checked. Specifying IMMUTABLE for a
310-
UDF that returns different values for the same input will result in
311-
undefined behavior.
291+
language: string
292+
called_on_null_input: boolean
293+
is_volatile: boolean
312294
description: Required parameter for the user_defined_functions resource.
313295
- name: comment
314296
value: string

0 commit comments

Comments
 (0)