Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

QdrantCollection

qdrantcollections.qdrant.io, short name qcol, namespaced. One collection inside a cluster, with its payload indexes and aliases.

Spec

FieldDefaultDescription
clusterRef.namerequiredThe QdrantCluster. Immutable
clusterRef.namespaceown namespace
collectionNamemetadata.nameName inside Qdrant. Immutable
vectors[]Dense vector spaces, up to 64. One unnamed entry is the single unnamed vector
vectors[].nameRequired when there is more than one entry
vectors[].sizerequiredDimension. Immutable
vectors[].distancerequiredCosine, Euclid, Dot or Manhattan. Immutable
vectors[].datatypeQdrant defaultfloat32, float16 or uint8. Immutable
vectors[].multivector.comparatormax_sim. Immutable
vectors[].onDiskQdrant defaultMutable
vectors[].hnsw{}Per-vector HnswConfigDiff, passed through. Mutable
vectors[].quantization{}Per-vector QuantizationConfig, passed through. Mutable
sparseVectors[]Up to 64, each with a required name
sparseVectors[].modifiernone or idf
sparseVectors[].index{}SparseIndexParams, passed through
shardNumberQdrant defaultImmutable
shardingMethodautoauto or custom. Immutable
replicationFactor, writeConsistencyFactor, readFanOutFactorQdrant defaultMutable
onDiskPayloadQdrant defaultMutable
hnsw{}Collection-wide HnswConfigDiff
optimizers{}OptimizersConfigDiff
quantization{}Collection-wide QuantizationConfig
wal{}WalConfigDiff, creation only
strictMode{}StrictModeConfig
payloadIndexes[]Up to 256, keyed by field
payloadIndexes[].fieldrequiredPayload key to index
payloadIndexes[].typerequiredkeyword, integer, float, geo, text, bool, datetime or uuid
payloadIndexes[].params{}Type-specific index parameters
aliases[]Up to 64 aliases that must point at this collection
deletionPolicyRetainRetain or Delete

Admission rules: at least one of vectors and sparseVectors; an unnamed vector must be the only vector; clusterRef and collectionName cannot change.

Status

FieldMeaning
phasePending, Ready, Degraded or Failed
collectionNameThe name inside Qdrant
healthQdrant's collection status: green, yellow, grey or red
pointsCount, indexedVectorsCount, segmentsCountFrom the collection info
payloadIndexesFields whose indexes this resource manages
aliasesAliases this resource manages
errorThe mismatch or failure message
observedGenerationSpec generation the status reflects
conditions[Ready]CollectionReady or ImmutableFieldMismatch

Behavior

On create, spec update, operator start and once a minute: resolve the cluster, require /readyz, PUT /collections/<name> when the collection does not exist, then compare the live config with the spec. An immutable mismatch sets Degraded and stops. A mutable mismatch issues PATCH /collections/<name>. Payload indexes are created, replaced when their type or parameters differ, and deleted only when this resource created them and the spec dropped them. Aliases are handled the same way through POST /collections/aliases.

A cluster that is missing or not ready is retried every thirty seconds. Any other error sets Failed with the message.

On delete with deletionPolicy: Delete, DELETE /collections/<name>; a missing collection or a missing cluster completes the deletion silently.

Print columns: CLUSTER, COLLECTION, PHASE, POINTS, HEALTH, AGE.