• Glossary
  • Support
  • Downloads
  • DataStax Home
Get Live Help
Expand All
Collapse All

DataStax Astra DB Classic Documentation

    • Overview
      • Release notes
      • Astra DB FAQs
      • Astra DB glossary
      • Get support
    • Getting Started
      • Grant a user access
      • Load and retrieve data
        • Use DSBulk to load data
        • Use Data Loader in Astra Portal
      • Connect a driver
      • Build sample apps
      • Use integrations
        • Connect with DataGrip
        • Connect with DBSchema
        • Connect with JanusGraph
        • Connect with Strapi
    • Planning
      • Plan options
      • Database regions
    • Securing
      • Security highlights
      • Security guidelines
      • Default user permissions
      • Change your password
      • Reset your password
      • Authentication and Authorization
      • Astra DB Plugin for HashiCorp Vault
    • Connecting
      • Connecting to a VPC
      • Connecting Change Data Capture (CDC)
      • Connecting CQL console
      • Connect the Spark Cassandra Connector to Astra
      • Drivers for Astra DB
        • Connecting C++ driver
        • Connecting C# driver
        • Connecting Java driver
        • Connecting Node.js driver
        • Connecting Python driver
        • Drivers retry policies
      • Connecting Legacy drivers
      • Get Secure Connect Bundle
    • Migrating
      • FAQs
      • Preliminary steps
        • Feasibility checks
        • Deployment and infrastructure considerations
        • Create target environment for migration
        • Understand rollback options
      • Phase 1: Deploy ZDM Proxy and connect client applications
        • Set up the ZDM Automation with ZDM Utility
        • Deploy the ZDM Proxy and monitoring
          • Configure Transport Layer Security
        • Connect client applications to ZDM Proxy
        • Manage your ZDM Proxy instances
      • Phase 2: Migrate and validate data
      • Phase 3: Enable asynchronous dual reads
      • Phase 4: Change read routing to Target
      • Phase 5: Connect client applications directly to Target
      • Troubleshooting
        • Troubleshooting tips
        • Troubleshooting scenarios
      • Additional resources
        • Glossary
        • Contribution guidelines
        • Release Notes
    • Managing
      • Managing your organization
        • User permissions
        • Pricing and billing
        • Audit Logs
        • Configuring SSO
          • Configure SSO for Microsoft Azure AD
          • Configure SSO for Okta
          • Configure SSO for OneLogin
      • Managing your database
        • Create your database
        • View your databases
        • Database statuses
        • Use DSBulk to load data
        • Use Data Loader in Astra Portal
        • Monitor your databases
        • Manage multiple keyspaces
        • Using multiple regions
        • Terminate your database
        • Resize your classic database
        • Park your classic database
        • Unpark your classic database
      • Managing with DevOps API
        • Managing database lifecycle
        • Managing roles
        • Managing users
        • Managing tokens
        • Managing multiple regions
        • Get private endpoints
        • AWS PrivateLink
        • Azure PrivateLink
        • GCP Private Service
    • Astra CLI
    • Developing with Stargate APIs
      • Develop with REST
      • Develop with Document
      • Develop with GraphQL
        • Develop with GraphQL (CQL-first)
        • Develop with GraphQL (Schema-first)
      • Develop with gRPC
        • gRPC Rust client
        • gRPC Go client
        • gRPC Node.js client
        • gRPC Java client
      • Develop with CQL
      • Tooling Resources
      • Node.js Document API client
      • Node.js REST API client
    • Stargate QuickStarts
      • Document API QuickStart
      • REST API QuickStart
      • GraphQL API CQL-first QuickStart
    • API References
      • DevOps REST API v2
      • Stargate Document API v2
      • Stargate REST API v2
  • DataStax Astra DB Classic Documentation
  • Migrating Java driver

Migrating Java driver

Complete the following procedure to migrate your existing DataStax Java driver to a version capable of connecting to Astra DB databases created using DataStax Astra DB.

  1. In your existing DSE Java driver code, update dependencies to include the DSE Java driver version that can connect to Astra DB databases.

    • DataStax Java driver for Apache Cassandra 4.x

    • DataStax Java driver for Apache Cassandra 3.x

    • DSE Java 2.x

    • DSE Java 1.x

    <dependency>
      <groupId>com.datastax.oss</groupId>
      <artifactId>java-driver-core</artifactId>
      <!--Use the latest version from https://search.maven.org/artifact/com.datastax.oss/java-driver-core -->
      <version>4.14.1</version>
    </dependency>
    <dependency>
      <groupId>com.datastax.cassandra</groupId>
      <artifactId>cassandra-driver-core</artifactId>
      <!--Use the latest version from https://search.maven.org/artifact/com.datastax.cassandra/cassandra-driver-core -->
      <version>3.11.2</version>
    </dependency>
    ----
    <dependency>
      <groupId>com.datastax.dse</groupId>
      <artifactId>dse-java-driver-core</artifactId>
      <!--Use the latest version from https://search.maven.org/artifact/com.datastax.dse/dse-java-driver-core -->
      <version>2.4.0</version>
    </dependency>
    ----
    <dependency>
      <groupId>com.datastax.dse</groupId>
      <artifactId>dse-java-driver-core</artifactId>
      <!-- Use the latest 1.x version from https://search.maven.org/artifact/com.datastax.dse/dse-java-driver-core -->
      <version>1.9.0</version>
    </dependency>
  1. Optional: To use DSE QueryBuilder, which is a utility used to generate CQL queries programmatically, add the following dependency to your pom.xml file:

<dependency>
  <groupId>com.datastax.dse</groupId>
  <artifactId>dse-java-driver-query-builder</artifactId>
  <!-- Use the latest 4.x version from https://search.maven.org/artifact/com.datastax.oss/java-driver-query-builder -->
  <version>4.14.1</version>
</dependency>
  1. Modify the connection code to use the Astra DB API. In the CqlSession or Session objects (DseCluster or DseSession objects for DSE), include the path to the secure connect bundle for your Cassandra database (secure-connect-database_name.zip) in the withCloudSecureConnectBundle() method, as shown in the following example.

    • DataStax Java driver for Apache Cassandra 4.x

    • DataStax Java driver for Apache Cassandra 3.x

    • Java 2.x

    • Java 1.x

    CqlSession session = CqlSession.builder()
      .withCloudSecureConnectBundle("/path/to/secure-connect-database_name.zip")
      .withAuthCredentials("clientId","clientSecret")
      .withKeyspace("keyspace_name")
      .build())
    Session session = Cluster.builder()
      .withCloudSecureConnectBundle("/path/to/secure-connect-database_name.zip")
      .withAuthProvider(new PlainTextAuthProvider("clientId", "clientSecret"))
      .build()
      .connect("keyspace_name"))
    DseSession session = DseSession.builder()
      .withCloudSecureConnectBundle("/path/to/secure-connect-database_name.zip")
      .withAuthCredentials("clientId", "clientSecret")
      .withKeyspace("keyspace_name")
      .build();
    DseCluster cluster = DseCluster.builder()
      .withCloudSecureConnectBundle("/path/to/secure-connect-database_name.zip")
      .withCredentials("clientId", "clientSecret")
      .build();
    DseSession session = cluster.connect("keyspace_name");

If converting from using the open source Cassandra Java driver to the DSE Java driver, ensure that you change Session to DseSession.

  1. Build the project to test the connection.

mvn clean compile exec:java -Dexec.mainClass=YourJavaDriver.java

If successful, the code builds, compiles, and connects to your Cassandra database.

General Inquiries: +1 (650) 389-6000 info@datastax.com

© DataStax | Privacy policy | Terms of use

DataStax, Titan, and TitanDB are registered trademarks of DataStax, Inc. and its subsidiaries in the United States and/or other countries.

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries.

Kubernetes is the registered trademark of the Linux Foundation.

landing_page landingpage