Stage

List stagesÂļ

GET/api/v2/databases/{database}/schemas/{schema}/stages
Lists stages under the database and schema, with show options as query parameters.

Path ParametersÂļ

ParameterDescription
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.
schema 
Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database.

Query ParametersÂļ

ParameterDescription
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

ResponseÂļ

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create a stageÂļ

POST/api/v2/databases/{database}/schemas/{schema}/stages
Create a stage, with standard create modifiers as query parameters. See the Stage component definition for what is required to be provided in the request body.

Query ParametersÂļ

ParameterDescription
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.

ResponseÂļ

CodeDescription
200
Successful request.
202

Fetch a stageÂļ

GET/api/v2/databases/{database}/schemas/{schema}/stages/{name}
Fetch a stage using the describe command output.

Path ParametersÂļ

ParameterDescription
name 
Identifier (i.e. name) for the resource.

ResponseÂļ

CodeDescription
200
successful
202

Delete a stageÂļ

DELETE/api/v2/databases/{database}/schemas/{schema}/stages/{name}
Delete a stage with the stage name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful.

Query ParametersÂļ

ParameterDescription
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.

ResponseÂļ

CodeDescription
200
202

List files in the stageÂļ

GET/api/v2/databases/{database}/schemas/{schema}/stages/{name}/files
List files in the stage -
  • this is equivalent to LIST @stage.

Query ParametersÂļ

ParameterDescription
pattern string
A query parameter that filters the command output by a regular expression pattern.

ResponseÂļ

CodeDescription
200
successful
202

Generate a presigned url and optionally encryption materialsÂļ

POST/api/v2/databases/{database}/schemas/{schema}/stages/{name}/files/{filePath}:presigned-url
Generate a presigned url and optionally encryption materials for uploading and downloading files.

Path ParametersÂļ

ParameterDescription
filePath string
The full stage path of the file.

ResponseÂļ

CodeDescription
200
successful
202
Language: English