KVDocumentStore
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:15
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new KVDocumentStore(
kvstore,namespace,options?):KVDocumentStore
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:22
Parameters
Section titled “Parameters”kvstore
Section titled “kvstore”namespace
Section titled “namespace”string = DEFAULT_NAMESPACE
options?
Section titled “options?”logger?
Section titled “logger?”Logger
Returns
Section titled “Returns”KVDocumentStore
Overrides
Section titled “Overrides”Properties
Section titled “Properties”serializer
Section titled “serializer”serializer:
Serializer<any> =jsonSerializer
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:108
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”persist()
Section titled “persist()”persist(
persistPath):void
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:111
Parameters
Section titled “Parameters”persistPath
Section titled “persistPath”string = DEFAULT_PERSIST_PATH
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getNodes()
Section titled “getNodes()”getNodes(
nodeIds,raiseError):Promise<BaseNode<Metadata>[]>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:144
Parameters
Section titled “Parameters”nodeIds
Section titled “nodeIds”string[]
raiseError
Section titled “raiseError”boolean = true
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”getNode()
Section titled “getNode()”Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:150
Parameters
Section titled “Parameters”nodeId
Section titled “nodeId”string
raiseError
Section titled “raiseError”boolean = true
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”getNodeDict()
Section titled “getNodeDict()”getNodeDict(
nodeIdDict):Promise<Record<number,BaseNode<Metadata>>>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:158
Parameters
Section titled “Parameters”nodeIdDict
Section titled “nodeIdDict”Returns
Section titled “Returns”Promise<Record<number, BaseNode<Metadata>>>
Inherited from
Section titled “Inherited from”docs()
Section titled “docs()”Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:35
Returns
Section titled “Returns”Promise<Record<string, BaseNode<Metadata>>>
Overrides
Section titled “Overrides”addDocuments()
Section titled “addDocuments()”addDocuments(
docs,allowUpdate):Promise<void>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:49
Parameters
Section titled “Parameters”allowUpdate
Section titled “allowUpdate”boolean = true
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”BaseDocumentStore.addDocuments
getDocument()
Section titled “getDocument()”getDocument(
docId,raiseError):Promise<undefined|BaseNode<Metadata>>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:91
Parameters
Section titled “Parameters”string
raiseError
Section titled “raiseError”boolean = true
Returns
Section titled “Returns”Promise<undefined | BaseNode<Metadata>>
Overrides
Section titled “Overrides”getRefDocInfo()
Section titled “getRefDocInfo()”getRefDocInfo(
refDocId):Promise<undefined|RefDocInfo>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:109
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Returns
Section titled “Returns”Promise<undefined | RefDocInfo>
Overrides
Section titled “Overrides”BaseDocumentStore.getRefDocInfo
getAllRefDocInfo()
Section titled “getAllRefDocInfo()”getAllRefDocInfo():
Promise<undefined|Record<string,RefDocInfo>>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:114
Returns
Section titled “Returns”Promise<undefined | Record<string, RefDocInfo>>
Overrides
Section titled “Overrides”BaseDocumentStore.getAllRefDocInfo
refDocExists()
Section titled “refDocExists()”refDocExists(
refDocId):Promise<boolean>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:122
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Returns
Section titled “Returns”Promise<boolean>
documentExists()
Section titled “documentExists()”documentExists(
docId):Promise<boolean>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:126
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
Overrides
Section titled “Overrides”BaseDocumentStore.documentExists
deleteDocument()
Section titled “deleteDocument()”deleteDocument(
docId,raiseError,removeRefDocNode):Promise<void>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:150
Parameters
Section titled “Parameters”string
raiseError
Section titled “raiseError”boolean = true
removeRefDocNode
Section titled “removeRefDocNode”boolean = true
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”BaseDocumentStore.deleteDocument
deleteRefDoc()
Section titled “deleteRefDoc()”deleteRefDoc(
refDocId,raiseError):Promise<void>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:167
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
raiseError
Section titled “raiseError”boolean = true
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”BaseDocumentStore.deleteRefDoc
setDocumentHash()
Section titled “setDocumentHash()”setDocumentHash(
docId,docHash):Promise<void>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:188
Parameters
Section titled “Parameters”string
docHash
Section titled “docHash”string
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”BaseDocumentStore.setDocumentHash
getDocumentHash()
Section titled “getDocumentHash()”getDocumentHash(
docId):Promise<undefined|string>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:193
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<undefined | string>
Overrides
Section titled “Overrides”BaseDocumentStore.getDocumentHash
getAllDocumentHashes()
Section titled “getAllDocumentHashes()”getAllDocumentHashes():
Promise<Record<string,string>>
Defined in: .build/typescript/packages/core/src/storage/doc-store/kv-document-store.ts:198
Returns
Section titled “Returns”Promise<Record<string, string>>