All
  • Public
  • Public/Protected
  • All

Class RVElasticsearchDataSource

Elasticsearch data source

Hierarchy

  • RVDashboardDataSource
    • RVElasticsearchDataSource

Index

Constructors

Accessors

Constructors

constructor

Accessors

certificateFingerprint

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

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

    Returns null | string

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

    Parameters

    • value: null | string

    Returns void

defaultRefreshRate

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

  • Returns null | number

  • 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: null | number

    Returns void

fieldMultiValueLeniency

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

  • (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 null | boolean

  • (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.

    Parameters

    • value: null | boolean

    Returns void

id

  • get id(): nullableString
  • set id(value: nullableString): void

  • The ID of the data source

    Returns nullableString

  • The ID of the data source

    Parameters

    • value: nullableString

    Returns void

nodes

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

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

    Returns null | string[]

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

    Parameters

    • value: null | string[]

    Returns void

processDataOnServerDefaultValue

  • get processDataOnServerDefaultValue(): boolean
  • set processDataOnServerDefaultValue(value: boolean): void

  • 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

  • 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.

    Parameters

    • value: boolean

    Returns void

subtitle

  • get subtitle(): nullableString
  • set subtitle(value: nullableString): void

  • 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

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

    Parameters

    • value: nullableString

    Returns void

title

  • get title(): nullableString
  • set title(value: nullableString): void

  • The title of the data source as displayed to users.

    Returns nullableString

  • The title of the data source as displayed to users.

    Parameters

    • value: nullableString

    Returns void