Data source parameters

connectString

Required

string

Connection string to connect to the data source through the DataProvider. This string is encrypted when stored, so secrets such as passwords are safe to use in this string.

If you have a pre-configured DSN, you may simply specify DSN={YourDSN} for this property, along with any other required parameters.

For more information, refer to the documentation for your relational database.

dataProvider

Required

string

Indicates which Data Provider the adapter should use to connect to the data source. Valid values are SQLServer or ODBC.

When connecting to Microsoft SQL Server, use SQLServer. When connecting to another relational database through ODBC, use ODBC. The SQLServer data provider does not require any additional software, but the ODBC data provider requires an ODBC driver.

For more details, see System requirements.

windowsUser

Optional

string

Optional username to use with Windows Authentication.

Note: You must add your domain to the WindowsUser.

Example: DomainName\\UserName

Note: This user should be configured to have the minimum permissions needed to read the desired data from your database. It is not recommended to use an admin user or even a user with write permissions.

windowsPassword

Optional

string

Optional password to be used with Windows Authentication.

commandTimeout

Optional

string

Optional timeout for running queries on the data source.

Expected format: HH:MM:SS.###
Default Value: 00:00:30 (30 seconds)

UTC

Optional

bool

If true, timestamps from the data source are interpreted as UTC time. If false, local time relative to the adapter is assumed.

Allowed value: true or false
Default value: true

streamIdPrefix

Optional

string

Specifies what prefix is used for stream Ids. The naming convention is {StreamIdPrefix}{StreamId}. An empty string means no prefix will be added to the stream Ids and names. A null value defaults to ComponentId followed by a period.

Example: RDBMS1.TBD

Note: If you change the StreamIdPrefix of a configured adapter (like when you delete and add a data source), you must restart the adapter for the changes to take place. New streams are created on adapter restart and pre-existing streams are no longer updated.

Allowed value: any string
Default value: null

defaultStreamIdPattern

Optional

string

Specifies the default stream Id pattern to use. An empty or null value results in the default value. Possible parameters: QueryId, ValueColumn, SelectValue, SelectColumn, and SourceId.

Allowed value: any string
Default value: {SourceId}

Note: {SourceId} in the DefaultStreamIdPattern evaluates the same as SourceId in the stream metadata. For selection items with a non-empty SelectValue, {SourceId} is equivalent to {QueryId}.{SelectValue}.{ValueColumn}. For selection items with an empty SelectValue, {SourceId} is equivalent to {QueryId}.{ValueColumn}.

requestInterval

Optional

string

Specifies the query interval for history recovery. This will be used to replace the ?ST? and ?ET? parameters in your query. For example, if the RequestInterval is set to 01:00:00, the difference between ?ST? and ?ET? in each query will be 1 hour. For more information, see also Automatic history recovery and Configure queries (RDBMS).

Expected format: HH:MM:SS.###
Default Value: 1.00:00:00 (1 day)

maxHistoryEventsPerSecond

Optional

int

Specifies the maximum number of events per second that the adapter will collect during history recovery. This can be used to limit the adapter to prevent overwhelming the data source or network. Setting this property to 0 will allow historical data to be collected without throttling.

Expected Format: #####
Default Value: 0

dataCollectionMode

Optional

string

Specifies the data collection mode the adapter is in. The following data collection modes are available:

• HistoryOnly - The adapter component does not get started and history recovery on-demand is enabled. For more information, see On-demand history recovery configuration.

• CurrentOnly - The adapter component operates normally and on-demand history recovery is disabled.

• CurrentWithBackfill - The adapter component operates normally, but will automatically recover intervals during the Shutdown device status. History recovery backfills data once device status is good. On-demand history recovery is disabled. For more information, see Automatic history recovery.

  Changing the mode requires a restart of the adapter component.

enableServerFailover

Optional

boolean

Specifies whether to use server-side failover.

Expected format: true or false
Default value: false

secondaryConnectString

Optional

string

The connection string that points to the secondary or backup server. This value is required if enableServerFailover is set to true.