https://github.com/yugabytedb-samples/yugabytedb-rust-examples
Rust examples for the usage of YugabyteDB.
https://github.com/yugabytedb-samples/yugabytedb-rust-examples
Last synced: 3 months ago
JSON representation
Rust examples for the usage of YugabyteDB.
- Host: GitHub
- URL: https://github.com/yugabytedb-samples/yugabytedb-rust-examples
- Owner: YugabyteDB-Samples
- Created: 2022-07-06T11:50:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-07T17:31:37.000Z (over 3 years ago)
- Last Synced: 2026-01-02T18:29:26.896Z (7 months ago)
- Language: Rust
- Size: 58.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rust examples for YugabyteDB
## YSQL
### Smart driver currently not available
Currently, YugabyteDB YSQL alias the PostgreSQL API does not have a YugabyteDB YSQL specific smart driver.
Not having a YSQL smart driver is not an issue for regular database usage, because YSQL tries to stay as close as possible to PostgreSQL,
and therefore the standard PostgreSQL drivers fully work with YugabyteDB YSQL.
However, this means that the YugabyteDB specific features that are in the JDBC driver are currently not available in the driver.
These functions are:
- Multiple hosts. To avoid having a single node for the initial connection.
- Cluster awareness. To enable uniform load balancing.
- Topology awareness. To be able to distribute connections using the topology decoration (cloud, region, zone).
- Configurable cluster topology refresh interval.
To express your interest for a Rust smart driver please share your interest with this [issue](https://github.com/yugabyte/yugabyte-db/issues/16657).
### pgcat (smart driver alternative)
However, there is a (next best) Rust based solution: [pgcat](https://github.com/postgresml/pcat).
Pgcat is a PostgreSQL pooler like PgBouncer, but adds features.
The main feature to overcome the absence of a native YugabyteDB YSQL driver, load balance new connections over multiple database endpoints,
can be achieved by using pgcat as a front-end or backend-end proxy/pooler.
See [this](https://dev.to/yugabyte/pgcat-a-postgresql-pooler-3a24) article on how to configure pgcat for connection distribution over YugabyteDB YSQL cluster endpoints.
### postgres
[Cargo project with examples](postgres)
### diesel
[Cargo project with examples](diesel)
### sqlx
[Cargo project with examples](sqlx)
## YCQL
### cassandra-cpp with the Yugabyte C++ driver
The cassandra-cpp driver for Rust uses the Cassandra C++ driver, and uses the functions in it via the Rust FFI (foreign functions interface).
The way the cassandra-cpp driver crate works is that it actually is a wrapper around the raw driver binding crate cassandra-cpp-sys, which provides the actual bindings.
The bindings use the functions provided by the libcassandra (C++) library.
#### driver installation
##### OSX
```shell
brew install autoconf automake cmake libtool libuv openssl zlib git
git clone https://github.com/yugabyte/cassandra-cpp-driver.git
cd cassandra-cpp-driver
mkdir build
pushd build
cmake ..
make
make install
popd
```
The `make install` command installs the driver (libcassandra.dylib) in `/usr/local/lib`.
##### Linux (EL)
EL7 (validated with Centos 7)
```shell
sudo yum install automake cmake gcc-c++ git libtool openssl-devel zlib-devel
sudo yum install https://downloads.datastax.com/cpp-driver/centos/7/dependencies/libuv/v1.35.0/libuv-1.35.0-1.el7.x86_64.rpm
sudo yum install https://downloads.datastax.com/cpp-driver/centos/7/dependencies/libuv/v1.35.0/libuv-devel-1.35.0-1.el7.x86_64.rpm
git clone https://github.com/yugabyte/cassandra-cpp-driver.git
cd cassandra-cpp-driver
mkdir build
pushd build
cmake ..
make
sudo make install
popd
```
The `make install` command install the driver (libcassandra.so) in `/usr/local/lib64`.
In order to make the dynamic loader find the library add the directory to the LD_LIBRARY_PATH environment variable:
```shell
export LD_LIBRARY_PATH=/usr/local/lib64
```
The error that is shown when the libcassandra.so driver is not in the path is:
```
target/debug/examples/local: error while loading shared libraries: libcassandra.so.2: cannot open shared object file: No such file or directory
```
##### Linux (EL)
EL8 (validated with Alma 8)
```shell
sudo yum install automake cmake gcc-c++ git libtool openssl-devel zlib-devel
sudo yum install https://downloads.datastax.com/cpp-driver/centos/8/dependencies/libuv/v1.35.0/libuv-1.35.0-1.el8.x86_64.rpm
sudo yum install https://downloads.datastax.com/cpp-driver/centos/8/dependencies/libuv/v1.35.0/libuv-devel-1.35.0-1.el8.x86_64.rpm
git clone https://github.com/yugabyte/cassandra-cpp-driver.git
cd cassandra-cpp-driver
mkdir build
pushd build
cmake ..
make
sudo make install
popd
```
The `make install` command installs the driver (libcassandra.so) in `/usr/local/lib64`, which is not in the default library path.
In order to make the dynamic loader find the library add the directory to the LD_LIBRARY_PATH environment variable:
```shell
export LD_LIBRARY_PATH=/usr/local/lib64
```
The error that is shown when the libcassandra.so driver is not in the path is:
```
target/debug/examples/local: error while loading shared libraries: libcassandra.so.2: cannot open shared object file: No such file or directory
```
[Cargo project with examples](cassandra-cpp).
----
### cassandra-cpp with the DataStax C++ driver
The cassandra-cpp driver for Rust uses the Cassandra C++ driver, and uses the functions in it via the Rust FFI (foreign function interface).
The way the cassandra-cpp driver crate works is that it actually is a wrapper around the raw driver binding crate cassandra-cpp-sys, which provides the actual bindings.
The bindings use the functions provided by the libcassandra (C++) library.
#### driver installation
##### OSX
```shell
brew install cassandra-cpp-driver openssl
```
##### Linux (EL)
EL8 (validated with Alma 8):
```shell
yum install https://downloads.datastax.com/cpp-driver/centos/8/cassandra/v2.16.0/cassandra-cpp-driver-2.16.0-1.el8.x86_64.rpm
```
EL7 (validated with Centos 7):
```shell
yum install https://downloads.datastax.com/cpp-driver/centos/7/cassandra/v2.16.0/cassandra-cpp-driver-2.16.0-1.el7.x86_64.rpm
```
[Cargo project with examples](cassandra-cpp).
----
### scylla
The scylla driver for Rust is a 'pure rust' driver, meaning it has no non-rust dependencies.
The scylla driver is an asynchronous driver.
The driver obviously is created for the Scylla database, but it can also be used for any Cassandra compatible database.
[Cargo project with examples](scylla).
---
# WARNING
Below are crates that are available, but are not active or do lack reasonable SSL support.
### cdrs
The cdrs driver for Rust is a 'pure rust' driver, meaning it has no non-rust dependencies.
[Cargo project with examples](cdrs).
Warning: the cdrs driver project asks for a new maintainer, and looks inactive.
### cdrs-tokio
The cdrs-tokio driver for Rust is a 'pure rust' driver, meaning it has no non-rust dependencies.
[Cargo project with examples](cdrs_tokio)
Warning: the cdrs-tokio driver project looks active, but seems to lack SSL/TLS support.
(tls support is a feature, which is not documented and throws crate version compatibility issues)
### cassandra
The cassandra crate is the original crate with bindings to the cassandra c++ driver, but has been abandoned.