Weaviate · Schema

ReplicationReplicateDetailsReplicaResponse

Provides a comprehensive overview of a specific replication operation, detailing its unique ID, the involved collection, shard, source and target nodes, transfer type, current status, and optionally, its status history.

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name	Type	Description
id	string	The unique identifier (ID) of this specific replication operation.
shard	string	The name of the shard involved in this replication operation.
collection	string	The name of the collection to which the shard being replicated belongs.
sourceNode	string	The identifier of the node from which the replica is being moved or copied (the source node).
targetNode	string	The identifier of the node to which the replica is being moved or copied (the target node).
type	string	Indicates whether the operation is a `COPY` (source replica remains) or a `MOVE` (source replica is removed after successful transfer).
uncancelable	boolean	Whether the replica operation can't be cancelled.
scheduledForCancel	boolean	Whether the replica operation is scheduled for cancellation.
scheduledForDelete	boolean	Whether the replica operation is scheduled for deletion.
status	object
statusHistory	array	An array detailing the historical sequence of statuses the replication operation has transitioned through, if requested and available.
whenStartedUnixMs	integer	The UNIX timestamp in ms when the replication operation was initiated. This is an approximate time and so should not be used for precise timing.

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-replication-replicate-details-replica-response-schema.json",
  "title": "ReplicationReplicateDetailsReplicaResponse",
  "description": "Provides a comprehensive overview of a specific replication operation, detailing its unique ID, the involved collection, shard, source and target nodes, transfer type, current status, and optionally, its status history.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier (ID) of this specific replication operation."
    },
    "shard": {
      "type": "string",
      "description": "The name of the shard involved in this replication operation."
    },
    "collection": {
      "type": "string",
      "description": "The name of the collection to which the shard being replicated belongs."
    },
    "sourceNode": {
      "type": "string",
      "description": "The identifier of the node from which the replica is being moved or copied (the source node)."
    },
    "targetNode": {
      "type": "string",
      "description": "The identifier of the node to which the replica is being moved or copied (the target node)."
    },
    "type": {
      "type": "string",
      "description": "Indicates whether the operation is a `COPY` (source replica remains) or a `MOVE` (source replica is removed after successful transfer).",
      "enum": [
        "COPY",
        "MOVE"
      ]
    },
    "uncancelable": {
      "type": "boolean",
      "description": "Whether the replica operation can't be cancelled."
    },
    "scheduledForCancel": {
      "type": "boolean",
      "description": "Whether the replica operation is scheduled for cancellation."
    },
    "scheduledForDelete": {
      "type": "boolean",
      "description": "Whether the replica operation is scheduled for deletion."
    },
    "status": {
      "$ref": "#/components/schemas/ReplicationReplicateDetailsReplicaStatus"
    },
    "statusHistory": {
      "type": "array",
      "description": "An array detailing the historical sequence of statuses the replication operation has transitioned through, if requested and available.",
      "items": {
        "$ref": "#/components/schemas/ReplicationReplicateDetailsReplicaStatus"
      }
    },
    "whenStartedUnixMs": {
      "type": "integer",
      "format": "int64",
      "description": "The UNIX timestamp in ms when the replication operation was initiated. This is an approximate time and so should not be used for precise timing."
    }
  },
  "required": [
    "id",
    "shard",
    "sourceNode",
    "targetNode",
    "collection",
    "status",
    "type"
  ]
}