Class: BaseDocumentStore
Constructors
constructor
• new BaseDocumentStore(): BaseDocumentStore
Returns
Methods
addDocuments
▸ addDocuments(docs
, allowUpdate
): Promise
<void
>
Parameters
Name | Type |
---|---|
docs | BaseNode <Metadata >[] |
allowUpdate | boolean |
Returns
Promise
<void
>
Defined in
packages/core/src/storage/docStore/types.ts:27
deleteDocument
▸ deleteDocument(docId
, raiseError
): Promise
<void
>
Parameters
Name | Type |
---|---|
docId | string |
raiseError | boolean |
Returns
Promise
<void
>
Defined in
packages/core/src/storage/docStore/types.ts:34
deleteRefDoc
▸ deleteRefDoc(refDocId
, raiseError
): Promise
<void
>
Parameters
Name | Type |
---|---|
refDocId | string |
raiseError | boolean |
Returns
Promise
<void
>
Defined in
packages/core/src/storage/docStore/types.ts:50
docs
▸ docs(): Promise
<Record
<string
, BaseNode
<Metadata
>>>
Returns
Promise
<Record
<string
, BaseNode
<Metadata
>>>
Defined in
packages/core/src/storage/docStore/types.ts:25
documentExists
▸ documentExists(docId
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
docId | string |
Returns
Promise
<boolean
>
Defined in
packages/core/src/storage/docStore/types.ts:36
getAllDocumentHashes
▸ getAllDocumentHashes(): Promise
<Record
<string
, string
>>
Returns
Promise
<Record
<string
, string
>>
Defined in
packages/core/src/storage/docStore/types.ts:43
getAllRefDocInfo
▸ getAllRefDocInfo(): Promise
<undefined
| Record
<string
, RefDocInfo
>>
Returns
Promise
<undefined
| Record
<string
, RefDocInfo
>>
Defined in
packages/core/src/storage/docStore/types.ts:46
getDocument
▸ getDocument(docId
, raiseError
): Promise
<undefined
| BaseNode
<Metadata
>>
Parameters
Name | Type |
---|---|
docId | string |
raiseError | boolean |
Returns
Promise
<undefined
| BaseNode
<Metadata
>>
Defined in
packages/core/src/storage/docStore/types.ts:29
getDocumentHash
▸ getDocumentHash(docId
): Promise
<undefined
| string
>
Parameters
Name | Type |
---|---|
docId | string |
Returns
Promise
<undefined
| string
>
Defined in
packages/core/src/storage/docStore/types.ts:41
getNode
▸ getNode(nodeId
, raiseError?
): Promise
<BaseNode
<Metadata
>>
Parameters
Name | Type | Default value |
---|---|---|
nodeId | string | undefined |
raiseError | boolean | true |
Returns
Defined in
packages/core/src/storage/docStore/types.ts:59
getNodeDict
▸ getNodeDict(nodeIdDict
): Promise
<Record
<number
, BaseNode
<Metadata
>>>
Parameters
Name | Type |
---|---|
nodeIdDict | Object |
Returns
Promise
<Record
<number
, BaseNode
<Metadata
>>>
Defined in
packages/core/src/storage/docStore/types.ts:67
getNodes
▸ getNodes(nodeIds
, raiseError?
): Promise
<BaseNode
<Metadata
>[]>
Parameters
Name | Type | Default value |
---|---|---|
nodeIds | string [] | undefined |
raiseError | boolean | true |
Returns
Defined in
packages/core/src/storage/docStore/types.ts:53
getRefDocInfo
▸ getRefDocInfo(refDocId
): Promise
<undefined
| RefDocInfo
>
Parameters
Name | Type |
---|---|
refDocId | string |
Returns
Promise
<undefined
| RefDocInfo
>
Defined in
packages/core/src/storage/docStore/types.ts:48
persist
▸ persist(persistPath?
, fs?
): void
Parameters
Name | Type | Default value |
---|---|---|
persistPath | string | defaultPersistPath |
fs? | GenericFileSystem | undefined |
Returns
void
Defined in
packages/core/src/storage/docStore/types.ts:17
setDocumentHash
▸ setDocumentHash(docId
, docHash
): void
Parameters
Name | Type |
---|---|
docId | string |
docHash | string |
Returns
void