Class RVSqlBasedDataSourceItem

The base item class used to represent a dataset from one of the supported database systems.

Hierarchy

Index

Accessors

  • get database(): nullableString

    Name of the database to connect to, optional as this value is usually specified in the data source object.

    Returns nullableString

  • set database(value: nullableString): void

    Parameters

    • value: nullableString

    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-. 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 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 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 table(): nullableString

    Name of the table (or view) to get data from

    Returns nullableString

  • set table(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