Stage
List stages¶
GET/api/v2/databases/{database}/schemas/{schema}/stages
Lists stages under the database and schema, with show options as query parameters.
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Path Parameters¶
| Parameter | 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. |
| 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¶
| Parameter | Description |
|---|---|
| like string | Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
Response¶
| Code | Description |
|---|---|
| 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.
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Query Parameters¶
| Parameter | Description |
|---|---|
| createMode string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
Response¶
| Code | Description |
|---|---|
| 200 | Successful request. |
| 202 |
Fetch a stage¶
GET/api/v2/databases/{database}/schemas/{schema}/stages/{name}
Fetch a stage using the describe command output.
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Path Parameters¶
| Parameter | Description |
|---|---|
| name | Identifier (i.e. name) for the resource. |
Response¶
| Code | Description |
|---|---|
| 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.
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Query Parameters¶
| Parameter | Description |
|---|---|
| ifExists boolean | Query parameter that specifies how to handle the request for a resource that does not exist:
|
Response¶
| Code | Description |
|---|---|
| 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.
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Query Parameters¶
| Parameter | Description |
|---|---|
| pattern string | A query parameter that filters the command output by a regular expression pattern. |
Response¶
| Code | Description |
|---|---|
| 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.
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Path Parameters¶
| Parameter | Description |
|---|---|
| filePath string | The full stage path of the file. |
Response¶
| Code | Description |
|---|---|
| 200 | successful |
| 202 |