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

# Update a Stored Procedure

> Update stored procedure properties using JSON Patch

# Update a Stored Procedure

Update a stored procedure's properties using JSON Merge Patch. You can update by ID or by fully qualified name.

## Update by ID

<ParamField path="id" type="string" required>
  UUID of the stored procedure to update.
</ParamField>

## Update by Name

Use `PATCH /v1/storedProcedures/name/{fqn}` to update by fully qualified name.

<ParamField path="fqn" type="string" required>
  Fully qualified name of the stored procedure (e.g., `snowflake_prod.analytics.public.usp_refresh_analytics`).
</ParamField>

## Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.

<ParamField body="description" type="string">
  Updated description in Markdown format.
</ParamField>

<ParamField body="displayName" type="string">
  Updated display name.
</ParamField>

<ParamField body="storedProcedureCode" type="object">
  Updated source code and language.

  <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="owners" type="array">
  Updated list of owner references.

  <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>
  </Expandable>
</ParamField>

<ParamField body="tags" type="array">
  Updated classification tags.

  <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="domain" type="string">
  Updated domain FQN.
</ParamField>

<ParamField body="extension" type="object">
  Updated custom property values.
</ParamField>

<RequestExample dropdown>
  ```python PATCH /v1/storedProcedures/{id} theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import StoredProcedures

  configure(
      host="https://your-company.open-metadata.org/api",
      jwt_token="your-jwt-token"
  )

  # Retrieve, modify, and update
  sp = StoredProcedures.retrieve("770e8400-e29b-41d4-a716-446655440000")
  sp.description = "Updated: Refreshes materialized analytics views with incremental logic"
  sp.storedProcedureCode = {
      "code": "CREATE OR REPLACE PROCEDURE usp_refresh_analytics() ... -- v2",
      "language": "SQL"
  }
  updated = StoredProcedures.update(sp)

  print(f"Updated to version {updated.version}")
  ```

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

  // Retrieve, modify, and update
  var sp = StoredProcedures.retrieve("770e8400-e29b-41d4-a716-446655440000");
  sp.setDescription("Updated: Refreshes materialized analytics views with incremental logic");
  var updated = StoredProcedures.update(sp);
  ```

  ```bash PATCH /v1/storedProcedures/{id} theme={null}
  # Update by ID
  curl -X PATCH "{base_url}/api/v1/storedProcedures/d02b24fa-a246-4563-adf1-9ad21f251c0e" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json-patch+json" \
    -d '[
      {"op": "replace", "path": "/description", "value": "Updated procedure to calculate average of integer arrays"}
    ]'

  # Update by name
  curl -X PATCH "{base_url}/api/v1/storedProcedures/name/sample_data.ecommerce_db.shopify.calculate_average" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json-patch+json" \
    -d '[
      {"op": "replace", "path": "/description", "value": "Updated procedure to calculate average of integer arrays"}
    ]'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "d02b24fa-a246-4563-adf1-9ad21f251c0e",
    "name": "calculate_average",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify.calculate_average",
    "description": "Updated procedure to calculate average of integer arrays",
    "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.2,
    "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 updated stored procedure object with the new version number.

## 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="description" type="string">
  Updated description.
</ResponseField>

<ResponseField name="version" type="number">
  Incremented version number.
</ResponseField>

***

## Error Handling

| Code  | Error Type     | Description                                           |
| ----- | -------------- | ----------------------------------------------------- |
| `400` | `BAD_REQUEST`  | Invalid JSON patch or malformed request               |
| `401` | `UNAUTHORIZED` | Invalid or missing authentication token               |
| `403` | `FORBIDDEN`    | User lacks permission to update this stored procedure |
| `404` | `NOT_FOUND`    | Stored procedure with given ID or FQN does not exist  |
| `409` | `CONFLICT`     | Concurrent modification detected                      |