Database

Lists databases

GET/api/v2/databases
Lists the accessible databases.

쿼리 매개 변수

매개 변수타입설명
likestring
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWithstring
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.
showLimitinteger
Query parameter to limit the maximum number of rows returned by a command.
fromNamestring
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.
historyboolean
Optionally includes dropped databases that have not yet been purged.

응답

코드설명
200
Successful request.
[
  {
    "created_on": "2019-08-24T14:15:22Z",
    "name": "TEST_NAME",
    "kind": "PERMANENT",
    "is_default": true,
    "is_current": true,
    "origin": "string",
    "owner": "string",
    "comment": "string",
    "options": "string",
    "retention_time": 0,
    "dropped_on": "2019-08-24T14:15:22Z",
    "budget": "string",
    "owner_role_type": "string",
    "data_retention_time_in_days": 0,
    "default_ddl_collation": "string",
    "log_level": "string",
    "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
  }
]
이름타입설명
X-Snowflake-Request-IDstringUnique ID of the API request.
LinkstringLinks to the page of results (e.g. the first page, the last page, etc.). The header can include multiple 'url' entries with different 'rel' attribute values that specify the page to return ('first', 'next', 'prev', and 'last').
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."
}
이름타입설명
LocationstringRelative path for checking request status or getting the result, if available.
X-Snowflake-Request-ID
400Bad 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. 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. The request is forbidden. This can also happen if the request is made even if the API is not enabled.
404Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.
405Method 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.
408Request Timeout. This indicates that the request from the client timed out and was not completed by the server.
409Conflict. 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.
410Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.
429Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.
500Internal 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.
503Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.
504Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.
매개 변수타입설명

Creates a database

POST/api/v2/databases
Creates a database, with modifiers as query parameters. You must provide the full database definition when creating a database.

쿼리 매개 변수

매개 변수타입설명
createModestring
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.
kindstring
Type of database to create. Currently, Snowflake supports only transient and permanent (also represented by the empty string).
매개 변수타입설명
{
  "created_on": "2019-08-24T14:15:22Z",
  "name": "TEST_NAME",
  "kind": "PERMANENT",
  "is_default": true,
  "is_current": true,
  "origin": "string",
  "owner": "string",
  "comment": "string",
  "options": "string",
  "retention_time": 0,
  "dropped_on": "2019-08-24T14:15:22Z",
  "budget": "string",
  "owner_role_type": "string",
  "data_retention_time_in_days": 0,
  "default_ddl_collation": "string",
  "log_level": "string",
  "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
}

응답

코드설명
200
Successful request.
{
  "status": "Request successfully completed"
}
이름타입
X-Snowflake-Request-ID
202
400
401
403
404
405
408
409
410
429
500
503
504
매개 변수타입설명
statusstringMessage returned by the server.

Creates a database from a share

POST/api/v2/databases:from-share
Creates a database from a given share.

쿼리 매개 변수

매개 변수타입설명
sharestring
ID of the share from which to create the database, in the form "<provider_account>.<share_name>".
매개 변수타입설명
{
  "name": "TEST_NAME"
}

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Creates a database from a share (Deprecated)

POST/api/v2/databases/{name}:from_share
Creates a database from a given share.

쿼리 매개 변수

매개 변수타입설명
sharestring
ID of the share from which to create the database, in the form "<provider_account>.<share_name>".

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Clones a database

POST/api/v2/databases/{name}:clone
Clones an existing database, with modifiers as query parameters. You must provide the full database definition when cloning an existing database.

쿼리 매개 변수

매개 변수타입설명
kindstring
Type of database to create. Currently, Snowflake supports only transient and permanent (also represented by the empty string).
매개 변수타입설명
{
  "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,
  "origin": "string",
  "owner": "string",
  "comment": "string",
  "options": "string",
  "retention_time": 0,
  "dropped_on": "2019-08-24T14:15:22Z",
  "budget": "string",
  "owner_role_type": "string",
  "data_retention_time_in_days": 0,
  "default_ddl_collation": "string",
  "log_level": "string",
  "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
}

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Fetches a database

GET/api/v2/databases/{name}
Fetches a database.

경로 매개 변수

매개 변수타입설명
name
Identifier (i.e. name) for the resource.

응답

코드설명
200
successful
{
  "created_on": "2019-08-24T14:15:22Z",
  "name": "TEST_NAME",
  "kind": "PERMANENT",
  "is_default": true,
  "is_current": true,
  "origin": "string",
  "owner": "string",
  "comment": "string",
  "options": "string",
  "retention_time": 0,
  "dropped_on": "2019-08-24T14:15:22Z",
  "budget": "string",
  "owner_role_type": "string",
  "data_retention_time_in_days": 0,
  "default_ddl_collation": "string",
  "log_level": "string",
  "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
}
이름타입
X-Snowflake-Request-ID
Link
202
400
401
403
404
405
408
409
410
429
500
503
504
매개 변수타입설명

Creates a new, or alters an existing, database

PUT/api/v2/databases/{name}
Creates a new, or alters an existing, database. You must provide the full database definition even when altering an existing database.
매개 변수타입설명
{
  "created_on": "2019-08-24T14:15:22Z",
  "name": "TEST_NAME",
  "kind": "PERMANENT",
  "is_default": true,
  "is_current": true,
  "origin": "string",
  "owner": "string",
  "comment": "string",
  "options": "string",
  "retention_time": 0,
  "dropped_on": "2019-08-24T14:15:22Z",
  "budget": "string",
  "owner_role_type": "string",
  "data_retention_time_in_days": 0,
  "default_ddl_collation": "string",
  "log_level": "string",
  "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
}

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Deletes a database

DELETE/api/v2/databases/{name}
Deletes the specified database. If you enable the ifExists parameter, the operation succeeds even if the database does not exist. Otherwise, a 404 failure is returned if the database does not exist. if the drop is unsuccessful.

쿼리 매개 변수

매개 변수타입설명
ifExistsboolean
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.
restrictboolean
Whether to drop the database if foreign keys exist that reference any tables in the database.
  • true: Return a warning about existing foreign key references and don't drop the database.
  • false: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Undrop a database

POST/api/v2/databases/{name}:undrop
Undrops database.

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Enables database replication

POST/api/v2/databases/{name}/replication:enable
Promotes a local database to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.

쿼리 매개 변수

매개 변수타입설명
ignore_edition_checkboolean
Whether to allow replicating data to accounts on lower editions. Default: true. For more information, see the <a href=https://docs.snowflake.com/en/sql-reference/sql/alter-database> ALTER DATABASE</a> reference.
매개 변수타입설명
{
  "accounts": [
    "accountName1",
    "accountName2"
  ]
}

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Disables database replication

POST/api/v2/databases/{name}/replication:disable
Disables replication for this primary database, meaning no replica of this database (i.e. secondary database) in another account can be refreshed. Any secondary databases remain linked to the primary database, but requests to refresh a secondary database are denied.
매개 변수타입설명
{
  "accounts": [
    "accountName1",
    "accountName2"
  ]
}

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Refreshes database replications

POST/api/v2/databases/{name}/replication:refresh
Refreshes a secondary database from a snapshot of its primary database. A snapshot includes changes to the objects and data. If you call this endpoint while another refresh for the same replica database is running, it fails and returns an error. Snowflake ensures only one refresh is executed at any given time.

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Enables database failover

POST/api/v2/databases/{name}/failover:enable
Specifies a comma-separated list of accounts in your organization where a replica of this primary database can be promoted to serve as the primary database.
매개 변수타입설명
{
  "accounts": [
    "accountName1",
    "accountName2"
  ]
}

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Disables database failover

POST/api/v2/databases/{name}/failover:disable
Disables failover for this primary database, meaning no replica of this database (i.e. secondary database) can be promoted to serve as the primary database.
매개 변수타입설명
{
  "accounts": [
    "accountName1",
    "accountName2"
  ]
}

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Sets a primary database

POST/api/v2/databases/{name}/failover:primary
Promotes the specified secondary (replica) database to serve as the primary database. When promoted, the database becomes writeable. At the same time, the previous primary database becomes a read-only secondary database.

응답

코드설명
200
202
400
401
403
404
405
408
409
410
429
500
503
504
언어: 한국어