DataStax C++ driver

Before using the DataStax driver, review the Best practices for DataStax drivers to understand the rules and recommendations for improving performance and minimizing resource utilization in applications that use a DataStax driver.

DataStax recommends using the unified DataStax driver. See this blog post for more information. You can also use the DataStax Enterprise (DSE) drivers, which exposes the same API for connecting to Cassandra databases.

Prerequisites

Create your database and set your environment variables to save time developing on your database. There are four environment variables, three of which are on the Astra dashboard (database id, region, and keyspace), and one that you must create (token). For more, see Create your database.

DataStax C++ driver download links

Download the DataStax C++ driver and dependency packages for your platform using the links in the following table:

Platform	Driver	Dependencies
CentOS 6	Download	Download
CentOS 7	Download	Download
Ubuntu 14.04	Download	Download
Ubuntu 16.04	Download	Download
Ubuntu 18.04	Download	Download
Windows	Download	Download

Platform

Driver

Dependencies

CentOS 6

CentOS 7

Ubuntu 14.04

Ubuntu 16.04

Ubuntu 18.04

Windows

Other platforms should build the driver from the source code packages.
Using the packages you downloaded, follow the installation instructions for your platform to install the DataStax C++ driver.
Client ID and Client Secret by creating your application token for your username and password.

Working with secure connect bundle

Downloading secure connect bundle

To connect to your Astra DB database using the drivers, download the secure database bundle from the DataStax Astra Portal that contains the connection credentials.

Open a browser, navigate to Astra DB, and log in.

From your Dashboard page, select your database.

On the Overview page, select Connect.

In the Select a Method section, select Drivers and then Legacy from the dropdown menu to select your driver type from the list to load language-specific instructions.

Java and Node.js are available as legacy and cloud native drivers.

If you have multiple regions, select the region you want to connect to from the dropdown menu for instructions.

The bundle URL is the same for all languages.

Click Download Bundle.

If you have multiple regions, you will have the option to download a bundle for each region from the expanded Download Bundle drop-down menu.

The secure-connect-database_name.zip file downloads, which contains the security certificates and credentials for your database.

Sharing secure connect bundle

Although teammates can access your Astra DB database, it will not display in their list of available databases under My Databases in Astra Portal.

After you create an Astra DB database, you can grant access to other members of your team by providing them with the database credentials and connection details for your database.

Be careful when sharing connection details. Providing this information to another user grants them access to your Astra DB database and ownership capabilities, such as making modifications to the database.

For security, delete downloaded connection credentials after sending them to your teammate.

Connecting C++ driver

Create a connect_database.c file in the main directory for your C++ project.

cd my_project
touch connect_database.c

Copy the following connection code into the connect_database.c file. The secure_connect_bundle must include the absolute path to your Astra database credentials (secure-connect-database_name.zip).

The cass_cluster_set_contact_points() and cass_cluster_set_ssl() methods should not used in conjunction with the cass_cluster_set_cloud_secure_connection_bundle() method.

#include <cassandra.h>
#include <stdio.h>

int main(int argc, char* argv[]) {
     /* Setup and connect to cluster */
     CassCluster* cluster = cass_cluster_new();
     CassSession* session = cass_session_new();

     /* Setup driver to connect to the cloud using the secure connection bundle */
     const char* secure_connect_bundle = "/path/to/secure-connect-database_name.zip";
     if (cass_cluster_set_cloud_secure_connection_bundle(cluster, secure_connect_bundle) != CASS_OK) {
       fprintf(stderr, "Unable to configure cloud using the secure connection bundle: %s\n",
               secure_connect_bundle);
       return 1;
     }

     /* Set credentials provided when creating your database */
     cass_cluster_set_credentials(cluster, "clientID", "clientSecret");

     CassFuture* connect_future = cass_session_connect(session, cluster);

     if (cass_future_error_code(connect_future) == CASS_OK) {
       /* Use the session to run queries */
     } else {
       /* Handle error */
     }

     cass_future_free(connect_future);
     cass_cluster_free(cluster);
     cass_session_free(session);

     return 0;
   }

Build and link your application against the DataStax C++ driver.
- Linux or macOS

For static linking, use cassandra_static.a.

cc connect-database.c -I/path/to/cassandra.h -L/path/to/cassandra.so -lcassandra

Windows Include these libraries in your Microsoft Visual Studio project by adding them to the project’s properties under Configuration Properties/Linker/Input/Additional Dependencies.

For static linking, use cassandra_static.lib.

Link your application against cassandra.lib. Your application will also require `cassandra.dll to be in your runtime path.

After connecting to your database, use the following code to query your database. This code creates a CassStatement object to connect to your Astra DB database, runs a CQL query, and prints the output to the console.

/* Build statement and execute query */
const char_ query = "SELECT release_version FROM system.local";
CassStatement* statement = cass_statement_new(query, 0);

CassFuture* result_future = cass_session_execute(session, statement);

if (cass_future_error_code(result_future) == CASS_OK) {
  /* Retrieve result set and get the first row _/
  const CassResult_ result = cass_future_get_result(result_future);
  const CassRow* row = cass_result_first_row(result);

  if (row) {
    const CassValue* value = cass_row_get_column_by_name(row, "release_version");

    const char* release_version;
    size_t release_version_length;
    cass_value_get_string(value, &release_version, &release_version_length);
    printf("release_version: '%._s'\n", (int)release_version_length, release_version);
  }

    cass_result_free(result);
  } else {
    /_ Handle error _/
    const char_ message;
    size_t message_length;
    cass_future_error_message(result_future, &message, &message_length);
    fprintf(stderr, "Unable to run query: '%.*s'\n", (int)message_length, message);
  }

  cass_statement_free(statement);
  cass_future_free(result_future);

Migrating C++ driver

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

In your existing DataStax C++ driver code, modify the connection code to use the Astra DB API.

Both the DataStax C driver for Apache Cassandra and the {company} Enterprise (DSE) C driver use the same code to connect and query your Astra database. When using the DSE C++ driver, use the header #include <dse.h>.

The secure_connect_bundle must include the absolute path to your Astra database credentials (secure-connect-database_name.zip).

cass_cluster_set_credentials(cluster, "clientId", "clientSecret");

  CassFuture* connect_future = cass_session_connect(session, cluster);
  if (cass_future_error_code(connect_future) == CASS_OK) {
    * Use the session to run queries _
    }
  else {
    _ Handle error *
  }

Build and link your application against the DataStax C++ driver.
- Linux or macOS
  
  For static linking, use cassandra_static.a or dse_static.a.
  DataStax C++ driver for Apache Cassandra
  
  DSE C++ driver
  cc connect-database.c -I/path/to/cassandra.h -L/path/to/cassandra.so -lcassandra
  
  cc connect-database.c -I/path/to/dse.h -L/path/to/dse.so -ldse
- Windows Include these libraries in your Microsoft Visual Studio project by adding them to the project’s properties under ]Configuration Properties/Linker/Input/Additional Dependencies.
  
  For static linking, use cassandra_static.lib or dse_static.libpass:c[.

DataStax C++ driver for Apache Cassandra Link your application against cassandra.lib. Your application will also require `cassandra.dll to be in your runtime path.

DSE C++ driver Link your application against dse.lib. Your application will also require dse.dll to be in your runtime path.