json.schema.api.data.createDatabase.json Maven / Gradle / Ivy

Go to download
{
  "$id": "https://open-metadata.org/schema/api/data/createDatabase.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateDatabaseRequest",
  "description": "Create Database entity request",
  "type": "object",
  "javaType": "org.openmetadata.catalog.api.data.CreateDatabase",
  "javaInterfaces": ["org.openmetadata.core.entity.interfaces.CreateEntity"],

  "properties": {
    "name": {
      "description": "Name that identifies this database instance uniquely.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this database.",
      "type": "string"
    },
    "description": {
      "description": "Description of the database instance. What it has and how to use it.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "owner": {
      "description": "Owner of this database",
      "$ref": "../../type/entityReference.json"
    },
    "service": {
      "description": "Link to the database service where this database is hosted in",
      "$ref": "../../type/entityReference.json"
    },
    "default": {
      "description": "Some databases don't support a database/catalog in the hierarchy and use default database. For example, `MySql`. For such databases, set this flag to true to indicate that this is a default database.",
      "type": "boolean",
      "default": false
    }
  },
  "required": ["name", "service"],
  "additionalProperties": false
}