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 Basic Tab.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are Basic, DSE, Kerberos, and LDAP. |
| Server | The host name or IP address of the server hosting the Cassandra database. |
| Port | The port for the Cassandra database. |
| LDAPServer | The host name or IP address of the LDAP server. |
| User | The Cassandra user account used to authenticate. |
| Password | The password used to authenticate the user. |
| LDAPPort | The port for the LDAP server. |
| Database | The name of the Cassandra keyspace. |
| DefaultLDAPUser | 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. |
| LDAPPassword | The password of the default LDAP user. It must be set if the LDAP server do not allow anonymous bind. |
| SearchBase | The search base for your LDAPServer, used to look up users. |
| SearchFilter | The search filter for looking up usernames in LDAP. The default setting is (uid=), When using Active Directory set the filter to (sAMAccountName=). |
| UseSSL | This field sets whether SSL is enabled. |
| Property | Description |
| KerberosKDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| KerberosRealm | The Kerberos Realm used to authenticate the user. |
| KerberosSPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosKeytabFile | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosServiceRealm | The Kerberos realm of the service. |
| KerberosServiceKDC | The Kerberos KDC of the service. |
| KerberosTicketCache | The full file path to an MIT Kerberos credential cache file. |
| Property | Description |
| SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLClientCertPassword | The password for the TLS/SSL client certificate. |
| SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| SSHAuthMode | The authentication method to be used to log on to an SFTP server. |
| SSHClientCert | A private key to be used for authenticating the user. |
| SSHClientCertPassword | The password of the SSHClientCert key if it has one. |
| SSHClientCertSubject | The subject of the SSH client certificate. |
| SSHClientCertType | The type of SSHClientCert private key. |
| SSHServer | The SSH server. |
| SSHPort | The SSH port. |
| SSHUser | The SSH user. |
| SSHPassword | The SSH password. |
| SSHServerFingerprint | The SSH server fingerprint. |
| UseSSH | Whether to tunnel the Cassandra connection over SSH. Use SSH. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| LogModules | Core modules to be included in the log file. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Property | Description |
| AggregationsSupported | 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. |
| AllowFiltering | When true, slow-performing queries are processed on the server. |
| CaseSensitivity | 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. |
| ConsistencyLevel | 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. |
| FlattenArrays | 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. |
| FlattenObjects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. |
| MaxRows | 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. |
| NullToUnset | Use unset instead of NULL in CQL query when performing INSERT operations. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from Cassandra. |
| Readonly | You can use this property to enforce read-only access to Cassandra from the provider. |
| RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UseJsonFormat | Whether to submit and return the JSON encoding for CQL data types. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| VarintToString | Map Cassandra VARINT to String value. |