Class: SimpleDocumentStore
Hierarchy
-
KVDocumentStore
↳
SimpleDocumentStore
Constructors
constructor
• new SimpleDocumentStore(kvStore?
, namespace?
): SimpleDocumentStore
Parameters
Name | Type |
---|---|
kvStore? | SimpleKVStore |
namespace? | string |
Returns
Overrides
KVDocumentStore.constructor
Defined in
packages/core/src/storage/docStore/SimpleDocumentStore.ts:18
Properties
kvStore
• Private
kvStore: SimpleKVStore
Defined in
packages/core/src/storage/docStore/SimpleDocumentStore.ts:16
Methods
addDocuments
▸ addDocuments(docs
, allowUpdate?
): Promise
<void
>
Parameters
Name | Type | Default value |
---|---|---|
docs | BaseNode <Metadata >[] | undefined |
allowUpdate | boolean | true |
Returns
Promise
<void
>
Inherited from
KVDocumentStore.addDocuments
Defined in
packages/core/src/storage/docStore/KVDocumentStore.ts:35
deleteDocument
▸ deleteDocument(docId
, raiseError?
, removeRefDocNode?
): Promise
<void
>
Parameters
Name | Type | Default value |
---|---|---|
docId | string | undefined |
raiseError | boolean | true |
removeRefDocNode | boolean | true |
Returns
Promise
<void
>
Inherited from
KVDocumentStore.deleteDocument
Defined in
packages/core/src/storage/docStore/KVDocumentStore.ts:135
deleteRefDoc
▸ deleteRefDoc(refDocId
, raiseError?
): Promise
<void
>
Parameters
Name | Type | Default value |
---|---|---|
refDocId | string | undefined |
raiseError | boolean | true |
Returns
Promise
<void
>
Inherited from
KVDocumentStore.deleteRefDoc
Defined in
packages/core/src/storage/docStore/KVDocumentStore.ts:152
docs
▸ docs(): Promise
<Record
<string
, BaseNode
<Metadata
>>>
Returns
Promise
<Record
<string
, BaseNode
<Metadata
>>>
Inherited from
KVDocumentStore.docs
Defined in
packages/core/src/storage/docStore/KVDocumentStore.ts:26
documentExists
▸ documentExists(docId
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
docId | string |
Returns
Promise
<boolean
>
Inherited from
KVDocumentStore.documentExists
Defined in
packages/core/src/storage/docStore/KVDocumentStore.ts:109
getAllDocumentHashes
▸ getAllDocumentHashes(): Promise
<Record
<string
, string
>>
Returns
Promise
<Record
<string
, string
>>
Inherited from
KVDocumentStore.getAllDocumentHashes
Defined in
packages/core/src/storage/docStore/KVDocumentStore.ts:183
getAllRefDocInfo
▸ getAllRefDocInfo(): Promise
<undefined
| Record
<string
, RefDocInfo
>>