Pipe
List pipes¶
GET/api/v2/databases/{database}/schemas/{schema}/pipes
List pipes
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 | 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 pipe¶
POST/api/v2/databases/{database}/schemas/{schema}/pipes
Create a pipe
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 | Parameter allowing support for different modes of resource creation. Possible values include:
|
Response¶
| Code | Description |
|---|---|
| 200 | Successful request. |
| 202 |
Fetch a pipe¶
GET/api/v2/databases/{database}/schemas/{schema}/pipes/{name}
Fetch a pipe
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 pipe¶
DELETE/api/v2/databases/{database}/schemas/{schema}/pipes/{name}
Delete a pipe
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 | Parameter that specifies how to handle the request for a resource that does not exist:
|
Response¶
| Code | Description |
|---|---|
| 200 | |
| 202 |
Refresh the pipe¶
POST/api/v2/databases/{database}/schemas/{schema}/pipes/{name}:refresh
Refresh the pipe
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 |
|---|---|
| prefix string | Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load. |
| modified_after string | Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged) |
Response¶
| Code | Description |
|---|---|
| 200 | |
| 202 |