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

# List Database Services

> List all database services with optional filtering and pagination

# List Database Services

List all database services with optional filtering and pagination.

## Query Parameters

<ParamField query="limit" type="integer" default="10">
  Maximum number of results to return (max: 1000000).
</ParamField>

<ParamField query="before" type="string">
  Cursor for backward pagination.
</ParamField>

<ParamField query="after" type="string">
  Cursor for forward pagination.
</ParamField>

<ParamField query="fields" type="string">
  Comma-separated list of fields to include. Valid fields: `pipelines`, `owners`, `tags`, `domains`, `followers`.
</ParamField>

<ParamField query="domain" type="string">
  Filter by domain fully qualified name.
</ParamField>

<ParamField query="include" type="string" default="non-deleted">
  Include `all`, `deleted`, or `non-deleted` entities.
</ParamField>

<RequestExample dropdown>
  ```python GET /v1/services/databaseServices theme={null}
  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}")
  ```

  ```java GET /v1/services/databaseServices theme={null}
  import static org.openmetadata.sdk.fluent.DatabaseServices.*;

  // Retrieve by ID
  DatabaseService service = DatabaseServices.retrieve(serviceId);

  // List services
  var result = DatabaseServices.list()
      .fields("owners", "tags")
      .limit(50)
      .execute();

  for (DatabaseService svc : result.getData()) {
      System.out.println(svc.getName() + " (" + svc.getServiceType() + ")");
  }
  ```

  ```bash GET /v1/services/databaseServices theme={null}
  # List all
  curl "{base_url}/api/v1/services/databaseServices?limit=50" \
    -H "Authorization: Bearer {access_token}"

  # With fields
  curl "{base_url}/api/v1/services/databaseServices?fields=owners,tags,domains&limit=50" \
    -H "Authorization: Bearer {access_token}"

  # Filter by domain
  curl "{base_url}/api/v1/services/databaseServices?domain=engineering&limit=50" \
    -H "Authorization: Bearer {access_token}"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "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
    }
  }
  ```
</ResponseExample>

***

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

<ResponseField name="data" type="array">
  Array of database service objects.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      Unique identifier for the database service (UUID format).
    </ResponseField>

    <ResponseField name="name" type="string">
      Database service name.
    </ResponseField>

    <ResponseField name="fullyQualifiedName" type="string">
      Fully qualified name of the service.
    </ResponseField>

    <ResponseField name="displayName" type="string">
      Human-readable display name.
    </ResponseField>

    <ResponseField name="serviceType" type="string">
      Type of database service (e.g., Snowflake, BigQuery, PostgreSQL).
    </ResponseField>

    <ResponseField name="owners" type="array" optional>
      List of owners assigned to the service. Only included when `fields` contains `owners`.
    </ResponseField>

    <ResponseField name="tags" type="array" optional>
      Classification tags applied to the service. Only included when `fields` contains `tags`.
    </ResponseField>

    <ResponseField name="domains" type="array" optional>
      Domain assignments for governance. Only included when `fields` contains `domains`.
    </ResponseField>

    <ResponseField name="pipelines" type="array" optional>
      Ingestion pipelines associated with this service. Only included when `fields` contains `pipelines`.
    </ResponseField>

    <ResponseField name="followers" type="array" optional>
      Users following this service. Only included when `fields` contains `followers`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="paging" type="object">
  Pagination information.

  <Expandable title="properties">
    <ResponseField name="total" type="integer">
      Total count of database services matching the query.
    </ResponseField>

    <ResponseField name="after" type="string" optional>
      Cursor for the next page of results. Null if this is the last page.
    </ResponseField>

    <ResponseField name="before" type="string" optional>
      Cursor for the previous page of results. Null if this is the first page.
    </ResponseField>
  </Expandable>
</ResponseField>