Weaviate · Schema

NodeShardStatus

The definition of a node shard status response body

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name	Type	Description
name	string	The name of the shard.
class	string	The name of shard's collection (class).
objectCount	number	The number of objects in shard.
vectorIndexingStatus	string	The status of the vector indexing process.
compressed	boolean	The status of vector compression/quantization.
vectorQueueLength	number	The length of the vector indexing queue.
loaded	boolean	The load status of the shard.
asyncReplicationStatus	array	The status of the async replication.
numberOfReplicas	integernull	Number of replicas for the shard.
replicationFactor	integernull	Minimum number of replicas for the shard.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NodeShardStatus",
  "title": "NodeShardStatus",
  "description": "The definition of a node shard status response body",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the shard."
    },
    "class": {
      "type": "string",
      "description": "The name of shard's collection (class)."
    },
    "objectCount": {
      "type": "number",
      "format": "int64",
      "description": "The number of objects in shard."
    },
    "vectorIndexingStatus": {
      "type": "string",
      "description": "The status of the vector indexing process."
    },
    "compressed": {
      "type": "boolean",
      "description": "The status of vector compression/quantization."
    },
    "vectorQueueLength": {
      "type": "number",
      "format": "int64",
      "description": "The length of the vector indexing queue."
    },
    "loaded": {
      "type": "boolean",
      "description": "The load status of the shard."
    },
    "asyncReplicationStatus": {
      "type": "array",
      "description": "The status of the async replication.",
      "items": {
        "$ref": "#/components/schemas/AsyncReplicationStatus"
      }
    },
    "numberOfReplicas": {
      "type": [
        "integer",
        "null"
      ],
      "format": "int64",
      "description": "Number of replicas for the shard."
    },
    "replicationFactor": {
      "type": [
        "integer",
        "null"
      ],
      "format": "int64",
      "description": "Minimum number of replicas for the shard."
    }
  }
}