Add CockroachDB examples (#46)

* Add CockroachDB examples

* Remove C++ binary

* Add missing Python README entries

* Indent continuation lines in docker run command

* Format Python example

* Add Java README in lieu of full example

---------

Co-authored-by: Emil Sadek <[email protected]>
Co-authored-by: Ian Cook <[email protected]>

Author: esadek

README.md

@@ -45,7 +45,9 @@ Simple examples showing how to use ADBC to connect, run a query, and return the
   - TiDB
   - Vitess
 - PostgreSQL
+  - CedarDB
   - Citus
+  - CockroachDB
   - CrateDB
   - Neon
   - ParadeDB

cpp/README.md

@@ -38,7 +38,9 @@ Simple C++ examples showing how to use ADBC to connect, run a query, and return
     - TiDB
     - Vitess
 - PostgreSQL
+  - CedarDB
   - Citus
+  - CockroachDB
   - CrateDB
   - Neon
   - ParadeDB

cpp/postgresql/README.md

@@ -22,7 +22,9 @@ This directory contains examples showing how to use ADBC to connect C++ applicat
 
 Any open source tool or vendor product that implements PostgreSQL frontend/backend protocol should work with the ADBC driver for PostgreSQL. The examples included here focus on the following systems:
 
+- CedarDB
 - Citus
+- CockroachDB
 - CrateDB
 - Neon
 - ParadeDB

cpp/postgresql/cockroachdb/CMakeLists.txt

@@ -0,0 +1,43 @@
+# Copyright 2025 Columnar Technologies Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+cmake_minimum_required(VERSION 3.15)
+project(cockroachdb_demo CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# Use conda environment paths
+if(DEFINED ENV{CONDA_PREFIX})
+    list(APPEND CMAKE_PREFIX_PATH "$ENV{CONDA_PREFIX}")
+endif()
+
+find_package(Arrow REQUIRED)
+
+add_executable(cockroachdb_demo main.cpp)
+
+if(DEFINED ENV{CONDA_PREFIX})
+    target_include_directories(cockroachdb_demo PRIVATE $ENV{CONDA_PREFIX}/include)
+    target_link_directories(cockroachdb_demo PRIVATE $ENV{CONDA_PREFIX}/lib)
+endif()
+
+target_link_libraries(cockroachdb_demo
+    adbc_driver_manager
+    Arrow::arrow_shared
+)
+
+target_compile_options(cockroachdb_demo PRIVATE
+    -Wall
+    -Werror
+)

cpp/postgresql/cockroachdb/Makefile

@@ -0,0 +1,24 @@
+# Copyright 2025 Columnar Technologies Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+CXXFLAGS = -std=c++17 -Wall -Werror -I$(CONDA_PREFIX)/include
+LIBS = -L$(CONDA_PREFIX)/lib -ladbc_driver_manager -larrow -Wl,-rpath,$(CONDA_PREFIX)/lib
+
+cockroachdb_demo: main.cpp
+	$(CXX) $(CXXFLAGS) -o cockroachdb_demo main.cpp $(LIBS)
+
+clean:
+	rm -f cockroachdb_demo
+
+.PHONY: clean

cpp/postgresql/cockroachdb/README.md

@@ -0,0 +1,105 @@
+<!--
+Copyright 2025 Columnar Technologies Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Connecting C++ and CockroachDB with ADBC
+
+## Instructions
+
+> [!TIP]
+> If you already have a CockroachDB instance running, skip the steps to set up and clean up CockroachDB.
+
+### Prerequisites
+
+1. [Install dbc](https://docs.columnar.tech/dbc/getting_started/installation/)
+
+2. [Install miniforge](https://github.com/conda-forge/miniforge)
+
+3. Create and activate a new environment with the required C++ libraries:
+
+    ```sh
+    mamba create -n adbc-cpp -c conda-forge cmake compilers libadbc-driver-manager libarrow
+
+    # Initialize mamba in your shell if not already done
+    eval "$(mamba shell hook --shell zsh)"
+    mamba activate adbc-cpp
+    ```
+
+    (`cmake` is only needed if you use CMake to build the C++ program below.)
+
+### Set up CockroachDB
+
+1. [Install Docker](https://docs.docker.com/get-started/get-docker/)
+
+2. Start a CockroachDB instance:
+
+    ```sh
+    docker run -d --rm \
+        --env COCKROACH_DATABASE=db \
+        --env COCKROACH_USER=username \
+        --env COCKROACH_PASSWORD=password \
+        --name=roach-single \
+        -p 26257:26257 \
+        -p 8080:8080 \
+        cockroachdb/cockroach:v25.4.2 start-single-node
+    ```
+
+### Connect to CockroachDB
+
+1. Install the PostgreSQL ADBC driver:
+
+    ```sh
+    dbc install --level user postgresql
+    ```
+
+2. Customize the C++ program `main.cpp` as needed
+    - Change the connection arguments in the `AdbcDatabaseSetOption()` calls
+        - Format `uri` according to the [connection URI format used by PostgreSQL](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS), or keep it as is
+    - If you changed which database you're connecting to, also change the SQL SELECT statement in `AdbcStatementSetSqlQuery()`
+
+3. Build and run the C++ program:
+
+    Using Make:
+    ```sh
+    make
+    ./cockroachdb_demo
+    ```
+
+    Or using CMake:
+    ```sh
+    cmake -B build
+    cmake --build build
+    ./build/cockroachdb_demo
+    ```
+
+### Clean up
+
+1. Clean build artifacts:
+
+    Using Make:
+    ```sh
+    make clean
+    ```
+
+    Using CMake:
+    ```sh
+    rm -rf build
+    ```
+
+2. Stop the Docker container running CockroachDB:
+
+    ```sh
+    docker stop roach-single
+    ```

cpp/postgresql/cockroachdb/main.cpp

@@ -0,0 +1,110 @@
+// Copyright 2025 Columnar Technologies Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// For EXIT_SUCCESS
+#include <cstdlib>
+// For strerror
+#include <cstring>
+#include <iostream>
+
+#include <arrow-adbc/adbc.h>
+#include <arrow-adbc/adbc_driver_manager.h>
+#include <arrow/c/bridge.h>
+#include <arrow/record_batch.h>
+
+// Error-checking helper for ADBC calls.
+// Assumes that there is an AdbcError named `error` in scope.
+#define CHECK_ADBC(EXPR)                                                       \
+  if (AdbcStatusCode status = (EXPR); status != ADBC_STATUS_OK) {              \
+    if (error.message != nullptr) {                                            \
+      std::cerr << error.message << std::endl;                                 \
+    }                                                                          \
+    return EXIT_FAILURE;                                                       \
+  }
+
+// Error-checking helper for ArrowArrayStream.
+#define CHECK_STREAM(STREAM, EXPR)                                             \
+  if (int status = (EXPR); status != 0) {                                      \
+    std::cerr << "(" << std::strerror(status) << "): ";                        \
+    const char *message = (STREAM).get_last_error(&(STREAM));                  \
+    if (message != nullptr) {                                                  \
+      std::cerr << message << std::endl;                                       \
+    } else {                                                                   \
+      std::cerr << "(no error message)" << std::endl;                          \
+    }                                                                          \
+    return EXIT_FAILURE;                                                       \
+  }
+
+int main() {
+  AdbcError error = {};
+
+  AdbcDatabase database = {};
+  CHECK_ADBC(AdbcDatabaseNew(&database, &error));
+
+  CHECK_ADBC(AdbcDatabaseSetOption(&database, "driver", "postgresql", &error));
+  CHECK_ADBC(AdbcDatabaseSetOption(&database, "uri",
+                                   "postgresql://username:password@localhost:26257/db", &error));
+  CHECK_ADBC(AdbcDriverManagerDatabaseSetLoadFlags(
+      &database, ADBC_LOAD_FLAG_DEFAULT, &error));
+  CHECK_ADBC(AdbcDatabaseInit(&database, &error));
+
+  AdbcConnection connection = {};
+  CHECK_ADBC(AdbcConnectionNew(&connection, &error));
+  CHECK_ADBC(AdbcConnectionInit(&connection, &database, &error));
+
+  AdbcStatement statement = {};
+  CHECK_ADBC(AdbcStatementNew(&connection, &statement, &error));
+
+  struct ArrowArrayStream stream = {};
+  int64_t rows_affected = -1;
+
+  CHECK_ADBC(
+      AdbcStatementSetOption(&statement, "adbc.postgresql.use_copy", "false", &error));
+  CHECK_ADBC(
+      AdbcStatementSetSqlQuery(&statement, "SELECT version()", &error));
+  CHECK_ADBC(
+      AdbcStatementExecuteQuery(&statement, &stream, &rows_affected, &error));
+
+  // Import stream as record batch reader
+  auto maybe_reader = arrow::ImportRecordBatchReader(&stream);
+  if (!maybe_reader.ok()) {
+    std::cerr << "Failed to import record batch reader: "
+              << maybe_reader.status().message() << std::endl;
+    return 1;
+  }
+
+  auto reader = maybe_reader.ValueOrDie();
+
+  while (true) {
+    auto maybe_batch = reader->Next();
+    if (!maybe_batch.ok()) {
+      std::cerr << "Error reading batch: " << maybe_batch.status().message()
+                << std::endl;
+      return 1;
+    }
+
+    auto batch = maybe_batch.ValueOrDie();
+    if (!batch) {
+      break;
+    }
+
+    std::cout << batch->ToString() << std::endl;
+  }
+
+  CHECK_ADBC(AdbcStatementRelease(&statement, &error));
+  CHECK_ADBC(AdbcConnectionRelease(&connection, &error));
+  CHECK_ADBC(AdbcDatabaseRelease(&database, &error));
+
+  return EXIT_SUCCESS;
+}

go/README.md

@@ -39,7 +39,9 @@ Simple Go examples showing how to use ADBC to connect, run a query, and return t
     - TiDB
     - Vitess
 - PostgreSQL
+  - CedarDB
   - Citus
+  - CockroachDB
   - CrateDB
   - Neon
   - ParadeDB

go/postgresql/README.md

@@ -22,7 +22,9 @@ This directory contains examples showing how to use ADBC to connect Go applicati
 
 Any open source tool or vendor product that implements PostgreSQL frontend/backend protocol should work with the ADBC driver for PostgreSQL. The examples included here focus on the following systems:
 
+- CedarDB
 - Citus
+- CockroachDB
 - CrateDB
 - Neon
 - ParadeDB