Striim 3.9.4 / 3.9.5 documentation

MSSQLReader properties

Before you can use this adapter, the tasks described in Microsoft SQL Server setup and in Installing the Microsoft JDBC driver must be completed.


By default, SQL Server retains three days of change capture logs.

Striim provides templates for creating applications that read from SQL Server and write to various targets. See Creating a new application using a template for details.

The adapter properties are:



default value


Auto Disable Table CDC

java.lang. Boolean


SQL Server starts capturing change data when the application is started. With the default setting of True, SQL Server will stop capturing change data when the application is undeployed. Set to False to continue capturing change data after the application is undeployed. Note: when change data capture is stopped, data in shadow tables is lost.


java.lang. Boolean


Set to True when the output of an MSSQLReader source is the input of a Notes on writing to Cassandra with DatabaseWriter target.

Connection Pool Size

java.lang. Integer


typically should be set to the number of tables, with a large number of tables can set lower to reduce impact on MSSQL host

Connection Retry Policy

java.lang. String

timeOut=30, retryInterval=30, maxRetries=3

With the default setting:

  • Striim will wait for the database to respond to a connection request for 30 seconds (timeOut=00).

  • If the request times out, Striim will try again in 30 seconds (retryInterval=30).

  • If the request times out on the third retry (maxRetries=3), a ConnectionException will be logged and the application will stop.

Negative values are not supported.

Connection URL

java.lang. String

IP address and port of Microsoft SQL server, separated by a colon

If the connection requires SSL, see Set up connection to MSSQLReader with SSL in Striim's knowledge base.

Database Name

java. lang. String

the SQL Server database name

Excluded Tables

java.lang. String

If the Tables string contains wildcards, any tables specified here will be excluded.

Fetch Transaction Metadata

java.lang. Boolean


With the default falue of False, the metadata array will include TimeStamp and TxnID fields only when the TxnID changes. If set to True, the metadata array will include TimeStamp and TxnID values for every record (note that this will reduce performance).


com. webaction. security. Password

the password specified for the username (see Encrypted passwords)

Start Position

java.lang. String


With the default value EOF, reading starts at the end of the log file (that is, only new data is read). Alternatively, you may specify a specific time (for example, TIME:2014-10-03 12:32:32.917) or SQL Server log sequence number (for example, LSN:0x00000A85000001B8002D) from which to start reading.


java.lang. String

The table(s) or view(s) in for which to return change data. Names must be specified as <schema name>.<table name> and are case-sensitive. (The server is specified by the IP address in connectionURL and the database by databaseName.) Tables must have a primary key.

You may specify multiple tables and views as a list separated by semicolons or with the following wildcards:

  • %: any series of characters

  • _: any single character

For example, my.% would read all tables in the my schema. At least one table must match the wildcard or start will fail with a "Could not find tables specifed in the database" error.


java.lang. String

the login name for the user created as described in Microsoft SQL Server setup