KVDocumentStore
Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:15
Extends
Constructors
Constructor
new KVDocumentStore(
kvstore,namespace,options?):KVDocumentStore
Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:22
Parameters
kvstore
namespace
string = DEFAULT_NAMESPACE
options?
logger?
Logger
Returns
KVDocumentStore
Overrides
Properties
serializer
serializer:
Serializer<any> =jsonSerializer
Defined in: packages/core/src/storage/doc-store/base-document-store.ts:108
Inherited from
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
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
Inherited from
getNode()
Defined in: packages/core/src/storage/doc-store/base-document-store.ts:150
Parameters
nodeId
string
raiseError
boolean = true
Returns
Inherited from
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
docs()
Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:35
Returns
Promise<Record<string, BaseNode<Metadata>>>
Overrides
addDocuments()
addDocuments(
docs,allowUpdate):Promise<void>
Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:49
Parameters
docs
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:91
Parameters
docId
string
raiseError
boolean = true
Returns
Promise<undefined | BaseNode<Metadata>>
Overrides
getRefDocInfo()
getRefDocInfo(
refDocId):Promise<undefined|RefDocInfo>
Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:109
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:114
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:122
Parameters
refDocId
string
Returns
Promise<boolean>
documentExists()
documentExists(
docId):Promise<boolean>
Defined in: packages/core/src/storage/doc-store/kv-document-store.ts:126
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:150
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:167
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:188
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:193
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:198
Returns
Promise<Record<string, string>>