Schema

Lists schemas¶

GET/api/v2/databases/{database}/schemas

Lists the accessible schemas.

Path Parameters

Parameter	Type	Description
database		Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases.

Query Parameters

Parameter	Type	Description
like	string	Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWith	string	Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimit	integer	Query parameter to limit the maximum number of rows returned by a command.
fromName	string	Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.
history	boolean	Whether to include dropped schemas that have not yet been purged. Default: false.

Response

Code

Description

200

Successful request.

[
  {
    "created_on": "2019-08-24T14:15:22Z",
    "name": "TEST_NAME",
    "kind": "PERMANENT",
    "is_default": true,
    "is_current": true,
    "database_name": "string",
    "owner": "string",
    "comment": "string",
    "options": "string",
    "managed_access": false,
    "retention_time": 0,
    "dropped_on": "2019-08-24T14:15:22Z",
    "owner_role_type": "string",
    "budget": "string",
    "data_retention_time_in_days": 0,
    "default_ddl_collation": "string",
    "log_level": "string",
    "pipe_execution_paused": true,
    "max_data_extension_time_in_days": 0,
    "suspend_task_after_num_failures": 0,
    "trace_level": "string",
    "user_task_managed_initial_warehouse_size": "string",
    "user_task_timeout_ms": 0
  }
]

Name	Type	Description
X-Snowflake-Request-ID	string	Unique ID of the API request.

202

Successfully accepted the request, but it is not completed yet.

{
  "code": "392604",
  "message": "Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management."
}

Name	Type	Description
Location	string	Relative path for checking request status or getting the result, if available.
X-Snowflake-Request-ID

400	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.
401	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.
403	Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.
404	Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.
405	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.
408	Request Timeout. This indicates that the request from the client timed out and was not completed by the server.
409	Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the options orReplace/ifNotExists.
410	Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.
429	Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.
500	Internal Server Error. The server hit 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.
503	Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.
504	Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.

Parameter	Type	Description

Creates a schema¶

POST/api/v2/databases/{database}/schemas

Creates a schema, with modifiers as query parameters. You must provide the full schema definition when creating a schema.

Query Parameters

Parameter	Type	Description
createMode	string	Query parameter allowing support for different modes of resource creation. Possible values include: errorIfExists: Throws an error if you try to create a resource that already exists. orReplace: Automatically replaces the existing resource with the current one. ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.
kind	string	Type of schema to create. Currently, Snowflake supports only transient and permanent (also represented by the empty string).

Parameter	Type	Description

{
  "created_on": "2019-08-24T14:15:22Z",
  "name": "TEST_NAME",
  "kind": "PERMANENT",
  "is_default": true,
  "is_current": true,
  "database_name": "string",
  "owner": "string",
  "comment": "string",
  "options": "string",
  "managed_access": false,
  "retention_time": 0,
  "dropped_on": "2019-08-24T14:15:22Z",
  "owner_role_type": "string",
  "budget": "string",
  "data_retention_time_in_days": 0,
  "default_ddl_collation": "string",
  "log_level": "string",
  "pipe_execution_paused": true,
  "max_data_extension_time_in_days": 0,
  "suspend_task_after_num_failures": 0,
  "trace_level": "string",
  "user_task_managed_initial_warehouse_size": "string",
  "user_task_timeout_ms": 0
}

Response

Code

Description

200

Successful request.

{
  "status": "Request successfully completed"
}

Name	Type
X-Snowflake-Request-ID

202

400
401
403
404
405
408
409
410
429
500
503
504

Parameter	Type	Description
status	string	Message returned by the server.

Clones a schema¶

POST/api/v2/databases/{database}/schemas/{name}:clone

Clones an existing schema, with modifiers as query parameters. You must provide the full schema definition when cloning an existing schema.

Query Parameters

Parameter	Type	Description
kind	string	Type of schema to clone. Currently, Snowflake supports only transient and permanent (also represented by the empty string).
targetDatabase	string	Database of the newly created schema. Defaults to the source schema's database.

Parameter	Type	Description

{
  "point_of_time": {
    "point_of_time_type": "string",
    "reference": "string"
  },
  "created_on": "2019-08-24T14:15:22Z",
  "name": "TEST_NAME",
  "kind": "PERMANENT",
  "is_default": true,
  "is_current": true,
  "database_name": "string",
  "owner": "string",
  "comment": "string",
  "options": "string",
  "managed_access": false,
  "retention_time": 0,
  "dropped_on": "2019-08-24T14:15:22Z",
  "owner_role_type": "string",
  "budget": "string",
  "data_retention_time_in_days": 0,
  "default_ddl_collation": "string",
  "log_level": "string",
  "pipe_execution_paused": true,
  "max_data_extension_time_in_days": 0,
  "suspend_task_after_num_failures": 0,
  "trace_level": "string",
  "user_task_managed_initial_warehouse_size": "string",
  "user_task_timeout_ms": 0
}

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

Undrop a schema¶

POST/api/v2/databases/{database}/schemas/{name}:undrop

Undrops schema.

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

Fetches a schema¶

GET/api/v2/databases/{database}/schemas/{name}

Fetches a schema.

Path Parameters

Parameter	Type	Description
name		Identifier (i.e. name) for the resource.

Response

Code

Description

200

successful

{
  "created_on": "2019-08-24T14:15:22Z",
  "name": "TEST_NAME",
  "kind": "PERMANENT",
  "is_default": true,
  "is_current": true,
  "database_name": "string",
  "owner": "string",
  "comment": "string",
  "options": "string",
  "managed_access": false,
  "retention_time": 0,
  "dropped_on": "2019-08-24T14:15:22Z",
  "owner_role_type": "string",
  "budget": "string",
  "data_retention_time_in_days": 0,
  "default_ddl_collation": "string",
  "log_level": "string",
  "pipe_execution_paused": true,
  "max_data_extension_time_in_days": 0,
  "suspend_task_after_num_failures": 0,
  "trace_level": "string",
  "user_task_managed_initial_warehouse_size": "string",
  "user_task_timeout_ms": 0
}

Name	Type
X-Snowflake-Request-ID

202

400
401
403
404
405
408
409
410
429
500
503
504

Parameter	Type	Description

Creates a new, or alters an existing, schema¶

PUT/api/v2/databases/{database}/schemas/{name}

Creates a new, or alters an existing, schema. You must provide the full schema definition even when altering an existing schema.

Query Parameters

Parameter	Type	Description
kind	string	Type of schema to create. Currently, Snowflake supports only transient and permanent (also represented by the empty string).

Parameter	Type	Description

{
  "created_on": "2019-08-24T14:15:22Z",
  "name": "TEST_NAME",
  "kind": "PERMANENT",
  "is_default": true,
  "is_current": true,
  "database_name": "string",
  "owner": "string",
  "comment": "string",
  "options": "string",
  "managed_access": false,
  "retention_time": 0,
  "dropped_on": "2019-08-24T14:15:22Z",
  "owner_role_type": "string",
  "budget": "string",
  "data_retention_time_in_days": 0,
  "default_ddl_collation": "string",
  "log_level": "string",
  "pipe_execution_paused": true,
  "max_data_extension_time_in_days": 0,
  "suspend_task_after_num_failures": 0,
  "trace_level": "string",
  "user_task_managed_initial_warehouse_size": "string",
  "user_task_timeout_ms": 0
}

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

Deletes a schema¶

DELETE/api/v2/databases/{database}/schemas/{name}

Deletes the specified schema. If you enable the ifExists parameter, the operation succeeds even if the schema does not exist. Otherwise, a 404 failure is returned if the schema does not exist. if the drop is unsuccessful.

Query Parameters

Parameter	Type	Description
ifExists	boolean	Query parameter that specifies how to handle the request for a resource that does not exist: true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. false: The endpoint throws an error if the resource doesn't exist.
restrict	boolean	Whether to drop the schema if foreign keys exist that reference any tables in the schema. true: Return a warning about existing foreign key references and don't drop the schema. false: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables. Default: `false`. true: Return a warning about existing foreign key references and don't drop the schema. false: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

Schema

Lists schemas¶

Path Parameters

Query Parameters

Response

Response Body Schema

Creates a schema¶

Query Parameters

Body Parameters

Request Example

Response

Response Body Schema

Clones a schema¶

Query Parameters

Body Parameters

Request Example

Response

Undrop a schema¶

Response

Fetches a schema¶

Path Parameters

Response

Response Body Schema

Creates a new, or alters an existing, schema¶

Query Parameters

Body Parameters

Request Example

Response

Deletes a schema¶

Query Parameters

Response