Quick Start

Follow these steps to get a local EloqStore build, issue your first requests, and run unit tests.

1. Install Prerequisites

• Linux kernel 6.8+ (Ubuntu 24.04 or equivalent) with io_uring enabled.
• Toolchain: cmake, gcc/clang, ninja (optional), pkg-config.
• Dependencies: run the helper script in the main repo (requires sudo):

  bash scripts/install_dependency_ubuntu2404.sh

2. Configure and Build

cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j$(nproc)

Set -DCMAKE_BUILD_TYPE=Debug if you prefer debug symbols.

3. Run the Basic Example

./build/examples/basic_example

This sample (see examples/basic_example.cpp) creates an EloqStore instance, performs async batch writes, then issues reads and scans. Inspect the source to see the pattern for KvOptions, TableIdent, ExecAsyn, and ExecSync usage.

4. Execute Your Own Requests

Include eloq_store.h in your application and follow the API Usage Guide for request construction rules. Minimum setup:

eloqstore::KvOptions opts;
opts.store_path = {"/tmp/eloq_store"};
opts.num_threads = 1;
eloqstore::EloqStore store(opts);
store.Start();
// Issue BatchWriteRequest / ReadRequest / ScanRequest
store.Stop();

5. Run Unit Tests

EloqStore tests rely on an S3-compatible backend such as MinIO. After starting MinIO on http://127.0.0.1:9090, and creating the eloqstore bucket, run:

ctest --test-dir build/tests

6. Next Steps

• Review the Overview for architecture and design rationale.
• Dive into the API Usage Guide for all request types and error codes.
• Check the EloqStore FAQ for answers to common integration questions.

With this workflow you can iterate quickly: edit code, rebuild with cmake --build build, and run either the example binary or your own application linked against EloqStore.