blob: 0c50089c029cf0809fcf04fc79a19ac8a552e3f6 [file] [log] [blame]
Search.setIndex({docnames:["_api/airflow/providers/databricks/hooks/databricks/index","_api/airflow/providers/databricks/hooks/index","_api/airflow/providers/databricks/index","_api/airflow/providers/databricks/operators/databricks/index","_api/airflow/providers/databricks/operators/index","commits","index","operators"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["_api/airflow/providers/databricks/hooks/databricks/index.rst","_api/airflow/providers/databricks/hooks/index.rst","_api/airflow/providers/databricks/index.rst","_api/airflow/providers/databricks/operators/databricks/index.rst","_api/airflow/providers/databricks/operators/index.rst","commits.rst","index.rst","operators.rst"],objects:{"airflow.providers":{databricks:[2,0,0,"-"]},"airflow.providers.databricks":{hooks:[1,0,0,"-"],operators:[4,0,0,"-"]},"airflow.providers.databricks.hooks":{databricks:[0,0,0,"-"]},"airflow.providers.databricks.hooks.databricks":{CANCEL_RUN_ENDPOINT:[0,1,1,""],DatabricksHook:[0,2,1,""],GET_RUN_ENDPOINT:[0,1,1,""],INSTALL_LIBS_ENDPOINT:[0,1,1,""],RESTART_CLUSTER_ENDPOINT:[0,1,1,""],RUN_LIFE_CYCLE_STATES:[0,1,1,""],RUN_NOW_ENDPOINT:[0,1,1,""],RunState:[0,2,1,""],START_CLUSTER_ENDPOINT:[0,1,1,""],SUBMIT_RUN_ENDPOINT:[0,1,1,""],TERMINATE_CLUSTER_ENDPOINT:[0,1,1,""],UNINSTALL_LIBS_ENDPOINT:[0,1,1,""],USER_AGENT_HEADER:[0,1,1,""],_TokenAuth:[0,2,1,""],_retryable_error:[0,5,1,""]},"airflow.providers.databricks.hooks.databricks.DatabricksHook":{_do_api_call:[0,3,1,""],_log_request_error:[0,3,1,""],_parse_host:[0,3,1,""],cancel_run:[0,3,1,""],conn_name_attr:[0,4,1,""],conn_type:[0,4,1,""],default_conn_name:[0,4,1,""],get_job_id:[0,3,1,""],get_run_page_url:[0,3,1,""],get_run_state:[0,3,1,""],hook_name:[0,4,1,""],install:[0,3,1,""],restart_cluster:[0,3,1,""],run_now:[0,3,1,""],start_cluster:[0,3,1,""],submit_run:[0,3,1,""],terminate_cluster:[0,3,1,""],uninstall:[0,3,1,""]},"airflow.providers.databricks.hooks.databricks.RunState":{__eq__:[0,3,1,""],__repr__:[0,3,1,""],is_successful:[0,4,1,""],is_terminal:[0,4,1,""]},"airflow.providers.databricks.hooks.databricks._TokenAuth":{__call__:[0,3,1,""]},"airflow.providers.databricks.operators":{databricks:[3,0,0,"-"]},"airflow.providers.databricks.operators.databricks":{DatabricksRunNowOperator:[3,2,1,""],DatabricksSubmitRunOperator:[3,2,1,""],XCOM_RUN_ID_KEY:[3,1,1,""],XCOM_RUN_PAGE_URL_KEY:[3,1,1,""],_deep_string_coerce:[3,5,1,""],_handle_databricks_operator_execution:[3,5,1,""]},"airflow.providers.databricks.operators.databricks.DatabricksRunNowOperator":{_get_hook:[3,3,1,""],execute:[3,3,1,""],on_kill:[3,3,1,""],template_fields:[3,4,1,""],ui_color:[3,4,1,""],ui_fgcolor:[3,4,1,""]},"airflow.providers.databricks.operators.databricks.DatabricksSubmitRunOperator":{_get_hook:[3,3,1,""],execute:[3,3,1,""],on_kill:[3,3,1,""],template_fields:[3,4,1,""],ui_color:[3,4,1,""],ui_fgcolor:[3,4,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","data","Python data"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"],"5":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:data","2":"py:class","3":"py:method","4":"py:attribute","5":"py:function"},terms:{"000":3,"00642a46d":5,"008035450":5,"0a0e1af80":5,"0b0e4f7a4":5,"0b2":5,"0beta1":5,"10205":5,"10462":5,"10483":5,"10525":5,"10528":5,"10543":5,"10762":5,"10818":5,"11170":5,"11238":5,"11242":5,"11249":5,"11447":5,"11487":5,"11688":5,"11826":5,"11855":5,"12082":5,"12175":5,"12206":5,"12212":5,"12304":5,"12316":5,"12366":5,"12390":5,"12427":5,"12438":5,"12444":5,"12449":5,"12558":5,"12681":5,"12917":5,"12955":5,"12af6a080":5,"12c5e5d8a":5,"13148":5,"13380":5,"13717":5,"13732":5,"13767":5,"1457570074236":3,"16903ba3a":5,"16e712971":5,"180":0,"1cb1c2":3,"2020":[5,6],"2021":5,"23rc1":5,"295d66f91":5,"2a1":5,"2f2d8dbfa":5,"32971a1a2":5,"3320e432a":5,"349b0811c":5,"3696c34c2":5,"375d1ca22":5,"3fd5ef355":5,"4d03e33c1":5,"4e8f9cc8d":5,"5220e4c38":5,"54353f874":5,"5648dfbc3":5,"59eb5de78":5,"5a439e84":5,"649935e8c":5,"6644":5,"6674":5,"6714":5,"6817":5,"6889a333c":5,"6cf76d7ac":5,"7265":5,"7287":5,"7338":5,"7456":5,"7517":5,"7825e8f59":5,"7827":5,"7ca0b6f12":5,"7d24b088c":5,"7e0d08e1f":5,"83c037873":5,"8472":5,"8473":5,"8474":5,"8475":5,"85a18e13d":5,"872b1566a":5,"8807":5,"8846":5,"8886":5,"8891":5,"8898":5,"8994":5,"8b1":5,"8c42cf1b0":5,"9026":5,"92585ca4c":5,"9320":5,"9370":5,"9404":5,"9408":5,"9458":5,"9549274d1":5,"9550":5,"966a06d96":5,"97a429f9d":5,"9985":5,"9b39f2478":5,"boolean":7,"byte":3,"case":[0,3,6],"class":[0,3,5,6,7],"default":3,"final":5,"float":[0,3],"function":[0,3],"import":5,"int":[0,3],"new":[3,6,7],"return":0,"static":0,"super":5,"switch":5,"throw":[0,3],"true":[0,3],AND:3,Added:5,Adding:5,For:[0,3,5],Its:3,The:[0,3,7],There:[3,7],Use:[5,7],__call__:0,__eq__:0,__init__:5,__repr__:0,_deep_string_coerc:3,_do_api_cal:[0,5],_get_hook:3,_handle_databricks_operator_execut:3,_log_request_error:0,_parse_host:0,_retryable_error:0,_tokenauth:0,a9ac2b040:5,about:[3,5],ac2f72c98:5,access:3,accomplish:[3,7],accord:5,actual:3,adam:3,add:[5,6],added:5,ae7cb4a1:5,age:3,aip:5,airflowexcept:0,all:[3,5,6],also:7,amazon:5,amount:[0,3,7],ani:3,anoth:[3,7],apach:3,api:[0,3,5,6,7],arrai:0,assert:0,attempt_num:0,auth:0,authbas:0,authent:3,auto:5,autom:5,b02722313:5,b2a28d159:5,b40dffa08:5,backend:[3,7],backport:5,base:[0,3],basehook:0,baseoper:3,batch:5,bd90136aa:5,becaus:3,been:6,befor:0,being:3,between:[0,3,7],bfefcce0c:5,black:5,bodi:[0,5],bool:[0,3],both:3,broken:5,build:5,c34ef853c:5,c42a375e7:5,c7e5bce57:5,ca4238eb4:5,call:[0,3,5,7],can:[3,6,7],cancel:0,cancel_run:0,cancel_run_endpoint:0,candid:5,cannot:3,cdec30125:5,chang:5,changelog:5,check:5,choic:6,cleanup:5,cloud:0,cloudant:5,cluster:[0,3,7],cluster_id:0,code:[0,3],coerc:3,com:[0,3,7],come:5,command:[3,5,6,7],comment:5,commit:[5,6],common:3,concept:0,conflict:3,conjunct:3,conn_name_attr:0,conn_typ:0,connect:[0,3,5],consid:3,contain:[0,3],context:3,control:[3,7],correct:[0,5],coverag:5,creat:3,cross:5,current:[0,3],d0e7db402:5,d200:5,dag:[5,6],data:0,databricks_conn_id:[0,3,7],databricks_default:[0,3],databricks_retry_delai:[3,7],databricks_retry_limit:[3,7],databrickshook:0,databricksrunnowoper:3,databrickssubmitrunoper:3,db3:3,dbf:7,dbutil:3,decim:7,default_arg:5,default_conn_nam:0,delet:0,depend:[5,6],deprec:6,detail:[5,6],dev:5,dict:[0,3,7],dictionari:[0,3],differ:5,directli:[3,7],do_xcom_push:[3,7],doc:[3,5,7],document:[5,6],doe:[3,6],dougla:3,downgrad:6,dry:3,dure:3,dynam:5,e13a14c87:5,each:[3,7],ee7ca128a:5,either:[3,6],empti:3,enabl:[0,5],endpoint:[0,3,7],endpoint_info:0,entri:5,equal:3,error:[0,6],etl:7,everi:3,exactli:[3,7],exampl:[0,3,6,7],example_dag:[5,7],example_databrick:7,exce:3,except:0,execut:3,exist:[3,6,7],existing_cluster_id:[3,7],explicit:5,extra:[3,5,6],f1073381e:5,f3521fb0e:5,f6bd817a3:5,face:5,fail:3,fals:3,fdd9b6f65:5,featur:5,fetch:5,fff:3,field:[0,3,5],file:[3,5,6,7],first:[3,7],five:5,fix:5,flynt:5,follow:7,form:5,formmatt:5,fresh:5,from:[0,3,5],gener:5,get:[0,3,5],get_job_id:0,get_run_endpoint:0,get_run_page_url:0,get_run_st:0,given:0,grammar:5,greater:3,guid:[3,5,6],handl:3,has:6,hash:5,have:3,head:5,header:5,helper:0,high:5,hook:[2,3,5],hook_nam:0,host:[0,3,5],how:[3,5],html:[3,7],http:[0,3,7],implement:[0,5],implicit:5,improp:0,improv:5,includ:5,increas:5,inform:[3,5],initi:[6,7],input:7,instal:[0,5],install_libs_endpoint:0,instanti:[3,7],instead:5,int32:3,integ:7,integr:5,intellij:5,interact:0,intern:0,internal_error:0,introduc:5,is_success:0,is_termin:0,jar:[3,7],jar_param:3,jinja:3,job:[0,3,7],job_id:[0,3,5],jobsclusterspecnewclust:3,jobsnotebooktask:3,jobssparkjartask:3,jobssparkpythontask:3,jobssparksubmittask:3,john:3,json:[0,3,7],json_path:3,keep:5,kei:3,kwarg:3,latest:[3,5,7],lazi:5,lead:6,leav:3,legaci:6,level:[3,5,7],lib:7,librari:[0,3,7],life_cycle_st:0,lifecycl:3,like:3,line:3,link:5,list:[3,5,6,7],load:5,log:3,logic:3,logo:5,look:3,magic:[0,5],main:[3,7],main_class_nam:7,managedlibrarieslibrari:3,map:3,markdown:5,markdownlint:5,match:5,md003:5,mean:3,merg:3,method:[0,3],might:[0,3,6],miss:5,model:3,modul:5,month:5,more:3,move:5,must:[0,3],name:[0,3,5,7],nativ:5,need:[3,6,7],new_clust:[3,7],noinspect:5,non:3,none:3,note:[3,5,7],notebook:[3,7],notebook_param:3,notebook_path:3,notebook_run:3,notebook_task:[3,7],notebook_task_param:7,novemb:6,now:[0,3],num_work:3,number:[0,3,5,7],numer:3,object:[0,3],octob:5,oldest:3,on_kil:3,one:[3,7],onli:3,oper:[0,2,5,6],option:[3,6],order:6,org:3,other:[0,3],otherwis:0,our:[3,7],out:[0,5],outag:0,overrid:3,overwrit:3,page:[0,5],paramet:[0,3,7],pass:[3,5,7],patch:5,path:[3,7],payload:[3,5,7],pend:0,per:5,perform:0,pip:5,platform:0,point:[0,3,5],poll:[3,7],polling_period_second:[3,7],possibl:5,post:0,preced:3,prepar:5,preparedata:3,preparedrequest:0,processdata:7,project:5,protocol:0,provid:7,purpos:0,push:[3,7],pydocstyl:5,pypi:[5,6],python:[3,5,6,7],python_param:3,pyupgrad:5,queri:5,rate:[3,7],rc3:5,readm:[5,6],reason:3,rebas:5,ref:5,refer:6,refernc:5,regener:5,relas:5,relat:5,releas:[5,6],rema:5,remain:5,remov:5,renam:5,render_templ:3,replac:5,repositori:6,represent:3,request:[0,5,6],requir:[0,3],resolv:6,resourc:6,respons:0,rest:5,restart:0,restart_clust:0,restart_cluster_endpoint:0,result:[0,3,7],result_st:0,retri:[0,3,7],retriev:0,retry_delai:0,retry_limit:0,robust:0,rule:5,run:[0,3,5,7],run_id:[0,3,7],run_life_cycle_st:0,run_nam:[3,7],run_now:0,run_now_endpoint:0,run_page_url:[0,3,7],runstat:0,same:[3,7],scala2:3,script:[3,5],second:[0,3,7],see:[3,5],self:[0,3],sensor:5,separ:5,servic:[0,5],set:[0,3],setup:5,should:[3,7],signatur:5,skip:0,sourc:[0,3,7],spark:[3,5,7],spark_jar_task:[3,7],spark_python_task:[3,7],spark_submit_param:3,spark_submit_task:[3,7],spark_vers:3,sparkpi:3,spec:[3,7],specif:0,specifi:3,squash:5,start:0,start_clust:0,start_cluster_endpoint:0,start_dat:5,state:0,state_messag:0,statu:0,stop:5,str:[0,3],string:[0,3,5,7],strip:0,style:5,subject:5,submit:[0,3,5,7],submit_run:0,submit_run_endpoint:0,success:0,superclass:3,suppli:[0,5],support:[3,5],take:[3,7],talk:0,task:[3,5,7],task_id:[3,7],templat:3,template_field:3,termin:0,terminate_clust:0,terminate_cluster_endpoint:0,than:3,thei:3,thi:[0,3,5,6,7],thing:[3,7],through:[3,7],time:[0,3,7],timeout:[3,7],timeout_second:[0,3,7],toc:5,togeth:3,token:[0,3],tool:5,top:[3,6,7],transfer:5,trigger:3,tupl:0,two:[3,7],type:[0,3,5],typic:[3,7],typo:5,ui_color:3,ui_fgcolor:3,uninstal:[0,5],uninstall_libs_endpoint:0,union:3,unreach:[3,7],untouch:5,updat:[5,6],upgrad:[5,6],upon:3,url:0,usag:7,use:[0,3,5,6,7],used:[0,3,7],user:[0,3,5],user_agent_head:0,using:[3,5,7],utf:5,util:0,valu:3,version:[5,6],via:6,view:7,wai:[3,7],wait:[0,3,7],warn:5,when:0,where:[0,3],whether:[3,7],which:[3,7],whitespac:5,why:3,widget:3,word:5,work:6,would:3,wrong:5,wrongli:5,xcom:[3,7],xcom_run_id_kei:3,xcom_run_page_url_kei:3,yet:6,you:[0,3,6,7],your:[3,6]},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.databricks.hooks.databricks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.databricks.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.databricks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.databricks.operators.databricks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.databricks.operators</span></code>","Package apache-airflow-providers-databricks","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-databricks</span></code>","DatabricksSubmitRunOperator"],titleterms:{Using:7,airflow:[0,1,2,3,4,5,6,7],apach:[5,6],changelog:6,connect:7,content:[0,3,6],databrick:[0,1,2,3,4,5,6,7],databrickssubmitrunoper:7,hook:[0,1],instal:6,metadata:7,modul:[0,3],oper:[3,4,7],packag:[5,6],pip:6,provid:[0,1,2,3,4,5,6],requir:6,submodul:[1,4],subpackag:2}})