+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/faq.html b/faq.html
index d9625ffdea9..b94388217bd 100644
--- a/faq.html
+++ b/faq.html
@@ -1,131 +1,198 @@
+
+
-
-
-
-
-
-
- FAQ — caravel documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ FAQ — Caravel's documentation documentation
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Gallery — caravel documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ Gallery — Caravel's documentation documentation
-
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/gallery.html b/gallery.html
index 9a91ea522ff..84d652a523e 100644
--- a/gallery.html
+++ b/gallery.html
@@ -1,124 +1,199 @@
+
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
+ FAQ¶
@@ -216,17 +283,68 @@ be applied, it’s as simple as that.
-
-
-
- Index — caravel documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ Index — Caravel's documentation documentation
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/genindex.html b/genindex.html
index ec11f30dd8e..65d0c4bb3d3 100644
--- a/genindex.html
+++ b/genindex.html
@@ -1,139 +1,289 @@
+
+
-
-
-
-
-
-
-
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
@@ -152,17 +227,70 @@
-
-Gallery¶
@@ -152,17 +227,70 @@
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/index.html b/index.html
index fe027cf50c3..245d01b0905 100644
--- a/index.html
+++ b/index.html
@@ -1,222 +1,213 @@
+
+
-
-
-
-
-
-
- Overview — caravel documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ Caravel’s documentation — Caravel's documentation documentation
-
-
-
-
+
-
-
-Installation & Configuration — caravel documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ Installation & Configuration — Caravel's documentation documentation
-
-
-
-
-
- -
-
-
-
-
-
-
-
-
-
- 
-
-
-
-
-
-
- Caravel
-- an open source data visualization platform -
-
- 
-
-
-
-
- Explore your data -
-- Intuitively navigate your data while slicing, dicing, and - visualizing through a rich set of widgets -
-
-
-
-
-
-
- Create and share dashboards
-Assemble many data visualization "slices" into a rich collection
-
- 
-
-
-
-
- Extend
-Join the community and take part in extending the widget library
-
- 
-
-
-
-
- Connect
-- Access data from MySql, Presto.db, Postgres, RedShift, Oracle, MsSql, - SQLite, and more through the SqlAlchemy integration. You can also - query realtime data blazingly fast out of Druid.io -
-
-
-
- Previous
-
-
-
- Next
-
-
- -
-
-
-
-
- Caravel
-- is an open source data visualization platform that provides easy - exploration of your data and allows you to create and share - beautiful charts and dashboards -
-
-
- 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/installation.html b/installation.html
index 93bf9302a16..73da62adeee 100644
--- a/installation.html
+++ b/installation.html
@@ -1,143 +1,199 @@
+
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
-
+
+
- Caravel’s documentation¶
+Caravel is a data exploration platform designed to be visual, intuitive +and interactive.
+
+Warning
-This project used to be name Panoramix and has been renamed +
This project used to be named Panoramix and has been renamed to Caravel in March 2016
-
Overview¶
+Overview¶
-
+
+
+
+
+
+Features¶
+Features¶
- A rich set of data visualizations, integrated from some of the best visualization libraries @@ -233,9 +224,16 @@ to the user
- Integration with most RDBMS through SqlAlchemy
- Deep integration with Druid.io
+
+
+
-
SQL Lab
+
Videos
+Contents¶
+Contents¶
- Installation & Configuration
-
@@ -265,6 +263,11 @@ to the user
- Customizing
- Quick Intro
- Dashboard Creation @@ -294,27 +297,79 @@ to the user
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- Search — caravel documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
+
-
-
-
-
-
-
-
-
+ Search — Caravel's documentation documentation
-
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/objects.inv b/objects.inv
index 7ff99299ce1..35838c5bf46 100644
--- a/objects.inv
+++ b/objects.inv
@@ -1,12 +1,5 @@
# Sphinx inventory version 2
-# Project: caravel
+# Project: Caravel's documentation
# Version:
# The remainder of this file is compressed using zlib.
-xm
-0
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
-
+
+ Installation & Configuration¶
@@ -464,6 +520,10 @@ broker for which we recommend using Redis or RabbitMQ.
It’s also preferable to setup an async result backend as a key value store that can hold the long-running query results for a period of time. More details to come as to how to set this up here soon.
+SQL Lab supports templating in queries, and it’s possible to override
+the default Jinja context in your environment by defining the
+JINJA_CONTEXT_ADDONS in your caravel configuration. Objects referenced
+in this dictionary are made available for users to use in their SQL.
Making your own build¶
@@ -482,17 +542,70 @@ python setup.py install
-
-
-
+
-
- Security — caravel documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ Security — Caravel's documentation documentation
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/searchindex.js b/searchindex.js
index 49662558988..90b2333332c 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({envversion:47,filenames:["druid","faq","gallery","index","installation","security","tutorial","videos"],objects:{},objnames:{},objtypes:{},terms:{"1thisismyscretkei":4,"3aclos":1,"3aexampl":1,"64bit":[],"__from":1,"__to":1,"abstract":1,"case":[0,4],"default":[1,4],"function":[3,4],"import":1,"long":4,"new":[0,1,5,6,7],"return":[1,4],"short":7,"switch":4,"true":4,"while":[0,4],abl:[4,5],about:[1,4,6],abov:1,accept:1,access:[],account:4,action:[4,5],activ:4,add:[],addit:4,admin:[],administr:[],advanc:[0,4],affect:[1,7],after:[1,4],against:0,ago:6,airbnb:[0,1],airpal:[],all:[0,1,4,5],all_datasource_access:5,all_read_write_access:[],allow:[1,3,4,5],alreadi:[4,7],also:[1,4,5,6],alter:[5,6,7],analysi:1,analyt:4,ani:[1,5,6],annot:[],anoth:5,api:[1,4],app:4,appbuild:[3,5],appear:0,appli:[1,7],applic:[4,5],apt:4,arbitrari:[1,6],around:6,arrai:1,aspect:7,asset:4,assign:5,associ:5,assum:[4,5],assumpt:5,async:4,asynchron:4,attempt:4,attribut:5,authent:[3,5],author:[],autocomplet:[],automag:5,avail:[3,5,7],avoid:1,awar:4,back:[4,6],backend:4,background:[],balanc:[],bar:6,base:5,basic:6,bat:[],batch:1,becaus:1,been:[3,5,6],behind:[],benefit:[],best:[3,5],better:4,beyond:4,bin:4,binari:4,bit:4,blob:[1,4],bottom:5,boundari:1,box:1,brew:4,bring:4,broker:4,brows:[],browser:4,build:[],builder:4,built:5,bundl:4,button:[5,6],cach:[],cache_config:4,call:4,can:[],can_add:5,can_delet:5,can_edit:5,can_list:5,can_show:5,cannot:5,capabl:1,caravel:[],caravel_config:[1,4],caravel_hom:4,caravel_webserver_port:4,caravel_work:4,categori:5,celeri:4,central:[],certain:[1,7],cflag:4,chanc:4,chang:4,chart:7,check:[0,1,5,6],checkbox:[0,1,5,6],clarifi:0,click:[0,5,6],client:4,cluster1:5,cluster:4,code:1,collect:[5,6,7],column:[0,1,6],com:[1,4],come:[1,4,5,7],command:4,comment:[],common:0,compat:4,complementari:5,compli:4,compos:5,computation:[],concept:4,config:4,configur:[],confin:4,confirm:5,connect:[4,6],connect_arg:4,consist:4,consolid:5,constant:4,construct:6,consult:4,consum:5,contain:[1,4],contribut:1,control:3,copi:4,cor:[],correctli:4,correspond:0,cors_opt:4,corydolphin:4,could:[5,6],count:0,country_nam:1,cover:0,creat:[],create_engin:4,creation:[],credenti:4,criteria:[1,4],cryptographi:4,csrf:4,csrf_enabl:4,css:[],cta:[],current:[0,5],custom:[],cut:6,cx_oracl:4,dai:[],dashboard:[],databas:[],dataset:[3,5,7],datasourc:[0,1,4,5],datasource1:5,date:[1,5,6],deactiv:4,deal:1,debian:4,deep:3,deeper:[],defin:[],definit:0,delet:5,democrat:[],demonstr:7,deni:5,depart:5,depend:[],deploi:4,deriv:[4,7],descend:1,describ:4,design:[],detail:4,dev:4,devel:4,develop:[4,5],dialect:4,differ:[1,4,5,6,7],dimens:[6,7],directli:[1,4],displai:3,disregard:1,distinct:[0,1],distribut:1,doc:[0,4],document:[0,4,6],doe:[4,5],don:1,done:[4,6],down:[1,3],download:4,driver:4,drop:3,dropdown:[0,1,5,6],durat:4,dynam:[],each:5,earli:[],easi:[1,4],easier:1,easili:6,edit:[0,1,4,5,6],editor:6,effect:1,either:6,elb:4,element:[0,4],employe:[],enabl:[1,4,5],enable_cor:4,enable_proxy_fix:4,encount:4,encrypt:4,endpoint:4,engin:[],engine_param:4,enough:1,ensur:4,enter:[4,6],enterpris:3,entiti:[4,5],entri:6,env:4,environ:4,era:[],error:[4,5],essenti:4,even:[],eventu:4,everyth:4,evolv:5,exampl:[1,4,5],exce:4,except:4,execut:[1,4,5],exist:[4,5,7],exit:4,expanded_slic:1,experi:1,explain:0,explor:[0,4,5,6,7],expos:[0,4,5,7],express:[],extens:[3,4],extra:4,extract:4,extrem:[],fab:5,fabmanag:4,factor:1,fall:4,fashion:1,fast:1,featur:[],fedora:4,fetch:6,few:[1,4,5,6],field:[0,1,3,4,5,6],figur:6,file:4,filesystem:4,fill:6,filter:[],filter_immune_slic:1,filter_immune_slice_field:1,financ:5,find:[4,6],first:[0,5,6],fix:5,flag:[1,4],flask:[3,4,5],flow:[],focuss:[],follow:[0,4],fork:4,form:[1,4,6],forward:4,found:6,foundat:5,frame:1,framework:[1,4,5],from:[0,1,3,4,5,6,7],full:[],futur:[],gamma:[],gatewai:1,gather:5,gcc:4,get:[],gigant:1,github:1,give:[1,5],global:4,goe:4,good:1,googl:4,grant:5,granular:[3,5],great:5,group:1,groupbi:0,grow:[],guess:6,gunicorn:4,handl:[4,5],happen:[1,5],hard:6,have:[0,4,5],header:4,health:4,healthcheck:4,here:[4,5,6,7],high:[3,7],histori:[],hit:[4,6],hive:4,hold:4,hostnam:4,hour:4,how:[],html:4,http:[1,4],icon:6,immun:7,impala:4,implement:4,impyla:4,includ:[4,5],increas:1,index:3,individu:[3,5],inform:[4,6],init:4,initi:[],insert:4,insid:4,instal:[],instanc:4,instruct:[],integr:[],intend:4,intens:[],interact:1,interest:6,intern:[],intric:3,intro:[],isn:[0,4],issu:1,item:[4,5],iter:[],itself:[4,5],jdbc:4,join:[],json:[0,1,4],just:[4,6],keep:[],kei:[1,4],keyword:[1,4],know:4,lab:[],label:1,lai:[],languag:[6,7],larg:[1,4],latest:4,layer:[1,3],ldap:3,ldflag:4,let:6,level:[1,4,5,7],lib:4,libffi:4,libldap2:4,librari:[3,4],libsasl2:4,libssl:4,light:[],like:[0,1,5],limit:[1,5],linear:6,list:[0,1,4,5,6],load:[],load_exampl:4,local:4,localhost:4,logic:[1,4],login:4,look:5,lookup:0,macro:[],made:[3,5],mai:[1,4,5,6],main:[1,4],major:3,make:[],manag:[],mani:[1,4,5],manual:0,mapbox_api_kei:[1,4],march:3,markdown:7,materi:1,matrix:0,matter:[],max:0,maximum:4,meantim:1,memcach:4,memori:4,mention:1,menu:[4,5,6],messag:5,metadata:[1,4,6],metadata_param:4,metric:[],might:[1,5],min:0,minut:4,mission:[],modal:6,model:[3,5],modern:4,modul:[3,4],moment:6,more:[1,4,5],most:[1,3],mostli:5,moto:[],move:6,mssql:4,much:0,multifold:[],must:4,mysql:4,mysqlclient:4,name:[1,3,5,6],natur:6,navig:[4,6,7],necessari:4,need:[1,4,5,6],never:1,newli:[],next:[4,6],nginx:4,nice:[],non:[],note:[1,4,5,6],notic:0,now:[1,6],npm:4,oauth:3,object:[4,5],off:[],offici:4,often:[],onc:[4,6],onli:[1,5],openid:3,openldap:4,openssl:4,oper:4,option:[4,6],oracl:4,order:4,org:4,origin:6,osx:4,other:[4,5,6,7],otherwis:4,out:[],overtim:[],own:[],packag:4,page:[0,3,5],panoramix:3,paramet:4,part:4,partit:[],pass:4,password:4,past:4,path:4,pem:4,pen:6,peopl:[1,5],per:[],perform:1,perhap:5,period:4,permiss:[],petabyt:[],pick:6,pip:[],pkg:4,place:4,plai:4,plan:1,platform:4,pleas:4,plu:[5,6],point:4,popul:[1,4],popup:6,port:4,posit:6,possibl:[1,4,5],postagg:0,postgr:[],postgresql:4,power:[4,5],practic:1,prefer:4,prefix:4,presto:4,pretti:[],previou:0,probabl:5,process:1,prod:4,product:4,profil:5,project:[3,4],proto:4,provid:[],proxi:4,psycopg2:4,pull:1,purpos:4,put:4,pyhiv:4,pylibmc:4,pymssql:4,pypi:4,python:[],pythonpath:4,pyvenv:4,quick:[],rabbitmq:4,ran:[],random:4,rapid:5,ration:[],rdbm:3,read_only_some_t:[],readi:3,reason:[],receiv:1,recommend:[4,5],record:5,redi:4,redshift:[],refer:[4,6],refresh:[1,4],refresh_druid:4,regex:0,regist:1,rel:[5,6],relat:[0,5],releas:[],relev:6,remote_us:3,renam:[3,6],replac:[],repo:4,request:[1,4],requir:4,reserv:1,resiz:6,respons:4,restrict:[],result:[0,1,4],revenu:5,revers:4,revok:5,rhel:4,rich:3,right:[4,5,6],roadmap:[],role:[],root:4,row:5,row_limit:4,rule:3,run:[0,1,4],runserv:[1,4],sai:5,same:6,save:[0,5,6],scale:[],scan:1,schedul:1,schema:[],script:4,search:[3,5],searchabl:6,searchpath:4,second:[1,4,5],secret:4,secret_kei:4,secur:[],see:[1,5,6],select:[5,6],semant:[3,7],sensit:5,serv:1,server:[1,4],set:[3,4,5],setup:[],setuptool:4,share:[1,3],she:5,ship:[4,5],should:[1,3,4,6],show:[1,3,4,6,7],shown:6,side:4,sign:[4,5,6],similar:6,simpl:[1,3,4,5,7],simplecach:4,simpler:0,simpli:[5,6],singl:[1,5],size:6,slice:[],slice_id:1,sliceid:1,slow:1,small:1,smart:[],smooth:[],smoother:[],solid:[],solut:1,some:[],sometim:5,soon:[4,7],sort:1,sourc:[],sparksql:4,speak:[],specif:[1,4,5],specifi:[0,1,4],sql:[],sqlalchemi:[],sqlalchemy_database_uri:4,sqlite:4,ssl:[],sslmode:4,sslrootcert:4,stai:5,standard:4,start:[],statement:[],statu:5,step:[4,6],store:4,straightforward:4,string:4,strong:[],style:6,subscrib:[],success:[],sudo:4,sum:0,summari:[],sure:[4,5,6],surfac:[],syntax:4,system:4,tab:[0,5,6],tag:1,take:6,target:[],tell:6,temp:4,templat:7,terabyt:1,teradata:[],test:[0,4,6],textbox:6,thei:[0,4,5],them:[4,5,6,7],theme:[],thi:[0,1,3,4,5,6,7],thing:6,those:[1,5],though:[0,4,5],through:[1,3,4,5,6,7],timeout:[1,4],tini:6,tmp:[],todai:[],toggl:7,tool:[],top:[1,4,5,6],track:[],transcend:[],transform:1,tri:6,tutori:[],tweak:4,twice:1,type:[0,4,5,6],typeahead:5,typic:4,ubuntu:4,ultim:4,uncommon:4,unfortun:4,union:[1,5],unpack:4,until:6,updat:[],upgrad:[],upon:[0,5],uri:[4,6],user:[1,3,4,5],utilis:4,valid:0,valu:[1,4],vcvarsal:[],venv:4,veri:[4,5],version:[0,4],vertica:[],video:[],view:[0,1,4,5,6,7],virtual:1,virtualenv:[],wai:5,walk:7,walkthrough:7,want:[1,4,5,6],web:[1,4,5],webserv:4,week:6,well:[0,4,5,6],were:5,what:[0,1,4],wheel:4,when:[1,5,6],where:[1,4,6],whether:[1,4],which:[1,3,4,6],who:3,widget:[1,7],window:[4,5,6],within:5,without:5,won:[1,4],work:[0,1,4,6,7],worker:4,workflow:[],workspac:[],world:4,would:[0,1,4,5],write:[],wtf:4,x86_amd64:[],year:6,you:[0,1,4,5,6,7],your:[],yourself:1,yum:4},titles:["Druid","FAQ","Gallery","Overview","Installation & Configuration","Security","Tutorial","Videos"],titleterms:{access:[4,5],add:1,admin:5,aggreg:0,alpha:5,annot:7,balanc:4,behind:4,big:1,build:4,cach:4,can:1,caravel:4,configur:4,content:3,cor:4,creat:1,creation:7,css:7,custom:[5,7],dashboard:[1,7],data:[1,5],databas:4,deeper:4,defin:7,depend:4,druid:[0,4],dynam:1,express:7,faq:1,featur:3,filter:[1,7],galleri:2,gamma:5,get:4,how:1,indic:3,initi:4,instal:4,integr:4,intro:7,join:1,lab:4,load:4,make:4,manag:5,map:1,mapbox:1,metric:5,multipl:1,out:1,overview:3,own:[1,4],per:5,permiss:5,pip:4,post:0,postgr:4,provid:5,python:4,queri:1,quick:7,redshift:4,restrict:5,role:5,schema:4,secur:5,setup:4,slice:7,some:5,sourc:[1,5],sql:[4,7],sqlalchemi:4,ssl:4,start:4,subset:5,support:0,tabl:[1,3,7],theme:7,time:1,tool:4,tutori:6,upgrad:4,video:7,virtualenv:4,visibl:1,visual:1,why:1,yet:0,your:4}})
\ No newline at end of file
+Search.setIndex({envversion:49,filenames:["druid","faq","gallery","index","installation","security","sqllab","tutorial","videos"],objects:{"caravel.jinja_context":{PrestoContext:[6,0,1,""]},"caravel.jinja_context.PrestoContext":{latest_partition:[6,1,1,""],latest_sub_partition:[6,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"1thisismyscretkei":4,"3aclose":1,"3aexampl":1,"abstract":1,"case":[0,4],"class":6,"default":[1,4],"function":[3,4],"import":1,"long":[4,6],"new":[0,1,5,7,8],"return":[1,4,6],"short":8,"switch":4,"true":4,"while":[0,4],__from:1,__to:1,abl:[4,5],about:[1,4,6,7],abov:1,accept:1,access:[],account:4,action:[4,5],activ:4,adding:[],addit:4,admin:[],advanc:[0,4],affect:[1,8],after:[1,4],against:0,aggreg:[0,3,5,7],ago:7,airbnb:[0,1],all:[0,1,4,5,6],all_datasource_access:5,allow:[1,3,4,5,6],alreadi:[4,8],also:[1,4,5,6,7],alter:[5,7,8],analysi:1,analyt:4,ani:[1,6,7],annot:8,annotat:[],anoth:5,any:5,api:[1,4],app:4,appbuilder:[3,5],appear:0,appli:[1,6,8],applic:[4,5],apt:4,arbitrari:[1,7],argument:6,around:7,arrai:1,aspect:8,asset:4,assign:5,associ:5,assum:[4,5],assumpt:5,async:4,asynchron:4,attempt:4,attribut:5,authent:[3,5],automag:5,avail:[3,4,5,8],avoid:1,awar:4,aws:4,back:[4,7],backend:[4,6],balanc:[],bar:7,base:5,basic:7,batch:1,becaus:1,been:[3,5,7],behind:[],best:[3,5],better:4,beyond:4,bin:4,binari:4,bit:4,blob:[1,4],both:6,bottom:5,boundari:1,box:1,brew:4,bring:4,broker:4,brows:6,browser:4,build:[],builder:4,built:5,builtin:6,bundl:4,button:[5,7],cach:[],cache_config:4,call:4,can:[],can_add:5,can_delet:5,can_edit:5,can_list:5,can_show:5,cannot:5,capabl:[1,6],caravel:[],caravel_config:[1,4],caravel_home:4,caravel_webserver_port:4,caravel_workers:4,categori:5,celeri:[4,6],certain:[1,6,8],cflags:4,chanc:4,chang:4,chart:8,check:[0,1,5,7],checkbox:[0,1,5,7],clarifi:0,click:[0,5,6,7],client:4,cluster1:5,cluster:4,code:[1,6],collect:[5,7,8],column:[0,1,6,7],com:[1,4],come:[1,4,5,6,8],command:4,common:0,compat:4,complementari:5,compli:4,compos:5,concept:4,config:4,configur:[],confin:4,confirm:5,connect:[4,6,7],connect_arg:4,consist:4,consolid:5,constant:4,construct:7,consult:4,consum:5,contain:[1,4],context:[4,6],contribut:1,control:3,copi:4,cor:4,correctli:4,correspond:0,cors:[],cors_options:4,corydolphin:4,could:[5,7],count:0,country_nam:1,cover:0,creat:[],create_engin:4,creation:[],credenti:4,criteria:[1,4,6],cryptographi:4,csrf:4,csrf_enabled:4,css:[],current:[0,5],custom:[],cut:7,cx_oracl:4,databas:[],dataset:[3,5,8],datasourc:[0,1,4,5],datasource1:5,date:[1,5,7],datetim:6,deactiv:4,deal:1,debian:4,deep:3,deeper:[],defin:[],definit:0,delet:5,demonstr:8,deni:5,depart:5,depend:[],deploi:4,deriv:[4,8],descend:1,describ:[4,6],design:3,detail:4,dev:4,devel:4,develop:[4,5],dialect:4,dictionari:4,differ:[1,4,5,7,8],dimens:[7,8],directli:[1,4],dispatch:6,displai:3,disregard:1,distinct:[0,1],distribut:[1,6],doc:[0,4],document:[],doe:[4,5],don:1,done:[4,7],down:[1,3],download:4,driver:4,drop:3,dropdown:[0,1,5,7],durat:4,each:5,easi:[1,4],easier:1,easili:[6,7],edit:[0,1,4,5,7],editor:7,effect:1,either:7,elb:4,element:[0,4],enabl:[1,4,5],enable_cors:4,enable_proxy_fix:4,encount:4,encrypt:4,endpoint:4,engin:6,engine_param:4,enough:1,ensur:4,enter:[4,7],enterpris:3,entiti:[4,5],entri:7,env:4,environ:[4,6],error:[4,5],essenti:4,event_categori:6,event_typ:6,eventu:4,everyth:4,evolv:5,exampl:[1,4,5,6],exce:4,except:[4,6],execut:[1,4,5,6],exist:[4,5,8],exit:4,expanded_slic:1,experi:1,explain:0,explor:[0,3,4,5,7],explore:[7,8],expos:[0,4,5,6,8],express:[1,7],expression:[],extens:[3,4],extra:4,extract:4,fab:5,fabmanag:4,factor:1,fall:4,fashion:1,fast:1,featur:[],fedora:4,fetch:7,few:[1,4,5,7],field:[0,1,3,4,5,6,7],figur:7,file:4,filesystem:4,fill:7,filter:[],filter_immune_slic:1,filter_immune_slice_field:1,financ:5,find:[4,6,7],first:[0,5,7],fix:5,flag:[1,4],flask:[3,4,5],flow:6,follow:[0,4],foo_tabl:6,fork:4,form:[1,4,7],forward:4,found:7,foundat:5,frame:1,framework:[1,4,5],from:[0,1,3,4,5,6,7,8],fulli:6,gamma:[],gatewai:1,gather:5,gcc:4,gener:6,get:[],gigant:1,github:1,give:[1,5],global:4,goe:4,good:1,googl:4,grant:5,granular:[3,5],great:5,group:1,groupbi:0,guess:7,gunicorn:4,handl:[4,5,6],happen:[1,5],hard:7,have:[0,4,5],header:4,health:4,healthcheck:4,here:[4,5,6,7,8],high:[3,8],hit:[4,7],hive:4,hold:4,hostnam:4,hour:4,how:[],html:4,http:[1,4],icon:7,ide:[4,6],immun:8,impala:4,implement:4,impyla:4,includ:[4,5],increas:1,index:[3,6],individu:[3,5],inform:[4,7],init:4,initi:[],initial:4,insert:4,insid:4,instal:[],install:4,installat:[],instanc:4,integr:[],integrat:3,intend:4,interact:[1,3],interest:7,intric:3,intro:[],intuit:3,isn:[0,4],issu:1,item:[4,5],itself:[4,5],jdbc:4,jinja:[],jinja_context:6,jinja_context_addons:4,join:[],json:[0,1,4],just:[4,6,7],kei:[1,4],keyword:[1,4,6],know:4,kwarg:6,lab:[],label:1,languag:[6,7,8],larg:[1,4],latest:[4,6],latest_partit:6,latest_sub_partit:6,layer:[1,3],ldap:3,ldflags:4,let:7,level:[1,4,5,8],lib:4,libffi:4,libldap2:4,librari:[3,4,6],libsasl2:4,libssl:4,like:[0,1,5],limit:[1,5],linear:7,list:[0,1,4,5,6,7],load:[],load_exampl:4,local:4,localhost:4,logic:[1,4],login:4,look:5,lookup:0,made:[3,4,5],mai:[1,4,5,7],main:[1,4],major:3,make:[],manag:[],mani:[1,4,5,6],manual:0,mapbox_api_key:[1,4],march:3,markdown:8,materi:1,matrix:0,max:[0,6],maximum:4,meantim:1,memcach:4,memori:4,mention:1,menu:[4,5,7],messag:5,metadata:[1,4,6,7],metadata_param:4,method:6,metric:[],might:[1,5],min:0,minut:4,modal:7,model:[3,5],modern:[4,6],modul:[3,4,6],moment:7,more:[1,4,5,6],most:[1,3],mostli:5,move:7,mssql:4,much:0,multi:6,must:4,my_tabl:6,mysql:4,mysqlclient:4,name:[1,3,5,6,7],namespac:6,natur:7,navig:[4,7,8],necessari:4,need:[1,4,5,6,7],never:1,next:[4,7],nginx:4,note:[1,4,5,7],notic:0,now:[1,7],npm:4,oauth:3,object:[4,5],offici:4,once:[4,7],one:5,onli:[1,5],openid:3,openldap:4,openssl:4,oper:4,option:[4,7],oracl:4,order:4,org:4,origin:7,osx:4,other:[4,5,7,8],otherwis:4,out:[],overrid:4,own:[],packag:4,page:[0,3,5,6],panoramix:3,paramet:[4,6],parameter:6,part:4,partit:6,partition_kei:6,pass:[4,6],password:4,past:[4,6],path:4,pem:4,pen:7,peopl:[1,5],per:[],perform:1,perhap:5,period:4,permiss:[],persist:6,pick:7,pip:[],pkg:4,place:4,plai:4,plan:1,platform:[3,4],pleas:4,plu:[5,7],point:4,popul:[1,4],popup:7,port:4,posit:7,possibl:[1,4,5],postagg:0,postgr:[],postgresql:4,power:[4,5,6],practic:1,prefer:4,prefix:4,presto:[4,6],prestocontext:6,preto:6,previou:0,probabl:5,process:1,prod:4,product:4,profil:5,program:6,project:[3,4],proto:4,provid:[],proxi:4,psycopg2:4,pull:1,purpos:4,put:4,pyhiv:4,pylibmc:4,pymssql:4,pypi:4,python:[],pythonpath:4,pyvenv:4,qualifi:6,queue:6,quick:[],rabbitmq:4,random:[4,6],rapid:5,rdbms:3,react:6,readi:3,receiv:1,recommend:[4,5],record:5,redi:4,redshift:[],refer:[4,7],referenc:4,refresh:[1,4],refresh_druid:4,regex:0,regist:1,rel:[5,7],relat:[0,5],relev:7,remote_user:3,renam:[3,7],repo:4,request:[1,4],requir:4,reserv:1,resiz:7,respons:4,result:[0,1,4,6],revenu:5,revers:4,revok:5,rhel:4,rich:[3,6],right:[4,5,7],role:[],root:4,row:5,row_limit:4,rule:3,run:[0,1,4,6],runserv:[1,4],sai:5,same:7,save:[0,5,7],scan:1,schedul:1,schema:[],schema_nam:6,script:4,search:[3,5,6],searchabl:7,searchpath:4,second:[1,4,5],secret:4,secret_key:4,secur:[],see:[1,5,7],select:[5,6,7],semant:[3,8],sensit:5,serv:1,server:[1,4],set:[3,4,5],setup:[],setuptool:4,share:[1,3],she:5,ship:[4,5],should:[1,3,4,6,7],show:[1,3,4,7,8],shown:7,side:4,sign:[4,5,7],similar:7,simpl:[1,3,4,5,8],simplecach:4,simpler:0,simpli:[5,7],singl:[1,5],size:7,slice:[],slice_id:1,sliceid:1,slow:1,small:1,smooth:6,solut:1,some:[],some_macro_cal:6,some_t:6,sometim:5,soon:[4,8],sort:1,sourc:[],sparksql:4,specif:[1,4,5],specifi:[0,1,4],sql:[],sqlalchemi:[],sqlalchemy_database_uri:4,sqlite:4,ssl:[],sslmode:4,sslrootcert:4,stai:5,standard:[4,6],start:[],statu:5,step:[4,7],store:4,str:6,straightforward:4,string:4,style:7,sub_partition_t:6,sudo:4,sum:0,sure:[4,5,7],syntax:4,system:4,tab:[0,5,6,7],table_nam:6,tag:1,take:7,tell:7,temp:4,templat:[],terabyt:1,test:[0,4,7],textbox:7,thei:[0,4,5,6],them:[4,5,7,8],theme:[],thi:[0,1,3,4,5,7,8],thing:7,those:[1,5],though:[0,4,5],through:[1,3,4,5,7,8],timeout:[1,4],tini:7,toggl:8,tool:[],top:[1,4,5,7],transform:1,tri:7,tutori:[],tweak:4,twice:1,type:[0,4,5,7],typeahead:5,typic:4,ubuntu:4,ultim:4,uncommon:4,under:6,unfortun:4,union:[1,5],unleash:6,unpack:4,until:7,upgrad:4,upgrade:[],upon:[0,5],uri:[4,7],user:[1,3,4,5],utilis:4,uuid:6,valid:0,valu:[1,4,6],venv:4,veri:[4,5],version:[0,4],video:[],view:[0,1,4,5,7,8],virtual:1,virtualenv:[],wai:5,walk:8,walkthrough:8,want:[1,4,5,6,7],web:[1,4,5],webserv:4,week:7,well:[0,4,5,7],were:5,what:[0,1,4],wheel:4,when:[1,5,7],where:[1,4,6,7],whether:[1,4],which:[1,3,4,6,7],who:3,widget:[1,8],window:[4,5,7],within:[5,6],without:5,won:[1,4],work:[0,1,4,6,7,8],worker:[4,6],world:4,would:[0,1,4,5],write:6,written:6,wtf:4,year:7,you:[0,1,4,5,6,7,8],your:[],yourself:1,yum:4},titles:["Druid","FAQ","Gallery","Caravel’s documentation","Installation & Configuration","Security","SQL Lab","Tutorial","Videos"],titleterms:{access:[4,5],add:1,adding:8,admin:5,aggregat:0,alpha:5,annotat:8,availabl:6,balanc:4,behind:4,big:1,build:4,cach:4,can:1,caravel:[3,4],configur:4,content:3,cors:4,creat:1,creation:8,css:8,custom:[5,8],dashboard:[1,8],data:[1,5],databas:4,deeper:4,defin:8,depend:4,document:3,druid:[0,4],dynam:1,expression:8,faq:1,featur:[3,6],filter:[1,8],galleri:2,gamma:5,get:4,how:1,indice:3,initi:4,instal:4,installat:4,integr:4,intro:8,jinja:6,join:1,lab:[4,6],load:4,macro:6,make:4,manag:5,map:1,mapbox:1,metric:5,multipl:1,out:1,overview:[3,6],own:[1,4],per:5,permiss:5,pip:4,post:0,postgr:4,provid:5,python:4,queri:1,quick:8,redshift:4,restrict:5,role:5,schema:4,secur:5,setup:4,slice:8,some:5,sourc:[1,5],sql:[4,6,8],sqlalchemi:4,ssl:4,start:4,subset:5,support:0,tabl:[1,3,8],templat:6,theme:8,time:1,tool:4,tutori:7,upgrade:4,video:8,virtualenv:4,visibl:1,visual:1,why:1,yet:0,your:4}})
\ No newline at end of file
diff --git a/security.html b/security.html
index 858870bd72b..d610fb379d4 100644
--- a/security.html
+++ b/security.html
@@ -1,139 +1,199 @@
+
+
-
-
-
-
-
-
- Search
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sqllab.html b/sqllab.html
index fc7f46b2f96..c1772a60431 100644
--- a/sqllab.html
+++ b/sqllab.html
@@ -1,200 +1,382 @@
+
+
-
-
-
-
-
-
- SQL Lab — caravel documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ SQL Lab — Caravel's documentation documentation
-
-
-
- Tutorial — caravel documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ Tutorial — Caravel's documentation documentation
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tutorial.html b/tutorial.html
index 7b238a22635..ea04a67b9db 100644
--- a/tutorial.html
+++ b/tutorial.html
@@ -1,124 +1,199 @@
+
+
-
-
-
-
-
-
-
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
-
-
-SQL Lab¶
-
-SQL Lab is a SQL IDE (interactive development environment) for SQL.
-It features:
+SQL Lab is a modern, feature-rich SQL IDE written in +React.
+
+
+Feature Overview¶
+-
+
Connects to just about any database backend
+
+A multi-tab environment to work on multiple queries at a time
+
+A smooth flow to visualize your query results using Caravel’s rich +visualization capabilities
+
+Browse database metadata: tables, columns, indexes, partitions
+
+Support for long-running queries +- uses the Celery distributed queue
++
to dispatch query handling to workers
+-
-
- multiple tabs as individual workspaces -
- table and column metadata browsing, providing a reference while authoring -queries -
- viewing query results in a table view -
- exposes an easy workflow to create rich visualizations out of arbitrary SQL -using Caravel’s visualization engine -
- a per-tab query history, keeping track of previous iterations -
- support for long running background sql statements as “CREATE TABLE AS” -
- works with most database backends, allowing to query Impala, Presto, -Hive, MySQL, Postgres, Vertica, Teradata, Oracle and pretty any -SQL-speaking database you may have laying around -
- a query search engine, allowing you to easily find that query you ran a -few weeks ago, seeing who has been querying a table you created +
- supports defining a “results backend” to persist query results
Caravel’s SQL Lab is growing within Airbnb to replace Airpal, a similar tool -focussed on querying Presto. Airpal has served us extremely well, democratizing -access to data internally, and its success built a strong case for SQL Lab. -The rational for integrating the Airpal use case -into Caravel is multifold. The main reason was to enable a smooth flow from -arbitrary SQL to visualization, dashboarding and sharing. We also wanted to -allow support and centralize the tooling for database engines beyond Presto -which transcends Airpal’s original mission. -Another benefit of having all of the data access within one platform is be -able to manage authentication, roles and permissions in a single tool.
-Computationally intensive, long running queries are common in this petabyte -scale era, and SQL Lab is designed to provide a nice workflow for this use -case. By setting up an asynchronous backend, you can enable the CTAS -(create table as) feature, which will run your query and store the result -in a newly created table. You can then query and visualize data off of that -summary table. Note that we’re planning to add even better support for long running -queries that won’t require write access to the source database -in the near future.
-SQL Lab makes it easy to expose internal databases to SQL speaking employees. -It a matter of filling in a form to register the database into Caravel, and -granting permissions to users through roles. While a Caravel user either has -full access to a database connection or no access at all, -it’s possible for administrator to create different database users -(say one MySQL all_read_write_access user and one a read_only_some_tables -user) and expose them as different connections into Caravel.
-On the Caravel side, individual databases can be set -to allow CREATE TABLE AS operation or not, and be instructed to target a -specified database schema when doing so. There’s also a flag for defining -whether non-SELECT statements (UPDATE, DELETE, CREATE, ...) are allowed for that -database connection, where Caravel won’t even attempt to run these statements.
-Note that Airbnb subscribes to the “release early, release often” moto, and while SQL -Lab is a solid product today, it will get even better overtime. Here are some -features we are currently working on that should see the light of day very -soon:
--
-
- An smoother “visualize flow”, with smart defaults -
- Better support for long running queries without the need of CTAS -
- SQL macros support -
- surface more metadata: index, partitions, views, comments, ... -
- column aware autocomplete in the SQL editor +
+A search engine to find queries executed in the past
+
+Supports templating using the +Jinja templating language +which allows for using macros in your SQL code
+
+
+
+
Templating with Jinja¶
+SELECT *
+FROM some_table
+WHERE partition_key = '{{ preto.latest_partition('some_table') }}'
+Templating unleashes the power and capabilities of a +programming language within your SQL code.
+Templates can also be used to write generic queries that are +parameterized so they can be re-used easily.
+
+
+Available macros¶
+We expose certain modules from Python’s standard library in
+Caravel’s Jinja context:
+- time: time
+- datetime: datetime.datetime
+- uuid: uuid
+- random: random
+- more to come!
Jinja’s builtin filters can be also be applied where needed.
+-
+
-
+class
caravel.jinja_context.PrestoContext(database, query)[source]¶
+ Presto Jinja context
+The methods described here are namespaced under
+prestoin the +jinja context as inSELECT '{{ presto.some_macro_call() }}'-
+
-
+
latest_partition(table_name)[source]¶
+ Returns the latest (max) partition value for a table
++
++ + + Parameters: table_name (str) – the name of the table, can be just the table +name or a fully qualified table name as +schema_name.table_name++>>> latest_partition('foo_table') +'2018-01-01' +
-
+
-
+
latest_sub_partition(table_name, **kwargs)[source]¶
+ Returns the latest (max) partition value for a table
+A filtering criteria should be passed for all fields that are +partitioned except for the field to be returned. For example, +if a table is partitioned by (
+ds,event_typeand +event_category) and you want the latestds, you’ll want +to provide a filter as keyword arguments for both +event_typeandevent_categoryas in +``latest_sub_partition(‘my_table’,+
+event_category=’page’, event_type=’click’)``+
++ + + Parameters: -
+
- table_name (str) – the name of the table, can be just the table
+name or a fully qualified table name as
schema_name.table_name
+ - kwargs (str) – keyword arguments define the filtering criteria +on the partition list. There can be many of these. +
++>>> latest_sub_partition('sub_partition_table', event_type='click') +'2018-01-01' +
- table_name (str) – the name of the table, can be just the table
+name or a fully qualified table name as
-
+