@resistdesign/voltra
    Preparing search index...

    Type Alias TypeInfoORMIndexingConfig

    Configuration for TypeInfoORM indexing integrations.

    type TypeInfoORMIndexingConfig = {
        fullText?: {
            backend: IndexBackend;
            defaultIndexFieldByType?: Record<string, string>;
        };
        limits?: ResolvedSearchLimits;
        relations?: {
            backend: RelationalBackend;
            decodeEntityId?: (typeName: string, entityId: string) => string;
            encodeEntityId?: (typeName: string, primaryFieldValue: string) => string;
            relationNameFor: (
                fromTypeName: string,
                fromTypeFieldName: string,
            ) => string;
        };
        structured?: {
            fieldMapByType?: Record<string, Record<string, string>>;
            reader: StructuredSearchDependencies;
            writer?: StructuredWriter;
        };
    }
    Index

    Properties

    fullText? limits? relations? structured?

    Properties

    fullText?: {
        backend: IndexBackend;
        defaultIndexFieldByType?: Record<string, string>;
    }

    Full text indexing configuration.

    Type Declaration

    • backend: IndexBackend

      Backend used for full text indexing.

    • OptionaldefaultIndexFieldByType?: Record<string, string>

      Default index field names by type.

    limits?: ResolvedSearchLimits

    Optional search limits for indexing queries.

    relations?: {
        backend: RelationalBackend;
        decodeEntityId?: (typeName: string, entityId: string) => string;
        encodeEntityId?: (typeName: string, primaryFieldValue: string) => string;
        relationNameFor: (
            fromTypeName: string,
            fromTypeFieldName: string,
        ) => string;
    }

    Relationship indexing configuration.

    Type Declaration

    • backend: RelationalBackend

      Backend used for relationship indexing.

    • OptionaldecodeEntityId?: (typeName: string, entityId: string) => string

      Optional decoder for entity ids.

    • OptionalencodeEntityId?: (typeName: string, primaryFieldValue: string) => string

      Optional encoder for entity ids.

    • relationNameFor: (fromTypeName: string, fromTypeFieldName: string) => string

      Resolver for relation name from type/field.

    structured?: {
        fieldMapByType?: Record<string, Record<string, string>>;
        reader: StructuredSearchDependencies;
        writer?: StructuredWriter;
    }

    Structured indexing configuration.

    Type Declaration

    • OptionalfieldMapByType?: Record<string, Record<string, string>>

      Field name mapping per type.

    • reader: StructuredSearchDependencies

      Reader used for structured queries.

    • Optionalwriter?: StructuredWriter

      Optional writer for structured indexing.

    Settings

    Member Visibility

    On This Page

    Properties