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

> Create a new database schema within a database

# Create a Database Schema

Create a new database schema within a database.

## Body Parameters

<ParamField body="name" type="string" required>
  Name of the database schema. Must be unique within the parent database.
</ParamField>

<ParamField body="database" type="string" required>
  Fully qualified name of the parent Database.
</ParamField>

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

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

<ParamField body="retentionPeriod" type="string">
  Data retention period in ISO 8601 duration format (e.g., `P365D`).
</ParamField>

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

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

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

<ParamField body="extension" type="object">
  Custom property values defined by your organization's metadata schema.
</ParamField>

<RequestExample dropdown>
  ```python POST /v1/databaseSchemas theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import DatabaseSchemas
  from metadata.generated.schema.api.data.createDatabaseSchema import CreateDatabaseSchemaRequest

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

  request = CreateDatabaseSchemaRequest(
      name="public",
      displayName="Public Schema",
      database="snowflake_prod.analytics",
      description="Main public schema for analytics tables",
      retentionPeriod="P365D"
  )

  schema = DatabaseSchemas.create(request)
  print(f"Created: {schema.fullyQualifiedName}")
  ```

  ```java POST /v1/databaseSchemas theme={null}
  import static org.openmetadata.sdk.fluent.DatabaseSchemas.*;

  DatabaseSchema schema = DatabaseSchemas.builder()
      .name("public")
      .database("snowflake_prod.analytics")
      .create();
  ```

  ```bash POST /v1/databaseSchemas theme={null}
  curl -X POST "{base_url}/api/v1/databaseSchemas" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "information_schema",
      "database": "Glue.default",
      "description": "This **mock** database contains tables related to the Glue service"
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "f681432b-e66c-4096-a1cd-7771358c5323",
    "name": "information_schema",
    "fullyQualifiedName": "Glue.default.information_schema",
    "description": "This **mock** database contains tables related to the Glue service",
    "version": 0.1,
    "updatedAt": 1769982658171,
    "updatedBy": "admin",
    "href": "http://localhost:8585/api/v1/databaseSchemas/f681432b-e66c-4096-a1cd-7771358c5323",
    "owners": [],
    "service": {
      "id": "0fab117a-4c58-4ebb-9d42-beab0768fa8e",
      "type": "databaseService",
      "name": "Glue",
      "fullyQualifiedName": "Glue",
      "displayName": "Glue",
      "deleted": false,
      "href": "http://localhost:8585/api/v1/services/databaseServices/0fab117a-4c58-4ebb-9d42-beab0768fa8e"
    },
    "serviceType": "Glue",
    "database": {
      "id": "9655ba5b-b8d7-419c-98f4-16b976692ad8",
      "type": "database",
      "name": "default",
      "fullyQualifiedName": "Glue.default",
      "description": "This **mock** database contains tables related to the Glue service",
      "displayName": "default",
      "deleted": false,
      "href": "http://localhost:8585/api/v1/databases/9655ba5b-b8d7-419c-98f4-16b976692ad8"
    },
    "tags": [],
    "deleted": false,
    "sourceUrl": "https://www.glue.com/information_schema",
    "domains": [],
    "entityStatus": "Unprocessed"
  }
  ```
</ResponseExample>

***

## Returns

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

## Response

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

<ResponseField name="name" type="string">
  Schema name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name in format `service.database.schema`.
</ResponseField>

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

<ResponseField name="description" type="string">
  Description of the schema in Markdown format.
</ResponseField>

<ResponseField name="database" type="object">
  Reference to the parent database.

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

    <ResponseField name="type" type="string">
      Type of entity (always `database`).
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the database.
    </ResponseField>

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

<ResponseField name="service" type="object">
  Reference to the parent database service.

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

    <ResponseField name="type" type="string">
      Type of entity (always `databaseService`).
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the database service.
    </ResponseField>
  </Expandable>
</ResponseField>

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

<ResponseField name="retentionPeriod" type="string" optional>
  Data retention period in ISO 8601 duration format.
</ResponseField>

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

  <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="domains" type="array" optional>
  Domain assignments for the schema.
</ResponseField>

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

  <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="extension" type="object" optional>
  Custom property values defined by your organization's metadata schema.
</ResponseField>

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

***

## Create or Update (PUT)

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

```bash theme={null}
curl -X PUT "{base_url}/api/v1/databaseSchemas" \
  -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/databaseSchemas/bulk` to create or update multiple database schemas in a single request. The request body is an array of create request objects.

```bash theme={null}
curl -X PUT "{base_url}/api/v1/databaseSchemas/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "schema_one", "database": "service.db" },
    { "name": "schema_two", "database": "service.db" }
  ]'
```

***

## 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 schemas             |
| `409` | `ENTITY_ALREADY_EXISTS` | Schema with same name already exists in database (POST only) |