blob: 396ea334fd17eb0a8f0b93cdedb602ab4db7f05a [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","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","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,"1457570074236":3,"180":0,"1cb1c2":3,"boolean":6,"byte":3,"case":[0,3],"class":[0,3,6],"default":3,"float":[0,3],"function":[0,3],"int":[0,3],"new":[3,6],"return":0,"static":0,"throw":[0,3],"true":[0,3],AND:3,For:[0,3],Its:3,The:[0,3,6],There:[3,6],Use:6,__call__:0,__eq__:0,__repr__:0,_deep_string_coerc:3,_do_api_cal:0,_get_hook:3,_handle_databricks_operator_execut:3,_log_request_error:0,_parse_host:0,_retryable_error:0,_tokenauth:0,about:3,access:3,accomplish:[3,6],actual:3,adam:3,age:3,airflowexcept:0,all:3,also:6,amount:[0,3,6],ani:3,anoth:[3,6],apach:3,api:[0,3,5,6],arrai:0,assert:0,attempt_num:0,auth:0,authbas:0,authent:3,backend:[3,6],base:[0,3],basehook:0,baseoper:3,becaus:3,befor:0,being:3,between:[0,3,6],bodi:0,bool:[0,3],both:3,call:[0,3,6],can:[3,6],cancel:0,cancel_run:0,cancel_run_endpoint:0,cannot:3,cloud:0,cluster:[0,3,6],cluster_id:0,code:[0,3],coerc:3,com:[0,3,6],command:[3,6],common:3,concept:0,conflict:3,conjunct:3,conn_name_attr:0,conn_typ:0,connect:[0,3],consid:3,contain:[0,3],context:3,control:[3,6],correct:0,creat:3,current:[0,3],dag:5,data:0,databricks_conn_id:[0,3,6],databricks_default:[0,3],databricks_retry_delai:[3,6],databricks_retry_limit:[3,6],databrickshook:0,databricksrunnowoper:3,databrickssubmitrunoper:3,db3:3,dbf:6,dbutil:3,decim:6,default_conn_nam:0,delet:0,dict:[0,3,6],dictionari:[0,3],directli:[3,6],do_xcom_push:[3,6],doc:[3,6],doe:3,dougla:3,dry:3,dure:3,each:[3,6],either:3,empti:3,enabl:0,endpoint:[0,3,6],endpoint_info:0,equal:3,error:0,etl:6,everi:3,exactli:[3,6],exampl:[0,3,5,6],example_dag:6,example_databrick:6,exce:3,except:0,execut:3,exist:[3,6],existing_cluster_id:[3,6],extra:3,fail:3,fals:3,fff:3,field:[0,3],file:[3,6],first:[3,6],follow:6,from:[0,3],get:[0,3],get_job_id:0,get_run_endpoint:0,get_run_page_url:0,get_run_st:0,given:0,greater:3,guid:[3,5],handl:3,have:3,helper:0,hook:[2,3],hook_nam:0,host:[0,3],how:3,html:[3,6],http:[0,3,6],implement:0,improp:0,inform:3,initi:6,input:6,instal:0,install_libs_endpoint:0,instanti:[3,6],int32:3,integ:6,interact:0,intern:0,internal_error:0,is_success:0,is_termin:0,jar:[3,6],jar_param:3,jinja:3,job:[0,3,6],job_id:[0,3],jobsclusterspecnewclust:3,jobsnotebooktask:3,jobssparkjartask:3,jobssparkpythontask:3,jobssparksubmittask:3,john:3,json:[0,3,6],json_path:3,kei:3,kwarg:3,latest:[3,6],leav:3,level:[3,6],lib:6,librari:[0,3,6],life_cycle_st:0,lifecycl:3,like:3,line:3,list:[3,6],log:3,logic:3,look:3,magic:0,main:[3,6],main_class_nam:6,managedlibrarieslibrari:3,map:3,mean:3,merg:3,method:[0,3],might:[0,3],model:3,more:3,must:[0,3],name:[0,3,6],need:[3,6],new_clust:[3,6],non:3,none:3,note:[3,6],notebook:[3,6],notebook_param:3,notebook_path:3,notebook_run:3,notebook_task:[3,6],notebook_task_param:6,now:[0,3],num_work:3,number:[0,3,6],numer:3,object:[0,3],oldest:3,on_kil:3,one:[3,6],onli:3,oper:[0,2,5],option:3,org:3,other:[0,3],otherwis:0,our:[3,6],out:0,outag:0,overrid:3,overwrit:3,page:0,paramet:[0,3,6],pass:[3,6],path:[3,6],payload:[3,6],pend:0,perform:0,platform:0,point:[0,3],poll:[3,6],polling_period_second:[3,6],post:0,preced:3,preparedata:3,preparedrequest:0,processdata:6,protocol:0,provid:6,purpos:0,push:[3,6],python:[3,5,6],python_param:3,rate:[3,6],reason:3,refer:5,render_templ:3,represent:3,request:0,requir:[0,3],resourc:5,respons:0,restart:0,restart_clust:0,restart_cluster_endpoint:0,result:[0,3,6],result_st:0,retri:[0,3,6],retriev:0,retry_delai:0,retry_limit:0,robust:0,run:[0,3,6],run_id:[0,3,6],run_life_cycle_st:0,run_nam:[3,6],run_now:0,run_now_endpoint:0,run_page_url:[0,3,6],runstat:0,same:[3,6],scala2:3,script:3,second:[0,3,6],see:3,self:[0,3],servic:0,set:[0,3],should:[3,6],skip:0,sourc:[0,3,6],spark:[3,6],spark_jar_task:[3,6],spark_python_task:[3,6],spark_submit_param:3,spark_submit_task:[3,6],spark_vers:3,sparkpi:3,spec:[3,6],specif:0,specifi:3,start:0,start_clust:0,start_cluster_endpoint:0,state:0,state_messag:0,statu:0,str:[0,3],string:[0,3,6],strip:0,submit:[0,3,6],submit_run:0,submit_run_endpoint:0,success:0,superclass:3,suppli:0,support:3,take:[3,6],talk:0,task:[3,6],task_id:[3,6],templat:3,template_field:3,termin:0,terminate_clust:0,terminate_cluster_endpoint:0,than:3,thei:3,thi:[0,3,6],thing:[3,6],through:[3,6],time:[0,3,6],timeout:[3,6],timeout_second:[0,3,6],togeth:3,token:[0,3],top:[3,6],trigger:3,tupl:0,two:[3,6],type:[0,3],typic:[3,6],ui_color:3,ui_fgcolor:3,uninstal:0,uninstall_libs_endpoint:0,union:3,unreach:[3,6],upon:3,url:0,usag:6,use:[0,3,6],used:[0,3,6],user:[0,3],user_agent_head:0,using:[3,6],util:0,valu:3,view:6,wai:[3,6],wait:[0,3,6],when:0,where:[0,3],whether:[3,6],which:[3,6],why:3,widget:3,would:3,xcom:[3,6],xcom_run_id_kei:3,xcom_run_page_url_kei:3,you:[0,3,6],your:3},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>","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-databricks</span></code>","DatabricksSubmitRunOperator"],titleterms:{Using:6,airflow:[0,1,2,3,4,5,6],apach:5,connect:6,content:[0,3,5],databrick:[0,1,2,3,4,5,6],databrickssubmitrunoper:6,hook:[0,1],metadata:6,modul:[0,3],oper:[3,4,6],provid:[0,1,2,3,4,5],submodul:[1,4],subpackag:2}})