Class RVElasticsearchDataSource

Elasticsearch data source

Hierarchy

Index

Accessors

Accessors

  • get certificateFingerprint(): string | null

    (Optional) The hex-encoded SHA-256 fingerprint of the Elasticsearch CA certificate used to establish trust for SSL/TLS connections.

    Returns string | null

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

    Parameters

    • value: string | null

    Returns void

  • 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-. Set it to override the widget editor default behavior.

    Parameters

    • v: number | null

    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 ID of the data source

    Returns nullableString

  • set id(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get nodes(): string[] | null

    List of Elasticsearch node endpoints to connect to in the cluster.

    Returns string[] | null

  • set nodes(value: string[] | null): void

    Parameters

    • value: string[] | null

    Returns void

  • get processDataOnServerDefaultValue(): boolean

    Sets the default value for "Process Data on Server" option for this data source, the end user can still change the value, unless processDataOnServerReadOnly is true.

    Returns boolean

  • set processDataOnServerDefaultValue(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 data source as displayed to users.

    Returns nullableString

  • set title(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void