Class RVClickHouseDataSource

ClickHouse data source

Hierarchy

Index

Accessors

Accessors

  • get database(): nullableString

    Name of the database to connect to.

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

    Parameters

    • v: number | null

    Returns void

  • get host(): nullableString

    Host name or IP address to connect to.

    Returns nullableString

  • set host(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get id(): nullableString

    The ID of the data source

    Returns nullableString

  • set id(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get path(): nullableString

    (Optional) The URL path appended after the host and port.

    Returns nullableString

  • set path(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get port(): number

    Returns number

  • set port(value: number): void

    Parameters

    • value: number

    Returns void

  • get processDataOnServerDefaultValue(): 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.

    Returns boolean

  • set processDataOnServerDefaultValue(value: boolean): void

    Parameters

    • value: boolean

    Returns void

  • get processDataOnServerReadOnly(): boolean

    When set to true the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.

    Returns boolean

  • set processDataOnServerReadOnly(value: boolean): void

    Parameters

    • value: boolean

    Returns void

  • get protocol(): nullableString

    (Optional) The protocol used to connect to ClickHouse (e.g. "http", "https").

    Returns nullableString

  • set protocol(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get skipServerCertificateValidation(): boolean | null

    (Optional) When true, skips server certificate validation for TLS connections.

    Returns boolean | null

  • set skipServerCertificateValidation(value: boolean | null): void

    Parameters

    • value: boolean | null

    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 timeout(): number | null

    (Optional) Connection timeout in seconds.

    Returns number | null

  • set timeout(value: number | null): void

    Parameters

    • value: number | null

    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