Class FullTextDdbWriter

Write-only DynamoDB helper for indexing documents and token stats.

Hierarchy (View Summary)

FullTextDdbWriter
- FullTextDdbBackend

Index

Constructors

Methods

buildTokenStatsWrite writeDocument

Constructors

constructor

new FullTextDdbWriter(config: FullTextDdbWriterConfig): FullTextDdbWriter
Parameters
- config: FullTextDdbWriterConfig
  Writer configuration including client and unified table.
Returns FullTextDdbWriter
- Defined in api/ORM/drivers/DynamoDBDataItemDBDriver/Indexing/FullTextDdbBackend.ts:193

Methods

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

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