All
  • Public
  • Public/Protected
  • All

Class RVAzureSynapseDataSource

Azure Synapse data source

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

database

  • get database(): nullableString
  • set database(value: nullableString): void

  • Name of the database to connect to.

    Returns nullableString

  • Name of the database to connect to.

    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

encrypt

  • get encrypt(): null | boolean
  • set encrypt(value: null | boolean): void

  • Set the Encrypt flag in the connection string to the given value, only supported for .NET backends

    Returns null | boolean

  • Set the Encrypt flag in the connection string to the given value, only supported for .NET backends

    Parameters

    • value: null | boolean

    Returns void

host

  • get host(): nullableString
  • set host(value: nullableString): void

  • Host name or IP address to connect to.

    Returns nullableString

  • Host name or IP address to connect to.

    Parameters

    • value: nullableString

    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

port

  • get port(): number
  • set port(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

processDataOnServerDefaultValue

  • get processDataOnServerDefaultValue(): boolean
  • set processDataOnServerDefaultValue(value: boolean): void

  • 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

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

    Parameters

    • value: boolean

    Returns void

processDataOnServerReadOnly

  • get processDataOnServerReadOnly(): boolean
  • set processDataOnServerReadOnly(value: boolean): void

  • 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

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

    Parameters

    • value: boolean

    Returns void

schema

  • get schema(): nullableString
  • set schema(value: nullableString): void

  • Name of the schema to use.

    Returns nullableString

  • Name of the schema to use.

    Parameters

    • value: nullableString

    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 data source as displayed to users.

    Returns nullableString

  • The title of the data source as displayed to users.

    Parameters

    • value: nullableString

    Returns void

trustServerCertificate

  • get trustServerCertificate(): null | boolean
  • set trustServerCertificate(value: null | boolean): void

  • Set the TrustServerCertificate flag in the connection string to the given value, only supported for .NET backends

    Returns null | boolean

  • Set the TrustServerCertificate flag in the connection string to the given value, only supported for .NET backends

    Parameters

    • value: null | boolean

    Returns void

Methods

getProviderKey

  • getProviderKey(): string

  • Returns string