libriak-c

libriak-c is a C11 client library designed for interacting with Riak KV using both Protocol Buffers and HTTP interfaces. Built upon technologies such as protobuf-c, OpenSSL, libcurl, and json-c, this library provides a robust and efficient solution for managing key-value data.

Key Features

• Transport Protocols: Utilize either Protocol Buffers (port 8087) or HTTP (port 8098), both sharing the same API. Protocol Buffers offer persistent connections and deliver about 2–2.5 times the throughput compared to HTTP.
• Comprehensive Object Management: Perform essential operations such as getting, putting, deleting objects, managing metadata, and handling secondary index entries, links, and bucket types. Support for conditional requests and sibling resolution is also included.
• Advanced Query Capabilities: Leverage secondary indexes for paged and streamed queries, utilize the Riak Query API for aggregation and filtering, and perform MapReduce operations alongside link walking and object folds.
• Rich Data Type Support: Use a variety of data types including counters, sets, maps, HyperLogLogs, and grow-only sets, ensuring the flexibility needed for diverse applications.
• Cluster Management: Encompasses features like round-robin or failover node selection, automatic retries with backoff, and the ability to eject failing nodes for enhanced reliability.
• Asynchronous Operations: Supports asynchronous requests on a single thread while allowing hooks for external event loops, promoting efficient processing without blocking.
• Security and Compatibility: Ensures data security through verified TLS (HTTPS or STARTTLS), password authentication, and client certificates. Maintains binary compatibility with previous versions, ensuring applications built against earlier releases can run without modifications.
• Extensive Logging and Metrics: Incorporates logging and per-request metrics, facilitating easy tracking and performance optimization.
• Accessibility: Debian and RPM packages, along with CMake and pkg-config support, provide convenient installation options for various environments.

Example Usage

Integrating libriak-c into a project can be accomplished with minimal code:

#include <stdio.h>
#include <riak/riak.h>

int main(void) {
    riak_global_init();
    riak_config cfg;
    riak_config_init(&cfg); // Protocol Buffers, 127.0.0.1:8087
    riak_client *c;
    if (riak_client_new(&cfg, &c) != RIAK_OK)
        return 1;

    riak_opts o = {.content_type = "text/plain"};
    riak_put(c, "greetings", "hello", "world", 5, &o, NULL, NULL);

    riak_object obj;
    riak_status st = riak_get(c, "greetings", "hello", NULL, &obj);
    if (st == RIAK_OK) {
        printf("%.*s\n", (int)obj.len, obj.data);
        riak_object_free(&obj);
    } else {
        fprintf(stderr, "%s: %s\n", riak_strerror(st), riak_client_errmsg(c));
    }

    riak_client_free(c);
    riak_global_cleanup();
    return 0;
}

The library can be linked using pkg-config or integrated with CMake for streamlined development.

Documentation

Comprehensive guides and documentation are available in the docs/ directory, covering all aspects from getting started to detailed operation instructions, security guidelines, and testing. API references can be generated using Doxygen to aid in development and usage.

For contributions or reporting issues, guidelines are provided in CONTRIBUTING.md and SECURITY.md. This library stands as a powerful tool for developers working with Riak KV, offering versatile functionalities and robust performance.