> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Stored Procedure

> Create a new stored procedure within a database schema

# Create a Stored Procedure

Create a new stored procedure within a database schema.

## Body Parameters

<ParamField body="name" type="string" required>
  Name of the stored procedure. Must be unique within the parent database schema.
</ParamField>

<ParamField body="databaseSchema" type="string" required>
  Fully qualified name of the parent DatabaseSchema (e.g., `snowflake_prod.analytics.public`).
</ParamField>

<ParamField body="storedProcedureCode" type="object">
  The source code and language of the stored procedure.

  <Expandable title="properties">
    <ParamField body="code" type="string">
      The source code of the stored procedure.
    </ParamField>

    <ParamField body="language" type="string">
      Programming language of the code (e.g., `SQL`, `JavaScript`, `Python`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="displayName" type="string">
  Human-readable display name for the stored procedure.
</ParamField>

<ParamField body="description" type="string">
  Description of the stored procedure in Markdown format.
</ParamField>

<ParamField body="owners" type="array">
  Array of owner references (users or teams) to assign to the stored procedure.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the owner entity.
    </ParamField>

    <ParamField body="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ParamField>

    <ParamField body="name" type="string">
      Name of the owner entity.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="domain" type="string">
  Fully qualified name of the domain to assign for governance purposes.
</ParamField>

<ParamField body="tags" type="array">
  Array of classification tags to apply to the stored procedure.

  <Expandable title="properties">
    <ParamField body="tagFQN" type="string" required>
      Fully qualified name of the tag.
    </ParamField>

    <ParamField body="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ParamField>

    <ParamField body="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="extension" type="object">
  Custom property values defined by your organization's metadata schema.
</ParamField>

<RequestExample dropdown>
  ```python POST /v1/storedProcedures theme={null}
  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.open-metadata.org/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}")
  ```

  ```java POST /v1/storedProcedures theme={null}
  import static org.openmetadata.sdk.fluent.StoredProcedures.*;

  // Create using builder pattern
  var storedProcedure = StoredProcedures.builder()
      .name("usp_refresh_analytics")
      .displayName("Refresh Analytics")
      .databaseSchema("snowflake_prod.analytics.public")
      .description("Refreshes materialized analytics views nightly")
      .create();
  ```

  ```bash POST /v1/storedProcedures theme={null}
  curl -X POST "{base_url}/api/v1/storedProcedures" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "calculate_average",
      "databaseSchema": "sample_data.ecommerce_db.shopify",
      "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;$$;"
      }
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "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"
  }
  ```
</ResponseExample>

***

## Returns

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

## Response

<ResponseField name="id" type="string">
  Unique identifier for the stored procedure (UUID format).
</ResponseField>

<ResponseField name="name" type="string">
  Stored procedure name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name in format `service.database.schema.storedProcedure`.
</ResponseField>

<ResponseField name="displayName" type="string">
  Human-readable display name.
</ResponseField>

<ResponseField name="description" type="string">
  Description of the stored procedure in Markdown format.
</ResponseField>

<ResponseField name="databaseSchema" type="object">
  Reference to the parent database schema.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      UUID of the database schema.
    </ResponseField>

    <ResponseField name="type" type="string">
      Type of entity (always `databaseSchema`).
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the database schema.
    </ResponseField>

    <ResponseField name="fullyQualifiedName" type="string">
      Fully qualified name of the database schema.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="storedProcedureCode" type="object">
  The source code and language of the stored procedure.

  <Expandable title="properties">
    <ResponseField name="code" type="string">
      The source code of the stored procedure.
    </ResponseField>

    <ResponseField name="language" type="string">
      Programming language of the code.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="serviceType" type="string">
  Type of database service (e.g., Snowflake, BigQuery, PostgreSQL).
</ResponseField>

<ResponseField name="owners" type="array" optional>
  List of owners assigned to the stored procedure.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      UUID of the owner entity.
    </ResponseField>

    <ResponseField name="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the owner entity.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="domains" type="array" optional>
  Domain assignments for governance.
</ResponseField>

<ResponseField name="tags" type="array" optional>
  Classification tags applied to the stored procedure.

  <Expandable title="properties">
    <ResponseField name="tagFQN" type="string">
      Fully qualified name of the tag.
    </ResponseField>

    <ResponseField name="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ResponseField>

    <ResponseField name="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="extension" type="object" optional>
  Custom property values defined by your organization's metadata schema.
</ResponseField>

<ResponseField name="version" type="number">
  Version number for the entity (starts at 0.1).
</ResponseField>

***

## 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`.

```bash theme={null}
curl -X PUT "{base_url}/api/v1/storedProcedures" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'
```

<Note>
  `PUT` will not return a `409` conflict error if the entity already exists -- it will update the existing entity instead.
</Note>

***

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

```bash theme={null}
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

| Code  | Error Type              | Description                                                          |
| ----- | ----------------------- | -------------------------------------------------------------------- |
| `400` | `BAD_REQUEST`           | Invalid request body or missing required fields                      |
| `401` | `UNAUTHORIZED`          | Invalid or missing authentication token                              |
| `403` | `FORBIDDEN`             | User lacks permission to create stored procedures                    |
| `409` | `ENTITY_ALREADY_EXISTS` | Stored procedure with same name already exists in schema (POST only) |