package esgg

Build not checked
  1. Overview
  2. Docs
Elasticsearch guided (code) generator

Install

dune-project
 Dependency

Authors

Maintainers

Sources

esgg-20190322.tar.gz
sha256=1bf9fce8d89e4a69dc46fb2fbf49fdc3e939721fe05377bb31171a8332ea2e40
md5=41dc1164f464e948c8f74f6ec5a27f23

Description

Tags

org:ahrefs

Added to opam-repository:

README

ElasticSearch Guided (code) Generator

Build Status

Development

Install dependencies with opam install --deps-only .

Buld with make

Variables

Syntax for variables in template json files is as follows:

  • $var for regular required variable
  • $var? for optional variable (minimal surrounding scope is conditionally expunged)
  • full form $(var:hint) where hint can be either list or list? currently

list hint is useful to chose between named (default) and unnamed dynamic filters

Tests

make test runs regression tests in test/ verifying that input and output atd generated from query stays unchanged. Once there is an expected change in generated query - it should be committed. Tests are easy to add and fast to run.

TODO tests to verify that:

 * code generated for query application of input variables does actually compile and produce correct query when run
* atd description of output (generated from query) can indeed unserialize ES output from that actual query

Conditions

Copyright (c) 2018 Ahrefs github@ahrefs.com

This project is distributed under the terms of GPL Version 2. See LICENSE file for full license text.

NB the output of esgg, i.e. the generated code, is all yours of course :)


2019-03-19

Dependencies (9)

  1. mybuild >= "4"
  2. ppx_deriving >= "4.2"
  3. jsonm
  4. easy-format
  5. atd >= "2.0.0" & < "4.0.0"
  6. extlib >= "1.7.1"
  7. yojson >= "1.7.0" & < "2.0.0"
  8. ocaml >= "4.04.0"
  9. dune >= "1.3."

Dev Dependencies

None

Optional Dependencies

None

Used by

None

Conflicts (1)

  1. dune = "1.4.0"

Build status

Results of building esgg with each compiler on check.ci.ocaml.org, run of against opam-repository 8d8d144. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

This version is not in the latest run; the versions below are.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
20260908 good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure