> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Database Schemas

> Create, retrieve, update, list, and delete database schema entities with tables, owners, tags, and retention policies within a database using the Collate REST API.

# Database Schemas

A **Database Schema** is a container within a Database. It holds Tables and sits between Database and Table in the hierarchy.

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

## Entity Hierarchy

Database Schemas sit between Databases and Tables in the hierarchy:

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

## Inheritance

When you set an **owner** or **domain** on a Database Schema, it is inherited by all child tables. Schemas also inherit from their parent database.

***

## API Endpoints

| Method   | Endpoint                                      | Description                                                                                   |
| -------- | --------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `PUT`    | `/v1/databaseSchemas`                         | [Create or update a database schema](/api-reference/data-assets/database-schemas/create)      |
| `POST`   | `/v1/databaseSchemas`                         | [Create a database schema (POST variant)](/api-reference/data-assets/database-schemas/create) |
| `GET`    | `/v1/databaseSchemas`                         | [List database schemas](/api-reference/data-assets/database-schemas/list)                     |
| `GET`    | `/v1/databaseSchemas/{id}`                    | [Get by ID](/api-reference/data-assets/database-schemas/retrieve)                             |
| `GET`    | `/v1/databaseSchemas/name/{fqn}`              | [Get by FQN](/api-reference/data-assets/database-schemas/retrieve)                            |
| `PATCH`  | `/v1/databaseSchemas/{id}`                    | [Update by ID](/api-reference/data-assets/database-schemas/update)                            |
| `PATCH`  | `/v1/databaseSchemas/name/{fqn}`              | [Update by name](/api-reference/data-assets/database-schemas/update)                          |
| `DELETE` | `/v1/databaseSchemas/{id}`                    | [Delete by ID](/api-reference/data-assets/database-schemas/delete)                            |
| `DELETE` | `/v1/databaseSchemas/name/{fqn}`              | [Delete by name](/api-reference/data-assets/database-schemas/delete)                          |
| `PUT`    | `/v1/databaseSchemas/restore`                 | [Restore soft-deleted schema](/api-reference/data-assets/database-schemas/delete)             |
| `GET`    | `/v1/databaseSchemas/{id}/versions`           | [List versions](/api-reference/data-assets/database-schemas/versions)                         |
| `GET`    | `/v1/databaseSchemas/{id}/versions/{version}` | [Get specific version](/api-reference/data-assets/database-schemas/versions)                  |
| `GET`    | `/v1/databaseSchemas/name/{fqn}/export`       | [Export to CSV](/api-reference/data-assets/database-schemas/import-export)                    |
| `GET`    | `/v1/databaseSchemas/name/{fqn}/exportAsync`  | [Export to CSV (async)](/api-reference/data-assets/database-schemas/import-export)            |
| `PUT`    | `/v1/databaseSchemas/name/{fqn}/import`       | [Import from CSV](/api-reference/data-assets/database-schemas/import-export)                  |
| `PUT`    | `/v1/databaseSchemas/name/{fqn}/importAsync`  | [Import from CSV (async)](/api-reference/data-assets/database-schemas/import-export)          |
| `PUT`    | `/v1/databaseSchemas/{id}/followers`          | [Add follower](/api-reference/data-assets/database-schemas/advanced)                          |
| `DELETE` | `/v1/databaseSchemas/{id}/followers/{userId}` | [Remove follower](/api-reference/data-assets/database-schemas/advanced)                       |
| `PUT`    | `/v1/databaseSchemas/{id}/vote`               | [Add/update vote](/api-reference/data-assets/database-schemas/advanced)                       |
| `GET`    | `/v1/databaseSchemas/{id}/profilerConfig`     | [Get profiler config](/api-reference/data-assets/database-schemas/advanced)                   |
| `PUT`    | `/v1/databaseSchemas/{id}/profilerConfig`     | [Set profiler config](/api-reference/data-assets/database-schemas/advanced)                   |
| `DELETE` | `/v1/databaseSchemas/{id}/profilerConfig`     | [Delete profiler config](/api-reference/data-assets/database-schemas/advanced)                |