Procedure
List procedures¶
GET/api/v2/databases/{database}/schemas/{schema}/procedures
List procedures
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 string | 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 procedure¶
POST/api/v2/databases/{database}/schemas/{schema}/procedures
Create a procedure
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:
|
| copyGrants boolean | Query parameter to enable copy grants when creating the object. |
Response¶
| Code | Description |
|---|---|
| 200 | Successful request. |
| 202 |
Fetch a procedure¶
GET/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}
Fetch a procedure
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 |
|---|---|
| nameWithArgs string | Function's name with Args |
Response¶
| Code | Description |
|---|---|
| 200 | successful |
| 202 |
Delete a procedure¶
DELETE/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}
Delete a procedure
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 |