C++ elasticlient library

C++ elasticlient library is simple library for simplified work with Elasticsearch in C++.

You can find some basic information - how to build library and how to use it in Readme.md file.

Provided features

Major provided classes

• elasticlient::Client - main library class which maintain connection to Elasticsearch cluster and implements methods which can be called on the cluster such as search, get, index, remove, etc. It takes care about choosing Elasticsearch node alive.
• elasticlient::Bulk - class which is able to perform bulk actions (Bulk API) on elasticlient::Client.
• elasticlient::Scroll - class which is able to use Scroll API on elasticlient::Client.
• elasticlient::ScrollByScan - class which is able to use Scroll API with DEPRECATED scan option on elasticlient::Client.

Helper functions

• elasticlient::setLogFunction(LogCallback extLogFunction) - function for set custom logging callback (for debugging purposes).

Helper enumerations

• elasticlient::LogLevel - logging levels, used for definition of seriousness of the log message

How to use the library

#include <string>
#include <vector>
#include <iostream>
#include <cpr/response.h>
#include <elasticlient/client.h>
 
 
int main() {
    // Prepare Client for nodes of one Elasticsearch cluster
    elasticlient::Client client({"http://elastic1.host:9200/"}); // last / is mandatory
 
    std::string document {"{\"message\": \"Hello world!\"}"};
 
    // Index the document, index "testindex" must be created before
    cpr::Response indexResponse = client.index("testindex", "docType", "docId", document);
    // 200
    std::cout << indexResponse.status_code << std::endl;
    // application/json; charset=UTF-8
    std::cout << indexResponse.header["content-type"] << std::endl;
    // Elasticsearch response (JSON text string)
    std::cout << indexResponse.text << std::endl;
 
    // Retrieve the document
    cpr::Response retrievedDocument = client.get("testindex", "docType", "docId");
    // 200
    std::cout << retrievedDocument.status_code << std::endl;
    // application/json; charset=UTF-8
    std::cout << retrievedDocument.header["content-type"] << std::endl;
    // Elasticsearch response (JSON text string) where key "_source" contain:
    // {"message": "Hello world!"}
    std::cout << retrievedDocument.text << std::endl;
 
    // Remove the document
    cpr::Response removedDocument = client.remove("testindex", "docType", "docId");
    // 200
    std::cout << removedDocument.status_code << std::endl;
    // application/json; charset=UTF-8
    std::cout << removedDocument.header["content-type"] << std::endl;
    // Elasticsearch response (JSON text string)
    std::cout << removedDocument.text << std::endl;
 
    return 0;
}

You can also find this and more examples of basic usage of library here.

Templated version of the constructor elasticlient::Client::Client accepts option arguments to set timeout, proxy servers or SSL. Just pass these instances to it in any order (just after vector of cluster nodes):

• elasticlient::Client::TimeoutOption - HTTP request timeout in ms.
• elasticlient::Client::ConnectTimeoutOption - Connect timeout in ms.
• elasticlient::Client::ProxiesOption - Proxy server settings.
• elasticlient::Client::SSLOption
  • elasticlient::Client::SSLOption::CertFile - path to the SSL certificate file.
  • elasticlient::Client::SSLOption::KeyFile - path to the SSL certificate key file.
  • elasticlient::Client::SSLOption::CaInfo - path to the CA bundle if custom CA is used.
  • elasticlient::Client::SSLOption::VerifyHost - verify the certificate's name against host.
  • elasticlient::Client::SSLOption::VerifyPeer - verify the peer's SSL certificate.