Created
July 31, 2023 20:31
-
-
Save 91pavan/d01ad72231d925759bf52ea3f3ad6041 to your computer and use it in GitHub Desktop.
OpenAPISpec for connector
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi": "3.0.0", | |
| "servers": [ | |
| { | |
| "url": "/" | |
| } | |
| ], | |
| "info": { | |
| "version": "2.0.0", | |
| "title": "Kosha Snowflake Connector API", | |
| "description": "The Snowflake SQL API is a REST API that you can use to access and update data in a Snowflake database. ", | |
| "contact": { | |
| "name": "Snowflake, Inc.", | |
| "url": "https://snowflake.com", | |
| "email": "support@snowflake.com" | |
| } | |
| }, | |
| "paths": { | |
| "/api/v2/statements": { | |
| "parameters": [ | |
| { | |
| "$ref": "#/components/parameters/requestId" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/async" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/nullable" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/accept" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/userAgent" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/snowflakeAuthorizationTokenType" | |
| } | |
| ], | |
| "post": { | |
| "operationId": "SubmitStatement", | |
| "summary": "Submits a SQL statement for execution.", | |
| "description": "Submits a single statement for execution. You can specify that the statement should be executed asynchronously.", | |
| "tags": [ | |
| "statements" | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "description": "Specifies the SQL statement to execute and the statement context.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "statement": { | |
| "description": "SQL statement or batch of SQL statements to execute. You can specify query, DML and DDL statements. The following statements are not supported: PUT, GET, USE, ALTER SESSION, BEGIN, COMMIT, ROLLBACK, statements that set session variables, and statements that create temporary tables and stages.", | |
| "type": "string" | |
| }, | |
| "timeout": { | |
| "description": "Timeout in seconds for statement execution. If the execution of a statement takes longer than the specified timeout, the execution is automatically canceled. To set the timeout to the maximum value (604800 seconds), set timeout to 0.", | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": 0, | |
| "example": 10 | |
| }, | |
| "database": { | |
| "description": "Database in which the statement should be executed. The value in this field is case-sensitive.", | |
| "type": "string", | |
| "example": "TESTDB" | |
| }, | |
| "schema": { | |
| "description": "Schema in which the statement should be executed. The value in this field is case-sensitive.", | |
| "type": "string", | |
| "example": "TESTSCHEMA" | |
| }, | |
| "warehouse": { | |
| "description": "Warehouse to use when executing the statement. The value in this field is case-sensitive.", | |
| "type": "string", | |
| "example": "TESTWH" | |
| }, | |
| "role": { | |
| "description": "Role to use when executing the statement. The value in this field is case-sensitive.", | |
| "type": "string", | |
| "example": "TESTROLE" | |
| }, | |
| "bindings": { | |
| "description": "Values of bind variables in the SQL statement. When executing the statement, Snowflake replaces placeholders ('?' and ':name') in the statement with these specified values.", | |
| "type": "object", | |
| "properties": {}, | |
| "example": { | |
| "1": { | |
| "type": "FIXED", | |
| "value": "123" | |
| }, | |
| "2": { | |
| "type": "TEXT", | |
| "value": "teststring" | |
| } | |
| } | |
| }, | |
| "parameters": { | |
| "description": "Session parameters that should be set before executing the statement.", | |
| "type": "object", | |
| "properties": { | |
| "timezone": { | |
| "description": "Time zone to use when executing the statement.", | |
| "type": "string", | |
| "example": "america/los_angeles" | |
| }, | |
| "query_tag": { | |
| "description": "Query tag that you want to associate with the SQL statement.", | |
| "type": "string", | |
| "example": "tag-1234" | |
| }, | |
| "binary_output_format": { | |
| "description": "Output format for binary values.", | |
| "type": "string", | |
| "example": "HEX" | |
| }, | |
| "date_output_format": { | |
| "description": "Output format for DATE values.", | |
| "type": "string", | |
| "example": "YYYY-MM-DD" | |
| }, | |
| "time_output_format": { | |
| "description": "Output format for TIME values.", | |
| "type": "string", | |
| "example": "HH24:MI:SS.FF6" | |
| }, | |
| "timestamp_output_format": { | |
| "description": "Output format for TIMESTAMP values.", | |
| "type": "string", | |
| "example": "YYYY-MM-DDTHH24:MI:SS.FF6" | |
| }, | |
| "timestamp_ltz_output_format": { | |
| "description": "Output format for TIMESTAMP_LTZ values.", | |
| "type": "string", | |
| "example": "YYYY-MM-DDTHH24:MI:SS.FF6" | |
| }, | |
| "timestamp_ntz_output_format": { | |
| "description": "Output format for TIMESTAMP_NTZ values.", | |
| "type": "string", | |
| "example": "YYYY-MM-DDTHH24:MI:SS.FF6" | |
| }, | |
| "timestamp_tz_output_format": { | |
| "description": "Output format for TIMESTAMP_TZ values.", | |
| "type": "string", | |
| "example": "YYYY-MM-DDTHH24:MI:SS.FF6 TZHTZM" | |
| }, | |
| "multi_statement_count": { | |
| "description": "Number of statements to execute when using multi-statement capability. 0 implies variable number of statements. Negative numbers are not allowed.", | |
| "type": "integer", | |
| "example": 4, | |
| "default": 1 | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "example": { | |
| "statement": "select * from T where c1=?", | |
| "timeout": 10, | |
| "database": "TESTDB", | |
| "schema": "TESTSCHEMA", | |
| "warehouse": "TESTWH", | |
| "bindings": { | |
| "1": { | |
| "type": "FIXED", | |
| "value": "123" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "The statement was executed successfully, and the response includes any data requested.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ResultSet" | |
| } | |
| } | |
| }, | |
| "headers": { | |
| "link": { | |
| "$ref": "#/components/headers/Link" | |
| } | |
| }, | |
| "links": { | |
| "GetStatementStatus": { | |
| "operationId": "GetStatementStatus", | |
| "parameters": { | |
| "statementHandle": "$response.body#/resultMetaData.statementHandle" | |
| } | |
| }, | |
| "CancelStatement": { | |
| "operationId": "CancelStatement", | |
| "parameters": { | |
| "statementHandle": "$response.body#/resultMetaData.statementHandle" | |
| } | |
| } | |
| } | |
| }, | |
| "202": { | |
| "description": "The execution of the statement is still in progress. Use GET /statements/ and specify the statement handle to check the status of the statement execution.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/QueryStatus" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "$ref": "#/components/responses/400BadRequest" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/401Unauthorized" | |
| }, | |
| "403": { | |
| "$ref": "#/components/responses/403Forbidden" | |
| }, | |
| "404": { | |
| "$ref": "#/components/responses/404NotFound" | |
| }, | |
| "405": { | |
| "$ref": "#/components/responses/405MethodNotAllowed" | |
| }, | |
| "408": { | |
| "description": "The execution of the statement exceeded the timeout period. The execution of the statement was cancelled.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/QueryStatus" | |
| } | |
| } | |
| } | |
| }, | |
| "415": { | |
| "$ref": "#/components/responses/415UnsupportedMediaType" | |
| }, | |
| "422": { | |
| "description": "An error occurred when executing the statement. Check the error code and error message for details.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/QueryFailureStatus" | |
| } | |
| } | |
| } | |
| }, | |
| "429": { | |
| "$ref": "#/components/responses/429LimitExceeded" | |
| }, | |
| "500": { | |
| "$ref": "#/components/responses/500InternalServerError" | |
| }, | |
| "503": { | |
| "$ref": "#/components/responses/503ServiceUnavailable" | |
| }, | |
| "504": { | |
| "$ref": "#/components/responses/504GatewayTimeout" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v2/statements/{statementHandle}": { | |
| "parameters": [ | |
| { | |
| "$ref": "#/components/parameters/statementHandle" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/requestId" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/partition" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/accept" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/userAgent" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/snowflakeAuthorizationTokenType" | |
| } | |
| ], | |
| "get": { | |
| "operationId": "GetStatementStatus", | |
| "summary": "Checks the status of the execution of a statement", | |
| "description": "Checks the status of the execution of the statement with the specified statement handle. If the statement was executed successfully, the operation returns the requested partition of the result set.", | |
| "tags": [ | |
| "statements" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The statement was executed successfully, and the response includes any data requested.", | |
| "headers": { | |
| "link": { | |
| "$ref": "#/components/headers/Link" | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ResultSet" | |
| } | |
| } | |
| } | |
| }, | |
| "202": { | |
| "description": "The execution of the statement is still in progress. Use this method again to check the status of the statement execution.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/QueryStatus" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "$ref": "#/components/responses/400BadRequest" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/401Unauthorized" | |
| }, | |
| "403": { | |
| "$ref": "#/components/responses/403Forbidden" | |
| }, | |
| "404": { | |
| "$ref": "#/components/responses/404NotFound" | |
| }, | |
| "405": { | |
| "$ref": "#/components/responses/405MethodNotAllowed" | |
| }, | |
| "415": { | |
| "$ref": "#/components/responses/415UnsupportedMediaType" | |
| }, | |
| "422": { | |
| "description": "An error occurred when executing the statement. Check the error code and error message for details.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/QueryFailureStatus" | |
| } | |
| } | |
| } | |
| }, | |
| "429": { | |
| "$ref": "#/components/responses/429LimitExceeded" | |
| }, | |
| "500": { | |
| "$ref": "#/components/responses/500InternalServerError" | |
| }, | |
| "503": { | |
| "$ref": "#/components/responses/503ServiceUnavailable" | |
| }, | |
| "504": { | |
| "$ref": "#/components/responses/504GatewayTimeout" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v2/statements/{statementHandle}/cancel": { | |
| "parameters": [ | |
| { | |
| "$ref": "#/components/parameters/statementHandle" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/requestId" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/accept" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/userAgent" | |
| }, | |
| { | |
| "$ref": "#/components/parameters/snowflakeAuthorizationTokenType" | |
| } | |
| ], | |
| "post": { | |
| "operationId": "CancelStatement", | |
| "summary": "Cancels the execution of a statement.", | |
| "description": "Cancels the execution of the statement with the specified statement handle.", | |
| "tags": [ | |
| "statements" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The execution of the statement was successfully canceled.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CancelStatus" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "$ref": "#/components/responses/400BadRequest" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/401Unauthorized" | |
| }, | |
| "403": { | |
| "$ref": "#/components/responses/403Forbidden" | |
| }, | |
| "404": { | |
| "$ref": "#/components/responses/404NotFound" | |
| }, | |
| "405": { | |
| "$ref": "#/components/responses/405MethodNotAllowed" | |
| }, | |
| "422": { | |
| "description": "An error occurred when cancelling the execution of the statement. Check the error code and error message for details.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CancelStatus" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "$ref": "#/components/responses/500InternalServerError" | |
| }, | |
| "503": { | |
| "$ref": "#/components/responses/503ServiceUnavailable" | |
| }, | |
| "504": { | |
| "$ref": "#/components/responses/504GatewayTimeout" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "components": { | |
| "schemas": { | |
| "QueryStatus": { | |
| "type": "object", | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "sqlState": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "statementHandle": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "createdOn": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Timestamp that specifies when the statement execution started. The timestamp is expressed in milliseconds since the epoch.", | |
| "example": 1597090533987 | |
| }, | |
| "statementStatusUrl": { | |
| "type": "string", | |
| "format": "uri", | |
| "description": "URL that you can use to check the status of the execution of the statement and the result set." | |
| } | |
| }, | |
| "required": [ | |
| "statementHandle" | |
| ], | |
| "example": { | |
| "code": "000000", | |
| "sqlState": "00000", | |
| "message": "successfully executed", | |
| "statementHandle": "e4ce975e-f7ff-4b5e-b15e-bf25f59371ae", | |
| "createdOn": 1597090533987, | |
| "statementStatusUrl": "/api/v2/statements/e4ce975e-f7ff-4b5e-b15e-bf25f59371ae?requestId=f63f7776-71d8-4ae6-af69-8c0e54dcf906" | |
| } | |
| }, | |
| "QueryFailureStatus": { | |
| "type": "object", | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "sqlState": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "statementHandle": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "createdOn": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Timestamp that specifies when the statement execution started. The timestamp is expressed in milliseconds since the epoch.", | |
| "example": "1597090533987" | |
| }, | |
| "statementStatusUrl": { | |
| "type": "string", | |
| "format": "uri" | |
| } | |
| }, | |
| "required": [ | |
| "message", | |
| "statementHandle" | |
| ], | |
| "example": { | |
| "code": "000123", | |
| "sqlState": "42601", | |
| "message": "SQL compilation error", | |
| "statementHandle": "e4ce975e-f7ff-4b5e-b15e-bf25f59371ae", | |
| "createdOn": 1597090533987, | |
| "statementStatusUrl": "/api/v2/statements/e4ce975e-f7ff-4b5e-b15e-bf25f59371ae" | |
| } | |
| }, | |
| "CancelStatus": { | |
| "type": "object", | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "sqlState": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "statementHandle": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "statementStatusUrl": { | |
| "type": "string", | |
| "format": "uri" | |
| } | |
| }, | |
| "required": [ | |
| "statementHandle" | |
| ], | |
| "example": { | |
| "message": "successfully canceled", | |
| "statementHandle": "536fad38-b564-4dc5-9892-a4543504df6c", | |
| "statementStatusUrl": "/api/v2/statements/536fad38-b564-4dc5-9892-a4543504df6c" | |
| } | |
| }, | |
| "ResultSet": { | |
| "type": "object", | |
| "properties": { | |
| "code": { | |
| "type": "string", | |
| "example": "000123" | |
| }, | |
| "sqlState": { | |
| "type": "string", | |
| "example": "42601" | |
| }, | |
| "message": { | |
| "type": "string", | |
| "example": "successfully executed" | |
| }, | |
| "statementHandle": { | |
| "type": "string", | |
| "format": "uuid", | |
| "example": "536fad38-b564-4dc5-9892-a4543504df6c" | |
| }, | |
| "createdOn": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Timestamp that specifies when the statement execution started. The timestamp is expressed in milliseconds since the epoch.", | |
| "example": 1597090533987 | |
| }, | |
| "statementStatusUrl": { | |
| "type": "string", | |
| "format": "uri", | |
| "example": "/api/v2/statements/536fad38-b564-4dc5-9892-a4543504df6c" | |
| }, | |
| "resultSetMetaData": { | |
| "type": "object", | |
| "properties": { | |
| "format": { | |
| "type": "string", | |
| "enum": [ | |
| "jsonv2" | |
| ], | |
| "description": "For v2 endpoints the only possible value for this field is jsonv2.", | |
| "example": "jsonv2" | |
| }, | |
| "rowType": { | |
| "type": "array", | |
| "minItems": 1, | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "length": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": 0 | |
| }, | |
| "precision": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": 0 | |
| }, | |
| "scale": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": 0 | |
| }, | |
| "nullable": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "example": [ | |
| { | |
| "name": "ROWNUM", | |
| "type": "FIXED", | |
| "length": 0, | |
| "precision": 38, | |
| "scale": 0, | |
| "nullable": false | |
| }, | |
| { | |
| "name": "ACCOUNT_ID", | |
| "type": "FIXED", | |
| "length": 0, | |
| "precision": 38, | |
| "scale": 0, | |
| "nullable": false | |
| }, | |
| { | |
| "name": "ACCOUNT_NAME", | |
| "type": "TEXT", | |
| "length": 1024, | |
| "precision": 0, | |
| "scale": 0, | |
| "nullable": false | |
| }, | |
| { | |
| "name": "ADDRESS", | |
| "type": "TEXT", | |
| "length": 16777216, | |
| "precision": 0, | |
| "scale": 0, | |
| "nullable": true | |
| }, | |
| { | |
| "name": "ZIP", | |
| "type": "TEXT", | |
| "length": 100, | |
| "precision": 0, | |
| "scale": 0, | |
| "nullable": true | |
| }, | |
| { | |
| "name": "CREATED_ON", | |
| "type": "TIMESTAMP_NTZ", | |
| "length": 0, | |
| "precision": 0, | |
| "scale": 3, | |
| "nullable": false | |
| } | |
| ] | |
| }, | |
| "partitionInfo": { | |
| "description": "Partition information", | |
| "type": "array", | |
| "minItems": 0, | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "rowCount": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of rows in the partition.", | |
| "minimum": 0, | |
| "example": 1324 | |
| }, | |
| "compressedSize": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "the partition size before the decompression. This may or may not be present in the partitionInfo. Uncompressed size would always be there.", | |
| "minimum": 0, | |
| "example": 37436824 | |
| }, | |
| "uncompressedSize": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "the partition size after the decompression", | |
| "minimum": 0, | |
| "example": 1343787384 | |
| } | |
| }, | |
| "example": [ | |
| { | |
| "rowCount": 1234, | |
| "compressedSize": 37436824, | |
| "uncompressedSize": 134787384 | |
| }, | |
| { | |
| "rowCount": 4738, | |
| "compressedSize": 432467488, | |
| "uncompressedSize": 183273624 | |
| }, | |
| { | |
| "rowCount": 434, | |
| "compressedSize": 3674, | |
| "uncompressedSize": 433243 | |
| }, | |
| { | |
| "rowCount": 76432, | |
| "uncompressedSize": 746342434 | |
| }, | |
| { | |
| "rowCount": 241634, | |
| "uncompressedSize": 532374374 | |
| } | |
| ] | |
| } | |
| }, | |
| "nullable": { | |
| "description": "false if null is replaced with a string 'null' otherwise false", | |
| "type": "boolean" | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "properties": { | |
| "binary_output_format": { | |
| "type": "string", | |
| "example": "HEX" | |
| }, | |
| "date_output_format": { | |
| "type": "string", | |
| "example": "YYYY-MM-DD" | |
| }, | |
| "time_output_format": { | |
| "type": "string", | |
| "example": "HH24:MI:SS" | |
| }, | |
| "timestamp_output_format": { | |
| "type": "string", | |
| "example": "YYYY-MM-DD HH24:MI:SS.FF6" | |
| }, | |
| "timestamp_ltz_output_format": { | |
| "type": "string", | |
| "example": "YYYY-MM-DD HH24:MI:SS.FF6" | |
| }, | |
| "timestamp_ntz_output_format": { | |
| "type": "string", | |
| "example": "YYYY-MM-DD HH24:MI:SS.FF6" | |
| }, | |
| "timestamp_tz_output_format": { | |
| "type": "string", | |
| "example": "YYYY-MM-DDTHH24:MI:SS.FF6 TZHTZM" | |
| }, | |
| "multi_statement_count": { | |
| "type": "integer", | |
| "example": 4 | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "data": { | |
| "description": "Result set data.", | |
| "type": "array", | |
| "minItems": 0, | |
| "items": { | |
| "type": "array", | |
| "minItems": 0, | |
| "items": { | |
| "type": "string", | |
| "nullable": true, | |
| "minItems": 0 | |
| } | |
| }, | |
| "example": [ | |
| [ | |
| "customer1", | |
| "1234 A Avenue", | |
| "98765", | |
| "2019-08-10 23:56:34.123" | |
| ], | |
| [ | |
| "customer2", | |
| "987 B Street", | |
| "98765", | |
| "2019-08-11 09:45:12.890" | |
| ], | |
| [ | |
| "customer3", | |
| "8777 C Blvd", | |
| "98765", | |
| "2019-08-12 10:23:51.999" | |
| ], | |
| [ | |
| "customer4", | |
| "64646 D Circle", | |
| "98765", | |
| "2019-08-13 01:54:32.000" | |
| ] | |
| ] | |
| }, | |
| "stats": { | |
| "type": "object", | |
| "description": "these stats might not be available for each request.", | |
| "properties": { | |
| "numRowsInserted": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of rows that were inserted.", | |
| "minimum": 0, | |
| "example": 12 | |
| }, | |
| "numRowsUpdated": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of rows that were updated.", | |
| "minimum": 0, | |
| "example": 9 | |
| }, | |
| "numRowsDeleted": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of rows that were deleted.", | |
| "minimum": 0, | |
| "example": 8 | |
| }, | |
| "numDuplicateRowsUpdated": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of duplicate rows that were updated.", | |
| "minimum": 0, | |
| "example": 20 | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": { | |
| "requestId": { | |
| "name": "requestId", | |
| "in": "query", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "required": false, | |
| "allowEmptyValue": false, | |
| "description": "Unique ID of the API request. This ensures that the execution is idempotent. If not specified, a new UUID is generated and assigned." | |
| }, | |
| "async": { | |
| "name": "async", | |
| "in": "query", | |
| "schema": { | |
| "type": "boolean", | |
| "example": false | |
| }, | |
| "required": false, | |
| "description": "Set to true to execute the statement asynchronously and return the statement handle. If the parameter is not specified or is set to false, a statement is executed and the first result is returned if the execution is completed in 45 seconds. If the statement execution takes longer to complete, the statement handle is returned." | |
| }, | |
| "partition": { | |
| "name": "partition", | |
| "in": "query", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": 0, | |
| "example": 0 | |
| }, | |
| "required": false, | |
| "description": "Number of the partition of results to return. The number can range from 0 to the total number of partitions minus 1." | |
| }, | |
| "nullable": { | |
| "name": "nullable", | |
| "in": "query", | |
| "schema": { | |
| "type": "boolean", | |
| "example": true | |
| }, | |
| "required": false, | |
| "description": "Set to true to execute the statement to generate the result set including null. If the parameter is set to false, the result set value null will be replaced with a string 'null'." | |
| }, | |
| "statementHandle": { | |
| "name": "statementHandle", | |
| "in": "path", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid", | |
| "example": "" | |
| }, | |
| "required": true, | |
| "allowEmptyValue": false, | |
| "description": "The handle of the statement that you want to use (e.g. to fetch the result set or cancel execution)." | |
| }, | |
| "userAgent": { | |
| "name": "User-Agent", | |
| "in": "header", | |
| "schema": { | |
| "type": "string", | |
| "example": "myApplication/1.0" | |
| }, | |
| "required": true, | |
| "allowEmptyValue": false, | |
| "description": "Set this to the name and version of your application (e.g. “applicationName/applicationVersion”). You must use a value that complies with RFC 7231." | |
| }, | |
| "accept": { | |
| "name": "Accept", | |
| "in": "header", | |
| "schema": { | |
| "type": "string", | |
| "example": "application/json" | |
| }, | |
| "required": false, | |
| "allowEmptyValue": false, | |
| "description": "The response payload format. The schema should be specified in resultSetMetaData in the request payload." | |
| }, | |
| "acceptEncoding": { | |
| "name": "Accept-Encoding", | |
| "in": "header", | |
| "schema": { | |
| "type": "string", | |
| "example": "gzip" | |
| }, | |
| "required": false, | |
| "allowEmptyValue": false, | |
| "description": "The response payload encoding. Optional." | |
| }, | |
| "snowflakeAuthorizationTokenType": { | |
| "name": "X-Snowflake-Authorization-Token-Type", | |
| "in": "header", | |
| "schema": { | |
| "type": "string", | |
| "example": "OAUTH" | |
| }, | |
| "required": false, | |
| "allowEmptyValue": true, | |
| "description": "Specify the authorization token type for the Authorization header. KEYPAIR_JWT is for Keypair JWT or OAUTH for oAuth token. If not specified, OAUTH is assumed." | |
| } | |
| }, | |
| "responses": { | |
| "400BadRequest": { | |
| "description": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the request body for retry." | |
| }, | |
| "401Unauthorized": { | |
| "description": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a new access token for retry." | |
| }, | |
| "403Forbidden": { | |
| "description": "Forbidden. The request is forbidden. This happens if the request is made even if the API is not enabled." | |
| }, | |
| "404NotFound": { | |
| "description": "Not Found. The request endpoint is not valid. This happens if the API endpoint is wrong. For example, if the application hits /api/api/hello which doesn't exist, it will receive this code." | |
| }, | |
| "405MethodNotAllowed": { | |
| "description": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST. The application must change a method for retry." | |
| }, | |
| "415UnsupportedMediaType": { | |
| "description": "The request header Content-Type includes unsupported media type. The API supports application/json only. If none specified, the request payload is taken as JSON, but if any other media type is specified, this error is returned." | |
| }, | |
| "429LimitExceeded": { | |
| "description": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints." | |
| }, | |
| "500InternalServerError": { | |
| "description": "Internal Server Error. The server hits an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support." | |
| }, | |
| "503ServiceUnavailable": { | |
| "description": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended. https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/" | |
| }, | |
| "504GatewayTimeout": { | |
| "description": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended. https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/" | |
| } | |
| }, | |
| "headers": { | |
| "Link": { | |
| "schema": { | |
| "type": "string", | |
| "description": "Links to the partition of results (e.g. the first partition, the last partition, etc.). The header can include multiple 'url' entries with different 'rel' attribute values that specify the partition to return ('first', 'next', 'prev', and 'last').", | |
| "example": "</api/statements/e127cc7c-7812-4e72-9a55-3b4d4f969840/fetch?partition=1>;rel=\"last\",</api/statements/e127cc7c-7812-4e72-9a55-3b4d4f969840/fetch?partition=1>;rel=\"next\",</api/statements/e127cc7c-7812-4e72-9a55-3b4d4f969840/fetch?partition=0>;rel=\"first\"" | |
| } | |
| } | |
| } | |
| }, | |
| "externalDocs": { | |
| "url": "https://docs.snowflake.com/en/developer-guide/sql-api/index.html" | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment