prorm API Reference
    Preparing search index...

    Class QdrantStore

    QdrantStore wraps a @qdrant/js-client-rest QdrantClient and exposes Qdrant's collection management, point upsert/search/scroll/retrieve/delete, payload management, and collection-alias operations as a typed, promise-based API.

    Implements

    Index
    name: "qdrant" = 'qdrant'

    The name of the store (e.g. 'mongodb', 'redis', 'dynamodb')

    library: "@qdrant/js-client-rest" = '@qdrant/js-client-rest'

    The client library being used

    • Create a new, empty collection. vectors is either a single { size, distance } (unnamed/default vector space) or a map of named vector spaces (for collections with multiple vector fields per point).

      Parameters

      Returns Promise<boolean>

    • Delete a collection and all of its data.

      Parameters

      • collectionName: string
      • options: { timeout?: number } = {}

      Returns Promise<boolean>

    • Detailed status, point counts, and configuration for a collection.

      Parameters

      • collectionName: string

      Returns Promise<{}>

    • List the names of all collections.

      Returns Promise<{}[]>

    • Whether a collection with this name exists.

      Parameters

      • collectionName: string

      Returns Promise<boolean>

    • Update mutable collection parameters (optimizer config, HNSW params, etc).

      Parameters

      • collectionName: string
      • args: {} & { timeout?: number } = {}

      Returns Promise<boolean>

    • Create an index on a payload field so filtered search on it is fast.

      Parameters

      • collectionName: string
      • fieldName: string
      • OptionalfieldSchema:
            | "text"
            | "integer"
            | "float"
            | "bool"
            | "uuid"
            | "datetime"
            | "keyword"
            | "geo"
            | {}
            | {}
            | {}
            | {}
            | {}
            | {}
            | {}
            | {}
      • options: QdrantWriteOptions = {}

      Returns Promise<{}>

    • Remove an index previously created with createPayloadIndex().

      Parameters

      Returns Promise<{}>

    • Insert or update points given in Qdrant's columnar "batch" shape ({ ids, vectors, payloads }, index-aligned across the three arrays) rather than an array of { id, vector, payload } objects. Equivalent to upsert(), just a more compact wire format for large batches.

      Parameters

      Returns Promise<{}>

    • Find the points whose vector is closest to vector, optionally constrained by a filter.

      Parameters

      Returns Promise<{}[]>

    • Run several search() requests against the same collection in a single round trip.

      Parameters

      Returns Promise<{}[][]>

    • Page through all (optionally filtered) points in a collection without doing a similarity search. Pass the returned nextPageOffset back in as options.offset to fetch the next page; a null nextPageOffset means there's no more data.

      Parameters

      Returns Promise<ScrollPage>

    • Fetch specific points by ID. IDs not found are simply omitted from the result.

      Parameters

      • collectionName: string
      • ids: (string | number)[]
      • options: RetrieveOptions = {}

      Returns Promise<{}[]>

    • Count points in a collection, optionally matching a filter.

      Parameters

      • collectionName: string
      • Optionalfilter: {}
      • options: QdrantReadOptions & { exact?: boolean } = {}

      Returns Promise<number>

    • Delete points by explicit ID list.

      Parameters

      Returns Promise<{}>

    • Merge payload into the existing payload of the selected points (existing keys not present in payload are left untouched).

      Parameters

      • collectionName: string
      • payload: { [key: string]: unknown }
      • selector: {} | {}
      • options: QdrantWriteOptions = {}

      Returns Promise<{}>

    • Replace the entire payload of the selected points with payload (unlike setPayload(), keys not present in payload are removed).

      Parameters

      • collectionName: string
      • payload: { [key: string]: unknown }
      • selector: {} | {}
      • options: QdrantWriteOptions = {}

      Returns Promise<{}>

    • Remove specific payload keys from the selected points.

      Parameters

      Returns Promise<{}>

    • Remove the entire payload (all keys) from the selected points.

      Parameters

      Returns Promise<{}>

    • Create an alternative name (aliasName) for a collection; the collection is queryable under both names.

      Parameters

      • collectionName: string
      • aliasName: string
      • Optionaltimeout: number

      Returns Promise<boolean>

    • Delete an alias (the underlying collection and its other aliases are unaffected).

      Parameters

      • aliasName: string
      • Optionaltimeout: number

      Returns Promise<boolean>

    • Atomically rename an alias (equivalent to delete + create in one operation).

      Parameters

      • oldAliasName: string
      • newAliasName: string
      • Optionaltimeout: number

      Returns Promise<boolean>

    • List the aliases pointing at a specific collection.

      Parameters

      • collectionName: string

      Returns Promise<{}>