Skip to main content

Class: AzureCosmosVCoreIndexStore

Extends

  • KVIndexStore

Constructors

new AzureCosmosVCoreIndexStore()

new AzureCosmosVCoreIndexStore(__namedParameters): AzureCosmosVCoreIndexStore

Parameters

__namedParameters: AzureCosmosVCoreIndexStoreArgs

Returns

AzureCosmosVCoreIndexStore

Overrides

KVIndexStore.constructor

Defined in

packages/llamaindex/src/storage/indexStore/AzureCosmosMongovCoreIndexStore.ts:14

Methods

addIndexStruct()

addIndexStruct(indexStruct): Promise<void>

Parameters

indexStruct: IndexStruct

Returns

Promise<void>

Inherited from

KVIndexStore.addIndexStruct

Defined in

packages/llamaindex/src/storage/indexStore/KVIndexStore.ts:20


deleteIndexStruct()

deleteIndexStruct(key): Promise<void>

Parameters

key: string

Returns

Promise<void>

Inherited from

KVIndexStore.deleteIndexStruct

Defined in

packages/llamaindex/src/storage/indexStore/KVIndexStore.ts:26


getIndexStruct()

getIndexStruct(structId?): Promise<undefined | IndexStruct>

Parameters

structId?: string

Returns

Promise<undefined | IndexStruct>

Inherited from

KVIndexStore.getIndexStruct

Defined in

packages/llamaindex/src/storage/indexStore/KVIndexStore.ts:30


getIndexStructs()

getIndexStructs(): Promise<IndexStruct[]>

Returns

Promise<IndexStruct[]>

Inherited from

KVIndexStore.getIndexStructs

Defined in

packages/llamaindex/src/storage/indexStore/KVIndexStore.ts:46


persist()

persist(persistPath?): Promise<void>

Parameters

persistPath?: string

Returns

Promise<void>

Inherited from

KVIndexStore.persist

Defined in

packages/core/storage/index-store/dist/index.d.ts:10


fromMongoClient()

static fromMongoClient(mongoClient, dbName, collectionName): AzureCosmosVCoreIndexStore

Static method for creating an instance using a MongoClient.

Parameters

mongoClient: MongoClient

MongoClient instance

dbName: string = DEFAULT_DATABASE

Database name

collectionName: string = DEFAULT_COLLECTION

Collection name

Returns

AzureCosmosVCoreIndexStore

Instance of AzureCosmosVCoreIndexStore

Example

const mongoClient = new MongoClient("mongodb://localhost:27017");
const indexStore = AzureCosmosVCoreIndexStore.fromMongoClient(mongoClient, "my_db", "my_collection");

Defined in

packages/llamaindex/src/storage/indexStore/AzureCosmosMongovCoreIndexStore.ts:33