Class LossyIndex

In-memory lossy index for token postings.

Index

Methods

addDocument addPosting getPostings removePosting

Methods

addDocument

addDocument(docId: DocId, indexField: string, tokens: string[]): void
Add a document by inserting postings for each unique token.
Parameters
- docId: DocId
  Document id to add.
- indexField: string
  Field name the tokens are indexed under.
- tokens: string[]
  Token list for the document.
Returns void
Nothing.
- Defined in api/Indexing/lossy/LossyIndex.ts:149

addPosting

addPosting(token: string, indexField: string, docId: DocId): void
Add a 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 void
Nothing.
- Defined in api/Indexing/lossy/LossyIndex.ts:116

getPostings

getPostings(
    token: string,
    indexField: string,
    options?: LossyQueryOptions,
): LossyQueryResult
Get postings for a token with optional paging.
Parameters
- token: string
  Token value to fetch postings for.
- indexField: string
  Field name the token was indexed under.
- options: LossyQueryOptions = {}
  Paging options for the query.
Returns LossyQueryResult
Postings result with optional next cursor.
- Defined in api/Indexing/lossy/LossyIndex.ts:163

removePosting

removePosting(token: string, indexField: string, docId: DocId): void
Remove a 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 void
Nothing.
- Defined in api/Indexing/lossy/LossyIndex.ts:130