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

# Create a Database Service

> Create a new database service connection

# Create a Database Service

Create a new database service connection to a platform such as Snowflake, BigQuery, or PostgreSQL.

## Body Parameters

<ParamField body="name" type="string" required>
  Name of the database service. Must be unique across all database services.
</ParamField>

<ParamField body="serviceType" type="string" required>
  Type of database service (e.g., `Snowflake`, `BigQuery`, `PostgreSQL`, `MySQL`, `Redshift`, `Databricks`).
</ParamField>

<ParamField body="description" type="string">
  Description of the database service in Markdown format.
</ParamField>

<ParamField body="displayName" type="string">
  Human-readable display name for the database service.
</ParamField>

<ParamField body="connection" type="object">
  Connection configuration specific to the service type.

  <Expandable title="properties">
    <ParamField body="config" type="object">
      Service-specific connection configuration (e.g., account, warehouse, database for Snowflake).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="owners" type="array">
  Array of owner references (users or teams) to assign to the service.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the owner entity.
    </ParamField>

    <ParamField body="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ParamField>

    <ParamField body="name" type="string">
      Name of the owner entity.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="domain" type="string">
  Fully qualified name of the domain to assign for governance purposes.
</ParamField>

<ParamField body="tags" type="array">
  Array of classification tags to apply to the database service.

  <Expandable title="properties">
    <ParamField body="tagFQN" type="string" required>
      Fully qualified name of the tag.
    </ParamField>

    <ParamField body="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ParamField>

    <ParamField body="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ParamField>
  </Expandable>
</ParamField>

<RequestExample dropdown>
  ```python POST /v1/services/databaseServices theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import DatabaseServices
  from metadata.generated.schema.api.services.createDatabaseService import CreateDatabaseServiceRequest

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

  request = CreateDatabaseServiceRequest(
      name="snowflake_prod",
      displayName="Snowflake Production",
      serviceType="Snowflake",
      description="Production Snowflake data warehouse",
      connection={
          "config": {
              "account": "xy12345.us-east-1",
              "username": "ingestion_user",
              "password": "***",
              "warehouse": "COMPUTE_WH",
              "database": "ANALYTICS"
          }
      }
  )

  service = DatabaseServices.create(request)
  print(f"Created: {service.fullyQualifiedName}")
  ```

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

  DatabaseService service = DatabaseServices.builder()
      .name("snowflake_prod")
      .serviceType("Snowflake")
      .connection(snowflakeConnection()
          .account("xy12345.us-east-1")
          .username("ingestion_user")
          .warehouse("COMPUTE_WH")
          .database("ANALYTICS"))
      .create();
  ```

  ```bash POST /v1/services/databaseServices theme={null}
  curl -X POST "{base_url}/api/v1/services/databaseServices" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "sample_data",
      "serviceType": "BigQuery",
      "description": "Sample data service for BigQuery",
      "connection": {
        "config": {
          "type": "BigQuery",
          "scheme": "bigquery",
          "hostPort": "bigquery.googleapis.com",
          "taxonomyLocation": "us",
          "usageLocation": "us",
          "supportsMetadataExtraction": true,
          "supportsUsageExtraction": true,
          "supportsLineageExtraction": true,
          "supportsDBTExtraction": true,
          "supportsProfiler": true,
          "supportsQueryComment": true
        }
      }
    }'
  ```
</RequestExample>

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

***

## Returns

Returns the created database service object with all specified properties and system-generated fields.

## Response

<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="description" type="string">
  Description of the database service in Markdown format.
</ResponseField>

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

<ResponseField name="connection" type="object">
  Connection configuration for the service.

  <Expandable title="properties">
    <ResponseField name="config" type="object">
      Service-specific connection configuration.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="owners" type="array" optional>
  List of owners assigned to the database service.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      UUID of the owner entity.
    </ResponseField>

    <ResponseField name="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the owner entity.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="domain" type="string" optional>
  Fully qualified name of the assigned domain.
</ResponseField>

<ResponseField name="tags" type="array" optional>
  Classification tags applied to the database service.

  <Expandable title="properties">
    <ResponseField name="tagFQN" type="string">
      Fully qualified name of the tag.
    </ResponseField>

    <ResponseField name="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ResponseField>

    <ResponseField name="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="version" type="number">
  Version number for the entity (starts at 0.1).
</ResponseField>

***

## Create or Update (PUT)

Use `PUT /v1/services/databaseServices` instead of `POST` to perform an upsert. If a database service with the same `fullyQualifiedName` already exists, it will be updated; otherwise, a new service is created. The request body is the same as `POST`.

```bash theme={null}
curl -X PUT "{base_url}/api/v1/services/databaseServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'
```

<Note>
  `PUT` will not return a `409` conflict error if the entity already exists -- it will update the existing entity instead.
</Note>

***

## Bulk Create or Update (PUT)

Use `PUT /v1/services/databaseServices/bulk` to create or update multiple database services in a single request. The request body is an array of create request objects.

```bash theme={null}
curl -X PUT "{base_url}/api/v1/services/databaseServices/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "service_one", "serviceType": "Snowflake", "connection": { "config": {} } },
    { "name": "service_two", "serviceType": "BigQuery", "connection": { "config": {} } }
  ]'
```

***

## Error Handling

| Code  | Error Type              | Description                                                |
| ----- | ----------------------- | ---------------------------------------------------------- |
| `400` | `BAD_REQUEST`           | Invalid request body or missing required fields            |
| `401` | `UNAUTHORIZED`          | Invalid or missing authentication token                    |
| `403` | `FORBIDDEN`             | User lacks permission to create database services          |
| `409` | `ENTITY_ALREADY_EXISTS` | Database service with same name already exists (POST only) |