https://github.com/yugabytedb-samples/yugabyte-simple-c-app
A simple C app that connects to a YugabyteDB database cluster and performs basic CRUD operations.
https://github.com/yugabytedb-samples/yugabyte-simple-c-app
demos
Last synced: 5 months ago
JSON representation
A simple C app that connects to a YugabyteDB database cluster and performs basic CRUD operations.
- Host: GitHub
- URL: https://github.com/yugabytedb-samples/yugabyte-simple-c-app
- Owner: YugabyteDB-Samples
- License: apache-2.0
- Created: 2022-02-07T16:18:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T16:29:39.000Z (about 2 years ago)
- Last Synced: 2025-02-28T14:06:31.007Z (over 1 year ago)
- Topics: demos
- Language: C
- Homepage:
- Size: 205 KB
- Stars: 2
- Watchers: 61
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple C Application for YugabyteDB
This application connects to your YugabyteDB instance via the
[libpq](https://docs.yugabyte.com/latest/reference/drivers/ysql-client-drivers/#libpq) driver and performs basic SQL
operations. The instructions below are provided for [YugabyteDB Aeon](https://cloud.yugabyte.com/) deployments.
If you use a different type of deployment, then update the `sample-app.c` file with proper connection parameters.
## Prerequisites
* A 32-bit (x86) or 64-bit (x64) architecture machine. Use [Rosetta](https://support.apple.com/en-us/HT211861) to build and run on the Apple silicon.
* gcc 4.1.2 or later, clang 3.4 or later installed.
* [libpq](https://docs.yugabyte.com/latest/reference/drivers/ysql-client-drivers/#libpq) driver.
* OpenSSL library (used by libpq to establish secured SSL connections).
* Command line tool or your favourite IDE, such as Visual Studio Code.
## Start YugabyteDB Aeon Cluster
* [Start YugabyteDB Aeon](https://docs.yugabyte.com/latest/yugabyte-cloud/cloud-quickstart/qs-add/) instance. You can use
the free tier at no cost.
* Add an IP address of your machine/laptop to the [IP allow list](https://docs.yugabyte.com/latest/yugabyte-cloud/cloud-secure-clusters/add-connections/#manage-ip-allow-lists)
## Clone Application Repository
Clone the repository and change dirs into it:
```bash
git clone https://github.com/YugabyteDB-Samples/yugabyte-simple-c-app.git && cd yugabyte-simple-c-app
```
## Provide Cluster Connection Parameters
Locate and define the following configuration-related macros in the `sample-app.c` file:
* `HOST` - the hostname of your instance.
* `USER` - the username for your instance.
* `PASSWORD` - the database password.
* `SSL_MODE` - the SSL mode to use. YugabyteDB Aeon requires SSL connections; use `verify-full`.
* `SSL_ROOT_CERT` - a full path to your CA root cert (for example, `/Users/dmagda/certificates/root.crt`).
Note, you can easily find all the settings on the YugabyteDB Aeon dashboard:
## Run the Application
1. Install the libpq driver via [Homebrew package manager](https://formulae.brew.sh/formula/libpq) or using a [different method](https://www.postgresql.org/download/).
2. Replace the `{libpq-install-dir}` placeholder with your libpq installation root dir and build the application with `gcc` or `clang`:
```bash
gcc sample-app.c -o sample-app -I{libpq-install-dir}/libpq/include -L{libpq-install-dir}/libpq/lib -lpq
```
3. Run the application:
```bash
./sample-app
```
Upon successful execution, you will see output similar to the following:
```bash
>>>> Connecting to YugabyteDB!
>>>> Connected to YugabyteDB!
>>>> Successfully created table DemoAccount.
>>>> Selecting accounts:
name = Jessica, age = 28, country = USA, balance = 10000
name = John, age = 28, country = Canada, balance = 9000
>>>> Transferred 800 between accounts.
>>>> Selecting accounts:
name = Jessica, age = 28, country = USA, balance = 9200
name = John, age = 28, country = Canada, balance = 9800
```
## Explore Application Logic
Congrats! You've successfully executed a simple C app that works with YugabyteDB.
Now, explore the source code of `sample-app.c`:
1. `connect` function - establishes a connection with your cloud instance via the libpq driver.
2. `createDatabase` function - creates a table and populates it with sample data.
3. `selectAccounts` function - queries the data with SQL `SELECT` statements.
4. `transferMoneyBetweenAccounts` function - updates records consistently with distributed transactions.
## Questions or Issues?
Having issues running this application or want to learn more from Yugabyte experts?
Join [our Slack channel](https://communityinviter.com/apps/yugabyte-db/register),
or raise a question on StackOverflow and tag the question with `yugabytedb`!