List Databases

List all databases with optional filtering and pagination

GET /v1/databases

GET /v1/databases

Python

from metadata.sdk import configure
from metadata.sdk.entities import Databases

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

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

# List all with auto-pagination
all_databases = Databases.list_all(batch_size=100)
for database in all_databases:
    print(f"{database.fullyQualifiedName}")

Response

{
  "data": [
    {
      "id": "1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
      "name": "default",
      "fullyQualifiedName": "mysql_sample.default",
      "tags": [],
      "version": 0.1,
      "updatedAt": 1769982658682,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/databases/1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
      "owners": [],
      "service": {
        "id": "4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3",
        "type": "databaseService",
        "name": "mysql_sample",
        "fullyQualifiedName": "mysql_sample",
        "displayName": "mysql_sample",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/services/databaseServices/4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3"
      },
      "serviceType": "Mysql",
      "databaseSchemas": [
        {
          "id": "ea2cfeb5-8daa-434d-ae22-1f56c688aa86",
          "type": "databaseSchema",
          "name": "posts_db",
          "fullyQualifiedName": "mysql_sample.default.posts_db",
          "displayName": "posts_db",
          "deleted": false,
          "href": "http://localhost:8585/api/v1/databaseSchemas/ea2cfeb5-8daa-434d-ae22-1f56c688aa86"
        }
      ],
      "default": false,
      "deleted": false,
      "sourceUrl": "https://localhost:3306/posts_db",
      "domains": [],
      "entityStatus": "Unprocessed"
    }
  ],
  "paging": {
    "after": "eyJsYXN0SWQiOiIxZDA4YzJjNi1jZWE3LTRhZGYtOTA0My0wZjZhNmFhZjk3MjEifQ==",
    "total": 8
  }
}

List Databases

List all databases with optional filtering and pagination.

Query Parameters

service · string

Filter by service fully qualified name.

domain · string

Filter by domain fully qualified name.

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: owners, databaseSchemas, usageSummary, location, tags, certification, extension, domains, sourceHash, followers.

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/databases

Python

from metadata.sdk import configure
from metadata.sdk.entities import Databases

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

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

# List all with auto-pagination
all_databases = Databases.list_all(batch_size=100)
for database in all_databases:
    print(f"{database.fullyQualifiedName}")

Response

{
  "data": [
    {
      "id": "1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
      "name": "default",
      "fullyQualifiedName": "mysql_sample.default",
      "tags": [],
      "version": 0.1,
      "updatedAt": 1769982658682,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/databases/1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
      "owners": [],
      "service": {
        "id": "4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3",
        "type": "databaseService",
        "name": "mysql_sample",
        "fullyQualifiedName": "mysql_sample",
        "displayName": "mysql_sample",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/services/databaseServices/4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3"
      },
      "serviceType": "Mysql",
      "databaseSchemas": [
        {
          "id": "ea2cfeb5-8daa-434d-ae22-1f56c688aa86",
          "type": "databaseSchema",
          "name": "posts_db",
          "fullyQualifiedName": "mysql_sample.default.posts_db",
          "displayName": "posts_db",
          "deleted": false,
          "href": "http://localhost:8585/api/v1/databaseSchemas/ea2cfeb5-8daa-434d-ae22-1f56c688aa86"
        }
      ],
      "default": false,
      "deleted": false,
      "sourceUrl": "https://localhost:3306/posts_db",
      "domains": [],
      "entityStatus": "Unprocessed"
    }
  ],
  "paging": {
    "after": "eyJsYXN0SWQiOiIxZDA4YzJjNi1jZWE3LTRhZGYtOTA0My0wZjZhNmFhZjk3MjEifQ==",
    "total": 8
  }
}

---

Returns

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

Response

data · array

Array of database objects.

Show properties

id · string

Unique identifier for the database (UUID format).

name · string

Database name.

fullyQualifiedName · string

Fully qualified name in format service.database.

displayName · string

Human-readable display name.

service · object

Reference to the parent database service.

serviceType · string

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

owners · array

List of owners (teams and users) assigned to the database. Only included when fields contains owners.

tags · array

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

domain · object

Domain assignment for governance. Only included when fields contains domain.

databaseSchemas · array

Child schemas within this database. Only included when fields contains databaseSchemas.

usageSummary · object

Usage statistics and query counts. Only included when fields contains usageSummary.

location · object

Storage location information. Only included when fields contains location.

extension · object

Custom properties defined on this database. Only included when fields contains extension.

sourceHash · string

Hash of the source metadata for change detection. Only included when fields contains sourceHash.

certification · object

Certification status for the database. Only included when fields contains certification.

followers · array

Users following this database for updates. Only included when fields contains followers.

paging · object

Pagination information.

Show properties

total · integer

Total count of databases 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.