Class RVAthenaDataSource

Amazon Athena data source

Hierarchy

Index

Accessors

  • get database(): nullableString

    Database that will be used

    Returns nullableString

  • set database(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get dataCatalog(): nullableString

    Athena's data catalog where the database is. If the value is null, "AwsDataCatalog" will be used.

    Returns nullableString

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

    Parameters

    • v: number | 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 outputLocation(): nullableString

    s3 path where the results will be stored. It is optional, but if missing and if the chosen workgroup doesn't have a valid s3 path, the queries will fail.

    Returns nullableString

  • set outputLocation(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 title(): nullableString

    The title of the data source as displayed to users.

    Returns nullableString

  • set title(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get workgroup(): nullableString

    Workgroup used to run queries. It is optional.

    Returns nullableString

  • set workgroup(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void