diff --git a/_images/cal_heatmap.png b/_images/cal_heatmap.png new file mode 100644 index 00000000000..bf79a9e237a Binary files /dev/null and b/_images/cal_heatmap.png differ diff --git a/_images/druid_agg.png b/_images/druid_agg.png new file mode 100644 index 00000000000..2d14e1e580a Binary files /dev/null and b/_images/druid_agg.png differ diff --git a/_images/horizon.png b/_images/horizon.png new file mode 100644 index 00000000000..7ccd90f3ff2 Binary files /dev/null and b/_images/horizon.png differ diff --git a/_sources/druid.txt b/_sources/druid.txt new file mode 100644 index 00000000000..5b4450cbeed --- /dev/null +++ b/_sources/druid.txt @@ -0,0 +1,48 @@ +Druid +===== + +Caravel works well with Druid, though currently not all +advanced features out of Druid are covered. This page clarifies what is +covered and what isn't and explains how to use some of the features. + +.. note :: + Currently Airbnb runs against Druid ``0.8.x`` and previous / + following versions are not tested against. + +Supported +''''''''' + +Aggregations +------------ + +Common aggregations, or Druid metrics can be defined and used in Caravel. +The first and simpler use case is to use the checkbox matrix expose in your +datasource's edit view (``Sources -> Druid Datasources -> +[your datasource] -> Edit -> [tab] List Druid Column``). +Clicking the ``GroupBy`` and ``Filterable`` checkboxes will make the column +appear in the related dropdowns while in explore view. Checking +``Count Distinct``, ``Min``, ``Max`` or ``Sum`` will result in creating +new metrics that will appear in the ``List Druid Metric`` tab upon saving the +datasource. By editing these metrics, you'll notice that they their ``json`` +element correspond to Druid aggregation definition. You can create your own +aggregations manually from the ``List Druid Metric`` tab following Druid +documentation. + +.. image:: _static/img/druid_agg.png + :scale: 50 % + +Post-Aggregations +----------------- + +Druid supports post aggregation and this works in Caravel. All you have to +do is creating a metric, much like you would create an aggregation manually, +but specify ``postagg`` as a ``Metric Type``. You then have to provide a valid +json post-aggregation definition (as specified in the Druid docs) in the +Json field. + + +Not yet supported +''''''''''''''''' + +- Regex filters +- Lookups / joins diff --git a/_static/img/druid_agg.png b/_static/img/druid_agg.png new file mode 100644 index 00000000000..2d14e1e580a Binary files /dev/null and b/_static/img/druid_agg.png differ diff --git a/_static/img/viz_thumbnails/cal_heatmap.png b/_static/img/viz_thumbnails/cal_heatmap.png new file mode 100644 index 00000000000..bf79a9e237a Binary files /dev/null and b/_static/img/viz_thumbnails/cal_heatmap.png differ diff --git a/_static/img/viz_thumbnails/horizon.png b/_static/img/viz_thumbnails/horizon.png new file mode 100644 index 00000000000..7ccd90f3ff2 Binary files /dev/null and b/_static/img/viz_thumbnails/horizon.png differ diff --git a/changelog.sh b/changelog.sh new file mode 100755 index 00000000000..d1d5a7922e5 --- /dev/null +++ b/changelog.sh @@ -0,0 +1,2 @@ +~/node_modules/github-changes/bin/index.js -o airbnb -r caravel --token ce8bb3bc4c2499b6bd0e3a4f84257211cca21d23 +#--between-tags 0.6.7...0.6.8 --only-pulls diff --git a/druid.html b/druid.html new file mode 100644 index 00000000000..1a89ecc262e --- /dev/null +++ b/druid.html @@ -0,0 +1,189 @@ + + + + + + + + Druid — caravel documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + Caravel Documentation + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+
+
+ + +
+ +
+

Druid

+

Caravel works well with Druid, though currently not all +advanced features out of Druid are covered. This page clarifies what is +covered and what isn’t and explains how to use some of the features.

+
+

Note

+

Currently Airbnb runs against Druid 0.8.x and previous / +following versions are not tested against.

+
+
+

Supported

+
+

Aggregations

+

Common aggregations, or Druid metrics can be defined and used in Caravel. +The first and simpler use case is to use the checkbox matrix expose in your +datasource’s edit view (Sources -> Druid Datasources -> +[your datasource] -> Edit -> [tab] List Druid Column). +Clicking the GroupBy and Filterable checkboxes will make the column +appear in the related dropdowns while in explore view. Checking +Count Distinct, Min, Max or Sum will result in creating +new metrics that will appear in the List Druid Metric tab upon saving the +datasource. By editing these metrics, you’ll notice that they their json +element correspond to Druid aggregation definition. You can create your own +aggregations manually from the List Druid Metric tab following Druid +documentation.

+_images/druid_agg.png +
+
+

Post-Aggregations

+

Druid supports post aggregation and this works in Caravel. All you have to +do is creating a metric, much like you would create an aggregation manually, +but specify postagg as a Metric Type. You then have to provide a valid +json post-aggregation definition (as specified in the Druid docs) in the +Json field.

+
+
+
+

Not yet supported

+
    +
  • Regex filters
    • +
  • Lookups / joins
    • +
+
+
+ + +
+ + + \ No newline at end of file