List Database Services

List all database services with optional filtering and pagination

GET /v1/services/databaseServices

GET /v1/services/databaseServices

Python

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

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

# List with pagination
page = DatabaseServices.list(limit=50, fields=["owners", "tags"])
for svc in page.entities:
    print(f"{svc.name} ({svc.serviceType})")
    if svc.owners:
        print(f"  Owners: {[o.name for o in svc.owners]}")

# List all with auto-pagination
all_services = DatabaseServices.list_all(batch_size=100)
for service in all_services:
    print(f"{service.fullyQualifiedName}")

Response

{
  "data": [
    {
      "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
      "name": "sample_data",
      "fullyQualifiedName": "sample_data",
      "serviceType": "BigQuery",
      "description": "Sample data service for BigQuery",
      "version": 0.1,
      "updatedAt": 1769982650000,
      "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"
    },
    {
      "id": "4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3",
      "name": "mysql_sample",
      "fullyQualifiedName": "mysql_sample",
      "serviceType": "Mysql",
      "description": "Sample MySQL database service",
      "version": 0.1,
      "updatedAt": 1769982658000,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/services/databaseServices/4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3",
      "connection": {
        "config": {
          "type": "Mysql",
          "scheme": "mysql+pymysql",
          "hostPort": "localhost:3306",
          "supportsMetadataExtraction": true,
          "supportsProfiler": true,
          "supportsQueryComment": true
        }
      },
      "owners": [],
      "tags": [],
      "deleted": false,
      "domains": [],
      "entityStatus": "Unprocessed"
    }
  ],
  "paging": {
    "after": "eyJ...",
    "total": 6
  }
}

List Database Services

List all database services with optional filtering and pagination.

Query Parameters

limit · integer · default: "10"

Maximum number of results to return (max: 1000000).

before · string

Cursor for backward pagination.

after · string

Cursor for forward pagination.

fields · string

Comma-separated list of fields to include. Valid fields: pipelines, owners, tags, domains, followers.

domain · string

Filter by domain fully qualified name.

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/services/databaseServices

Python

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

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

# List with pagination
page = DatabaseServices.list(limit=50, fields=["owners", "tags"])
for svc in page.entities:
    print(f"{svc.name} ({svc.serviceType})")
    if svc.owners:
        print(f"  Owners: {[o.name for o in svc.owners]}")

# List all with auto-pagination
all_services = DatabaseServices.list_all(batch_size=100)
for service in all_services:
    print(f"{service.fullyQualifiedName}")

Response

{
  "data": [
    {
      "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
      "name": "sample_data",
      "fullyQualifiedName": "sample_data",
      "serviceType": "BigQuery",
      "description": "Sample data service for BigQuery",
      "version": 0.1,
      "updatedAt": 1769982650000,
      "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"
    },
    {
      "id": "4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3",
      "name": "mysql_sample",
      "fullyQualifiedName": "mysql_sample",
      "serviceType": "Mysql",
      "description": "Sample MySQL database service",
      "version": 0.1,
      "updatedAt": 1769982658000,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/services/databaseServices/4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3",
      "connection": {
        "config": {
          "type": "Mysql",
          "scheme": "mysql+pymysql",
          "hostPort": "localhost:3306",
          "supportsMetadataExtraction": true,
          "supportsProfiler": true,
          "supportsQueryComment": true
        }
      },
      "owners": [],
      "tags": [],
      "deleted": false,
      "domains": [],
      "entityStatus": "Unprocessed"
    }
  ],
  "paging": {
    "after": "eyJ...",
    "total": 6
  }
}

---

Returns

Returns a paginated list of database service objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data · array

Array of database service objects.

Show properties

id · string

Unique identifier for the database service (UUID format).

name · string

Database service name.

fullyQualifiedName · string

Fully qualified name of the service.

displayName · string

Human-readable display name.

serviceType · string

Type of database service (e.g., Snowflake, BigQuery, PostgreSQL).

owners · array

List of owners assigned to the service. Only included when fields contains owners.

tags · array

Classification tags applied to the service. Only included when fields contains tags.

domains · array

Domain assignments for governance. Only included when fields contains domains.

pipelines · array

Ingestion pipelines associated with this service. Only included when fields contains pipelines.

followers · array

Users following this service. Only included when fields contains followers.

paging · object

Pagination information.

Show properties

total · integer

Total count of database services matching the query.

after · string

Cursor for the next page of results. Null if this is the last page.

before · string

Cursor for the previous page of results. Null if this is the first page.