Description

A D Elasticsearch library with an API similar to the official Elasticsearch packages for other languages.

Package Information

Version1.0.7 (2016-Aug-17)
Repositoryhttps://github.com/intrica/elasticsearch-d
LicenseMIT
CopyrightCopyright © 2014, David Monagle
AuthorsDavid Monagle
Registered byDavid Monagle
Dependencies

vibe-d

feature-test-d

Installation

To use this package, put the following dependency into your project's dependencies section:

dub.json
dub.sdl

Readme

elasticsearch-d is a package modeled on the official Elasticsearch ruby client library. This one package contains both the transport and api packages.

While currently incomplete in terms of the API, the majority of the work has been done on the transport making most API implmentations trivial. Most API implementations just need a D function defined to take in the required parameters and pass them through to the transport layers.

While this package definitely needs more work, it seems very stable using the APIs that have been written so far. The APIs currently being used the mostly straightforward indices and base APIs.

This package also currently relies on vibe.d. Although it's quite possible with more work that this could be optional and a curl transport could be developed, the only functioning transport at this point is called VibeTransport. Also the package relies rather heavily on vibe.data.json (which could be replaced in future with a new phobos JSON candidate Finally elasticsearch-d also relies on the DictionaryList defined in vibe.d, because it was outside of the scope of the project to rewrite something like this.

I tried to make the API work exactly the same as the Ruby api, but although the overall design of the transport side of things should be able to remain consitent with the official packages, the API needs some more thought. Ruby allows named parameters in the form of a hash whereas there is no such thing in D. Elasticsearch endpoints can take a large number of optional parameters so a more elegant solution is required.

Because of all of this, I expect there will be breaking changes as I continue to keep it inline with elasticsearch development, as well as vibe.d and other packages. For the moment though, it works well with the implemented APIs.

Quick example

`D

import std.stdio;

import elasticsearch.api.actions.base;
import elasticsearch.api.actions.indices;

// The host structure defaults to connecting to localhost
auto client = new Client(Host());

Parameters p;
p.addField("index", "es_test_index");
p.addField("body", `
	{ 
		"settings": {
           "index": {
             "number_of_shards": 1,
             "number_of_replicas": 0,
           },
         },
         "mappings": {
           "user": {
             "properties": {
               "name": { "type": "string"}
             }
           }
         }			
	}
`);

auto user = Json.emptyObject;
user.name = "Ginny";
user._id = "1024";

client.createIndex(p);

// Index the user to the es_text_index container with a type of "user" and id of "1024"
client.index("es_test_index", "user", "1024", user.toString);

// Basic query


Parameters searchParams;
searchParams["body"] = "<elasticsearch query>";
searchParams["index"] = "es_test_index";

auto response = client.search(params);

puts response.jsonBody;

client.deleteIndex("es_test_index");

`

Available versions

1.0.7 1.0.6 1.0.5 1.0.4 1.0.3 1.0.2 1.0.1 1.0.0 ~master ~release