Weaviate · Schema

ExportStatusResponse

Current status of an export operation

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name	Type	Description
id	string	Unique identifier for this export
backend	string	The backend storage system used
path	string	Full path where the export is stored
status	string	Current status of the export
startedAt	string	When the export started
completedAt	string	When the export completed (successfully, with failure, or was canceled)
tookInMs	integer	Duration of the export in milliseconds
classes	array	List of collections in this export
shardStatus	object	Per-shard progress: className -> shardName -> status
error	string	Error message if export failed

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-export-status-response-schema.json",
  "title": "ExportStatusResponse",
  "description": "Current status of an export operation",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for this export"
    },
    "backend": {
      "type": "string",
      "description": "The backend storage system used"
    },
    "path": {
      "type": "string",
      "description": "Full path where the export is stored"
    },
    "status": {
      "type": "string",
      "description": "Current status of the export",
      "enum": [
        "STARTED",
        "TRANSFERRING",
        "SUCCESS",
        "FAILED",
        "CANCELED"
      ]
    },
    "startedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the export started"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the export completed (successfully, with failure, or was canceled)"
    },
    "tookInMs": {
      "type": "integer",
      "format": "int64",
      "description": "Duration of the export in milliseconds"
    },
    "classes": {
      "type": "array",
      "description": "List of collections in this export",
      "items": {
        "type": "string"
      }
    },
    "shardStatus": {
      "type": "object",
      "description": "Per-shard progress: className -> shardName -> status",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/components/schemas/ShardProgress"
        }
      }
    },
    "error": {
      "type": "string",
      "description": "Error message if export failed"
    }
  }
}