Class FullTextDdbBackend

Read/write DynamoDB backend that adds query helpers to FullTextDdbWriter.

Hierarchy (View Summary)

FullTextDdbWriter
- FullTextDdbBackend

Index

Constructors

Methods

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

Constructors

constructor

new FullTextDdbBackend(config: FullTextDdbBackendConfig): FullTextDdbBackend
Parameters
- config: FullTextDdbBackendConfig
  Backend configuration including query client and unified table.
Returns FullTextDdbBackend
Overrides FullTextDdbWriter.constructor
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:687

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.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:983

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.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:794

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.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:1256

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.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:1154

`Protected`buildTokenStatsWrite

buildTokenStatsWrite(
    token: string,
    indexField: string,
    delta: number,
): Promise<TableWrite | undefined>
Build a token stats write request for a document frequency delta.
Parameters
- token: string
  Token value to update stats for.
- indexField: string
  Field name the token was indexed under.
- delta: number
  Delta to apply to document frequency.
Returns Promise<TableWrite | undefined>
Write request or undefined when no update is needed.
Inherited from FullTextDdbWriter.buildTokenStatsWrite
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:238

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/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:1234

listDocuments

listDocuments(
options?: TextIndexDocumentListOptions,
): Promise<TextIndexDocumentPage>
Enumerate a bounded page of persisted full-text document mirrors.
Parameters
- options: TextIndexDocumentListOptions = {}
  Paging options.
Returns Promise<TextIndexDocumentPage>
Full-text document/field mirrors and continuation state.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:698

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.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:1118

loadLossyPostings

loadLossyPostings(token: string, indexField: string): Promise<DocId[]>
Load all 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.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:902

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 missing.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:1311

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.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:929

readDocumentIndex

readDocumentIndex(docId: DocId, indexField: string): Promise<string | undefined>
Read the normalized persisted full-text mirror for maintenance.
Parameters
- docId: DocId
  Document id to inspect.
- indexField: string
  Fully qualified persisted field.
Returns Promise<string | undefined>
Normalized indexed content, or undefined when missing.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:735

removeDocumentIndex

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

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.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:1055

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.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:851

setActiveTrace

setActiveTrace(trace: SearchTrace | undefined): void
Attach or clear an active search trace for metrics.
Parameters
- trace: SearchTrace | undefined
  Trace instance to record metrics into.
Returns void
Nothing.
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:765

writeDocument

writeDocument(
    document: DocumentRecord,
    primaryField: string,
    indexField: string,
    indexFieldQualified?: string,
    previousDocument?: DocumentRecord,
): Promise<void>
Apply generic full-text document semantics through DynamoDB persistence.
Parameters
- document: DocumentRecord
- primaryField: string
- indexField: string
- indexFieldQualified: string = indexField
- OptionalpreviousDocument: DocumentRecord
Returns Promise<void>
Inherited from FullTextDdbWriter.writeDocument
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:615

Class FullTextDdbBackend

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FullTextDdbBackend

Methods

addExactPositions

Parameters

Returns Promise<void>

addLossyPosting

Parameters

Returns Promise<void>

batchHasDocTokens

Parameters

Returns Promise<boolean[]>

batchLoadExactPositions

Parameters

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

ProtectedbuildTokenStatsWrite

Parameters

Returns Promise<TableWrite | 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>

setActiveTrace

Parameters

Returns void

writeDocument

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`buildTokenStatsWrite