Weaviate · Schema

ExportCreateRequest

Request to create a new export operation

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name Type Description
id string Unique identifier for this export. Must be URL-safe.
file_format string Output file format for the export.
include array List of collection names to include in the export. Cannot be used with 'exclude'.
exclude array List of collection names to exclude from the export. Cannot be used with 'include'.
View JSON Schema on GitHub

JSON Schema

weaviate-export-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-export-create-request-schema.json",
  "title": "ExportCreateRequest",
  "description": "Request to create a new export operation",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for this export. Must be URL-safe."
    },
    "file_format": {
      "type": "string",
      "description": "Output file format for the export.",
      "enum": [
        "parquet"
      ]
    },
    "include": {
      "type": "array",
      "description": "List of collection names to include in the export. Cannot be used with 'exclude'.",
      "items": {
        "type": "string"
      }
    },
    "exclude": {
      "type": "array",
      "description": "List of collection names to exclude from the export. Cannot be used with 'include'.",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "id",
    "file_format"
  ]
}