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

# Database Services

> Create and manage database service connections

# Database Services

A **Database Service** represents a connection to a database platform (e.g., Snowflake, BigQuery, PostgreSQL). It is the root of the database hierarchy and contains Databases.

<Info>
  Entity schema follows the [OpenMetadata Standard](https://openmetadatastandards.org/data-assets/databases/database-service/).
</Info>

## Entity Hierarchy

Database Services are at the top of the hierarchy:

<CodeGroup>
  ```txt Database Service theme={null}
  DatabaseService (this page)
  └── Database
      └── DatabaseSchema
          └── Table
  ```
</CodeGroup>

***

## API Endpoints

| Method   | Endpoint                                                  | Description                                                                               |
| -------- | --------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `PUT`    | `/v1/services/databaseServices`                           | [Create or update](/v1.12.x/api-reference/data-assets/database-services/create)           |
| `POST`   | `/v1/services/databaseServices`                           | [Create (POST variant)](/v1.12.x/api-reference/data-assets/database-services/create)      |
| `GET`    | `/v1/services/databaseServices`                           | [List services](/v1.12.x/api-reference/data-assets/database-services/list)                |
| `GET`    | `/v1/services/databaseServices/{id}`                      | [Get by ID](/v1.12.x/api-reference/data-assets/database-services/retrieve)                |
| `GET`    | `/v1/services/databaseServices/name/{fqn}`                | [Get by name](/v1.12.x/api-reference/data-assets/database-services/retrieve)              |
| `PATCH`  | `/v1/services/databaseServices/{id}`                      | [Update by ID](/v1.12.x/api-reference/data-assets/database-services/update)               |
| `PATCH`  | `/v1/services/databaseServices/name/{fqn}`                | [Update by name](/v1.12.x/api-reference/data-assets/database-services/update)             |
| `DELETE` | `/v1/services/databaseServices/{id}`                      | [Delete by ID](/v1.12.x/api-reference/data-assets/database-services/delete)               |
| `DELETE` | `/v1/services/databaseServices/name/{fqn}`                | [Delete by name](/v1.12.x/api-reference/data-assets/database-services/delete)             |
| `PUT`    | `/v1/services/databaseServices/restore`                   | [Restore](/v1.12.x/api-reference/data-assets/database-services/delete)                    |
| `GET`    | `/v1/services/databaseServices/{id}/versions`             | [List versions](/v1.12.x/api-reference/data-assets/database-services/versions)            |
| `GET`    | `/v1/services/databaseServices/{id}/versions/{version}`   | [Get version](/v1.12.x/api-reference/data-assets/database-services/versions)              |
| `GET`    | `/v1/services/databaseServices/name/{fqn}/export`         | [Export CSV](/v1.12.x/api-reference/data-assets/database-services/import-export)          |
| `PUT`    | `/v1/services/databaseServices/name/{fqn}/import`         | [Import CSV](/v1.12.x/api-reference/data-assets/database-services/import-export)          |
| `GET`    | `/v1/services/databaseServices/name/{fqn}/exportAsync`    | [Export CSV async](/v1.12.x/api-reference/data-assets/database-services/import-export)    |
| `PUT`    | `/v1/services/databaseServices/name/{fqn}/importAsync`    | [Import CSV async](/v1.12.x/api-reference/data-assets/database-services/import-export)    |
| `POST`   | `/v1/services/databaseServices/{id}/testConnectionResult` | [Add test connection result](/v1.12.x/api-reference/data-assets/database-services/create) |