Class RVElasticsearchDataSourceItem

Elasticsearch data source item

Hierarchy

  • RVDataSourceItem
    • RVElasticsearchDataSourceItem

Index

Constructors

constructor

Accessors

dataSource

  • get dataSource(): RVDashboardDataSource
  • set dataSource(value: RVDashboardDataSource): void
  • Reference to the data source object this item belongs to.

    Returns RVDashboardDataSource

  • Reference to the data source object this item belongs to.

    Parameters

    • value: RVDashboardDataSource

    Returns void

defaultRefreshRate

  • get defaultRefreshRate(): null | number
  • set defaultRefreshRate(v: null | number): 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.

    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-. If not set it will use the default value set in the data source object.

    Parameters

    • v: null | number

    Returns void

description

  • get description(): nullableString
  • set description(value: nullableString): void
  • Description of this data source item.

    Returns nullableString

  • Description of this data source item.

    Parameters

    • value: nullableString

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

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

    Parameters

    • value: nullableString

    Returns void

index

  • get index(): null | string
  • set index(value: null | string): void
  • The name of the Elasticsearch index to query.

    Returns null | string

  • The name of the Elasticsearch index to query.

    Parameters

    • value: null | string

    Returns void

processDataOnServer

  • get processDataOnServer(): boolean
  • set processDataOnServer(value: boolean): void
  • Configures if the "Process Data on Server" option is turned on for this item, defaults to "true"

    Returns boolean

  • Configures if the "Process Data on Server" option is turned on for this item, defaults to "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 item, as displayed to the user, it might be for example the name of the table in a database.

    Returns nullableString

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

    Parameters

    • value: nullableString

    Returns void