انتقل إلى المحتوى الرئيسي

Class: abstract BaseDocumentStore

Constructors​

new BaseDocumentStore()​

new BaseDocumentStore(): BaseDocumentStore

Returns​

BaseDocumentStore

Methods​

addDocuments()​

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

Parameters​

• docs: BaseNode <Metadata>[]

• allowUpdate: boolean

Returns​

Promise<void>

Source​

packages/core/src/storage/docStore/types.ts:27

deleteDocument()​

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

Parameters​

• docId: string

• raiseError: boolean

Returns​

Promise<void>

Source​

packages/core/src/storage/docStore/types.ts:34

deleteRefDoc()​

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

Parameters​

• refDocId: string

• raiseError: boolean

Returns​

Promise<void>

Source​

packages/core/src/storage/docStore/types.ts:50

docs()​

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

Returns​

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

Source​

packages/core/src/storage/docStore/types.ts:25

documentExists()​

abstract documentExists(docId): Promise<boolean>

Parameters​

• docId: string

Returns​

Promise<boolean>

Source​

packages/core/src/storage/docStore/types.ts:36

getAllDocumentHashes()​

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

Returns​

Promise<Record<string, string>>

Source​

packages/core/src/storage/docStore/types.ts:43

getAllRefDocInfo()​

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

Returns​

Promise<undefined | Record<string, RefDocInfo>>

Source​

packages/core/src/storage/docStore/types.ts:46

getDocument()​

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

Parameters​

• docId: string

• raiseError: boolean

Returns​

Promise<undefined | BaseNode <Metadata>>

Source​

packages/core/src/storage/docStore/types.ts:29

getDocumentHash()​

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

Parameters​

• docId: string

Returns​

Promise<undefined | string>

Source​

packages/core/src/storage/docStore/types.ts:41

getNode()​

getNode(nodeId, raiseError): Promise <BaseNode <Metadata>>

Parameters​

• nodeId: string

• raiseError: boolean= true

Returns​

Promise <BaseNode <Metadata>>

Source​

packages/core/src/storage/docStore/types.ts:59

getNodeDict()​

getNodeDict(nodeIdDict): Promise<Record<number, BaseNode <Metadata>>>

Parameters​

• nodeIdDict

Returns​

Promise<Record<number, BaseNode <Metadata>>>

Source​

packages/core/src/storage/docStore/types.ts:67

getNodes()​

getNodes(nodeIds, raiseError): Promise <BaseNode <Metadata>[]>

Parameters​

• nodeIds: string[]

• raiseError: boolean= true

Returns​

Promise <BaseNode <Metadata>[]>

Source​

packages/core/src/storage/docStore/types.ts:53

getRefDocInfo()​

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

Parameters​

• refDocId: string

Returns​

Promise<undefined | RefDocInfo>

Source​

packages/core/src/storage/docStore/types.ts:48

persist()​

persist(persistPath, fs?): void

Parameters​

• persistPath: string= defaultPersistPath

• fs?: GenericFileSystem

Returns​

void

Source​

packages/core/src/storage/docStore/types.ts:17

setDocumentHash()​

abstract setDocumentHash(docId, docHash): void

Parameters​

• docId: string

• docHash: string

Returns​

void

Source​

packages/core/src/storage/docStore/types.ts:39