Class FullTextMemoryBackend

In-memory backend combining lossy and exact indexes.

Implements

Index

Methods

addExactPositions addLossyPosting batchHasDocTokens batchLoadExactPositions hasDocToken listDocuments loadExactPositions loadLossyPostings loadTokenStats queryLossyPostingsPage readDocumentIndex removeDocumentIndex removeExactPositions removeLossyPosting writeDocument

Methods

addExactPositions

addExactPositions(
    token: string,
    indexField: string,
    docId: DocId,
    positions: number[],
): Promise<void>
Add exact token positions for a document.
Parameters
- token: string
  Token value to store positions for.
- indexField: string
  Field name the token was indexed under.
- docId: DocId
  Document id containing the token.
- positions: number[]
  Token positions within the document.
Returns Promise<void>
Promise resolved once positions are stored.
Implementation of IndexWriter.addExactPositions
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:238

addLossyPosting

addLossyPosting(token: string, indexField: string, docId: DocId): Promise<void>
Add a lossy posting for a token.
Parameters
- token: string
  Token value to add.
- indexField: string
  Field name the token was indexed under.
- docId: DocId
  Document id containing the token.
Returns Promise<void>
Promise resolved once posting is added.
Implementation of IndexWriter.addLossyPosting
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:171

batchHasDocTokens

batchHasDocTokens(keys: DocTokenKey[]): Promise<boolean[]>
Batch check whether documents contain tokens.
Parameters
- keys: DocTokenKey[]
  Token keys to check.
Returns Promise<boolean[]>
Booleans aligned with the input keys.
Implementation of DocTokenBatchReader.batchHasDocTokens
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:336

batchLoadExactPositions

batchLoadExactPositions(keys: DocTokenKey[]): Promise<(number[] | undefined)[]>
Batch load exact positions for token keys.
Parameters
- keys: DocTokenKey[]
  Token keys to load positions for.
Returns Promise<(number[] | undefined)[]>
Positions arrays aligned with the input keys.
Implementation of ExactBatchReader.batchLoadExactPositions
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:285

hasDocToken

hasDocToken(docId: DocId, indexField: string, token: string): Promise<boolean>
Check whether a document contains a token.
Parameters
- docId: DocId
  Document id to check.
- indexField: string
  Field name the token was indexed under.
- token: string
  Token value to check.
Returns Promise<boolean>
True when the document contains the token.
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:321

listDocuments

listDocuments(
options?: TextIndexDocumentListOptions,
): Promise<TextIndexDocumentPage>
Enumerate indexed document/field pairs for bounded maintenance.
Parameters
- options: TextIndexDocumentListOptions = {}
  Paging options.
Returns Promise<TextIndexDocumentPage>
A deterministic page of text-index document mirrors.
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:349

loadExactPositions

loadExactPositions(
    token: string,
    indexField: string,
    docId: DocId,
): Promise<number[] | undefined>
Load exact positions for a token in a document.
Parameters
- token: string
  Token value to load positions for.
- indexField: string
  Field name the token was indexed under.
- docId: DocId
  Document id containing the token.
Returns Promise<number[] | undefined>
Positions array or undefined when missing.
Implementation of IndexReader.loadExactPositions
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:271

loadLossyPostings

loadLossyPostings(token: string, indexField: string): Promise<DocId[]>
Load lossy postings for a token.
Parameters
- token: string
  Token value to load postings for.
- indexField: string
  Field name the token was indexed under.
Returns Promise<DocId[]>
Document ids containing the token.
Implementation of IndexReader.loadLossyPostings
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:202

loadTokenStats

loadTokenStats(
token: string,
indexField: string,
): Promise<TokenStats | undefined>
Load token stats for a token.
Parameters
- token: string
  Token value to load stats for.
- indexField: string
  Field name the token was indexed under.
Returns Promise<TokenStats | undefined>
Token stats or undefined when no postings exist.
Implementation of IndexReader.loadTokenStats
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:304

queryLossyPostingsPage

queryLossyPostingsPage(
    token: string,
    indexField: string,
    options?: LossyPostingsPageOptions,
): Promise<LossyPostingsPage>
Query a page of lossy postings for a token.
Parameters
- token: string
  Token value to query postings for.
- indexField: string
  Field name the token was indexed under.
- options: LossyPostingsPageOptions = {}
  Paging options for the query.
Returns Promise<LossyPostingsPage>
Postings page with optional cursor.
Implementation of LossyPagingReader.queryLossyPostingsPage
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:213

readDocumentIndex

readDocumentIndex(docId: DocId, indexField: string): Promise<string | undefined>
Read normalized indexed content reconstructed from exact token positions.
Parameters
- docId: DocId
  Document id to inspect.
- indexField: string
  Fully qualified persisted index field.
Returns Promise<string | undefined>
Normalized indexed content, or undefined when missing.
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:405

removeDocumentIndex

removeDocumentIndex(docId: DocId, indexField: string): Promise<void>
Remove every in-memory text-index artifact for one document/field pair.
Parameters
- docId: DocId
  Document id to clean.
- indexField: string
  Fully qualified persisted index field.
Returns Promise<void>
Promise resolved when cleanup is complete.
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:448

removeExactPositions

removeExactPositions(
    token: string,
    indexField: string,
    docId: DocId,
): Promise<void>
Remove exact token positions for a document.
Parameters
- token: string
  Token value to remove positions for.
- indexField: string
  Field name the token was indexed under.
- docId: DocId
  Document id containing the token.
Returns Promise<void>
Promise resolved once positions are removed.
Implementation of IndexWriter.removeExactPositions
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:255

removeLossyPosting

removeLossyPosting(
    token: string,
    indexField: string,
    docId: DocId,
): Promise<void>
Remove a lossy posting for a token.
Parameters
- token: string
  Token value to remove.
- indexField: string
  Field name the token was indexed under.
- docId: DocId
  Document id containing the token.
Returns Promise<void>
Promise resolved once posting is removed.
Implementation of IndexWriter.removeLossyPosting
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:187

writeDocument

writeDocument(
    document: Record<string, unknown>,
    primaryField: string,
    indexField: string,
    indexFieldQualified?: string,
    previousDocument?: Record<string, unknown>,
): Promise<void>
Apply generic full-text document semantics to in-memory persistence.
Parameters
- document: Record<string, unknown>
- primaryField: string
- indexField: string
- indexFieldQualified: string = indexField
- OptionalpreviousDocument: Record<string, unknown>
Returns Promise<void>
Implementation of IndexWriter.writeDocument
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/FullTextMemoryBackend.ts:148

Class FullTextMemoryBackend

Implements

Index

Methods

Methods

addExactPositions

Parameters

Returns Promise<void>

addLossyPosting

Parameters

Returns Promise<void>

batchHasDocTokens

Parameters

Returns Promise<boolean[]>

batchLoadExactPositions

Parameters

Returns Promise<(number[] | undefined)[]>

hasDocToken

Parameters

Returns Promise<boolean>

listDocuments

Parameters

Returns Promise<TextIndexDocumentPage>

loadExactPositions

Parameters

Returns Promise<number[] | undefined>

loadLossyPostings

Parameters

Returns Promise<DocId[]>

loadTokenStats

Parameters

Returns Promise<TokenStats | undefined>

queryLossyPostingsPage

Parameters

Returns Promise<LossyPostingsPage>

readDocumentIndex

Parameters

Returns Promise<string | undefined>

removeDocumentIndex

Parameters

Returns Promise<void>

removeExactPositions

Parameters

Returns Promise<void>

removeLossyPosting

Parameters

Returns Promise<void>

writeDocument

Parameters

Returns Promise<void>

Settings

On This Page