KVDocumentStore

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:14

Extends

• BaseDocumentStore

Constructors

Constructor

new KVDocumentStore(kvstore, namespace): KVDocumentStore

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:20

Parameters

kvstore

BaseKVStore

namespace

string = DEFAULT_NAMESPACE

Returns

KVDocumentStore

Overrides

BaseDocumentStore.constructor

Properties

serializer

serializer: Serializer<any> = jsonSerializer

Defined in: packages/core/src/storage/doc-store/base-document-store.ts:108

Inherited from

BaseDocumentStore.serializer

Methods

persist()

persist(persistPath): void

Defined in: packages/core/src/storage/doc-store/base-document-store.ts:111

Parameters

persistPath

string = DEFAULT_PERSIST_PATH

Returns

void

Inherited from

BaseDocumentStore.persist

---

getNodes()

getNodes(nodeIds, raiseError): Promise<BaseNode<Metadata>[]>

Defined in: packages/core/src/storage/doc-store/base-document-store.ts:144

Parameters

nodeIds

string[]

raiseError

boolean = true

Returns

Promise<BaseNode<Metadata>[]>

Inherited from

BaseDocumentStore.getNodes

---

getNode()

getNode(nodeId, raiseError): Promise<BaseNode<Metadata>>

Defined in: packages/core/src/storage/doc-store/base-document-store.ts:150

Parameters

nodeId

string

raiseError

boolean = true

Returns

Promise<BaseNode<Metadata>>

Inherited from

BaseDocumentStore.getNode

---

getNodeDict()

getNodeDict(nodeIdDict): Promise<Record<number, BaseNode<Metadata>>>

Defined in: packages/core/src/storage/doc-store/base-document-store.ts:158

Parameters

nodeIdDict

Returns

Promise<Record<number, BaseNode<Metadata>>>

Inherited from

BaseDocumentStore.getNodeDict

---

docs()

docs(): Promise<Record<string, BaseNode<Metadata>>>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:28

Returns

Promise<Record<string, BaseNode<Metadata>>>

Overrides

BaseDocumentStore.docs

---

addDocuments()

addDocuments(docs, allowUpdate): Promise<void>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:42

Parameters

docs

BaseNode<Metadata>[]

allowUpdate

boolean = true

Returns

Promise<void>

Overrides

BaseDocumentStore.addDocuments

---

getDocument()

getDocument(docId, raiseError): Promise<undefined | BaseNode<Metadata>>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:84

Parameters

docId

string

raiseError

boolean = true

Returns

Promise<undefined | BaseNode<Metadata>>

Overrides

BaseDocumentStore.getDocument

---

getRefDocInfo()

getRefDocInfo(refDocId): Promise<undefined | RefDocInfo>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:102

Parameters

refDocId

string

Returns

Promise<undefined | RefDocInfo>

Overrides

BaseDocumentStore.getRefDocInfo

---

getAllRefDocInfo()

getAllRefDocInfo(): Promise<undefined | Record<string, RefDocInfo>>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:107

Returns

Promise<undefined | Record<string, RefDocInfo>>

Overrides

BaseDocumentStore.getAllRefDocInfo

---

refDocExists()

refDocExists(refDocId): Promise<boolean>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:115

Parameters

refDocId

string

Returns

Promise<boolean>

---

documentExists()

documentExists(docId): Promise<boolean>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:119

Parameters

docId

string

Returns

Promise<boolean>

Overrides

BaseDocumentStore.documentExists

---

deleteDocument()

deleteDocument(docId, raiseError, removeRefDocNode): Promise<void>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:143

Parameters

docId

string

raiseError

boolean = true

removeRefDocNode

boolean = true

Returns

Promise<void>

Overrides

BaseDocumentStore.deleteDocument

---

deleteRefDoc()

deleteRefDoc(refDocId, raiseError): Promise<void>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:160

Parameters

refDocId

string

raiseError

boolean = true

Returns

Promise<void>

Overrides

BaseDocumentStore.deleteRefDoc

---

setDocumentHash()

setDocumentHash(docId, docHash): Promise<void>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:181

Parameters

docId

string

docHash

string

Returns

Promise<void>

Overrides

BaseDocumentStore.setDocumentHash

---

getDocumentHash()

getDocumentHash(docId): Promise<undefined | string>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:186

Parameters

docId

string

Returns

Promise<undefined | string>

Overrides

BaseDocumentStore.getDocumentHash

---

getAllDocumentHashes()

getAllDocumentHashes(): Promise<Record<string, string>>

Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:191

Returns

Promise<Record<string, string>>

Overrides

BaseDocumentStore.getAllDocumentHashes