BaseDocumentStore

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

Extended by

• KVDocumentStore

Constructors

Constructor

new BaseDocumentStore(): BaseDocumentStore

Returns

BaseDocumentStore

Properties

serializer

serializer: Serializer<any> = jsonSerializer

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

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

---

docs()

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

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

Returns

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

---

addDocuments()

abstract addDocuments(docs, allowUpdate): Promise<void>

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

Parameters

docs

BaseNode<Metadata>[]

allowUpdate

boolean

Returns

Promise<void>

---

getDocument()

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

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

Parameters

docId

string

raiseError

boolean

Returns

Promise<undefined | BaseNode<Metadata>>

---

deleteDocument()

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

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

Parameters

docId

string

raiseError

boolean

Returns

Promise<void>

---

documentExists()

abstract documentExists(docId): Promise<boolean>

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

Parameters

docId

string

Returns

Promise<boolean>

---

setDocumentHash()

abstract setDocumentHash(docId, docHash): Promise<void>

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

Parameters

docId

string

docHash

string

Returns

Promise<void>

---

getDocumentHash()

abstract getDocumentHash(docId): Promise<undefined | string>

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

Parameters

docId

string

Returns

Promise<undefined | string>

---

getAllDocumentHashes()

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

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

Returns

Promise<Record<string, string>>

---

getAllRefDocInfo()

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

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

Returns

Promise<undefined | Record<string, RefDocInfo>>

---

getRefDocInfo()

abstract getRefDocInfo(refDocId): Promise<undefined | RefDocInfo>

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

Parameters

refDocId

string

Returns

Promise<undefined | RefDocInfo>

---

deleteRefDoc()

abstract deleteRefDoc(refDocId, raiseError): Promise<void>

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

Parameters

refDocId

string

raiseError

boolean

Returns

Promise<void>

---

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>[]>

---

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>>

---

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>>>