Skip to main content
PATCH
/
v1
/
databaseSchemas
/
{id}
PATCH /v1/databaseSchemas/{id}
from metadata.sdk import configure
from metadata.sdk.entities import DatabaseSchemas

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

# Retrieve, modify, and update
schema = DatabaseSchemas.retrieve("770e8400-e29b-41d4-a716-446655440000")
schema.description = "Updated public schema for analytics"
schema.retentionPeriod = "P730D"
updated = DatabaseSchemas.update(schema)

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

{
  "id": "f681432b-e66c-4096-a1cd-7771358c5323",
  "name": "information_schema",
  "fullyQualifiedName": "Glue.default.information_schema",
  "description": "Updated schema for Glue service tables",
  "version": 0.2,
  "updatedAt": 1769982700000,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/databaseSchemas/f681432b-e66c-4096-a1cd-7771358c5323",
  "owners": [],
  "service": {
    "id": "0fab117a-4c58-4ebb-9d42-beab0768fa8e",
    "type": "databaseService",
    "name": "Glue",
    "fullyQualifiedName": "Glue",
    "displayName": "Glue",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/services/databaseServices/0fab117a-4c58-4ebb-9d42-beab0768fa8e"
  },
  "serviceType": "Glue",
  "database": {
    "id": "9655ba5b-b8d7-419c-98f4-16b976692ad8",
    "type": "database",
    "name": "default",
    "fullyQualifiedName": "Glue.default",
    "displayName": "default",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/databases/9655ba5b-b8d7-419c-98f4-16b976692ad8"
  },
  "tags": [],
  "deleted": false,
  "sourceUrl": "https://www.glue.com/information_schema",
  "domains": [],
  "entityStatus": "Unprocessed"
}

​
Update a Database Schema

Update a database schema’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

​
Update by ID

​
id
string
required
UUID of the database schema to update.

​
Update by Name

Use PATCH /v1/databaseSchemas/name/{fqn} to update by fully qualified name.
​
fqn
string
required
Fully qualified name of the schema (e.g., snowflake_prod.analytics.public).

​
Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.
​
description
string
Updated description in Markdown format.
​
displayName
string
Updated display name.
​
owners
array
Updated list of owner references.
​
tags
array
Updated classification tags.
​
retentionPeriod
string
Updated retention period in ISO 8601 duration format.
​
domain
string
Updated domain FQN.
​
extension
object
Updated custom property values.
PATCH /v1/databaseSchemas/{id}
from metadata.sdk import configure
from metadata.sdk.entities import DatabaseSchemas

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

# Retrieve, modify, and update
schema = DatabaseSchemas.retrieve("770e8400-e29b-41d4-a716-446655440000")
schema.description = "Updated public schema for analytics"
schema.retentionPeriod = "P730D"
updated = DatabaseSchemas.update(schema)

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

{
  "id": "f681432b-e66c-4096-a1cd-7771358c5323",
  "name": "information_schema",
  "fullyQualifiedName": "Glue.default.information_schema",
  "description": "Updated schema for Glue service tables",
  "version": 0.2,
  "updatedAt": 1769982700000,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/databaseSchemas/f681432b-e66c-4096-a1cd-7771358c5323",
  "owners": [],
  "service": {
    "id": "0fab117a-4c58-4ebb-9d42-beab0768fa8e",
    "type": "databaseService",
    "name": "Glue",
    "fullyQualifiedName": "Glue",
    "displayName": "Glue",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/services/databaseServices/0fab117a-4c58-4ebb-9d42-beab0768fa8e"
  },
  "serviceType": "Glue",
  "database": {
    "id": "9655ba5b-b8d7-419c-98f4-16b976692ad8",
    "type": "database",
    "name": "default",
    "fullyQualifiedName": "Glue.default",
    "displayName": "default",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/databases/9655ba5b-b8d7-419c-98f4-16b976692ad8"
  },
  "tags": [],
  "deleted": false,
  "sourceUrl": "https://www.glue.com/information_schema",
  "domains": [],
  "entityStatus": "Unprocessed"
}

​
Returns

Returns the updated database schema object with the new version number.

​
Response

​
id
string
Unique identifier for the schema (UUID format).
​
name
string
Schema name.
​
fullyQualifiedName
string
Fully qualified name in format service.database.schema.
​
description
string
Updated description.
​
version
number
Incremented version number.

​
Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this schema
404NOT_FOUNDSchema with given ID or FQN does not exist
409CONFLICTConcurrent modification detected