Class RVElasticsearchDataSourceItem

Elasticsearch data source item

Hierarchy

Index

Accessors

Accessors

  • get defaultRefreshRate(): number | null

    Returns number | null

  • set defaultRefreshRate(v: number | null): void

    Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g. 1440 = 1 day). A value of N means that whenever the visualization requests data, the engine will return data found in the cache if it's not older than N minutes -this means, if the engine fetched it from the datasource no more than N minutes before-. If not set it will use the default value set in the data source object.

    Parameters

    • v: number | null

    Returns void

  • get description(): nullableString

    Description of this data source item.

    Returns nullableString

  • set description(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get fieldMultiValueLeniency(): boolean | null

    (Optional) Controls behavior when SQL queries encounter fields with multiple values. If false, an error is returned for fields containing array values. If true, returns the first value from the array with no guarantee of consistent ordering. Defaults to false.

    Returns boolean | null

  • set fieldMultiValueLeniency(value: boolean | null): void

    Parameters

    • value: boolean | null

    Returns void

  • get id(): nullableString

    The value that identifies this item in the data source, it might be for example the name of the schema concatenated with the table name.

    Returns nullableString

  • set id(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get index(): string | null

    The name of the Elasticsearch index to query.

    Returns string | null

  • set index(value: string | null): void

    Parameters

    • value: string | null

    Returns void

  • get processDataOnServer(): boolean

    Configures if the "Process Data on Server" option is turned on for this item, defaults to "true"

    Returns boolean

  • set processDataOnServer(value: boolean): void

    Parameters

    • value: boolean

    Returns void

  • get subtitle(): nullableString

    The subtitle of the data source, if not null will be displayed to users instead of connection information like host and database name.

    Returns nullableString

  • set subtitle(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get title(): nullableString

    The title of the item, as displayed to the user, it might be for example the name of the table in a database.

    Returns nullableString

  • set title(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void