JDBC Driver for Cassandra

Build 24.0.9060

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Cassandra consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example: 
    cdata.jdbc.cassandra.CassandraDriver
  • Provide the JDBC URL. For example: 
    jdbc:cassandra:Database=MyCassandraDB;Port=9042;Server=127.0.0.1;

or

jdbc:cdata:cassandra:Database=MyCassandraDB;Port=9042;Server=127.0.0.1;

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:cassandra:" or "jdbc:cdata:cassandra:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Cassandra

You can connect directly to Cassandra instances, as well as Cosmos DB and DataStax Astra DB via their Cassandra APIs.

Cassandra

Set the following to connect to a Cassandra instance:

  • Server: Set this to the the host name or IP address of the server hosting the Cassandra database. You can specify the port at the end of this property or in Port.
  • Port: Set this to the port on which the Cassandra database is hosted, if you haven't specified the port as part of the Server connection property.
  • Database: Set this to the name of the Cassandra keyspace containing your tables.
  • ConsistencyLevel: Set this to the number of the replicas that you want to enforce a response from before queries are considered a success.
  • User: Set this to the username used to access your Cassandra database.
  • Password: Set this to the password used to access your Cassandra database.

Cosmos DB

If you're using Cosmos DB as your Cassandra data store, specify the following values to connect:

  • Server: Set this to the Host value, the FQDN of the server provisioned for your account. You can specify the port at the end of this property or in Port.
  • Port: Set this to the port on which your Cosmos DB instance is hosted, if you haven't specified the port as part of the Server connection property.
  • Database: Set this to the database you want to read from and write to.
  • ConsistencyLevel: Set this to the number of the replicas that you want to enforce a response from before queries are considered a success.
  • User: Set this to your Cosmos DB account name.
  • Password: Set this to the account key associated with the Cosmos DB account.

DataStax Astra DB

If you're using Astra DB as your Cassandra data store, specify the following values to connect:

  • Server: Set this to the server in your BASE_ADDRESS value. You can also specify the port here or in Port.
  • Port: Set this to the port on which your Astra DB instance is hosted, if you haven't specified the port as part of the Server connection property.
  • Database: Set this to the database you want to read from and write to.
  • ConsistencyLevel: Set this to the number of the replicas that you want to enforce a response from before queries are considered a success.
  • User: Set this to your Astra DB username.
  • Password: Set this to the password associated with your Astra DB username.

Secure Bundle Connection

You can configure any connection as a secure bundle by setting the following connection properties:

  • Server: Set this to your server name.
  • Port: Set this to 29042.
  • User: Set this to the Atra DB user.
  • Password: Set this to Astra DB user password.
  • SSLClientCert: Set this to the path to the identity.jks file.
  • SSLClientCertType: Set this JKSFILE.
  • SSLClientCertPassword: Set this to the password for the identity.jks file.
  • SSLClientCertSubject: Set this to CERTIFICATE SUBJECT INFORMATION.
  • UseSSL: Set this to "true".

See Secure connect bundle contents for a list of files that are included in a secure bundle.

Authenticating to Cassandra

The driver supports Basic authentication with login credentials and the additional authentication features of DataStax Enterprise (DSE). The following sections detail connection properties your authentication method may require.

You need to set AuthScheme to the value corresponding to the authenticator configured for your system. You specify the authenticator in the authenticator property in the cassandra.yaml file. This file is typically found in /etc/dse/cassandra or through the DSE Unified Authenticator on DSE Cassandra.

Basic

Set AuthScheme to Basic to authenticate with login credentials alone.

In the cassandra.yaml file, set the authenticator property to "PasswordAuthenticator".

DSE

Set the AuthScheme property to DSE to authenticate with login credentials and the DSE Unified Authenticator.

In the file, set the authenticator property to "com.datastax.bdp.cassandra.auth.DseAuthenticator".

Kerberos

Set the following to authenticating using Kerberos:

  • AuthScheme: Set this to KERBEROS.
  • KerberosKDC: Set this to the Kerberos Key Distribution Center (KDC) service used to authenticate the user.
  • KerberosRealm: Set this to the Kerberos Realm used to authenticate the user.
  • KerberosSPN: Set this to the service principal name (SPN) for the Kerberos Domain Controller.
Next, configure these YAML files as described below:
  • In the cassandra.yaml file, set the authenticator property to "com.datastax.bdp.cassandra.auth.DseAuthenticator".
  • Modify the authentication_options section in the dse.yaml file, specifying the default_schema and other_schemas properties as "kerberos".
  • Modify the kerberos_options section in the dse.yaml file, specifying the keytab, service_principle, http_principle and qop properties.

Please see Using Kerberos for more details on how to set connection properties in order to connect to Kerberos.

LDAP

Set the following to authenticate:

  • AuthScheme: Set this to LDAP to authenticate an LDAP user.
  • LDAPServer: Set this to the host name or IP address of the LDAP server.
  • LDAPPassword: The password of the default LDAP user.
Next, configure these YAML files as described below:
  • In the cassandra.yaml file, set the authenticator property to "com.datastax.bdp.cassandra.auth.DseAuthenticator".
  • Modify the authentication_options section in the dse.yaml file, specifying the default_schema and other_schemas properties as "ldap".
  • Modify the ldap_options section in the dse.yaml file, specifying the server_host, server_port, search_dn, search_password, user_search_base, and user_search_filter properties.

Securing Cassandra Connections

You can set UseSSL to negotiate SSL/TLS encryption when you connect. By default, the driver attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060