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

  • DataStax C++ driver download links

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

Platform Download links

CentOS 6

Driver

Dependencies

CentOS 7

Driver

Dependencies

Ubuntu 14.04

Driver

Dependencies

Ubuntu 16.04

Driver

Dependencies

Ubuntu 18.04

Driver

Dependencies

Windows

Driver

Dependencies

  • 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 DB console that contains the connection credentials.

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

  1. From your Dashboard page, select your database.

  1. On the Overview page, select Connect.

  1. In the Connect using a driver section, click your preferred language from the list to load language-specific instructions.

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

Note, though, that the bundle URL is the same for all languages.

  1. 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.

If you’ve enabled VPC peering, you can also Download External Secure Connect Bundle for use within your VPC peering. The secure-connect-database_name.zip file downloads, which contains the security certificates and credentials for your database.

VPC peering is only available on Classic databases.

Alternatively, you can right-click the Download credentials link, copy the link source, and then use a curl command to download the secure-connect-database_name.zip file:

curl -L "<secure-connect-database_name-download-URL>" > database_name.zip

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 the Astra DB console.

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

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

cd my_project
touch connect_database.c
  1. 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;
   }
  1. 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.

  1. 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.

  1. 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 *
      }
  2. 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.