json.schema.metadataIngestion.storage.containerMetadataConfig.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation
There is a newer version: 1.6.0-rc1
{
  "$id": "https://open-metadata.org/schema/metadataIngestion/storage/containerMetadataConfig.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "StorageContainerConfig",
  "description": "Definition of the properties contained by an object store container template config file",
  "javaType": "org.openmetadata.schema.metadataIngestion.storage.ContainerMetadataConfig",
  "type": "object",
  "definitions": {
    "metadataEntry": {
      "description": "Config properties for a container found in a user-supplied metadata config",
      "javaType": "org.openmetadata.schema.metadataIngestion.storage.ContainerMetadataEntry",
      "type": "object",
      "properties": {
        "dataPath": {
          "title": "Data path",
          "description": "The path where the data resides in the container, excluding the bucket name",
          "type": "string"
        },
        "structureFormat": {
          "title": "Schema format",
          "description": "What's the schema format for the container, eg. avro, parquet, csv.",
          "type": "string",
          "default": null
        },
        "unstructuredFormats": {
          "title": "Unstructured format",
          "description": "What the unstructured formats you want to ingest, eg. png, pdf, jpg.",
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": null
        },
        "separator": {
          "title": "Separator",
          "description": "For delimited files such as CSV, what is the separator being used?",
          "type": "string",
          "default": null
        },
        "isPartitioned": {
          "title": "Is Partitioned",
          "description": "Flag indicating whether the container's data is partitioned",
          "type": "boolean",
          "default": false
        },
        "partitionColumns": {
          "title": "Partition Columns",
          "description": "What are the partition columns in case the container's data is partitioned",
          "type": "array",
          "items": {
            "$ref": "../../entity/data/table.json#/definitions/column"
          },
          "default": null
        }
      },
      "required": ["dataPath"]
    }
  },
  "properties": {
    "entries": {
      "description": "List of metadata entries for the bucket containing information about where data resides and its structure",
      "type": "array",
      "items": {
        "$ref": "#/definitions/metadataEntry"
      },
      "default": null
    }
  },
  "required": ["entries"],
  "additionalProperties": false
}