http://git-wip-us.apache.org/repos/asf/incubator-superset-site/blob/886f04b0/searchindex.js ---------------------------------------------------------------------- diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 0000000..befed68 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({envversion:49,filenames:["druid","faq","gallery","index","installation","security","sqllab","tutorial","videos","visualization"],objects:{"superset.jinja_context":{PrestoTemplateProcessor:[6,0,1,""],url_param:[6,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","function","Python function"]},objtypes:{"0":"py:class","1":"py:function"},terms:{"1thisismyscretkei":4,"37k":7,"3aclose":1,"3aexampl":1,"\u00e1lava":9,"\u00e1vila":9,"a\u00eft":9,"abstract":1,"almer\u00eda":9,"amap\u00e1":9,"ard\u00e8che":9,"ari\u00e8g":9,"b\u00e9ni":9,"c\u00e1cere":9,"c\u00e1diz":9,"c\u00f3rdoba":9,"c\u00f4te":9,"case":[0,4,7],"castell\u00f3n":9,"cear\u00e1":9,"class":[4,6],"corr\u00e8z":9,"coru\u00f1a":9,"d\u00f4me":9,"default":[1,4,5,6,7,9],"dr\u00f4me":9,"esp\u00edrito":9,"export":1,"final":7,"finist\u00e8r":9,"function":[3,4],"goi\u00e1":9,"guip\u00fazcoa":9,"h\u00e9rault":9,"hoce\u00efma":9,"import":[1,4,9],"is\u00e8re":9,"ja\u00e9n":9,"k\u00e9nitra":9,"kela\u00e2":9,"kh\ u00e9misset":9,"kh\u00e9nifra":9,"la\u00e2youn":9,"le\u00f3n":9,"li\u00e8g":9,"long":[4,6],"loz\u00e8r":9,"m\u00e1laga":9,"maranh\u00e3o":9,"mekn\u00e8":9,"new":[],"ni\u00e8vr":9,"par\u00e1":9,"para\u00edba":9,"paran\u00e1":9,"piau\u00ed":9,"pyr\u00e9n\u00e9":9,"return":[1,4,6],"rh\u00f4ne":9,"rond\u00f4nia":9,"s\u00e3o":9,"s\u00e8vre":9,"sa\u00f4n":9,"sal\u00e9":9,"short":[8,9],"switch":4,"t\u00e9mara":9,"t\u00e9touan":9,"th\u00fcringen":9,"true":[4,5],"var":9,"vend\u00e9":9,"w\u00fcrttemberg":9,"while":[0,4,5],__call__:4,__from:1,__init__:4,__name__:4,__to:1,abd:9,abe:9,aberdeen:9,aberdeenshir:9,abil:7,abl:[4,5,7],about:[],abov:[1,7],absenc:6,accept:1,access:[],account:4,acre:9,action:[4,5,9],activ:4,adapt:4,adding:[],addit:4,additional_middleware:4,adjust:7,admin:[],administr:[],advanc:[0,4,7],adventur:4,adygei:9,affect:[1,8],after:[1,4,7],afterward:1,agadir:9,again:[1,7],against:[0,4],agb:9,agd:9,aggreg:[0,3,5],ago:7,agrigento:9,agy:9,ahmar:9,ain:9,airbnb:[0,1,4],aisn:9,alabama: 9,alagoa:9,alaska:9,albacet:9,alessandria:9,alicant:9,all:[0,1,4,5,7,9],all_datasource_access:5,allier:9,allow:[1,3,4,5,6],alongsid:4,alpe:9,alphanumer:9,alreadi:[4,7,8,9],also:[1,4,5,6,7,9],alt:[6,9],altai:9,alter:[5,8],alx:9,amazona:9,amazonaw:4,ambigu:9,amu:9,amur:9,analys:7,analysi:[1,7],analyst:5,analyt:4,analyz:7,ancona:9,andria:9,angad:9,anglesei:9,angu:9,anhalt:9,anhui:9,ani:[1,4,5,6,7],anjra:9,annot:8,annotat:[],anonym:5,anoth:[4,5],another:1,ans:9,ant:9,antrim:9,antwerpen:9,any:5,aosta:9,api:[1,4],app:4,appbuilder:[3,5],appear:[0,7],appli:[1,6,7,8],applic:[4,5],appropri:1,apt:4,aquila:9,arbitrari:1,ard:9,ardenn:9,arezzo:9,argyll:9,arizona:9,ark:9,arkansa:9,arkhangel:9,arm:9,armagh:9,armor:9,around:1,arrai:[1,4],ascoli:9,ash:9,ask:7,asn:9,aspect:8,assa:9,asset:[4,9],assign:5,assilah:9,associ:5,assum:[4,5,7],assumpt:5,ast:9,asti:9,astrakhan:9,asturia:9,aswan:9,async:[],asynchron:4,asyut:9,asz:9,athena:[],atlantiqu:9,attempt:4,attribut:5,aube:9,aude:9,audienc:7,auth_remote_us er:4,authent:[3,5,7],automag:5,avail:[3,4,5,7,8],avellino:9,aveyron:9,avoid:1,awar:4,aws:[],aws_access_key_id:4,aws_secret_access_kei:4,awsathena:4,axi:7,ayrshir:9,ayshir:9,azi:9,azilal:9,back:[4,7],backend:[4,6],badajoz:9,baden:9,baha:9,bahia:9,bahr:9,bake:7,balanc:[],balear:9,balkar:9,ballymena:9,ballymonei:9,banbridg:9,bani:9,bar:7,barcelona:9,bari:9,bark:9,barletta:9,bas:9,base:[1,5],basecach:4,bashkortostan:9,basi:5,basic:7,batch:1,bath:9,bayern:9,bbd:9,bdf:9,bdg:9,becaus:[1,9],bedfordshir:9,been:[5,7],befor:4,behalf:7,behind:[],beij:9,bel:9,belfast:9,belfort:9,belgium:9,belgorod:9,belluno:9,below:7,bem:9,ben:9,benevento:9,ber:9,bergamo:9,berkan:9,berkshir:9,berlin:9,bes:9,best:[3,5],better:[4,7],bex:9,bexlei:9,beyond:4,bfs:9,bge:9,bgw:9,biella:9,bin:4,binari:4,bind:4,bit:[4,7],bkm:9,bla:9,blackburn:9,blaenau:9,blank:7,blob:[1,4],blueprint:[],blueprints:4,bly:9,bmh:9,bnb:9,bnh:9,bns:9,bologna:9,bolzano:9,bom:9,border:9,both:[4,5],bottom:[5,7],bouch:9,bouleman:9,boundari:1,bourn emouth:9,box:[1,7],brabant:9,brandenburg:9,brazil:9,bremen:9,brent:9,brescia:9,brew:4,brianza:9,bridgend:9,brighton:9,brindisi:9,bring:4,bristol:9,broad:7,broken:1,broker:4,broker_url:4,bromlei:9,brows:6,browser:4,bru:9,bruxel:9,bry:9,bryansk:9,bst:9,buckinghamshir:9,buhayrah:9,build:[],builder:4,built:[1,5],builtin:6,bundl:4,bur:9,burgo:9,buryat:9,buryatdan:9,bute:9,button:[5,7],cach:[],cache_config:4,caerphilli:9,cagliari:9,calabria:9,calai:9,california:9,call:[4,7],caltanissetta:9,calvado:9,cam:9,cambridgeshir:9,camden:9,campidano:9,campobasso:9,can:[],can_add:5,can_delet:5,can_edit:5,can_list:5,can_show:5,cannot:5,cantabria:9,cantal:9,capabl:[1,6],captur:7,caravel:3,carbonia:9,cardiff:9,care:7,carmarthenshir:9,carolina:9,carrara:9,carrickfergu:9,cas:9,casablanca:9,caserta:9,castlereagh:9,catania:9,catanzaro:9,catarina:9,categori:5,cay:9,celeri:[4,6],celery_annotations:4,celery_config:4,celery_imports:4,celery_result_backend:4,celeryconfig:4,celsiu:7,ceredigion:9,certain:[1,6,8], cesena:9,ceuta:9,cflags:4,cgn:9,cgv:9,chanc:4,chang:[1,4,7],charact:9,charent:9,chart:[7,8],che:9,chechnya:9,check:[0,1,5,7],checkbox:[0,1,5],chefchaouen:9,chelsea:9,chelyabinsk:9,cher:9,cherkasi:9,cherkess:9,chernihiv:9,chernivtsi:9,cheshir:9,chi:9,chichaoua:9,chieti:9,china:9,choic:9,chongq:9,chs:9,cht:9,chtouka:9,chu:9,chukot:9,chuvash:9,citi:9,ciudad:9,ckf:9,ckt:9,clackmannanshir:9,clarifi:0,clearli:7,cleveland:9,click:[0,1,5,7],clickhous:4,client:4,clk:9,clr:9,cluster1:5,cluster:4,cma:9,cmd:9,cmn:9,code:[1,4,6,9],colerain:9,collect:[5,8],colorado:9,columbia:9,column:[],com:[1,4],come:[1,4,5,6,8],comma:7,command:[4,5],comment:1,common:[0,1,4],como:9,compat:4,complementari:5,complet:9,compli:4,compon:9,compos:5,con:9,concept:4,concern:9,config:[4,7],configur:[],confin:4,confirm:[5,7],congrat:7,connect:[],connect_arg:4,connecticut:9,consist:[4,9],consolid:5,constant:4,consult:4,consum:5,contain:[1,4,9],context:[4,6],contrib:4,contribut:1,control:[3,9],conveni:9,convert:[7,9],conwi :9,cookstown:9,copi:4,cor:4,corner:7,cornwal:9,correctli:[4,7],correspond:0,cors:[],cors_options:4,corydolphin:4,cosenza:9,could:5,count:[0,7],countri:[],country_nam:1,coupl:7,cover:[0,7],craigavon:9,creat:[],create_engin:4,creation:[],credenti:4,cremona:9,creus:9,crf:9,crimea:9,criteria:[1,4],croton:9,croydon:9,cruz:9,cry:9,cryptographi:4,csr:9,csrf:4,csrf_enabled:[],css:[],cuenca:9,cumbria:9,cuneo:9,current:[0,3,4,5],cusio:9,custom:[],cwy:9,cx_oracl:4,cycl:1,d3format:7,dagenham:9,dagestan:9,dakota:9,dal:9,daqahliyah:9,darlington:9,darwen:9,databas:[],dataset:[3,5,7,8],datasourc:[0,1,4,5],datasource1:5,date:[1,5,7],datetim:6,dateutil:6,dby:9,deactiv:4,deal:1,debian:4,deep:3,deeper:[],def:4,defin:[],definit:0,degre:7,delawar:9,delet:5,demonstr:8,den:9,denbighshir:9,deni:[5,9],depart:[5,9],departmen:9,depend:[],deploi:[],der:9,derbi:9,derbyshir:9,deriv:[4,8],derri:9,descend:1,describ:[1,4,5,6,7],descript:9,design:3,desir:7,detail:1,deux:9,dev:[4,9],devel:4,develop:[],devon:9,dgn:9,dg y:9,dialect:4,dictionari:4,differ:[1,4,5,7,8],difficult:7,dimens:[1,7,8],direct:7,directli:[1,4],discov:1,dispatch:6,displai:[3,9],disregard:1,distinct:[0,1,7],distribut:[1,6,7],district:9,distrito:9,diva:9,divis:9,dnd:9,dnipropetrov:9,doc:[0,4],document:[],don:1,done:4,donet:9,dor:9,dordogn:9,dorset:9,doub:9,dow:9,down:[1,3,7,9],download:4,drag:7,drenth:9,driver:4,drop:[3,7],dropdown:[0,1,5],dry:9,due:1,dumfri:9,dumyat:9,dunbartonshir:9,dunde:9,dungannon:9,dur:9,durat:4,durham:9,each:[5,9],eal:9,eale:9,easi:[1,4],easier:1,easili:6,east:9,eay:9,edh:9,edinburgh:9,edit:[0,1,4,5,7],editor:1,edu:9,effect:1,egypt:9,eilean:9,elb:4,element:[0,4],eln:9,els:9,emilia:9,enabl:[1,4,5],enable_cors:4,enable_proxy_fix:4,encod:4,encount:4,encrypt:4,end:7,endpoint:4,enf:9,enfield:9,engin:6,engine_param:4,enna:9,enough:1,ensur:4,enter:[4,6],enterpris:3,entiti:[4,5],env:4,environ:[1,4,6],equal:7,err:9,errachidia:9,error:[4,5],erw:9,ery:9,escap:4,esi:9,ess:9,essaouira:9,essenti:4,essex:9,essonn:9,estab lish:9,esx:9,etc:7,eure:9,even:[5,7],eventu:4,everyth:4,evolv:[1,5],exampl:[1,4,5,7,9],exce:4,except:4,execut:[1,4,5,6,7],exist:[],exit:4,expanded_slic:1,expect:4,experi:[1,7],explain:0,explicit:5,explor:[0,3,4,5,7],explore:[],explorev2:9,expos:[0,4,5,6,7,8],express:1,expression:[],extens:[3,4,7],extra:[],extract:4,fab:5,factor:1,fah:9,fahrenheit:7,fal:9,falkirk:9,fall:4,fashion:1,fast:1,fayyum:9,featur:[],feder:9,fedora:4,feel:7,fer:9,fermanagh:9,fermo:9,ferrara:9,fes:9,few:[1,4,5,7],field:[0,1,3,4,5,7],fif:9,fife:9,fig:9,figuig:9,file:[1,4,9],filesystem:4,filter:[],filter_immune_slic:1,filter_immune_slice_field:1,financ:5,financi:5,find:[4,6,7],first:[0,4,5,7,9],fix:5,flag:[1,4],flask:[3,4,5],flevoland:9,flintshir:9,fln:9,florenc:9,florida:9,flow:6,foggia:9,folder:9,follow:[0,1,4,7,9],foobar:4,forest:9,fork:4,forli:9,form:[1,4,9],format:7,forward:4,foundat:5,frame:1,framework:[1,4,5],franc:9,frankiv:9,fresh:7,friesland:9,from:[0,1,3,4,5,6,7,8,9],frosinon:9,fujian:9,fulham:9,full:[ 7,9],futur:4,fym:9,gallowai:9,gamma:[],gansu:9,gard:9,garonn:9,gatewai:1,gather:5,gcc:4,gdal:9,gdata:9,gelderland:9,gener:6,genova:9,geojson:9,georgia:9,ger:9,gerai:9,germani:9,get:[],gharbiyah:9,gigant:1,girona:9,girond:9,git:4,github:[1,4],give:[1,5],given:5,glamorgan:9,glasgow:9,glg:9,global:4,gloucestershir:9,gls:9,goe:4,good:[1,7],googl:4,gorizia:9,gorno:9,granada:9,grand:9,grant:5,granular:[3,5],gre:9,great:5,green:7,greenplum:4,greenwich:9,groningen:9,grosseto:9,grosso:9,group:[1,7],groupabl:7,groupbi:0,guadalajara:9,guangdong:9,guangxi:9,gue:9,guelmim:9,guizhou:9,gunicorn:4,gwent:9,gwn:9,gwynedd:9,hacknei:9,hainan:9,hainaut:9,haj:9,hajeb:9,hal:9,halton:9,ham:9,hamburg:9,hamlet:9,hammersmith:9,hampshir:9,handl:[4,5,6],hao:9,haouz:9,happen:[1,5],haringei:9,harrow:9,hartlepool:9,haut:9,hav:9,have:[0,1,4,5,7],haven:7,haver:9,hawaii:9,hck:9,header:[4,7],health:4,healthcheck:4,hebei:9,hef:9,heilongjiang:9,help:[4,7],henan:9,here:[1,4,5,6,7,8],herefordshir:9,hertfordshir:9,hessen:9 ,high:[3,8],highest:7,highland:9,hil:9,hillingdon:9,hit:[1,4,6],hive:4,hld:9,hmf:9,hns:9,hoc:9,hold:7,holland:9,holstein:9,host:4,hostnam:4,hounslow:9,hour:4,hove:9,how:[],hpl:9,hrt:9,hrw:9,hry:9,html:[4,9],http:[1,4,9],http_x_proxy_remote_user:4,hubei:9,huelva:9,huesca:9,hui:9,hull:9,hunan:9,hyphen:9,icon:[1,7],ida:9,idaho:9,ide:[4,6],ideal:7,identifi:9,ifr:9,ifrane:9,iglesia:9,ijsselmeer:9,iliyah:9,ille:9,illinoi:9,immedi:7,immun:8,impala:4,impati:4,imperia:9,implement:[1,4],impyla:4,includ:[4,5],increas:1,index:[3,4,6],indiana:9,indic:7,individu:[3,5],indre:9,ine:9,inezgan:9,inform:[4,7],ingush:9,init:[4,5],initi:[],initial:4,input:9,insert:4,insid:4,instal:[],install:4,installat:[],instanc:[4,5,7],integr:[],integrat:3,intend:4,interact:[1,3],interest:7,interfac:4,intern:9,internat:9,intric:3,intro:[],intuit:3,inverclyd:9,investig:7,iow:9,iowa:9,irk:9,irkutsk:9,isernia:9,iskandariyah:9,isl:9,island:9,isle:9,islington:9,isma:9,isn:[0,4],iso:9,issu:1,itali:9,item:[4,5],itself:[4,5, 7,9],iva:9,ivano:9,ivanovo:9,ivc:9,jadid:9,jadida:9,janeiro:9,janub:9,javascript:9,jdbc:4,jdi:9,jerada:9,jersei:9,jiangsu:9,jiangxi:9,jilin:9,jinja:[],jinja_context:6,jinja_context_addons:4,jizah:9,join:[],jra:9,json:[0,1,4],jsx:9,jura:9,just:[4,6,7],kabardin:9,kacem:9,kafr:9,kaliningrad:9,kalmyk:9,kaluga:9,kam:9,kamchatka:9,kansa:9,karachai:9,karelia:9,kda:9,kec:9,kei:[1,4],kem:9,kemerovo:9,ken:9,kensington:9,kent:9,kentucki:9,kes:9,key_prefix:4,keyboard:6,keyn:9,keyword:[1,4],kfs:9,kgd:9,kgn:9,kha:9,khabarovsk:9,khakass:9,khanti:9,kharkiv:9,khe:9,kherson:9,khl:9,khm:9,khmel:9,khn:9,kho:9,khouribga:9,kiev:9,kingston:9,kinross:9,kir:9,kirov:9,kirovohrad:9,klu:9,know:4,known:1,komi:9,kos:9,kostroma:9,krasnodar:9,krasnoyarsk:9,krs:9,ktt:9,kurgan:9,kursk:9,kwarg:6,kya:9,kyi:9,laa:9,lab:[],label:[1,7,9],lambda:4,lambeth:9,lan:9,lanarkshir:9,lancashir:9,land:9,languag:[6,8],lar:9,larach:9,larg:[1,4],larn:9,last:4,latest:4,latest_partit:6,latina:9,latitud:7,laughingman7743:4,layer:[1,3],l bh:9,lce:9,ldap:3,ldflags:4,least:4,leav:7,lec:9,lecc:9,lecco:9,left:7,leicest:9,leicestershir:9,len:9,leningrad:9,less:9,let:7,level:[1,4,5,8],lew:9,lewisham:9,liaon:9,lib:4,libffi:4,libldap2:4,librari:[3,4,6],libsasl2:4,libssl:4,life:1,like:[0,1,4,5,7],limavadi:9,limburg:9,limit:[1,5,7],lin:9,lincolnshir:9,link:7,lip:9,lipetsk:9,lisburn:9,list:[],live:1,livorno:9,lleida:9,lmv:9,lnd:9,lo4:9,load:[],load_exampl:4,local:4,localhost:4,localt:1,locat:1,lock:1,lodi:9,log:[1,5],logic:[1,4,7],login:4,loir:9,loiret:9,london:9,longitud:7,look:[4,5,7],lookup:[0,6],lot:9,lothian:9,louisiana:9,lrn:9,lsb:9,lucca:9,luckili:7,lugo:9,luhan:9,lut:9,luton:9,luxembourg:9,macerata:9,made:[3,4,5,9],madrid:9,mag:9,maga:9,magherafelt:9,mai:[1,4,5,7,9],main:[1,4,9],major:3,make:[],man:9,manag:[],manch:9,manchest:9,mani:[1,4,5,7],manifest:7,mansii:9,mantua:9,manual:[0,5],mapbox_api_key:[1,4],mapshap:9,march:3,margin:7,marii:9,maritim:9,mark:7,markdown:8,marn:9,marrakech:9,maryland:9,massa:9,massachusett:9, match:7,matera:9,materi:1,mato:9,matrix:0,matrouh:9,max:[0,7],max__measurement_flag:7,maximum:[4,7],mayenn:9,mdb:9,mdw:9,mean:5,meantim:1,measur:7,measurement_d:7,measurement_flag:7,mecklenburg:9,medio:9,medwai:9,mek:9,melilla:9,mellal:9,melloul:9,memcach:4,memori:4,mention:1,menu:[1,4,5,7],mer:9,meren:9,merg:1,merseysid:9,merthyr:9,merton:9,messag:[4,5,7],messina:9,metadata:[1,4,6],metadata_param:4,method:6,metric:[],meurth:9,meus:9,mexico:9,mft:9,michigan:9,middl:7,middlesbrough:9,middlewar:4,middleware:[],midland:9,midlothian:9,might:[1,5,7],mik:9,milano:9,milton:9,min:[0,7],mina:9,minnesota:9,minufiyah:9,minut:4,minya:9,mississippi:9,missouri:9,mln:9,mmd:9,mnf:9,model:[3,5],modena:9,modern:6,modul:[3,4,6],moh:9,mohammedia:9,moment:7,mon:9,mongol:9,monmouthshir:9,montana:9,monza:9,morai:9,morbihan:9,mordovia:9,more:[1,4,5,6,7,9],moreov:7,morocco:9,mos:9,moscow:9,mosel:9,moskva:9,most:[1,3],mostli:5,mou:9,moulai:9,mourn:9,mow:9,moyl:9,mrt:9,mry:9,mssql:4,mty:9,mu6:9,much:0,multi:6 ,mur:9,murcia:9,murmansk:9,must:[4,7],my_crazy_macro:4,mykolayiv:9,myl:9,mysql:4,mysqlclient:4,na7:9,nad:9,nador:9,name:[1,3,4,5,7,9],nameofyourcountri:9,namespac:6,namur:9,napoli:9,nation:9,navarra:9,navig:[4,8],nay:9,nbl:9,ndn:9,neath:9,nebraska:9,necessari:4,need:[],nei:9,nel:9,nell:9,nen:9,nenet:9,netherland:9,nevada:[7,9],never:1,newham:9,newport:9,newri:9,newtownabbei:9,next:[1,4,5,7,9],nfk:9,nginx:4,ngm:9,ngr:9,niedersachsen:9,ningxia:9,niz:9,nizhegorod:9,nlk:9,nln:9,non:1,none:[4,6],noord:9,nord:9,nordrhein:9,norfolk:9,norm:9,nort:9,north:9,northamptonshir:9,northumberland:9,note:[1,4,5,7],notic:0,nottingham:9,nottinghamshir:9,novara:9,novemb:3,novgorod:9,novosibirsk:9,now:[1,7],npm:4,nsm:9,nta:9,nth:9,ntl:9,ntt:9,number:[7,9],numer:7,nuoro:9,nvs:9,nwm:9,nwp:9,nyk:9,nym:9,nyt:9,oauth:3,object:[4,5],obtain:9,odessa:9,offici:4,ogliastra:9,ogr2ogr:9,ohio:9,oise:9,oklahoma:9,olbia:9,omagh:9,omh:9,oms:9,omsk:9,once:[4,7],one:[1,5],onli:[1,5,7],ont:9,oost:9,openid:3,openldap:4,ope nssl:4,oper:4,opt:1,option:[4,7],optional:7,oracl:4,order:4,ore:9,oregon:9,orel:9,orenburg:9,org:[4,9],organ:7,organiz:9,oriental:9,origin:[3,5,7],oristano:9,ork:9,orknei:9,orl:9,orne:9,ossetia:9,ossola:9,osx:4,other:[4,5,7,8],otherwis:4,oua:9,ouarzaz:9,ouj:9,oujda:9,our:7,ourens:9,out:[],outlier:7,overijssel:9,overload:4,overrid:[],own:[],oxf:9,oxfordshir:9,packag:4,padua:9,page:[0,3,4,5,7],palencia:9,palermo:9,palma:9,panoramix:3,param:6,paramat:6,paramet:[4,6],parameter:6,pari:9,parma:9,part:[4,9],partit:[1,6],partition_kei:6,pass:4,password:4,past:[4,6],path:4,paulo:9,pavia:9,pem:[4,9],pembrokeshir:9,pennsylvania:9,penza:9,peopl:[1,5],per:[],perform:1,perhap:5,period:[],perm:9,permiss:[],pernambuco:9,persist:[4,6],perthshir:9,perugia:9,pesaro:9,pescara:9,peterborough:9,petersburg:9,pfalz:9,phrase:7,piacenza:9,piceno:9,piec:7,pip:[],pisa:9,pistoia:9,pkg:4,pkn:9,place:[4,7],plai:4,plain:7,plan:[1,4],platform:[3,4],pleas:[4,7],plu:[5,7],ply:9,plymouth:9,pnz:9,pocoo:4,point:[4,7],po l:9,poltava:9,pontevedra:9,pool:9,pop:4,popul:[1,4],popup:7,por:9,pordenon:9,port:[4,9],portion:7,portsmouth:9,possibl:[1,4,5],postagg:0,postgr:[],postgresql:[4,7],potenza:9,pow:9,power:[4,5,6],powi:9,practic:1,prato:9,precipit:7,prefer:[],prefix:4,present:7,presto:[4,6],prestotemplateprocessor:6,pretti:1,previou:0,pri:9,primor:9,princip:9,probabl:5,process:[1,4],product:4,profil:5,program:6,project:[3,4],prompt:4,proto:4,provenc:9,provid:[],provinc:9,proxi:4,psk:9,pskov:9,psycopg2:4,pte:9,pts:9,public_role_like_gamma:5,publish:9,pui:9,pull:1,purpos:[4,7,9],put:[4,9],pyathenajdbc:4,pyhiv:4,pylibmc:4,pymssql:4,pypi:4,python:[],pythonpath:[1,4],pyvenv:4,qahirah:9,qalyubiyah:9,qina:9,qinghai:9,queue:[4,6],quick:[],rab:9,rabat:9,rabbitmq:4,ragusa:9,random:[4,6],rang:7,rapid:5,rate_limit:4,ravenna:9,rcc:9,rct:9,rdb:9,rdbms:3,react:6,read:7,readi:3,real:9,receiv:1,recommend:[4,5],record:[5,7,9],redbridg:9,redcar:9,redi:4,redirect:7,rediscach:4,redshift:[],reduc:9,refer:[4,7],referenc:4,re flect:1,refresh:[1,4],refresh_druid:4,regex:0,reggio:9,region:9,region_nam:4,regist:1,rel:5,relat:[0,4,5],relativedelta:6,relev:9,reli:4,remote_user:[3,4],remoteusermiddlewar:4,remov:5,renam:3,renfrewshir:9,replac:7,repo:4,repres:9,request:[1,4],requir:[1,4,5,9],research:7,reserv:1,respons:4,rest:7,result:[0,1,4,6,7],results_backend:4,retain:7,reusabl:4,revenu:5,revers:4,revok:5,rfw:9,rheinland:9,rhel:4,rhin:9,rhode:9,rhondda:9,ric:9,rich:[3,6],richmond:9,ride:9,rieti:9,right:[4,5,7],rimini:9,rio:9,rioja:9,rivn:9,role:[],roma:9,root:4,roraima:9,ros:9,rostov:9,roughli:7,rout:4,rovigo:9,row:[5,7],row_limit:4,rule:3,run:[0,1,4,5,6,7],runserv:[1,4],russia:9,russian:9,rut:9,rutland:9,rya:9,ryazan:9,s3_cache_bucket:4,s3_cache_key_prefix:4,s3_staging_dir:4,s3cach:4,s3werkzeugcach:4,saarland:9,sachsen:9,saf:9,safi:9,sai:[4,5],saint:9,sak:9,sakha:9,sakhalin:9,sal:9,salamanca:9,salerno:9,sam:9,samara:9,same:[4,5],sampl:7,sandbox:1,santa:9,santo:9,sar:9,saratov:9,sarth:9,sassari:9,save:[0,1,5, 7],savoi:9,savona:9,say:9,scan:1,scb:9,scene:1,schedul:1,schema:[],schema_nam:4,schleswig:9,scope:4,scottish:9,scratch:7,script:4,sea:9,search:[3,5,6],searchpath:4,second:[1,4,5,9],secret:4,secret_key:4,section:[1,7],secur:[],see:[1,5,7],seem:7,sef:9,sefrou:9,segovia:9,sein:9,select:[5,6,7],select_countri:9,selectcontrol:9,self:4,semant:[3,8],sensit:5,separ:[7,9],sergip:9,serv:[1,4],server:[1,4],set:[3,4,5,7,9],settat:9,setup:[],setuptool:4,sevastopol:9,sevilla:9,sfk:9,sgc:9,shaanxi:9,shamal:9,shandong:9,shanghai:9,shanxi:9,shapfil:9,share:[1,3],sharqiyah:9,shaykh:9,she:5,shetland:9,shg:9,ship:[4,5],shortcut:6,should:[1,3,4,5,7,9],show:[1,3,4,7,8],shr:9,shropshir:9,siar:9,sichuan:9,side:4,sidi:9,siena:9,sign:[4,5,7],sik:9,simpl:[1,3,4,5,7,8],simple_pag:4,simplecach:4,simpler:0,simpli:[4,5,7],sin:9,sina:9,sinc:[5,7],singapor:9,singl:[1,4,5],site:9,size:[7,9],skh:9,skhirat:9,slice:[],slice_id:1,sliceid:1,sliman:9,slk:9,slow:1,small:1,smaller:7,smo:9,smolensk:9,smooth:6,snippet:4,snowf al:7,solut:1,som:9,some:[],some_macro_cal:6,some_t:6,someon:7,somerset:9,someth:[4,7],sometim:5,somm:9,sondrio:9,soon:8,soria:9,sort:1,sos:9,sourc:[],south:9,southampton:9,southend:9,southwark:9,spain:9,sparksql:4,spe:9,specif:[1,4,5,7],specifi:[0,1,4],spezia:9,sql:[],sql_lab_result:4,sqlalchemi:[],sqlalchemy_database_uri:[1,4],sqlite:[1,4],sraghna:9,sry:9,ssl:[],sslmode:4,sslrootcert:4,sta:9,staffordshir:9,stai:5,standard:[4,6,9],start_respons:4,state:9,statist:7,statu:5,stavropol:9,stb:9,ste:9,stem:9,step:[4,9],stg:9,sth:9,still:5,stirl:9,stn:9,stockton:9,stoke:9,store:[1,4,9],str:6,straban:9,straightforward:4,strategi:5,string:[4,7,9],sts:9,stt:9,subdivis:9,successfulli:7,sud:9,sudo:4,suffolk:9,suhaj:9,sul:9,sum:[0,7],sumi:9,summari:7,superset:[],superset_config:[1,4,5],superset_home:4,superset_result:4,superset_webserver_port:4,superset_workers:4,support_sqlalchemi:4,sure:[4,5],surfac:7,surrei:9,sussex:9,sutton:9,suwai:9,suwayf:9,suz:9,sve:9,sverdlovsk:9,swa:9,swansea:9,swd:9,sw indon:9,swk:9,symlink:1,synchron:5,syntax:4,syracus:9,system:[4,9],tab:[0,1,5,6,7],tag:1,taken:7,talbot:9,tam:9,tambov:9,tan:9,tanan:9,tanger:9,tao:9,taounat:9,taourirt:9,tar:9,taranto:9,target:7,tarn:9,taroudannt:9,tarragona:9,task:4,tat:9,tata:9,tatarstan:9,taw:9,taz:9,taza:9,tee:9,telford:9,temp:4,temperatur:7,tempio:9,templat:[],template_fold:4,tempor:7,tenerif:9,tennesse:9,tenth:7,terabyt:1,teramo:9,terni:9,ternopil:9,territoir:9,territori:9,teruel:9,test:[0,4,7],tet:9,texa:9,text:7,tfw:9,thame:9,than:[7,9],thei:[0,4,5,6],them:[4,5,8],theme:[],therefor:7,thi:[0,1,3,4,5,7,8,9],thing:[4,7],those:[1,5],though:[0,4,5,7],thr:9,three:9,through:[1,3,4,5,7,8],thurrock:9,tianjin:9,tick:7,timeout:[1,4],tiz:9,tiznit:9,tng:9,tnt:9,tob:9,tocantin:9,tof:9,toggl:8,toledo:9,tom:9,tomsk:9,tool:[],top:[1,4,5,7],torbai:9,torfaen:9,torino:9,tower:9,trani:9,transcarpathia:9,transform:1,trapani:9,trent:9,trento:9,treviso:9,triest:9,tul:9,tula:9,tutori:[],tuva:9,tve:9,tver:9,tweak:4,twh:9,twice:1,two :[7,9],tydfil:9,tyne:9,type:[],typeahead:5,typic:4,tyu:9,tyumen:9,ubuntu:4,udine:9,udmurt:9,ukrain:9,ultim:4,uly:9,uncommon:[],under:[6,7],unfortun:4,union:[1,5],uniqu:9,unleash:6,unlik:7,unpack:4,unreleas:4,until:7,updat:4,upgrad:4,upgrade:[],upon:[0,5,9],upper:7,uqsur:9,urbino:9,uri:[4,7],url:[4,6],url_param:6,usa:9,user:[1,3,4,5,7],usernam:4,usr:5,usual:9,utah:9,utilis:4,utrecht:9,uuid:6,uygur:9,val:9,vale:9,valencia:9,valentia:9,valid:0,valladolid:9,valu:[1,4,5,6,7],van:9,vares:9,variabl:[1,4],vauclus:9,vbr:9,venezia:9,venv:4,verbano:9,vercelli:9,veri:[4,5],vermont:9,verona:9,version:[0,4],vertica:4,vertica_python:4,vgg:9,vgl:9,via:9,vibo:9,vicenza:9,video:[],vienn:9,view:[0,1,4,5,7,8],vilain:9,vinnytsya:9,virginia:9,virtual:1,virtualenv:[],viterbo:9,viv:9,vizcaya:9,vla:9,vlaam:9,vlaanderen:9,vladimir:9,vlg:9,vli:9,volgograd:9,vologda:9,volyn:9,vor:9,voronezh:9,vorpommern:9,vosg:9,vov:9,vwv:9,wad:9,wadi:9,wai:[5,7],walk:[7,8],walkthrough:[7,8],wallon:9,waltham:9,wandsworth:9,wan t:[1,4,5,7,9],war:9,warrington:9,warwickshir:9,washington:9,wbk:9,wbr:9,wdu:9,wealth:7,wear:9,weather:7,weather_descript:7,web:[1,4,5],webserv:4,well:[0,1,4,5],were:[5,7],werkzeug:4,west:9,westfalen:9,westminst:9,wft:9,what:[0,1,4,7],wheel:4,where:[1,4,6,7],whether:[1,4],which:[1,3,4,6,7,9],who:[1,3],wht:9,widget:[1,8],wight:9,wil:9,wiltshir:9,window:[4,5],wisconsin:9,within:[5,6],without:5,wlg:9,wln:9,wlx:9,wna:9,wnd:9,won:1,wor:9,worcestershir:9,work:[0,1,4,6,7,8],worker:[4,6],world:[],would:[0,1,4,5],wrekin:9,wrexham:9,write:[4,6],written:6,wrt:9,wrx:9,wsm:9,wsx:9,wtf:4,wtf_csrf_enabled:4,www:9,wyom:9,xinjiang:9,xizang:9,yacoub:9,yamal:9,yan:9,yanovsk:9,yar:9,yaroslavl:9,year:7,yev:9,yevrei:9,yonn:9,yor:9,york:9,yorkshir:9,you:[],your:[],yourself:1,yum:4,yunnan:9,yvelin:9,zab:9,zabayk:9,zag:9,zagora:9,zamora:9,zaporizhzhya:9,zaragoza:9,zeeland:9,zeeuws:9,zet:9,zhejiang:9,zhytomyr:9,zouagha:9,zuid:9},titles:["Druid","FAQ","Gallery","Superset’s documentation","Installation &a mp; Configuration","Security","SQL Lab","Tutorial for Superset Administrators","Videos","Visualization Tools"],titleterms:{"new":[1,7,9],"public":5,about:1,access:[4,5],add:[1,9],adding:[7,8],admin:5,administr:7,aggregat:0,alpha:5,annotat:8,athena:4,availabl:6,aws:4,balanc:4,behind:4,big:1,blueprint:4,build:4,cach:4,can:1,column:1,configur:4,connect:7,content:3,cors:4,countri:9,creat:[1,7],creation:8,css:8,custom:[5,8],dashboard:[1,7,8],data:[1,5,7],databas:[4,7],deeper:4,defin:8,depend:4,develop:1,directori:1,document:3,doe:1,druid:[0,4],dynam:1,exist:1,explore:7,expression:8,extra:6,fabmanag:1,faq:1,featur:[3,6],filter:[1,8],freez:1,galleri:2,gamma:5,get:4,home:1,how:1,hung:1,indice:3,initi:4,instal:4,installat:4,integr:4,intro:8,jinja:6,join:1,lab:[4,6],list:9,load:4,macro:6,make:4,manag:5,map:[1,9],mapbox:1,metric:5,middleware:4,mount:1,multipl:1,need:9,nfs: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,respond :1,restrict:5,role:5,schema:4,secur:5,setup:4,slice:[7,8],some:5,sourc:[1,5],sql:[4,6,8],sql_lab:5,sqlalchemi:4,ssl:4,start:[1,4],subset:5,superset:[1,3,4,7],support:0,tabl:[1,3,7,8],templat:6,theme:8,time:1,tool:[4,9],tutori:7,type:1,upgrade:4,video:8,virtualenv:4,visibl:1,visual:[1,9],when:1,why:1,yet:0,you:9,your:[4,7]}}) \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-superset-site/blob/886f04b0/security.html ---------------------------------------------------------------------- diff --git a/security.html b/security.html new file mode 100644 index 0000000..792349d --- /dev/null +++ b/security.html @@ -0,0 +1,364 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Security — Superset's documentation documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="genindex.html"/> + <link rel="search" title="Search" href="search.html"/> + <link rel="top" title="Superset's documentation documentation" href="index.html"/> + <link rel="next" title="SQL Lab" href="sqllab.html"/> + <link rel="prev" title="Tutorial for Superset Administrators" href="tutorial.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search"> + + + + <a href="index.html" class="icon icon-home"> Superset's documentation + + + + </a> + + + + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation & Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Security</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#provided-roles">Provided Roles</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#admin">Admin</a></li> +<li class="toctree-l3"><a class="reference internal" href="#alpha">Alpha</a></li> +<li class="toctree-l3"><a class="reference internal" href="#gamma">Gamma</a></li> +<li class="toctree-l3"><a class="reference internal" href="#sql-lab">sql_lab</a></li> +<li class="toctree-l3"><a class="reference internal" href="#public">Public</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#managing-gamma-per-data-source-access">Managing Gamma per data source access</a></li> +<li class="toctree-l2"><a class="reference internal" href="#customizing">Customizing</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#permissions">Permissions</a></li> +<li class="toctree-l3"><a class="reference internal" href="#restricting-access-to-a-subset-of-data-sources">Restricting access to a subset of data sources</a></li> +<li class="toctree-l3"><a class="reference internal" href="#restricting-the-access-to-some-metrics">Restricting the access to some metrics</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li> +<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li> +<li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li> +<li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li> +<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">Superset's documentation</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html">Docs</a> »</li> + + <li>Security</li> + <li class="wy-breadcrumbs-aside"> + + + + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="security"> +<h1>Security<a class="headerlink" href="#security" title="Permalink to this headline">¶</a></h1> +<p>Security in Superset is handled by Flask AppBuilder (FAB). FAB is a +“Simple and rapid application development framework, built on top of Flask.”. +FAB provides authentication, user management, permissions and roles.</p> +<div class="section" id="provided-roles"> +<h2>Provided Roles<a class="headerlink" href="#provided-roles" title="Permalink to this headline">¶</a></h2> +<p>Superset ships with a set of roles that are handled by Superset itself. +You can assume that these roles will stay up-to-date as Superset evolves. +Even though it’s possible for <code class="docutils literal"><span class="pre">Admin</span></code> usrs to do so, it is not recommended +that you alter these roles in any way by removing +or adding permissions to them as these roles will be re-synchronized to +their original values as you run your next <code class="docutils literal"><span class="pre">superset</span> <span class="pre">init</span></code> command.</p> +<p>Since it’s not recommended to alter the roles described here, it’s right +to assume that your security strategy should be to compose user access based +on these base roles and roles that you create. For instance you could +create a role <code class="docutils literal"><span class="pre">Financial</span> <span class="pre">Analyst</span></code> that would be made of set of permissions +to a set of data sources (tables) and/or databases. Users would then be +granted <code class="docutils literal"><span class="pre">Gamma</span></code>, <code class="docutils literal"><span class="pre">Financial</span> <span class="pre">Analyst</span></code>, and perhaps <code class="docutils literal"><span class="pre">sql_lab</span></code>.</p> +<div class="section" id="admin"> +<h3>Admin<a class="headerlink" href="#admin" title="Permalink to this headline">¶</a></h3> +<p>Admins have all possible rights, including granting or revoking rights from +other users and altering other people’s slices and dashboards.</p> +</div> +<div class="section" id="alpha"> +<h3>Alpha<a class="headerlink" href="#alpha" title="Permalink to this headline">¶</a></h3> +<p>Alpha have access to all data sources, but they cannot grant or revoke access +from other users. They are also limited to altering the objects that they +own. Alpha users can add and alter data sources.</p> +</div> +<div class="section" id="gamma"> +<h3>Gamma<a class="headerlink" href="#gamma" title="Permalink to this headline">¶</a></h3> +<p>Gamma have limited access. They can only consume data coming from data sources +they have been giving access to through another complementary role. +They only have access to view the slices and +dashboards made from data sources that they have access to. Currently Gamma +users are not able to alter or add data sources. We assume that they are +mostly content consumers, though they can create slices and dashboards.</p> +<p>Also note that when Gamma users look at the dashboards and slices list view, +they will only see the objects that they have access to.</p> +</div> +<div class="section" id="sql-lab"> +<h3>sql_lab<a class="headerlink" href="#sql-lab" title="Permalink to this headline">¶</a></h3> +<p>The <code class="docutils literal"><span class="pre">sql_lab</span></code> role grants access to SQL Lab. Note that while <code class="docutils literal"><span class="pre">Admin</span></code> +users have access to all databases by default, both <code class="docutils literal"><span class="pre">Alpha</span></code> and <code class="docutils literal"><span class="pre">Gamma</span></code> +users need to be given access on a per database basis.</p> +</div> +<div class="section" id="public"> +<h3>Public<a class="headerlink" href="#public" title="Permalink to this headline">¶</a></h3> +<p>It’s possible to allow logged out users to access some Superset features.</p> +<p>By setting <code class="docutils literal"><span class="pre">PUBLIC_ROLE_LIKE_GAMMA</span> <span class="pre">=</span> <span class="pre">True</span></code> in your <code class="docutils literal"><span class="pre">superset_config.py</span></code>, +you grant public role the same set of permissions as for the GAMMA role. +This is useful if one wants to enable anonymous users to view +dashboards. Explicit grant on specific datasets is still required, meaning +that you need to edit the <code class="docutils literal"><span class="pre">Public</span></code> role and add the Public data sources +to the role manually.</p> +</div> +</div> +<div class="section" id="managing-gamma-per-data-source-access"> +<h2>Managing Gamma per data source access<a class="headerlink" href="#managing-gamma-per-data-source-access" title="Permalink to this headline">¶</a></h2> +<p>Here’s how to provide users access to only specific datasets. First make +sure the users with limited access have [only] the Gamma role assigned to +them. Second, create a new role (<code class="docutils literal"><span class="pre">Menu</span> <span class="pre">-></span> <span class="pre">Security</span> <span class="pre">-></span> <span class="pre">List</span> <span class="pre">Roles</span></code>) and +click the <code class="docutils literal"><span class="pre">+</span></code> sign.</p> +<a class="reference internal image-reference" href="_images/create_role.png"><img alt="_images/create_role.png" src="_images/create_role.png" style="width: 591.5px; height: 309.5px;" /></a> +<p>This new window allows you to give this new role a name, attribute it to users +and select the tables in the <code class="docutils literal"><span class="pre">Permissions</span></code> dropdown. To select the data +sources you want to associate with this role, simply click in the dropdown +and use the typeahead to search for your table names.</p> +<p>You can then confirm with your Gamma users that they see the objects +(dashboards and slices) associated with the tables related to their roles.</p> +</div> +<div class="section" id="customizing"> +<h2>Customizing<a class="headerlink" href="#customizing" title="Permalink to this headline">¶</a></h2> +<p>The permissions exposed by FAB are very granular and allow for a great level +of customization. FAB creates many permissions automagically for each model +that is create (can_add, can_delete, can_show, can_edit, ...) as well as for +each view. On top of that, Superset can expose more granular permissions like +<code class="docutils literal"><span class="pre">all_datasource_access</span></code>.</p> +<p>We do not recommend altering the 3 base roles as there +are a set of assumptions that Superset build upon. It is possible though for +you to create your own roles, and union them to existing ones.</p> +<div class="section" id="permissions"> +<h3>Permissions<a class="headerlink" href="#permissions" title="Permalink to this headline">¶</a></h3> +<p>Roles are composed of a set of permissions, and Superset has many categories +of permissions. Here are the different categories of permissions:</p> +<ul class="simple"> +<li><strong>Model & action</strong>: models are entities like <code class="docutils literal"><span class="pre">Dashboard</span></code>, +<code class="docutils literal"><span class="pre">Slice</span></code>, or <code class="docutils literal"><span class="pre">User</span></code>. Each model has a fixed set of permissions, like +<code class="docutils literal"><span class="pre">can_edit</span></code>, <code class="docutils literal"><span class="pre">can_show</span></code>, <code class="docutils literal"><span class="pre">can_delete</span></code>, <code class="docutils literal"><span class="pre">can_list</span></code>, <code class="docutils literal"><span class="pre">can_add</span></code>, and +so on. By adding <code class="docutils literal"><span class="pre">can_delete</span> <span class="pre">on</span> <span class="pre">Dashboard</span></code> to a role, and granting that +role to a user, this user will be able to delete dashboards.</li> +<li><strong>Views</strong>: views are individual web pages, like the <code class="docutils literal"><span class="pre">explore</span></code> view or the +<code class="docutils literal"><span class="pre">SQL</span> <span class="pre">Lab</span></code> view. When granted to a user, he/she will see that view in +the its menu items, and be able to load that page.</li> +<li><strong>Data source</strong>: For each data source, a permission is created. If the user +does not have the <code class="docutils literal"><span class="pre">all_datasource_access</span></code> permission granted, the user +will only be able to see Slices or explore the data sources that are granted +to them</li> +<li><strong>Database</strong>: Granting access to a database allows for the user to access +all data sources within that database, and will enable the user to query +that database in SQL Lab, provided that the SQL Lab specific permission +have been granted to the user</li> +</ul> +</div> +<div class="section" id="restricting-access-to-a-subset-of-data-sources"> +<h3>Restricting access to a subset of data sources<a class="headerlink" href="#restricting-access-to-a-subset-of-data-sources" title="Permalink to this headline">¶</a></h3> +<p>The best way to go is probably to give user <code class="docutils literal"><span class="pre">Gamma</span></code> plus one or many other +roles that would add access to specific data sources. We recommend that you +create individual roles for each access profile. Say people in your finance +department might have access to a set of databases and data sources, and +these permissions can be consolidated in a single role. Users with this +profile then need to be attributed <code class="docutils literal"><span class="pre">Gamma</span></code> as a foundation to the models +and views they can access, and that <code class="docutils literal"><span class="pre">Finance</span></code> role that is a collection +of permissions to data objects.</p> +<p>One user can have many roles, so a finance executive could be granted +<code class="docutils literal"><span class="pre">Gamma</span></code>, <code class="docutils literal"><span class="pre">Finance</span></code>, and perhaps another <code class="docutils literal"><span class="pre">Executive</span></code> role that gather +a set of data sources that power dashboards only made available to executives. +When looking at its dashboard list, this user will only see the +list of dashboards it has access to, based on the roles and +permissions that were attributed.</p> +</div> +<div class="section" id="restricting-the-access-to-some-metrics"> +<h3>Restricting the access to some metrics<a class="headerlink" href="#restricting-the-access-to-some-metrics" title="Permalink to this headline">¶</a></h3> +<p>Sometimes some metrics are relatively sensitive (e.g. revenue). +We may want to restrict those metrics to only a few roles. +For example, assumed there is a metric <code class="docutils literal"><span class="pre">[cluster1].[datasource1].[revenue]</span></code> +and only Admin users are allowed to see it. Hereâs how to restrict the access.</p> +<ol class="arabic simple"> +<li>Edit the datasource (<code class="docutils literal"><span class="pre">Menu</span> <span class="pre">-></span> <span class="pre">Source</span> <span class="pre">-></span> <span class="pre">Druid</span> <span class="pre">datasources</span> <span class="pre">-></span> <span class="pre">edit</span> <span class="pre">the</span> +<span class="pre">record</span> <span class="pre">"datasource1"</span></code>) and go to the tab <code class="docutils literal"><span class="pre">List</span> <span class="pre">Druid</span> <span class="pre">Metric</span></code>. Check +the checkbox <code class="docutils literal"><span class="pre">Is</span> <span class="pre">Restricted</span></code> in the row of the metric <code class="docutils literal"><span class="pre">revenue</span></code>.</li> +<li>Edit the role (<code class="docutils literal"><span class="pre">Menu</span> <span class="pre">-></span> <span class="pre">Security</span> <span class="pre">-></span> <span class="pre">List</span> <span class="pre">Roles</span> <span class="pre">-></span> <span class="pre">edit</span> <span class="pre">the</span> <span class="pre">record</span> +<span class="pre">âAdminâ</span></code>), in the permissions field, type-and-search the permission +<code class="docutils literal"><span class="pre">metric</span> <span class="pre">access</span> <span class="pre">on</span> <span class="pre">[cluster1].[datasource1].[revenue]</span> <span class="pre">(id:</span> <span class="pre">1)</span></code>, then +click the Save button on the bottom of the page.</li> +</ol> +<p>Any users without the permission will see the error message +<em>Access to the metrics denied: revenue (Status: 500)</em> in the slices. +It also happens when the user wants to access a post-aggregation metric that +is dependent on revenue.</p> +</div> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="sqllab.html" class="btn btn-neutral float-right" title="SQL Lab" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="tutorial.html" class="btn btn-neutral" title="Tutorial for Superset Administrators" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'./', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-superset-site/blob/886f04b0/sqllab.html ---------------------------------------------------------------------- diff --git a/sqllab.html b/sqllab.html new file mode 100644 index 0000000..60c7531 --- /dev/null +++ b/sqllab.html @@ -0,0 +1,292 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>SQL Lab — Superset's documentation documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="genindex.html"/> + <link rel="search" title="Search" href="search.html"/> + <link rel="top" title="Superset's documentation documentation" href="index.html"/> + <link rel="next" title="Visualization Tools" href="visualization.html"/> + <link rel="prev" title="Security" href="security.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search"> + + + + <a href="index.html" class="icon icon-home"> Superset's documentation + + + + </a> + + + + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation & Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a></li> +<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">SQL Lab</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#feature-overview">Feature Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="#extra-features">Extra features</a></li> +<li class="toctree-l2"><a class="reference internal" href="#templating-with-jinja">Templating with Jinja</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#available-macros">Available macros</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li> +<li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li> +<li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li> +<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">Superset's documentation</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html">Docs</a> »</li> + + <li>SQL Lab</li> + <li class="wy-breadcrumbs-aside"> + + + + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="sql-lab"> +<h1>SQL Lab<a class="headerlink" href="#sql-lab" title="Permalink to this headline">¶</a></h1> +<p>SQL Lab is a modern, feature-rich SQL IDE written in +<a class="reference external" href="https://facebook.github.io/react/";>React</a>.</p> +<div class="section" id="feature-overview"> +<h2>Feature Overview<a class="headerlink" href="#feature-overview" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li>Connects to just about any database backend</li> +<li>A multi-tab environment to work on multiple queries at a time</li> +<li>A smooth flow to visualize your query results using Superset’s rich +visualization capabilities</li> +<li>Browse database metadata: tables, columns, indexes, partitions</li> +<li>Support for long-running queries<ul> +<li>uses the <a class="reference external" href="http://www.python.org/";>Celery distributed queue</a> +to dispatch query handling to workers</li> +<li>supports defining a “results backend” to persist query results</li> +</ul> +</li> +<li>A search engine to find queries executed in the past</li> +<li>Supports templating using the +<a class="reference external" href="http://jinja.pocoo.org/docs/dev/";>Jinja templating language</a> +which allows for using macros in your SQL code</li> +</ul> +</div> +<div class="section" id="extra-features"> +<h2>Extra features<a class="headerlink" href="#extra-features" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li>Hit <code class="docutils literal"><span class="pre">alt</span> <span class="pre">+</span> <span class="pre">enter</span></code> as a keyboard shortcut to run your query</li> +</ul> +</div> +<div class="section" id="templating-with-jinja"> +<h2>Templating with Jinja<a class="headerlink" href="#templating-with-jinja" title="Permalink to this headline">¶</a></h2> +<div class="highlight-sql"><div class="highlight"><pre><span></span><span class="k">SELECT</span> <span class="o">*</span> +<span class="k">FROM</span> <span class="n">some_table</span> +<span class="k">WHERE</span> <span class="n">partition_key</span> <span class="o">=</span> <span class="s1">'{{ presto.latest_partition('</span><span class="n">some_table</span><span class="s1">') }}'</span> +</pre></div> +</div> +<p>Templating unleashes the power and capabilities of a +programming language within your SQL code.</p> +<p>Templates can also be used to write generic queries that are +parameterized so they can be re-used easily.</p> +<div class="section" id="available-macros"> +<h3>Available macros<a class="headerlink" href="#available-macros" title="Permalink to this headline">¶</a></h3> +<p>We expose certain modules from Python’s standard library in +Superset’s Jinja context: +- <code class="docutils literal"><span class="pre">time</span></code>: <code class="docutils literal"><span class="pre">time</span></code> +- <code class="docutils literal"><span class="pre">datetime</span></code>: <code class="docutils literal"><span class="pre">datetime.datetime</span></code> +- <code class="docutils literal"><span class="pre">uuid</span></code>: <code class="docutils literal"><span class="pre">uuid</span></code> +- <code class="docutils literal"><span class="pre">random</span></code>: <code class="docutils literal"><span class="pre">random</span></code> +- <code class="docutils literal"><span class="pre">relativedelta</span></code>: <code class="docutils literal"><span class="pre">dateutil.relativedelta.relativedelta</span></code> +- more to come!</p> +<p><a class="reference external" href="http://jinja.pocoo.org/docs/dev/templates/";>Jinja’s builtin filters</a> can be also be applied where needed.</p> +<dl class="class"> +<dt id="superset.jinja_context.PrestoTemplateProcessor"> +<em class="property">class </em><code class="descclassname">superset.jinja_context.</code><code class="descname">PrestoTemplateProcessor</code><span class="sig-paren">(</span><em>database=None</em>, <em>query=None</em>, <em>table=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/superset/jinja_context.html#PrestoTemplateProcessor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#superset.jinja_context.PrestoTemplateProcessor" title="Permalink to this definition">¶</a></dt> +<dd><p>Presto Jinja context</p> +<p>The methods described here are namespaced under <code class="docutils literal"><span class="pre">presto</span></code> in the +jinja context as in <code class="docutils literal"><span class="pre">SELECT</span> <span class="pre">'{{</span> <span class="pre">presto.some_macro_call()</span> <span class="pre">}}'</span></code></p> +</dd></dl> + +<dl class="function"> +<dt id="superset.jinja_context.url_param"> +<code class="descclassname">superset.jinja_context.</code><code class="descname">url_param</code><span class="sig-paren">(</span><em>param</em>, <em>default=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/superset/jinja_context.html#url_param"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#superset.jinja_context.url_param" title="Permalink to this definition">¶</a></dt> +<dd><p>Get a url paramater</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>param</strong> (<em>str</em>) – the url parameter to lookup</li> +<li><strong>default</strong> (<em>str</em>) – the value to return in the absence of the parameter</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="visualization.html" class="btn btn-neutral float-right" title="Visualization Tools" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="security.html" class="btn btn-neutral" title="Security" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'./', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-superset-site/blob/886f04b0/tutorial.html ---------------------------------------------------------------------- diff --git a/tutorial.html b/tutorial.html new file mode 100644 index 0000000..1d61d8d --- /dev/null +++ b/tutorial.html @@ -0,0 +1,416 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Tutorial for Superset Administrators — Superset's documentation documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="genindex.html"/> + <link rel="search" title="Search" href="search.html"/> + <link rel="top" title="Superset's documentation documentation" href="index.html"/> + <link rel="next" title="Security" href="security.html"/> + <link rel="prev" title="Installation & Configuration" href="installation.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search"> + + + + <a href="index.html" class="icon icon-home"> Superset's documentation + + + + </a> + + + + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation & Configuration</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Tutorial for Superset Administrators</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#connecting-to-a-new-database">Connecting to a new database</a></li> +<li class="toctree-l2"><a class="reference internal" href="#adding-a-new-table">Adding a new table</a></li> +<li class="toctree-l2"><a class="reference internal" href="#exploring-your-data">Exploring your data</a></li> +<li class="toctree-l2"><a class="reference internal" href="#creating-a-slice-and-dashboard">Creating a slice and dashboard</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li> +<li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li> +<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li> +<li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li> +<li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li> +<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">Superset's documentation</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html">Docs</a> »</li> + + <li>Tutorial for Superset Administrators</li> + <li class="wy-breadcrumbs-aside"> + + + + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="tutorial-for-superset-administrators"> +<h1>Tutorial for Superset Administrators<a class="headerlink" href="#tutorial-for-superset-administrators" title="Permalink to this headline">¶</a></h1> +<p>This tutorial targets a Superset administrator: someone configuring Superset +for an organization on behalf of users. We’ll show you how to connect Superset +to a new database and configure a table in that database for analysis. You’ll +also explore the data you’ve exposed and add a visualization to a dashboard +so that you get a feel for the end-to-end user experience.</p> +<div class="section" id="connecting-to-a-new-database"> +<h2>Connecting to a new database<a class="headerlink" href="#connecting-to-a-new-database" title="Permalink to this headline">¶</a></h2> +<p>We assume you already have a database configured and can connect to it from the +instance on which youâre running Superset. If youâre just testing Superset and +want to explore sample data, you can load some +<a class="reference external" href="https://wiki.postgresql.org/wiki/Sample_Databases";>sample PostgreSQL datasets</a> +into a fresh DB, or configure the +<a class="reference external" href="https://github.com/dylburger/noaa-ghcn-weather-data";>example weather data</a> +we use here.</p> +<p>Under the <strong>Sources</strong> menu, select the <em>Databases</em> option:</p> +<a class="reference internal image-reference" href="_images/tutorial_01_sources_database.png"><img alt="_images/tutorial_01_sources_database.png" src="_images/tutorial_01_sources_database.png" style="width: 316.4px; height: 187.6px;" /></a> +<p>On the resulting page, click on the green plus sign, near the top left:</p> +<a class="reference internal image-reference" href="_images/tutorial_02_add_database.png"><img alt="_images/tutorial_02_add_database.png" src="_images/tutorial_02_add_database.png" style="width: 369.6px; height: 232.4px;" /></a> +<p>You can configure a number of advanced options on this page, but for +this walkthrough, youâll only need to do <strong>two things</strong>:</p> +<ol class="arabic simple"> +<li>Name your database connection:</li> +</ol> +<a class="reference internal image-reference" href="_images/tutorial_03_database_name.png"><img alt="_images/tutorial_03_database_name.png" src="_images/tutorial_03_database_name.png" style="width: 554.4px; height: 98.0px;" /></a> +<ol class="arabic simple" start="2"> +<li>Provide the SQLAlchemy Connection URI and test the connection:</li> +</ol> +<a class="reference internal image-reference" href="_images/tutorial_04_sqlalchemy_connection_string.png"><img alt="_images/tutorial_04_sqlalchemy_connection_string.png" src="_images/tutorial_04_sqlalchemy_connection_string.png" style="width: 1071.0px; height: 196.0px;" /></a> +<p>This example shows the connection string for our test weather database. +As noted in the text below the URI, you should refer to the SQLAlchemy +documentation on +<a class="reference external" href="http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html#database-urls";>creating new connection URIs</a> +for your target database.</p> +<p>Click the <strong>Test Connection</strong> button to confirm things work end to end. +Once Superset can successfully connect and authenticate, you should see +a popup like this:</p> +<a class="reference internal image-reference" href="_images/tutorial_05_connection_popup.png"><img alt="_images/tutorial_05_connection_popup.png" src="_images/tutorial_05_connection_popup.png" style="width: 562.0px; height: 277.0px;" /></a> +<p>Moreover, you should also see the list of tables Superset can read from +the schema youâre connected to, at the bottom of the page:</p> +<a class="reference internal image-reference" href="_images/tutorial_06_list_of_tables.png"><img alt="_images/tutorial_06_list_of_tables.png" src="_images/tutorial_06_list_of_tables.png" style="width: 963.2px; height: 127.4px;" /></a> +<p>If the connection looks good, save the configuration by clicking the <strong>Save</strong> +button at the bottom of the page:</p> +<a class="reference internal image-reference" href="_images/tutorial_07_save_button.png"><img alt="_images/tutorial_07_save_button.png" src="_images/tutorial_07_save_button.png" style="width: 187.6px; height: 85.4px;" /></a> +</div> +<div class="section" id="adding-a-new-table"> +<h2>Adding a new table<a class="headerlink" href="#adding-a-new-table" title="Permalink to this headline">¶</a></h2> +<p>Now that youâve configured a database, youâll need to add specific tables +to Superset that youâd like to query.</p> +<p>Under the <strong>Sources</strong> menu, select the <em>Tables</em> option:</p> +<a class="reference internal image-reference" href="_images/tutorial_08_sources_tables.png"><img alt="_images/tutorial_08_sources_tables.png" src="_images/tutorial_08_sources_tables.png" style="width: 315.0px; height: 187.6px;" /></a> +<p>On the resulting page, click on the green plus sign, near the top left:</p> +<a class="reference internal image-reference" href="_images/tutorial_09_add_new_table.png"><img alt="_images/tutorial_09_add_new_table.png" src="_images/tutorial_09_add_new_table.png" style="width: 322.0px; height: 232.4px;" /></a> +<p>You only need a few pieces of information to add a new table to Superset:</p> +<ul class="simple"> +<li>The name of the table</li> +</ul> +<a class="reference internal image-reference" href="_images/tutorial_10_table_name.png"><img alt="_images/tutorial_10_table_name.png" src="_images/tutorial_10_table_name.png" style="width: 772.8px; height: 130.2px;" /></a> +<ul class="simple"> +<li>The target database from the <strong>Database</strong> drop-down menu (i.e. the one +you just added above)</li> +</ul> +<a class="reference internal image-reference" href="_images/tutorial_11_choose_db.png"><img alt="_images/tutorial_11_choose_db.png" src="_images/tutorial_11_choose_db.png" style="width: 387.8px; height: 229.6px;" /></a> +<ul class="simple"> +<li>Optionally, the database schema. If the table exists in the âdefaultâ schema +(e.g. the <em>public</em> schema in PostgreSQL or Redshift), you can leave the schema +field blank.</li> +</ul> +<p>Click on the <strong>Save</strong> button to save the configuration:</p> +<a class="reference internal image-reference" href="_images/tutorial_07_save_button.png"><img alt="_images/tutorial_07_save_button.png" src="_images/tutorial_07_save_button.png" style="width: 187.6px; height: 85.4px;" /></a> +<p>When redirected back to the list of tables, you should see a message indicating +that your table was created:</p> +<a class="reference internal image-reference" href="_images/tutorial_12_table_creation_success_msg.png"><img alt="_images/tutorial_12_table_creation_success_msg.png" src="_images/tutorial_12_table_creation_success_msg.png" style="width: 1260.0px; height: 89.6px;" /></a> +<p>This message also directs you to edit the table configuration. Weâll edit a limited +portion of the configuration now - just to get you started - and leave the rest for +a more advanced tutorial.</p> +<p>Click on the edit button next to the table youâve created:</p> +<a class="reference internal image-reference" href="_images/tutorial_13_edit_table_config.png"><img alt="_images/tutorial_13_edit_table_config.png" src="_images/tutorial_13_edit_table_config.png" style="width: 509.6px; height: 180.6px;" /></a> +<p>On the resulting page, click on the <strong>List Table Column</strong> tab. Here, youâll define the +way you can use specific columns of your table when exploring your data. Weâll run +through these options to describe their purpose:</p> +<ul class="simple"> +<li>If you want users to group metrics by a specific field, mark it as <strong>Groupable</strong>.</li> +<li>If you need to filter on a specific field, mark it as <strong>Filterable</strong>.</li> +<li>Is this field something youâd like to get the distinct count of? Check the <strong>Count +Distinct</strong> box.</li> +<li>Is this a metric you want to sum, or get basic summary statistics for? The <strong>Sum</strong>, +<strong>Min</strong>, and <strong>Max</strong> columns will help.</li> +<li>The <strong>is temporal</strong> field should be checked for any date or time fields. Weâll cover +how this manifests itself in analyses in a moment.</li> +</ul> +<p>Hereâs how weâve configured fields for the weather data. Even for measures like the +weather measurements (precipitation, snowfall, etc.), itâs ideal to group and filter +by these values:</p> +<img alt="_images/tutorial_14_field_config.png" src="_images/tutorial_14_field_config.png" /> +<p>As with the configurations above, click the <strong>Save</strong> button to save these settings.</p> +</div> +<div class="section" id="exploring-your-data"> +<h2>Exploring your data<a class="headerlink" href="#exploring-your-data" title="Permalink to this headline">¶</a></h2> +<p>To start exploring your data, simply click on the table name you just created in +the list of available tables:</p> +<img alt="_images/tutorial_15_click_table_name.png" src="_images/tutorial_15_click_table_name.png" /> +<p>By default, youâll be presented with a Table View:</p> +<img alt="_images/tutorial_16_datasource_chart_type.png" src="_images/tutorial_16_datasource_chart_type.png" /> +<p>Letâs walk through a basic query to get the count of all records in our table. +First, weâll need to change the <strong>Since</strong> filter to capture the range of our data. +You can use simple phrases to apply these filters, like “3 years ago”:</p> +<img alt="_images/tutorial_17_choose_time_range.png" src="_images/tutorial_17_choose_time_range.png" /> +<p>The upper limit for time, the <strong>Until</strong> filter, defaults to “now”, which may or may +not be what you want.</p> +<p>Look for the Metrics section under the <strong>GROUP BY</strong> header, and start typing “Count” +- youâll see a list of metrics matching what you type:</p> +<img alt="_images/tutorial_18_choose_metric.png" src="_images/tutorial_18_choose_metric.png" /> +<p>Select the <em>COUNT(*)</em> metric, then click the green <strong>Query</strong> button near the top +of the explore:</p> +<img alt="_images/tutorial_19_click_query.png" src="_images/tutorial_19_click_query.png" /> +<p>Youâll see your results in the table:</p> +<img alt="_images/tutorial_20_count_star_result.png" src="_images/tutorial_20_count_star_result.png" /> +<p>Letâs group this by the <em>weather_description</em> field to get the count of records by +the type of weather recorded by adding it to the <em>Group by</em> section:</p> +<img alt="_images/tutorial_21_group_by.png" src="_images/tutorial_21_group_by.png" /> +<p>and run the query:</p> +<img alt="_images/tutorial_22_group_by_result.png" src="_images/tutorial_22_group_by_result.png" /> +<p>Letâs find a more useful data point: the top 10 times and places that recorded the +highest temperature in 2015.</p> +<p>We replace <em>weather_description</em> with <em>latitude</em>, <em>longitude</em> and <em>measurement_date</em> in the +<em>Group by</em> section:</p> +<img alt="_images/tutorial_23_group_by_more_dimensions.png" src="_images/tutorial_23_group_by_more_dimensions.png" /> +<p>And replace <em>COUNT(*)</em> with <em>max__measurement_flag</em>:</p> +<img alt="_images/tutorial_24_max_metric.png" src="_images/tutorial_24_max_metric.png" /> +<p>The <em>max__measurement_flag</em> metric was created when we checked the box under <strong>Max</strong> and +next to the <em>measurement_flag</em> field, indicating that this field was numeric and that +we wanted to find its maximum value when grouped by specific fields.</p> +<p>In our case, <em>measurement_flag</em> is the value of the measurement taken, which clearly +depends on the type of measurement (the researchers recorded different values for +precipitation and temperature). Therefore, we must filter our query only on records +where the <em>weather_description</em> is equal to “Maximum temperature”, which we do in +the <strong>Filters</strong> section at the bottom of the explore:</p> +<img alt="_images/tutorial_25_max_temp_filter.png" src="_images/tutorial_25_max_temp_filter.png" /> +<p>Finally, since we only care about the top 10 measurements, we limit our results to +10 records using the <em>Row limit</em> option under the <strong>Options</strong> header:</p> +<img alt="_images/tutorial_26_row_limit.png" src="_images/tutorial_26_row_limit.png" /> +<p>We click <strong>Query</strong> and get the following results:</p> +<img alt="_images/tutorial_27_top_10_max_temps.png" src="_images/tutorial_27_top_10_max_temps.png" /> +<p>In this dataset, the maximum temperature is recorded in tenths of a degree Celsius. +The top value of 1370, measured in the middle of Nevada, is equal to 137 C, or roughly +278 degrees F. Itâs unlikely this value was correctly recorded. Weâve already been able +to investigate some outliers with Superset, but this just scratches the surface of what +we can do.</p> +<p>You may want to do a couple more things with this measure:</p> +<ul class="simple"> +<li>The default formatting shows values like 1.37k, which may be difficult for some +users to read. Itâs likely you may want to see the full, comma-separated value. +You can change the formatting of any measure by editing its config (<em>Edit Table +Config > List Sql Metric > Edit Metric > D3Format</em>)</li> +<li>Moreover, you may want to see the temperature measurements in plain degrees C, +not tenths of a degree. Or you may want to convert the temperature to degrees +Fahrenheit. You can change the SQL that gets executed agains the database, baking +the logic into the measure itself (<em>Edit Table Config > List Sql Metric > Edit +Metric > SQL Expression</em>)</li> +</ul> +<p>For now, though, letâs create a better visualization of these data and add it to +a dashboard.</p> +<p>We change the Chart Type to “Distribution - Bar Chart”:</p> +<img alt="_images/tutorial_28_bar_chart.png" src="_images/tutorial_28_bar_chart.png" /> +<p>Our filter on Maximum temperature measurements was retained, but the query and +formatting options are dependent on the chart type, so youâll have to set the +values again:</p> +<img alt="_images/tutorial_29_bar_chart_series_metrics.png" src="_images/tutorial_29_bar_chart_series_metrics.png" /> +<p>You should note the extensive formatting options for this chart: the ability to +set axis labels, margins, ticks, etc. To make the data presentable to a broad +audience, youâll want to apply many of these to slices that end up in dashboards. +For now, though, we run our query and get the following chart:</p> +<a class="reference internal image-reference" href="_images/tutorial_30_bar_chart_results.png"><img alt="_images/tutorial_30_bar_chart_results.png" src="_images/tutorial_30_bar_chart_results.png" style="width: 956.9px; height: 435.4px;" /></a> +</div> +<div class="section" id="creating-a-slice-and-dashboard"> +<h2>Creating a slice and dashboard<a class="headerlink" href="#creating-a-slice-and-dashboard" title="Permalink to this headline">¶</a></h2> +<p>This view might be interesting to researchers, so letâs save it. In Superset, +a saved query is called a <strong>Slice</strong>.</p> +<p>To create a slice, click the <strong>Save as</strong> button near the top-left of the +explore:</p> +<img alt="_images/tutorial_19_click_query.png" src="_images/tutorial_19_click_query.png" /> +<p>A popup should appear, asking you to name the slice, and optionally add it to a +dashboard. Since we havenât yet created any dashboards, we can create one and +immediately add our slice to it. Letâs do it:</p> +<a class="reference internal image-reference" href="_images/tutorial_31_save_slice_to_dashboard.png"><img alt="_images/tutorial_31_save_slice_to_dashboard.png" src="_images/tutorial_31_save_slice_to_dashboard.png" style="width: 432.6px; height: 268.8px;" /></a> +<p>Click Save, which will direct you back to your original query. We see that +our slice and dashboard were successfully created:</p> +<a class="reference internal image-reference" href="_images/tutorial_32_save_slice_confirmation.png"><img alt="_images/tutorial_32_save_slice_confirmation.png" src="_images/tutorial_32_save_slice_confirmation.png" style="width: 611.8px; height: 105.7px;" /></a> +<p>Letâs check out our new dashboard. We click on the <strong>Dashboards</strong> menu:</p> +<img alt="_images/tutorial_33_dashboard.png" src="_images/tutorial_33_dashboard.png" /> +<p>and find the dashboard we just created:</p> +<img alt="_images/tutorial_34_weather_dashboard.png" src="_images/tutorial_34_weather_dashboard.png" /> +<p>Things seemed to have worked - our slice is here!</p> +<a class="reference internal image-reference" href="_images/tutorial_35_slice_on_dashboard.png"><img alt="_images/tutorial_35_slice_on_dashboard.png" src="_images/tutorial_35_slice_on_dashboard.png" style="width: 464.8px; height: 397.6px;" /></a> +<p>But itâs a bit smaller than we might like. Luckily, you can adjust the size +of slices in a dashboard by clicking, holding and dragging the bottom-right +corner to your desired dimensions:</p> +<a class="reference internal image-reference" href="_images/tutorial_36_adjust_dimensions.gif"><img alt="_images/tutorial_36_adjust_dimensions.gif" src="_images/tutorial_36_adjust_dimensions.gif" style="width: 576.0px; height: 297.6px;" /></a> +<p>After adjusting the size, youâll be asked to click on the icon near the +top-right of the dashboard to save the new configuration.</p> +<p>Congrats! Youâve successfully linked, analyzed, and visualized data in Superset. +There are a wealth of other table configuration and visualization options, so +please start exploring and creating slices and dashboards of your own.</p> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="security.html" class="btn btn-neutral float-right" title="Security" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="installation.html" class="btn btn-neutral" title="Installation & Configuration" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'./', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
