Skip to content

Commit fae2541

Browse files
2321 - documentation - generated
1 parent dac931f commit fae2541

File tree

1 file changed

+30
-13
lines changed

1 file changed

+30
-13
lines changed

docs/src/content/docs/reference/components/snowflake.md

+30-13
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ Version: 1
2626

2727
| Name | Label | Type | Description | Required |
2828
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
29-
| account_identifier | null | STRING | Account identifier. | true |
30-
| clientId | null | STRING | Snowflake OAuth Client ID. | true |
31-
| clientSecret | null | STRING | Snowflake OAuth Client Secret. | true |
29+
| account_identifier | Account Identifier | STRING | Account identifier of your account. | true |
30+
| clientId | Client ID | STRING | Snowflake OAuth Client ID. | true |
31+
| clientSecret | Client Secret | STRING | Snowflake OAuth Client Secret. | true |
3232

3333

3434

@@ -53,8 +53,7 @@ Delete row from the table.
5353
| database | Database | STRING | | true |
5454
| schema | Schema | STRING <details> <summary> Depends On </summary> database </details> | | true |
5555
| table | Table | STRING <details> <summary> Depends On </summary> schema </details> | | true |
56-
| column | Column | STRING | Column name that will be checked for condition. | true |
57-
| condition | Condition | STRING | Condition that will be checked in the column. | true |
56+
| condition | Condition | STRING | Condition that will be checked in the column. Example: column1=5 | true |
5857

5958
#### Example JSON Structure
6059
```json
@@ -65,7 +64,6 @@ Delete row from the table.
6564
"database" : "",
6665
"schema" : "",
6766
"table" : "",
68-
"column" : "",
6967
"condition" : ""
7068
},
7169
"type" : "snowflake/v1/deleteRow"
@@ -197,7 +195,7 @@ Insert row into the table.
197195
| database | Database | STRING | | true |
198196
| schema | Schema | STRING <details> <summary> Depends On </summary> database </details> | | true |
199197
| table | Table | STRING <details> <summary> Depends On </summary> schema </details> | | true |
200-
| values | Values | STRING | Values to insert into the table. Seperated by comma. | true |
198+
| values | | DYNAMIC_PROPERTIES <details> <summary> Depends On </summary> table </details> | | true |
201199

202200
#### Example JSON Structure
203201
```json
@@ -208,7 +206,7 @@ Insert row into the table.
208206
"database" : "",
209207
"schema" : "",
210208
"table" : "",
211-
"values" : ""
209+
"values" : { }
212210
},
213211
"type" : "snowflake/v1/insertRow"
214212
}
@@ -271,9 +269,8 @@ Update row from the table.
271269
| database | Database | STRING | | true |
272270
| schema | Schema | STRING <details> <summary> Depends On </summary> database </details> | | true |
273271
| table | Table | STRING <details> <summary> Depends On </summary> schema </details> | | true |
274-
| column | Column | STRING | Column name that will be checked for condition. | true |
275-
| condition | Condition | STRING | Condition that will be checked in the column. | true |
276-
| values | Values | STRING | Updated values of the table. Seperated by comma. | true |
272+
| condition | Condition | STRING | Condition that will be checked in the column. Example: column1=5 | true |
273+
| values | | DYNAMIC_PROPERTIES <details> <summary> Depends On </summary> table </details> | | true |
277274

278275
#### Example JSON Structure
279276
```json
@@ -284,9 +281,8 @@ Update row from the table.
284281
"database" : "",
285282
"schema" : "",
286283
"table" : "",
287-
"column" : "",
288284
"condition" : "",
289-
"values" : ""
285+
"values" : { }
290286
},
291287
"type" : "snowflake/v1/updateRow"
292288
}
@@ -344,3 +340,24 @@ Type: OBJECT
344340
# Additional instructions
345341
<hr />
346342

343+
After creating you Snowflake account, you have to create SECURITY INTEGRATION.
344+
https://docs.snowflake.com/en/sql-reference/sql/create-security-integration-oauth-snowflake
345+
1. Create SQL Worksheet
346+
2. Change <name> and <callback url> to fit your application.
347+
CREATE SECURITY INTEGRATION <name>
348+
TYPE = oauth
349+
ENABLED = true
350+
OAUTH_CLIENT = custom
351+
OAUTH_CLIENT_TYPE = 'CONFIDENTIAL'
352+
OAUTH_REDIRECT_URI = '<callback url>'
353+
OAUTH_ISSUE_REFRESH_TOKENS = TRUE
354+
OAUTH_ALLOW_NON_TLS_REDIRECT_URI = true
355+
OAUTH_REFRESH_TOKEN_VALIDITY = 86400;
356+
3. Run the SQL Worksheet.
357+
358+
To get your Client ID and Client Secret:
359+
https://docs.snowflake.com/sql-reference/functions/system_show_oauth_client_secrets
360+
1. Create SQL Worksheet
361+
2. Change <name> to name of your security integration:
362+
select system$show_oauth_client_secrets( '<name>' )
363+
3. Run the SQL Worksheet

0 commit comments

Comments
 (0)