arango-cpp

This is a lightweight ArangoDB client C++ library, providing CRUD and query operations using several databases and many collections on local and/or remote ArangoDB instances at the same time.

What arango-cpp can do?

ArangoDBCollectionAPI

• Use methods from this API for manipulating collections and documents within the database. The Collection API is valid for all Collection instances, regardless of their type (vertices or edges).

ArangoDBGraphAPI

• Use methods from this API for manipulating property graphs within one database (vertices and edges can be located in multiple collections).

ArangoDBUsersAPI

• Use methods from this API for managing (creating or deleting) users and databases.

For all methods and APIs, see headers "arangocollection.h", "arangograph.h" and "arangodbusers.h".

arango-cpp is written in C++20 using the open-source library Velocypack from ArangoDB. Version: currently 1.1. Will be distributed as is (no liability) under the terms of Lesser GPL v.3 license.

How to install the arango-cpp library

• Make sure you have g++, cmake and git installed. If not, install them (on Ubuntu Linux):

sudo apt-get install g++ cmake git libssl-dev

For Mac OSX, make sure you have Xcode and Homebrew installed (see Homebrew web site ).

• Download arango-cpp source code using git clone command:

git clone --recurse-submodules https://github.com/sdmytrievs/arango-cpp.git

• Install Dependencies

In order to build the arango-cpp library on Ubuntu Linux or MacOS, first execute the following (may ask your sudo password):

cd arango-cpp
./install-dependencies.sh

• Install the arango-cpp library (will ask your sudo password)

./install.sh

After that, headers and the library can be found in /usr/local/include/arango-cpp, /usr/local/lib/.

• To test arango-cpp execute:

mkdir build && \
cd build && \
cmake .. -DBULID_LOCAL_TESTS=ON -DBULID_REMOTE_TESTS=ON && \
make &&\
./tests/test_main

Install current version of ArangoDB server locally

• On (K)Ubuntu linux, install from here:

First, add the repository key to the apt database:

curl -OL https://download.arangodb.com/arangodb35/DEBIAN/Release.key
sudo apt-key add - < Release.key

Then use apt-get to install arangodb:

echo 'deb https://download.arangodb.com/arangodb35/DEBIAN/ /' | sudo tee /etc/apt/sources.list.d/arangodb.list
sudo apt-get install apt-transport-https
sudo apt-get update
sudo apt-get install arangodb3=3.5.0-1

The future updates will come together with other ubuntu packages installed.

• On MacOS Sierra or higher, navigate here and follow the instructions on how to install ArangoDB with homebrew. Briefly, you have to open a terminal and run two commands:

brew update
brew install arangodb

How to use arango-cpp (use cases)

#include <iostream>
#include "arango-cpp/arangocollection.h"
#include "arango-cpp/arangoexception.h"

int main(int, char* [])
{
    std::string databaseURL = "http://localhost:8529";
    std::string databaseName = "mydatabase";
    std::string collectionName = "mydocuments";

    try{
        // Set ArangoDB root connection data (URL, user name, password, database name)
        arangocpp::ArangoDBConnection root_data( databaseURL, "root", "", "_system");
        // Create a database root connection
        arangocpp::ArangoDBRootClient root_connect{root_data};

        // Define ArangoDB users
        arangocpp::ArangoDBUser dbuser( "myuser", "mypasswd", "rw");
        // Create a new database "mydatabase" (or get to existing one)
        root_connect.createDatabase(databaseName, {dbuser} );

        // Set ArangoDB connection data (URL, user name, password, database name)
        arangocpp::ArangoDBConnection mydb_data( databaseURL, dbuser.name, dbuser.password, databaseName);
        // Create a database connection
        arangocpp::ArangoDBCollectionAPI mydb_connect{mydb_data};

        // Create a new collection "mydocuments" (or get to existing one)
        mydb_connect.createCollection( collectionName, "vertex");

        // Set data to document
        std::string documentData = "{ \"_key\" : \"CRUD\", "
                                   "  \"baz\": [1, 2, 3], "
                                   "  \"foo\" : { \"baz\": \"boo\" } "
                                   "}";

        // Insert a new document into database collection and retrieve its handle (i.e. value of "_key" field)
        auto documentHandle = mydb_connect.createDocument( collectionName, documentData );

        // Read a document from database collection
        std::string readDocumentData;
        mydb_connect.readDocument( collectionName, documentHandle,  readDocumentData);

        // Modify the document in readDocumentData as a string or using any JSON parser
        ...

        // Save the modified document into database collection
        mydb_connect.updateDocument( collectionName, documentHandle, readDocumentData );

        // Delete the document from database collection
        mydb_connect.deleteDocument( collectionName, documentHandle );
    }

    catch(arangocpp::arango_exception& e)
    {
        std::cout << e.header() << e.what() <<  std::endl;
    }
    catch(std::exception& e)
    {
        std::cout <<  " std::exception" << e.what() <<  std::endl;
    }

    return 0;
}

For more information on APIs and more examples, take a look into the /examples directory.