JDBC Driver for Cassandra

Build 20.0.7587

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 SupportedWhether 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 FilteringWhen true, slow-performing queries are processed on the server.
Auth SchemeThe scheme used for authentication. Accepted entries are Basic, DSE, Kerberos, and LDAP.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
Batch SizeThe maximum size of each batch operation to submit.
Cache ConnectionThe 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 DriverThe database driver to be used to cache data.
Cache LocationSpecifies the path to the cache when caching to a file.
Cache MetadataThis property determines whether or not to cache the table metadata to a file store.
Cache ToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
Case SensitivityEnable 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 TimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Connect On OpenThis property species whether to connect to the Cassandra when the connection is opened.
Consistency LevelThe 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.
DatabaseThe name of the Cassandra keyspace.
Default LDAP UserThe 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 PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Flatten ArraysBy 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 ObjectsSet FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.
Kerberos KDCThe Kerberos Key Distribution Center (KDC) service used to authenticate the user.
Kerberos Keytab FileThe Keytab file containing your pairs of Kerberos principals and encrypted keys.
Kerberos RealmThe Kerberos Realm used to authenticate the user with.
Kerberos Service KDCThe Kerberos KDC of the service.
Kerberos Service RealmThe Kerberos realm of the service.
Kerberos SPNThe service principal name (SPN) for the Kerberos Domain Controller.
Kerberos Ticket CacheThe full file path to an MIT Kerberos credential cache file.
LDAP PasswordThe password of the default LDAP user. It must be set if the LDAP server do not allow anonymous bind.
LDAP PortThe port for the LDAP server.
LDAP ServerThe host name or IP address of the LDAP server.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA filepath which designates the name and location of the log file.
Log ModulesCore modules to be included in the log file.
Max Log File CountA 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 SizeA 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 RowsLimits 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 UnsetUse unset instead of NULL in CQL query when performing INSERT operations.
OfflineUse offline mode to get the data from the cache instead of the live source.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Cassandra.
PasswordThe password used to authenticate the user.
Pool Idle TimeoutThe allowed idle time for a connection before it is closed.
Pool Max SizeThe maximum connections in the pool.
Pool Min SizeThe minimum number of connections in the pool.
Pool Wait TimeThe max seconds to wait for an available connection.
PortThe port for the Cassandra database.
Pseudo ColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
Query PassthroughThis option passes the query to the Cassandra server as is.
ReadonlyYou can use this property to enforce read-only access to Cassandra from the provider.
Row Scan DepthThe maximum number of rows to scan to look for the columns available in a table.
RTKThe runtime key used for licensing.
Search BaseThe search base for your LDAPServer, used to look up users.
Search FilterThe search filter for looking up usernames in LDAP. The default setting is (uid=), When using Active Directory set the filter to (sAMAccountName=).
ServerThe host name or IP address of the server hosting the Cassandra database.
SSL Client CertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSL Client Cert PasswordThe password for the TLS/SSL client certificate.
SSL Client Cert SubjectThe subject of the TLS/SSL client certificate.
SSL Client Cert TypeThe type of key store containing the TLS/SSL client certificate.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
Support Enhanced SQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
Use Connection PoolingThis property enables connection pooling.
Use Json FormatWhether to submit and return the JSON encoding for CQL data types.
UserThe Cassandra user account used to authenticate.
Use SSLThis field sets whether SSL is enabled.
Varint To StringMap Cassandra VARINT to String value.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587