Class RVAthenaDataSource

Amazon Athena data source

Hierarchy

  • RVDashboardDataSource
    • RVAthenaDataSource

Index

Constructors

constructor

Accessors

dataCatalog

  • get dataCatalog(): nullableString
  • set dataCatalog(value: nullableString): void
  • Athena's data catalog where the database is. If the value is null, "AwsDataCatalog" will be used.

    Returns nullableString

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

    Parameters

    • value: nullableString

    Returns void

database

  • get database(): nullableString
  • set database(value: nullableString): void
  • Database that will be used

    Returns nullableString

  • Database that will be used

    Parameters

    • value: nullableString

    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

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

outputLocation

  • get outputLocation(): nullableString
  • set outputLocation(value: nullableString): void
  • 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

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

    Parameters

    • value: nullableString

    Returns void

region

  • get region(): nullableString
  • set region(value: nullableString): 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

workgroup

  • get workgroup(): nullableString
  • set workgroup(value: nullableString): void
  • Workgroup used to run queries. It is optional.

    Returns nullableString

  • Workgroup used to run queries. It is optional.

    Parameters

    • value: nullableString

    Returns void