Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.| Aggregations Supported | Whether or not to support aggregations in the Cassandra server. Note that in queries to the provider, you must use single quotes to define strings. |
| Allow Filtering | When true, slow-performing queries are processed on the server. |
| Auth Scheme | The scheme used for authentication. Accepted entries are Basic, DSE, Kerberos, and LDAP. |
| Auto Cache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| Batch Size | The maximum size of each batch operation to submit. |
| Cache Connection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| Cache Driver | The database driver to be used to cache data. |
| Cache Location | Specifies the path to the cache when caching to a file. |
| Cache Metadata | This property determines whether or not to cache the table metadata to a file store. |
| Cache Tolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Case Sensitivity | Enable case sensitivity to the CQL sending to the server, if set to True, the identifiers in the CQL will be enclosed in double quotation marks. |
| Connection Life Time | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| Connect On Open | This property species whether to connect to the Cassandra when the connection is opened. |
| Consistency Level | The consistency level determines how many of the replicas of the data you are interacting with need to respond for the query to be considered a success. |
| Database | The name of the Cassandra keyspace. |
| Default LDAP User | The default LDAP user used to connect to and communicate with the server, it must be set if the LDAP server do not allow anonymous bind. |
| Firewall Password | A password used to authenticate to a proxy-based firewall. |
| Firewall Port | The TCP port for a proxy-based firewall. |
| Firewall Server | The name or IP address of a proxy-based firewall. |
| Firewall Type | The protocol used by a proxy-based firewall. |
| Firewall User | The user name to use to authenticate with a proxy-based firewall. |
| Flatten Arrays | By default, nested arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays. |
| Flatten Objects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. |
| Kerberos KDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| Kerberos Keytab File | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| Kerberos Realm | The Kerberos Realm used to authenticate the user with. |
| Kerberos Service KDC | The Kerberos KDC of the service. |
| Kerberos Service Realm | The Kerberos realm of the service. |
| Kerberos SPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| Kerberos Ticket Cache | The full file path to an MIT Kerberos credential cache file. |
| LDAP Password | The password of the default LDAP user. It must be set if the LDAP server do not allow anonymous bind. |
| LDAP Port | The port for the LDAP server. |
| LDAP Server | The host name or IP address of the LDAP server. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Logfile | A filepath which designates the name and location of the log file. |
| Log Modules | Core modules to be included in the log file. |
| Max Log File Count | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
| Max Log File Size | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
| Max Rows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| Null To Unset | Use unset instead of NULL in CQL query when performing INSERT operations. |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from Cassandra. |
| Password | The password used to authenticate the user. |
| Pool Idle Timeout | The allowed idle time for a connection before it is closed. |
| Pool Max Size | The maximum connections in the pool. |
| Pool Min Size | The minimum number of connections in the pool. |
| Pool Wait Time | The max seconds to wait for an available connection. |
| Port | The port for the Cassandra database. |
| Pseudo Columns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Query Passthrough | This option passes the query to the Cassandra server as is. |
| Readonly | You can use this property to enforce read-only access to Cassandra from the provider. |
| Row Scan Depth | The maximum number of rows to scan to look for the columns available in a table. |
| RTK | The runtime key used for licensing. |
| Search Base | The search base for your LDAPServer, used to look up users. |
| Search Filter | The search filter for looking up usernames in LDAP. The default setting is (uid=), When using Active Directory set the filter to (sAMAccountName=). |
| Server | The host name or IP address of the server hosting the Cassandra database. |
| SSH Auth Mode | The authentication method to be used to log on to an SFTP server. |
| SSH Client Cert | A certificate to be used for authenticating the user. |
| SSH Client Cert Password | The password of the SSHClientCert certificate if it has one. |
| SSH Client Cert Subject | The subject of the SSH client certificate. |
| SSH Client Cert Type | The type of SSHClientCert certificate. |
| SSH Password | The SSH password. |
| SSH Port | The SSH port. |
| SSH Server | The SSH server. |
| SSH Server Fingerprint | The SSH server fingerprint. |
| SSH User | The SSH user. |
| SSL Client Cert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSL Client Cert Password | The password for the TLS/SSL client certificate. |
| SSL Client Cert Subject | The subject of the TLS/SSL client certificate. |
| SSL Client Cert Type | The type of key store containing the TLS/SSL client certificate. |
| SSL Server Cert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Support Enhanced SQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| Use Connection Pooling | This property enables connection pooling. |
| Use Json Format | Whether to submit and return the JSON encoding for CQL data types. |
| User | The Cassandra user account used to authenticate. |
| Use SSH | Use SSH. |
| Use SSL | This field sets whether SSL is enabled. |
| Varint To String | Map Cassandra VARINT to String value. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |