Class TypeInfoORMService

TypeInfo-driven ORM service with optional DAC and indexing integrations.

Implements

TypeInfoORMAPI

Index

Constructors

Methods

applyStructuredFieldMap buildStructuredFields canUseStructuredIndexForCriteria cleanupRelationships create createRelationship decodeFullScanCompareCursor delete deleteRelationship emitListRoutingDecision emitStructuredIndexWrite encodeFullScanCompareCursor getCleanItem getCleanSelectedFields getIndexedItemSnapshot getIndexingRelationshipDriverInternal getTypeInfo indexFullTextDocument indexItemIndexes indexStructuredDocument isFullTextSearchOperator isStructuredOperatorSupportedForField isStructuredValue list listByFullScanAndCompare listRelatedItems listRelationships read reindexStoredItem reindexStoredType removeFullTextDocument removeItemIndexes removeStructuredDocument replaceFullTextDocument replaceItemIndexes resolveAutoFullTextCriteriaPlan resolveFullTextIndexFields resolveStructuredIndexedFields toFullTextSearchPlan update validate validateReadOperation validateRelationshipItem validateUpdateConfig

Properties

config

Constructors

constructor

new TypeInfoORMService(config: TypeInfoORMServiceConfig): TypeInfoORMService
Parameters
- config: TypeInfoORMServiceConfig
  ORM service configuration.
Returns TypeInfoORMService
- Defined in api/ORM/TypeInfoORMService.ts:512

Methods

`Protected`applyStructuredFieldMap

applyStructuredFieldMap(
    typeName: string,
    where: Where,
    fieldMap?: Record<string, string>,
): Where
Parameters
- typeName: string
  Type name used for field qualification.
- where: Where
  Structured query to map.
- OptionalfieldMap: Record<string, string>
  Optional field mapping by type.
Returns Where
Mapped structured query.
- Defined in api/ORM/TypeInfoORMService.ts:1467

`Protected`buildStructuredFields

buildStructuredFields(
typeName: string,
item: Partial<TypeInfoDataItem>,
): StructuredDocFieldsRecord
Parameters
- typeName: string
  Type name for field mapping.
- item: Partial<TypeInfoDataItem>
  Item to extract structured fields from.
Returns StructuredDocFieldsRecord
Structured fields record for indexing.
- Defined in api/ORM/TypeInfoORMService.ts:1405

`Protected`canUseStructuredIndexForCriteria

canUseStructuredIndexForCriteria(
typeName: string,
criteria?: SearchCriteria,
): boolean
Parameters
- typeName: string
  Type being listed.
- Optionalcriteria: SearchCriteria
  Criteria to evaluate.
Returns boolean
True when criteria can be evaluated using structured indexing.
- Defined in api/ORM/TypeInfoORMService.ts:1070

`Protected`cleanupRelationships

cleanupRelationships(
relationshipOriginatingItem: ItemRelationshipOriginatingItemInfo,
): Promise<void>
Parameters
- relationshipOriginatingItem: ItemRelationshipOriginatingItemInfo
  Relationship originating item used for cleanup.
Returns Promise<void>
Promise resolved once cleanup is complete.
- Defined in api/ORM/TypeInfoORMService.ts:2171

create

create(typeName: string, item: TypeInfoDataItem): Promise<any>
Create a new item of the given type.
Parameters
- typeName: string
  Type name to create.
- item: TypeInfoDataItem
  Item payload to create.
Returns Promise<any>
Primary field value for the created item.
Implementation of TypeInfoORMAPI.create
- Defined in api/ORM/TypeInfoORMService.ts:2565

createRelationship

createRelationship(
relationshipItem: BaseItemRelationshipInfo,
context?: TypeInfoORMContext,
): Promise<boolean>
Create a new relationship between two items.
Parameters
- relationshipItem: BaseItemRelationshipInfo
  Relationship item to create.
  
  When DAC is enabled and getOwnerPrefix is configured, relationship creation requires:
  
  relationship permission on the relationship resource path, and
  
  endpoint ownership permission for both from and to items.
- Optionalcontext: TypeInfoORMContext
Returns Promise<boolean>
True when the relationship was created.
Implementation of TypeInfoORMAPI.createRelationship
- Defined in api/ORM/TypeInfoORMService.ts:2194

`Protected`decodeFullScanCompareCursor

decodeFullScanCompareCursor(cursor?: string): number
Parameters
- Optionalcursor: string
  Cursor from list config.
Returns number
Decoded offset for full-scan compare pagination.
- Defined in api/ORM/TypeInfoORMService.ts:1258

delete

delete(
    typeName: string,
    primaryFieldValue: any,
    context?: TypeInfoORMContext,
): Promise<boolean>
Delete an existing item of the given type.
Parameters
- typeName: string
  Type name to delete.
- primaryFieldValue: any
  Primary field value to delete.
- Optionalcontext: TypeInfoORMContext
Returns Promise<boolean>
True when the delete succeeded.
Implementation of TypeInfoORMAPI.delete
- Defined in api/ORM/TypeInfoORMService.ts:2775

deleteRelationship

deleteRelationship(
relationshipItem: BaseItemRelationshipInfo,
context?: TypeInfoORMContext,
): Promise<DeleteRelationshipResults>
Delete a relationship between two items.
Parameters
- relationshipItem: BaseItemRelationshipInfo
  Relationship item to delete.
  
  When DAC is enabled and getOwnerPrefix is configured, relationship deletion requires:
  
  relationship permission on the relationship resource path, and
  
  endpoint ownership permission for both from and to items.
- Optionalcontext: TypeInfoORMContext
Returns Promise<DeleteRelationshipResults>
Deletion results including whether items remain.
Implementation of TypeInfoORMAPI.deleteRelationship
- Defined in api/ORM/TypeInfoORMService.ts:2308

`Protected`emitListRoutingDecision

emitListRoutingDecision(
    typeName: string,
    path: "fullText" | "structured" | "fullScanCompare",
    reason:
        | "fullTextPlan"
        | "structuredEligible"
        | "criteriaWithoutIndexedPath"
        | "indexedPathFailedOrUnsupported",
    criteriaCount: number,
): void
Emit list routing decision observability events without impacting runtime behavior.
Parameters
- typeName: string
  Type being listed.
- path: "fullText" | "structured" | "fullScanCompare"
  Selected routing path.
- reason:
      | "fullTextPlan"
      | "structuredEligible"
      | "criteriaWithoutIndexedPath"
      | "indexedPathFailedOrUnsupported"
  Why this path was selected.
- criteriaCount: number
  Number of criteria considered.
Returns void
- Defined in api/ORM/TypeInfoORMService.ts:435

`Protected`emitStructuredIndexWrite

emitStructuredIndexWrite(
    typeName: string,
    docId: string,
    action: "upsert" | "remove",
    indexedFieldCount: number,
): void
Emit structured index write observability events without impacting behavior.
Parameters
- typeName: string
  Type being indexed.
- docId: string
  Indexed document id.
- action: "upsert" | "remove"
  Structured indexing action.
- indexedFieldCount: number
  Number of indexed fields in the write payload.
Returns void
- Defined in api/ORM/TypeInfoORMService.ts:478

`Protected`encodeFullScanCompareCursor

encodeFullScanCompareCursor(offset: number): string
Parameters
- offset: number
  Next offset in filtered/sorted results.
Returns string
Encoded cursor for full-scan compare pagination.
- Defined in api/ORM/TypeInfoORMService.ts:1248

`Protected`getCleanItem

getCleanItem(
    typeName: string,
    item: Partial<TypeInfoDataItem>,
    dacFieldResources?: Partial<Record<string, DACAccessResult>>,
    selectedFields?: string[],
): Partial<TypeInfoDataItem>
Parameters
- typeName: string
  Type name used to look up TypeInfo.
- item: Partial<TypeInfoDataItem>
  Item to clean.
- OptionaldacFieldResources: Partial<Record<string, DACAccessResult>>
  Optional DAC field resource map.
- OptionalselectedFields: string[]
  Optional selected fields to include.
Returns Partial<TypeInfoDataItem>
Cleaned item with selected fields and DAC constraints applied.
- Defined in api/ORM/TypeInfoORMService.ts:2031

`Protected`getCleanSelectedFields

getCleanSelectedFields(
typeName: string,
selectedFields?: string[],
): string[] | undefined
Parameters
- typeName: string
  Type name used to look up TypeInfo.
- OptionalselectedFields: string[]
  Optional selected fields to include.
Returns string[] | undefined
Sanitized selected fields or undefined for all fields.
- Defined in api/ORM/TypeInfoORMService.ts:2090

`Protected`getIndexedItemSnapshot

getIndexedItemSnapshot(
typeName: string,
item: Partial<TypeInfoDataItem>,
): Partial<TypeInfoDataItem>
Parameters
- typeName: string
  Type name used to clean the item.
- item: Partial<TypeInfoDataItem>
  Item snapshot to normalize.
Returns Partial<TypeInfoDataItem>
Item snapshot normalized for indexing operations.
- Defined in api/ORM/TypeInfoORMService.ts:1453

`Protected`getIndexingRelationshipDriverInternal

getIndexingRelationshipDriverInternal(): IndexingRelationshipDriver
Returns IndexingRelationshipDriver
Indexing relationship driver for relation indexing.
- Defined in api/ORM/TypeInfoORMService.ts:856

`Protected`getTypeInfo

getTypeInfo(typeName: string): TypeInfo
Parameters
- typeName: string
  Type name to resolve.
Returns TypeInfo
Type info for the requested type.
- Defined in api/ORM/TypeInfoORMService.ts:878

`Protected`indexFullTextDocument

indexFullTextDocument(
    typeName: string,
    item: Partial<TypeInfoDataItem>,
    indexFieldOverride?: string | string[],
): Promise<void>
Parameters
- typeName: string
  Type name for index field resolution.
- item: Partial<TypeInfoDataItem>
  Item to index.
- OptionalindexFieldOverride: string | string[]
  Optional override for the index field.
Returns Promise<void>
Promise resolved once indexing is complete.
- Defined in api/ORM/TypeInfoORMService.ts:1510

indexItemIndexes

indexItemIndexes(
    typeName: string,
    item: Partial<TypeInfoDataItem>,
    config?: TypeInfoORMManualIndexingConfig,
): Promise<void>
Write the provided item snapshot into the configured indexes.

Use this when data was created or modified outside TypeInfoORMService.
Parameters
- typeName: string
  Type name for the indexed item.
- item: Partial<TypeInfoDataItem>
  Item snapshot to index.
- config: TypeInfoORMManualIndexingConfig = {}
  Optional full-text field overrides.
Returns Promise<void>
Promise resolved when manual indexing completes.
- Defined in api/ORM/TypeInfoORMService.ts:1645

`Protected`indexStructuredDocument

indexStructuredDocument(
typeName: string,
item: Partial<TypeInfoDataItem>,
): Promise<void>
Parameters
- typeName: string
  Type name for field mapping.
- item: Partial<TypeInfoDataItem>
  Item to index.
Returns Promise<void>
Promise resolved once indexing is complete.
- Defined in api/ORM/TypeInfoORMService.ts:1803

`Protected`isFullTextSearchOperator

isFullTextSearchOperator(operator: ComparisonOperators): boolean
Parameters
- operator: ComparisonOperators
  Operator to evaluate.
Returns boolean
True when the operator maps to full-text search.
- Defined in api/ORM/TypeInfoORMService.ts:974

`Protected`isStructuredOperatorSupportedForField

isStructuredOperatorSupportedForField(
field: TypeInfoField,
operator: ComparisonOperators,
): boolean
Parameters
- field: TypeInfoField
  Field definition from TypeInfo.
- operator: ComparisonOperators
  Search operator to evaluate.
Returns boolean
True when the field type and operator can be served by structured indexing.
- Defined in api/ORM/TypeInfoORMService.ts:1020

`Protected`isStructuredValue

isStructuredValue(value: unknown): value is WhereValue
Parameters
- value: unknown
  Value to check.
Returns value is WhereValue
True when the value is a supported structured value.
- Defined in api/ORM/TypeInfoORMService.ts:1396

list

list(
    typeName: string,
    config: ListItemsConfig,
    selectedFields?: string[],
    context?: TypeInfoORMContext,
): Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
List items of the given type, with the given criteria.
Parameters
- typeName: string
  Type name to list.
- config: ListItemsConfig
  List configuration and criteria.
- OptionalselectedFields: string[]
  Optional fields to select.
- Optionalcontext: TypeInfoORMContext
Returns Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
List results with items and cursor.
Implementation of TypeInfoORMAPI.list
- Defined in api/ORM/TypeInfoORMService.ts:2821

`Protected`listByFullScanAndCompare

listByFullScanAndCompare(
    typeName: string,
    config: ListItemsConfig,
    cleanSelectedFields: string[] | undefined,
    useDAC: boolean,
    context?: TypeInfoORMContext,
): Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
Execute a criteria list via full scan + in-memory compare.

This is the universal fallback strategy for criteria/operators that are not supported by indexed query planners.
Parameters
- typeName: string
  Type name to list.
- config: ListItemsConfig
  Original list config.
- cleanSelectedFields: string[] | undefined
  Selected fields for cleaned response.
- useDAC: boolean
  Whether DAC checks are enabled.
- Optionalcontext: TypeInfoORMContext
  Optional request context.
Returns Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
List results with cursor.
- Defined in api/ORM/TypeInfoORMService.ts:1293

listRelatedItems

listRelatedItems(
    config: ListRelationshipsConfig,
    selectedFields?: string[],
    context?: TypeInfoORMContext,
): Promise<
    { cursor: string
    | undefined; items: Partial<TypeInfoDataItem>[] },
>
List related items for the relationship origin.
Parameters
- config: ListRelationshipsConfig
  Relationship list configuration.
- OptionalselectedFields: string[]
  Optional fields to select on related items.
- Optionalcontext: TypeInfoORMContext
Returns Promise<{ cursor: string | undefined; items: Partial<TypeInfoDataItem>[] }>
Items and cursor for related items.
Implementation of TypeInfoORMAPI.listRelatedItems
- Defined in api/ORM/TypeInfoORMService.ts:2510

listRelationships

listRelationships(
config: ListRelationshipsConfig,
context?: TypeInfoORMContext,
): Promise<ListItemsResults<ItemRelationshipInfo>>
List the relationships for a given item.
Parameters
- config: ListRelationshipsConfig
  Relationship list configuration.
- Optionalcontext: TypeInfoORMContext
Returns Promise<ListItemsResults<ItemRelationshipInfo>>
Relationship items and paging cursor.
Implementation of TypeInfoORMAPI.listRelationships
- Defined in api/ORM/TypeInfoORMService.ts:2414

read

read(
    typeName: string,
    primaryFieldValue: any,
    selectedFields?: string[],
    context?: TypeInfoORMContext,
): Promise<Partial<TypeInfoDataItem>>
Read an existing item of the given type.
Parameters
- typeName: string
  Type name to read.
- primaryFieldValue: any
  Primary field value to fetch.
- OptionalselectedFields: string[]
  Optional fields to select.
- Optionalcontext: TypeInfoORMContext
Returns Promise<Partial<TypeInfoDataItem>>
Cleaned item data.
Implementation of TypeInfoORMAPI.read
- Defined in api/ORM/TypeInfoORMService.ts:2591

reindexStoredItem

reindexStoredItem(
    typeName: string,
    primaryFieldValue: LiteralValue,
    config?: TypeInfoORMReindexStoredItemConfig,
): Promise<boolean>
Reindex the current stored item using the configured driver.

When no previous snapshot is supplied, the current stored item is used for both removal and indexing to refresh existing postings without duplication. Supply previousItem when an out-of-band update changed indexed field values, otherwise old full-text tokens cannot be removed safely.
Parameters
- typeName: string
  Type name to reindex.
- primaryFieldValue: LiteralValue
  Primary field value for the stored item.
- config: TypeInfoORMReindexStoredItemConfig = {}
  Optional previous snapshot and full-text field overrides.
Returns Promise<boolean>
True when reindexing completed.
- Defined in api/ORM/TypeInfoORMService.ts:1733

reindexStoredType

reindexStoredType(
typeName: string,
config?: TypeInfoORMReindexStoredTypeConfig,
): Promise<TypeInfoORMReindexStoredTypeResults>
Reindex all currently stored items for a type.

This is intended for maintenance passes after out-of-band writes or schema/index configuration changes. Deleted items still require explicit cleanup via removeItemIndexes, because full-text token removal needs a prior snapshot of indexed field values. For out-of-band updates that changed indexed values, provide previousItemsByPrimaryField.
Parameters
- typeName: string
  Type name to reindex.
- config: TypeInfoORMReindexStoredTypeConfig = {}
  Paging, previous snapshots, and full-text field overrides.
Returns Promise<TypeInfoORMReindexStoredTypeResults>
Count of processed stored items.
- Defined in api/ORM/TypeInfoORMService.ts:1763

`Protected`removeFullTextDocument

removeFullTextDocument(
    typeName: string,
    item: Partial<TypeInfoDataItem>,
    indexFieldOverride?: string | string[],
): Promise<void>
Parameters
- typeName: string
  Type name for index field resolution.
- item: Partial<TypeInfoDataItem>
  Item to remove from the index.
- OptionalindexFieldOverride: string | string[]
  Optional override for the index field.
Returns Promise<void>
Promise resolved once removal is complete.
- Defined in api/ORM/TypeInfoORMService.ts:1551

removeItemIndexes

removeItemIndexes(
    typeName: string,
    item: Partial<TypeInfoDataItem>,
    config?: TypeInfoORMManualIndexingConfig,
): Promise<void>
Remove the provided item snapshot from the configured indexes.

Use this when data was deleted outside TypeInfoORMService.
Parameters
- typeName: string
  Type name for the indexed item.
- item: Partial<TypeInfoDataItem>
  Item snapshot to remove from the indexes.
- config: TypeInfoORMManualIndexingConfig = {}
  Optional full-text field overrides.
Returns Promise<void>
Promise resolved when index cleanup completes.
- Defined in api/ORM/TypeInfoORMService.ts:1670

`Protected`removeStructuredDocument

removeStructuredDocument(
typeName: string,
item: Partial<TypeInfoDataItem>,
): Promise<void>
Parameters
- typeName: string
  Type name for field mapping.
- item: Partial<TypeInfoDataItem>
  Item to remove from the structured index.
Returns Promise<void>
Promise resolved once removal is complete.
- Defined in api/ORM/TypeInfoORMService.ts:1847

`Protected`replaceFullTextDocument

replaceFullTextDocument(
    typeName: string,
    previousItem: Partial<TypeInfoDataItem>,
    nextItem: Partial<TypeInfoDataItem>,
    indexFieldOverride?: string | string[],
): Promise<void>
Parameters
- typeName: string
  Type name for index field resolution.
- previousItem: Partial<TypeInfoDataItem>
  Previous item state to remove from the index.
- nextItem: Partial<TypeInfoDataItem>
  Next item state to index.
- OptionalindexFieldOverride: string | string[]
  Optional override for the index field.
Returns Promise<void>
Promise resolved once replacement is complete.
- Defined in api/ORM/TypeInfoORMService.ts:1592

replaceItemIndexes

replaceItemIndexes(
    typeName: string,
    previousItem: Partial<TypeInfoDataItem>,
    nextItem: Partial<TypeInfoDataItem>,
    config?: TypeInfoORMReplaceIndexingConfig,
): Promise<void>
Replace one indexed item snapshot with another.

Use this when an existing stored item changed outside TypeInfoORMService or when a schema/config change requires removing old full-text fields and indexing a new field set.
Parameters
- typeName: string
  Type name for the indexed item.
- previousItem: Partial<TypeInfoDataItem>
  Previous item snapshot to remove.
- nextItem: Partial<TypeInfoDataItem>
  Next item snapshot to index.
- config: TypeInfoORMReplaceIndexingConfig = {}
  Optional previous/next full-text field overrides.
Returns Promise<void>
Promise resolved when replacement indexing completes.
- Defined in api/ORM/TypeInfoORMService.ts:1698

`Protected`resolveAutoFullTextCriteriaPlan

resolveAutoFullTextCriteriaPlan(
    typeName: string,
    criteria?: SearchCriteria,
):
    | { indexField: string; mode: "lossy"
    | "exact"; query: string }
    | undefined
Parameters
- typeName: string
  Type being listed.
- Optionalcriteria: SearchCriteria
  Search criteria from list config.
Returns { indexField: string; mode: "lossy" | "exact"; query: string } | undefined
Auto full-text search plan for list criteria, if applicable.
- Defined in api/ORM/TypeInfoORMService.ts:1171

`Protected`resolveFullTextIndexFields

resolveFullTextIndexFields(
typeName: string,
override?: string | string[],
): string[]
Parameters
- typeName: string
  Type name used to resolve the default index field(s).
- Optionaloverride: string | string[]
  Optional override for the index field.
Returns string[]
Resolved full-text index field names.
- Defined in api/ORM/TypeInfoORMService.ts:903

`Protected`resolveStructuredIndexedFields

resolveStructuredIndexedFields(typeName: string): Set<string>
Parameters
- typeName: string
  Type name used to resolve indexed structured fields.
Returns Set<string>
Explicitly indexed structured field names for a type.
- Defined in api/ORM/TypeInfoORMService.ts:987

`Protected`toFullTextSearchPlan

toFullTextSearchPlan(
criterion: FieldCriterion,
): { mode: "lossy" | "exact"; query: string } | undefined
Parameters
- criterion: FieldCriterion
  Criterion to map.
Returns { mode: "lossy" | "exact"; query: string } | undefined
Full-text query plan derived from a field criterion.
- Defined in api/ORM/TypeInfoORMService.ts:1113

update

update(
    typeName: string,
    item: TypeInfoDataItem,
    updateConfig?: TypeInfoORMUpdateConfig,
    context?: TypeInfoORMContext,
): Promise<boolean>
Update an existing item of the given type.

This update will always act as a patch. Use null to signify the deletion of a field. Assign values to all fields to perform a replacement.

The item must always contain its primary field value.
Parameters
- typeName: string
  Type name to update.
- item: TypeInfoDataItem
  Item payload to update.
- OptionalupdateConfig: TypeInfoORMUpdateConfig
  Optional per-field operator config.
- Optionalcontext: TypeInfoORMContext
Returns Promise<boolean>
True when the update succeeded.
Implementation of TypeInfoORMAPI.update
- Defined in api/ORM/TypeInfoORMService.ts:2655

`Protected`validate

validate(
    typeName: string,
    item: TypeInfoDataItem,
    typeOperation: TypeOperation,
    itemIsPartial?: boolean,
): void
Parameters
- typeName: string
  Type name to validate.
- item: TypeInfoDataItem
  Item to validate.
- typeOperation: TypeOperation
  Operation being validated.
- OptionalitemIsPartial: boolean
  Whether the item is a partial update.
Returns void
Nothing (throws on invalid items).
- Defined in api/ORM/TypeInfoORMService.ts:1943

`Protected`validateReadOperation

validateReadOperation(typeName: string, selectedFields?: string[]): void
Parameters
- typeName: string
  Type name to validate for read.
- OptionalselectedFields: string[]
  Optional selected fields to validate.
Returns void
Nothing (throws on invalid operations).
- Defined in api/ORM/TypeInfoORMService.ts:1885

`Protected`validateRelationshipItem

validateRelationshipItem(
relationshipItem: ItemRelationshipInfoType,
omitFields: ItemRelationshipInfoKeys[],
): void
Parameters
- relationshipItem: ItemRelationshipInfoType
  Relationship item to validate.
- omitFields: ItemRelationshipInfoKeys[]
  Relationship fields to omit from validation.
Returns void
Nothing (throws on invalid relationships).
- Defined in api/ORM/TypeInfoORMService.ts:2127

`Protected`validateUpdateConfig

validateUpdateConfig(
    typeName: string,
    item: TypeInfoDataItem,
    updateConfig?: TypeInfoORMUpdateConfig,
): void
Validate update operator config against the target TypeInfo fields.
Parameters
- typeName: string
- item: TypeInfoDataItem
- OptionalupdateConfig: TypeInfoORMUpdateConfig
Returns void
- Defined in api/ORM/TypeInfoORMService.ts:1980

Properties

`Protected`config

config: TypeInfoORMServiceConfig

ORM service configuration.

Class TypeInfoORMService

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns TypeInfoORMService

Methods

ProtectedapplyStructuredFieldMap

Parameters

Returns Where

ProtectedbuildStructuredFields

Parameters

Returns StructuredDocFieldsRecord

ProtectedcanUseStructuredIndexForCriteria

Parameters

Returns boolean

ProtectedcleanupRelationships

Parameters

Returns Promise<void>

create

Parameters

Returns Promise<any>

createRelationship

Parameters

Returns Promise<boolean>

ProtecteddecodeFullScanCompareCursor

Parameters

Returns number

delete

Parameters

Returns Promise<boolean>

deleteRelationship

Parameters

Returns Promise<DeleteRelationshipResults>

ProtectedemitListRoutingDecision

Parameters

Returns void

ProtectedemitStructuredIndexWrite

Parameters

Returns void

ProtectedencodeFullScanCompareCursor

Parameters

Returns string

ProtectedgetCleanItem

Parameters

Returns Partial<TypeInfoDataItem>

ProtectedgetCleanSelectedFields

Parameters

Returns string[] | undefined

ProtectedgetIndexedItemSnapshot

Parameters

Returns Partial<TypeInfoDataItem>

ProtectedgetIndexingRelationshipDriverInternal

Returns IndexingRelationshipDriver

ProtectedgetTypeInfo

Parameters

Returns TypeInfo

ProtectedindexFullTextDocument

Parameters

Returns Promise<void>

indexItemIndexes

Parameters

Returns Promise<void>

ProtectedindexStructuredDocument

Parameters

Returns Promise<void>

ProtectedisFullTextSearchOperator

Parameters

Returns boolean

ProtectedisStructuredOperatorSupportedForField

Parameters

Returns boolean

ProtectedisStructuredValue

Parameters

Returns value is WhereValue

list

`Protected`applyStructuredFieldMap

`Protected`buildStructuredFields

`Protected`canUseStructuredIndexForCriteria

`Protected`cleanupRelationships

`Protected`decodeFullScanCompareCursor

`Protected`emitListRoutingDecision

`Protected`emitStructuredIndexWrite

`Protected`encodeFullScanCompareCursor

`Protected`getCleanItem

`Protected`getCleanSelectedFields

`Protected`getIndexedItemSnapshot

`Protected`getIndexingRelationshipDriverInternal

`Protected`getTypeInfo

`Protected`indexFullTextDocument

`Protected`indexStructuredDocument

`Protected`isFullTextSearchOperator

`Protected`isStructuredOperatorSupportedForField

`Protected`isStructuredValue

`Protected`listByFullScanAndCompare

`Protected`removeFullTextDocument

`Protected`removeStructuredDocument

`Protected`replaceFullTextDocument

`Protected`resolveAutoFullTextCriteriaPlan

`Protected`resolveFullTextIndexFields

`Protected`resolveStructuredIndexedFields

`Protected`toFullTextSearchPlan

`Protected`validate

`Protected`validateReadOperation

`Protected`validateRelationshipItem

`Protected`validateUpdateConfig

`Protected`config