Update a Database Service

Update database service connection properties using JSON Patch operations to modify configuration, authentication, owners, and tags via the Collate REST API.

PATCH /v1/services/databaseServices/{id}

PATCH /v1/services/databaseServices/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import DatabaseServices

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

# Retrieve, modify, and update
service = DatabaseServices.retrieve("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
service.description = "Updated production Snowflake warehouse"
service.displayName = "Snowflake Prod (Updated)"
updated = DatabaseServices.update(service)

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

Response

{
  "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
  "name": "sample_data",
  "fullyQualifiedName": "sample_data",
  "serviceType": "BigQuery",
  "description": "Updated BigQuery data service",
  "version": 0.2,
  "updatedAt": 1769982700000,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09",
  "connection": {
    "config": {
      "type": "BigQuery",
      "scheme": "bigquery",
      "hostPort": "bigquery.googleapis.com",
      "taxonomyProjectID": [],
      "taxonomyLocation": "us",
      "usageLocation": "us",
      "supportsMetadataExtraction": true,
      "supportsUsageExtraction": true,
      "supportsLineageExtraction": true,
      "supportsDBTExtraction": true,
      "supportsProfiler": true,
      "supportsQueryComment": true
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": [],
  "entityStatus": "Unprocessed"
}

Update a Database Service

Update a database service’s properties using JSON Patch. Update the service by ID or by fully qualified name.

Update by ID

id · string · required

UUID of the database service to update.

Update by Name

Use PATCH /v1/services/databaseServices/name/{fqn} to update by fully qualified name.

fqn · string · required

Fully qualified name of the database service (e.g., snowflake_prod).

Body Parameters

Send an array of JSON Patch operation objects. Collate applies each operation in order.

op · string · required

Operation to perform. Use add, remove, replace, move, copy, or test.

path · string · required

JSON Pointer path to the property to update, such as /description or /connection/config/authType.

from · string

Source JSON Pointer path. Required for move and copy operations.

value · any

Value used by the operation. Required for add, replace, and test operations.

PATCH /v1/services/databaseServices/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import DatabaseServices

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

# Retrieve, modify, and update
service = DatabaseServices.retrieve("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
service.description = "Updated production Snowflake warehouse"
service.displayName = "Snowflake Prod (Updated)"
updated = DatabaseServices.update(service)

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

Response

{
  "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
  "name": "sample_data",
  "fullyQualifiedName": "sample_data",
  "serviceType": "BigQuery",
  "description": "Updated BigQuery data service",
  "version": 0.2,
  "updatedAt": 1769982700000,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09",
  "connection": {
    "config": {
      "type": "BigQuery",
      "scheme": "bigquery",
      "hostPort": "bigquery.googleapis.com",
      "taxonomyProjectID": [],
      "taxonomyLocation": "us",
      "usageLocation": "us",
      "supportsMetadataExtraction": true,
      "supportsUsageExtraction": true,
      "supportsLineageExtraction": true,
      "supportsDBTExtraction": true,
      "supportsProfiler": true,
      "supportsQueryComment": true
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": [],
  "entityStatus": "Unprocessed"
}

---

Returns

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

Response

id · string

Unique identifier for the database service (UUID format).

name · string

Database service name.

fullyQualifiedName · string

Fully qualified name of the service.

description · string

Updated description.

version · number

Incremented version number.

---

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 database service
404	NOT_FOUND	Database service with given ID or FQN does not exist
409	CONFLICT	Concurrent modification detected