Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zapr-oss/druidry
Java based Druid Query Generator library
https://github.com/zapr-oss/druidry
client database druid java query-builder
Last synced: 2 months ago
JSON representation
Java based Druid Query Generator library
- Host: GitHub
- URL: https://github.com/zapr-oss/druidry
- Owner: zapr-oss
- License: apache-2.0
- Created: 2017-05-05T10:25:55.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2023-08-06T20:28:33.000Z (over 1 year ago)
- Last Synced: 2024-10-31T11:31:39.598Z (3 months ago)
- Topics: client, database, druid, java, query-builder
- Language: Java
- Size: 585 KB
- Stars: 194
- Watchers: 15
- Forks: 89
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome to project Druidry!
=======================================
 [](https://www.apache.org/licenses/LICENSE-2.0.txt) [](https://javadoc.io/doc/in.zapr.druid/druidry)
Druid is an extremely popular tool to perform OLAP queries on event data. Druid drives real-time dashboards in most of the organisations right now. We@Zapr love Druid! Therefore we want to contribute towards making Druid, even more, friendlier to the ever expanding community.
We want to make the process of deep meaningful conversations with Druid little easier. What do we mean is that we don’t want developers to write big, scary JSON anymore but instead use a simple Java-based query generator to help with the querying.
Creating JSON freely can cause tedious bugs such as date type mistakes or spelling mistakes and potentially code can get bigger and messier and less readable. So, in reality, we want to keep the main focus of querying to be the use-case, not the type-checks.
We are excited to know whether you liked it or loved it, so please reach out to us at [email protected]
Description
-----------
Druidry is an open-source Java based utility library which supports creating query to Druid automatically taking care of following,
* Type checking.
* Spelling Checks.
* Code reviewability and readability.
This library is still growing and does not support each and every constructs, however it supports the most common one used internally @Zapr.
Getting Started
---------------
Prerequisite
-----------
* Maven
* Java 8
Usage
-----
Add this in your pom.xml (assuming maven based project)
```xml
in.zapr.druid
druidry
${LATEST_VERSION}
```
Replace ${LATEST_VERSION} with latest release version
Examples
--------
Taking from Druid's example query
```json
{
"queryType": "topN",
"dataSource": "sample_data",
"dimension": "sample_dim",
"threshold": 5,
"metric": "count",
"granularity": "all",
"filter": {
"type": "and",
"fields": [
{
"type": "selector",
"dimension": "dim1",
"value": "some_value"
},
{
"type": "selector",
"dimension": "dim2",
"value": "some_other_val"
}
]
},
"aggregations": [
{
"type": "longSum",
"name": "count",
"fieldName": "count"
},
{
"type": "doubleSum",
"name": "some_metric",
"fieldName": "some_metric"
}
],
"postAggregations": [
{
"type": "arithmetic",
"name": "sample_divide",
"fn": "/",
"fields": [
{
"type": "fieldAccess",
"name": "some_metric",
"fieldName": "some_metric"
},
{
"type": "fieldAccess",
"name": "count",
"fieldName": "count"
}
]
}
],
"intervals": [
"2013-08-31T00:00:00.000/2013-09-03T00:00:00.000"
]
}
```
```java
SelectorFilter selectorFilter1 = new SelectorFilter("dim1", "some_value");
SelectorFilter selectorFilter2 = new SelectorFilter("dim2", "some_other_val");
AndFilter filter = new AndFilter(Arrays.asList(selectorFilter1, selectorFilter2));
DruidAggregator aggregator1 = new LongSumAggregator("count", "count");
DruidAggregator aggregator2 = new DoubleSumAggregator("some_metric", "some_metric");
FieldAccessPostAggregator fieldAccessPostAggregator1
= new FieldAccessPostAggregator("some_metric", "some_metric");
FieldAccessPostAggregator fieldAccessPostAggregator2
= new FieldAccessPostAggregator("count", "count");
DruidPostAggregator postAggregator = ArithmeticPostAggregator.builder()
.name("sample_divide")
.function(ArithmeticFunction.DIVIDE)
.fields(Arrays.asList(fieldAccessPostAggregator1, fieldAccessPostAggregator2))
.build();
DateTime startTime = new DateTime(2013, 8, 31, 0, 0, 0, DateTimeZone.UTC);
DateTime endTime = new DateTime(2013, 9, 3, 0, 0, 0, DateTimeZone.UTC);
Interval interval = new Interval(startTime, endTime);
Granularity granularity = new SimpleGranularity(PredefinedGranularity.ALL);
DruidDimension dimension = new SimpleDimension("sample_dim");
TopNMetric metric = new SimpleMetric("count");
DruidTopNQuery query = DruidTopNQuery.builder()
.dataSource("sample_data")
.dimension(dimension)
.threshold(5)
.topNMetric(metric)
.granularity(granularity)
.filter(filter)
.aggregators(Arrays.asList(aggregator1, aggregator2))
.postAggregators(Collections.singletonList(postAggregator))
.intervals(Collections.singletonList(interval))
.build();
ObjectMapper mapper = new ObjectMapper();
String requiredJson = mapper.writeValueAsString(query);
```
``` java
DruidConfiguration config = DruidConfiguration
.builder()
.host("druid.io")
.endpoint("druid/v2/")
.build();
DruidClient client = new DruidJerseyClient(druidConfiguration);
client.connect();
List responses = client.query(query, DruidResponse.class);
client.close();
```
Supported Features
------------------
#### Queries
* Aggregation Queries
* TopN
* TimeSeries
* GroupBy
* DruidScanQuery
* DruidSelectQuery
#### Aggregators
* Cardinality
* Count
* DoubleMax
* DoubleMin
* DoubleSum
* DoubleLast
* DoubleFirst
* FloatFirst
* FloatLast
* Filtered
* HyperUnique
* Javascript
* LongMax
* LongMin
* LongSum
* LongFirst
* LongLast
* DistinctCount
* Histogram
* [Data Sketches](https://druid.apache.org/docs/latest/development/extensions-core/datasketches-extension.html)
* ThetaSketch
* TupleSketch
* QuantilesSketch
* HllSketchBuild
* HllSketchMerge
#### Filters
* And
* Bound
* In
* Interval (Without Extraction Function)
* Javascript
* Not
* Or
* Regex
* Search (Without Extraction Function)
* Selector
#### Post Aggregators
* Arithmetic
* Constant
* FieldAccess
* HyperUniqueCardinality
* Javascript
* [Data Sketches](https://druid.apache.org/docs/latest/development/extensions-core/datasketches-extension.html)
* [Theta Sketch](https://druid.apache.org/docs/latest/development/extensions-core/datasketches-theta.html)
* ThetaSketchEstimate
* ThetaSketchSetOp
* [Tuple Sketch](https://druid.apache.org/docs/latest/development/extensions-core/datasketches-tuple.html)
* TupleSketchToEstimate
* TupleSketchToEstimateAndBounds
* TupleSketchToNumEntries
* TupleSketchToMeans
* TupleSketchToVariances
* TupleSketchToQuantilesSketch
* TupleSketchSetOp
* TupleSketchTTest
* TupleSketchToString
* [Quantiles Sketch](https://druid.apache.org/docs/latest/development/extensions-core/datasketches-quantiles.html)
* QuantilesSketchToQuantile
* QuantilesSketchToQuantiles
* QuantilesSketchToHistogram
* QuantilesSketchToString
* [HLL Sketch](https://druid.apache.org/docs/latest/development/extensions-core/datasketches-hll.html)
* HllSketchEstimateWithBounds
* HllSketchUnion
* HllSketchToString
#### Virtual Columns
* Expression
#### Granularity
* Duration
* Period
* Predefined
Contact
------
For any features or bugs, please raise it in issues section
If anything else, get in touch with us at [[email protected]]([email protected])