Skip to main content
POST
https://sandbox.getcollate.io/api
/
v1
/
storedProcedures
POST /v1/storedProcedures
from metadata.sdk import configure
from metadata.sdk.entities import StoredProcedures
from metadata.generated.schema.api.data.createStoredProcedure import CreateStoredProcedureRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

request = CreateStoredProcedureRequest(
    name="usp_refresh_analytics",
    displayName="Refresh Analytics",
    databaseSchema="snowflake_prod.analytics.public",
    description="Refreshes materialized analytics views nightly",
    storedProcedureCode={
        "code": "CREATE OR REPLACE PROCEDURE usp_refresh_analytics() ...",
        "language": "SQL"
    }
)

stored_procedure = StoredProcedures.create(request)
print(f"Created: {stored_procedure.fullyQualifiedName}")

{
  "id": "d02b24fa-a246-4563-adf1-9ad21f251c0e",
  "name": "calculate_average",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.calculate_average",
  "description": "Procedure to calculate average",
  "storedProcedureCode": {
    "code": "CREATE OR REPLACE PROCEDURE calculate_average(numbers INT ARRAY) RETURNS FLOAT NOT NULL LANGUAGE SQL AS $$DECLARE sum_val INT = 0;count_val INT = 0;average_val FLOAT;BEGIN\n  FOR num IN ARRAY numbers DO sum_val := sum_val + num;\n  count_val := count_val + 1;\nEND FOR;\nIF count_val = 0 THEN\n  average_val := 0.0;\nELSE\n  average_val := sum_val / count_val;\nEND IF;\nRETURN average_val;\nEND;$$;"
  },
  "version": 0.1,
  "updatedAt": 1769982660822,
  "updatedBy": "admin",
  "storedProcedureType": "StoredProcedure",
  "href": "http://localhost:8585/api/v1/storedProcedures/d02b24fa-a246-4563-adf1-9ad21f251c0e",
  "databaseSchema": {
    "id": "4dd30184-009c-4792-b296-9562eaed651f",
    "type": "databaseSchema",
    "name": "shopify",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify",
    "description": "This **mock** database contains schema related to shopify sales and orders with related dimension tables.",
    "displayName": "shopify",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/databaseSchemas/4dd30184-009c-4792-b296-9562eaed651f"
  },
  "database": {
    "id": "0be090de-0941-48c4-af49-a6157c91cda0",
    "type": "database",
    "name": "ecommerce_db",
    "fullyQualifiedName": "sample_data.ecommerce_db",
    "description": "This **mock** database contains schemas related to shopify sales and orders with related dimension tables.",
    "displayName": "ecommerce_db",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/databases/0be090de-0941-48c4-af49-a6157c91cda0"
  },
  "serviceType": "BigQuery",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": [],
  "processedLineage": false,
  "entityStatus": "Unprocessed"
}

​
Create a Stored Procedure

Create a new stored procedure within a database schema.

​
Body Parameters

​
name
string
required
Name of the stored procedure. Must be unique within the parent database schema.
​
databaseSchema
string
required
Fully qualified name of the parent DatabaseSchema (e.g., snowflake_prod.analytics.public).
​
storedProcedureCode
object
The source code and language of the stored procedure.
​
displayName
string
Human-readable display name for the stored procedure.
​
description
string
Description of the stored procedure in Markdown format.
​
owners
array
Array of owner references (users or teams) to assign to the stored procedure.
​
domain
string
Fully qualified name of the domain to assign for governance purposes.
​
tags
array
Array of classification tags to apply to the stored procedure.
​
extension
object
Custom property values defined by your organization’s metadata schema.
POST /v1/storedProcedures
from metadata.sdk import configure
from metadata.sdk.entities import StoredProcedures
from metadata.generated.schema.api.data.createStoredProcedure import CreateStoredProcedureRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

request = CreateStoredProcedureRequest(
    name="usp_refresh_analytics",
    displayName="Refresh Analytics",
    databaseSchema="snowflake_prod.analytics.public",
    description="Refreshes materialized analytics views nightly",
    storedProcedureCode={
        "code": "CREATE OR REPLACE PROCEDURE usp_refresh_analytics() ...",
        "language": "SQL"
    }
)

stored_procedure = StoredProcedures.create(request)
print(f"Created: {stored_procedure.fullyQualifiedName}")

{
  "id": "d02b24fa-a246-4563-adf1-9ad21f251c0e",
  "name": "calculate_average",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.calculate_average",
  "description": "Procedure to calculate average",
  "storedProcedureCode": {
    "code": "CREATE OR REPLACE PROCEDURE calculate_average(numbers INT ARRAY) RETURNS FLOAT NOT NULL LANGUAGE SQL AS $$DECLARE sum_val INT = 0;count_val INT = 0;average_val FLOAT;BEGIN\n  FOR num IN ARRAY numbers DO sum_val := sum_val + num;\n  count_val := count_val + 1;\nEND FOR;\nIF count_val = 0 THEN\n  average_val := 0.0;\nELSE\n  average_val := sum_val / count_val;\nEND IF;\nRETURN average_val;\nEND;$$;"
  },
  "version": 0.1,
  "updatedAt": 1769982660822,
  "updatedBy": "admin",
  "storedProcedureType": "StoredProcedure",
  "href": "http://localhost:8585/api/v1/storedProcedures/d02b24fa-a246-4563-adf1-9ad21f251c0e",
  "databaseSchema": {
    "id": "4dd30184-009c-4792-b296-9562eaed651f",
    "type": "databaseSchema",
    "name": "shopify",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify",
    "description": "This **mock** database contains schema related to shopify sales and orders with related dimension tables.",
    "displayName": "shopify",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/databaseSchemas/4dd30184-009c-4792-b296-9562eaed651f"
  },
  "database": {
    "id": "0be090de-0941-48c4-af49-a6157c91cda0",
    "type": "database",
    "name": "ecommerce_db",
    "fullyQualifiedName": "sample_data.ecommerce_db",
    "description": "This **mock** database contains schemas related to shopify sales and orders with related dimension tables.",
    "displayName": "ecommerce_db",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/databases/0be090de-0941-48c4-af49-a6157c91cda0"
  },
  "serviceType": "BigQuery",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": [],
  "processedLineage": false,
  "entityStatus": "Unprocessed"
}

​
Returns

Returns the created stored procedure object with all specified properties and system-generated fields.

​
Response

​
id
string
Unique identifier for the stored procedure (UUID format).
​
name
string
Stored procedure name.
​
fullyQualifiedName
string
Fully qualified name in format service.database.schema.storedProcedure.
​
displayName
string
Human-readable display name.
​
description
string
Description of the stored procedure in Markdown format.
​
databaseSchema
object
Reference to the parent database schema.
​
storedProcedureCode
object
The source code and language of the stored procedure.
​
serviceType
string
Type of database service (e.g., Snowflake, BigQuery, PostgreSQL).
​
owners
array
List of owners assigned to the stored procedure.
​
domains
array
Domain assignments for governance.
​
tags
array
Classification tags applied to the stored procedure.
​
extension
object
Custom property values defined by your organization’s metadata schema.
​
version
number
Version number for the entity (starts at 0.1).

​
Create or Update (PUT)

Use PUT /v1/storedProcedures instead of POST to perform an upsert. If a stored procedure with the same fullyQualifiedName already exists, it will be updated; otherwise, a new stored procedure is created. The request body is the same as POST. 
curl -X PUT "{base_url}/api/v1/storedProcedures" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'
PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead.

​
Bulk Create or Update (PUT)

Use PUT /v1/storedProcedures/bulk to create or update multiple stored procedures in a single request. The request body is an array of create request objects. 
curl -X PUT "{base_url}/api/v1/storedProcedures/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "proc_one", "databaseSchema": "service.db.schema" },
    { "name": "proc_two", "databaseSchema": "service.db.schema" }
  ]'

​
Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid request body or missing required fields
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to create stored procedures
409ENTITY_ALREADY_EXISTSStored procedure with same name already exists in schema (POST only)