Options
All
  • Public
  • Public/Protected
  • All
Menu

A utility service that aims to provide elasticsearch query string query index names for data set queries.

If your app uses a customised elasticsearch database mapping for Case objects, that affects the way data fields are indexed you must provide an updated version of this service, so that search can generate correct queries.

You are encouraged to use this service when creating Filters, with elastic query string queries, so that future changes to the default mapping don't affect your existing code.

Hierarchy

  • SearchIndexResolverService

Index

Constructors

Properties

Methods

Constructors

Properties

KEYWORD: ".keyword" = '.keyword'

Methods

  • getCoreIndex(index: string, keyword?: boolean): string
  • Constructs the index name for the specified core field.

    Note that almost all combinations are valid and will not throw an error when used to query the database, but not all combinations are used by the application engine. The SearchIndex class has some information about which field types map to which indices, but you should consult the backend documentation for more reliable information.

    Parameters

    • index: string

      the queried index

    • keyword: boolean = false

      whether the keyword of a TEXT index should be queried

    Returns string

    the full name of the specified index

  • getIndex(dataFieldIdentifier: string, index: SearchIndex, keyword?: boolean): string
  • Constructs the index name for the specified field.

    Note that almost all combinations are valid and will not throw an error when used to query the database, but not all combinations are used by the application engine. The SearchIndex class has some information about which field types map to which indices, but you should consult the backend documentation for more reliable information.

    Parameters

    • dataFieldIdentifier: string

      import ID of the queried data field

    • index: SearchIndex

      the queried index

    • keyword: boolean = false

      whether the keyword of a TEXT index should be queried

    Returns string

    the full name of the specified index

Generated using TypeDoc