Process & Analyze Couchbase Data in Databricks (AWS)

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Couchbase JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Couchbase NoSQL databases.



Host the CData JDBC Driver for Couchbase in AWS and use Databricks to perform data engineering and data science on live Couchbase data.

Databricks is a cloud-based service that provides data processing capabilities through Apache Spark. When paired with the CData JDBC Driver, customers can use Databricks to perform data engineering and data science on live Couchbase data. This article walks through hosting the CData JDBC Driver in AWS, as well as connecting to and processing live Couchbase data in Databricks.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Couchbase data. When you issue complex SQL queries to Couchbase, the driver pushes supported SQL operations, like filters and aggregations, directly to Couchbase and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Couchbase data using native data types.

Install the CData JDBC Driver in Databricks

To work with live Couchbase data in Databricks, install the driver on your Databricks cluster.

  1. Navigate to your Databricks administration screen and select the target cluster.
  2. On the Libraries tab, click "Install New."
  3. Select "Upload" as the Library Source and "Jar" as the Library Type.
  4. Upload the JDBC JAR file (cdata.jdbc.couchbase.jar) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for Couchbase\lib).

Access Couchbase Data in your Notebook: Python

With the JAR file installed, we are ready to work with live Couchbase data in Databricks. Start by creating a new notebook in your workspace. Name the notebook, select Python as the language (though Scala is available as well), and choose the cluster where you installed the JDBC driver. When the notebook launches, we can configure the connection, query Couchbase, and create a basic report.

Configure the Connection to Couchbase

Connect to Couchbase by referencing the JDBC Driver class and constructing a connection string to use in the JDBC URL.

Step 1: Connection Information

driver = "cdata.jdbc.couchbase.CouchbaseDriver"
url = "jdbc:couchbase:User=myuseraccount;Password=mypassword;Server=http://mycouchbaseserver;"

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Couchbase JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.couchbase.jar

Fill in the connection properties and copy the connection string to the clipboard.

To connect using the Login method, set User, Password, and Server to the credentials for the account and the address of the server you want to connect to.

Load Couchbase Data

Once you configure the connection, you can load Couchbase data as a dataframe using the CData JDBC Driver and the connection information.

Step 2: Reading the data

remote_table = spark.read.format ( "jdbc" ) \
	.option ( "driver" , driver) \
	.option ( "url" , url) \
	.option ( "dbtable" , "Customer") \
	.load ()

Display Couchbase Data

Check the loaded Couchbase data by calling the display function.

Step 3: Checking the result

display (remote_table.select ("FirstName"))

Analyze Couchbase Data in Databricks

If you want to process data with Databricks SparkSQL, register the loaded data as a Temp View.

Step 4: Create a view or table

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

With the Temp View created, you can use SparkSQL to retrieve the Couchbase data for reporting, visualization, and analysis.

% sql

SELECT FirstName, TotalDue FROM SAMPLE_VIEW ORDER BY TotalDue DESC LIMIT 5

The data from Couchbase is only available in the target notebook. If you want to use it with other users, save it as a table.

remote_table.write.format ( "parquet" ) .saveAsTable ( "SAMPLE_TABLE" )

Download a free, 30-day trial of the CData JDBC Driver for Couchbase and start working with your live Couchbase data in Databricks. Reach out to our Support Team if you have any questions.