blob: e2260b557024474647d959e7b1a32ca156bc333e [file] [log] [blame]
Search.setIndex({docnames:["index","operators-and-hooks-ref/apache","operators-and-hooks-ref/aws","operators-and-hooks-ref/azure","operators-and-hooks-ref/google","operators-and-hooks-ref/index","operators-and-hooks-ref/protocol","operators-and-hooks-ref/services","operators-and-hooks-ref/software","packages-ref"],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:["index.rst","operators-and-hooks-ref/apache.rst","operators-and-hooks-ref/aws.rst","operators-and-hooks-ref/azure.rst","operators-and-hooks-ref/google.rst","operators-and-hooks-ref/index.rst","operators-and-hooks-ref/protocol.rst","operators-and-hooks-ref/services.rst","operators-and-hooks-ref/software.rst","packages-ref.rst"],objects:{"":{"apache-airflow-providers-amazon":[9,0,1,"std-provider-apache-airflow-providers-amazon"],"apache-airflow-providers-apache-cassandra":[9,0,1,"std-provider-apache-airflow-providers-apache-cassandra"],"apache-airflow-providers-apache-druid":[9,0,1,"std-provider-apache-airflow-providers-apache-druid"],"apache-airflow-providers-apache-hdfs":[9,0,1,"std-provider-apache-airflow-providers-apache-hdfs"],"apache-airflow-providers-apache-hive":[9,0,1,"std-provider-apache-airflow-providers-apache-hive"],"apache-airflow-providers-apache-kylin":[9,0,1,"std-provider-apache-airflow-providers-apache-kylin"],"apache-airflow-providers-apache-livy":[9,0,1,"std-provider-apache-airflow-providers-apache-livy"],"apache-airflow-providers-apache-pig":[9,0,1,"std-provider-apache-airflow-providers-apache-pig"],"apache-airflow-providers-apache-pinot":[9,0,1,"std-provider-apache-airflow-providers-apache-pinot"],"apache-airflow-providers-apache-spark":[9,0,1,"std-provider-apache-airflow-providers-apache-spark"],"apache-airflow-providers-apache-sqoop":[9,0,1,"std-provider-apache-airflow-providers-apache-sqoop"],"apache-airflow-providers-celery":[9,0,1,"std-provider-apache-airflow-providers-celery"],"apache-airflow-providers-cloudant":[9,0,1,"std-provider-apache-airflow-providers-cloudant"],"apache-airflow-providers-cncf-kubernetes":[9,0,1,"std-provider-apache-airflow-providers-cncf-kubernetes"],"apache-airflow-providers-databricks":[9,0,1,"std-provider-apache-airflow-providers-databricks"],"apache-airflow-providers-datadog":[9,0,1,"std-provider-apache-airflow-providers-datadog"],"apache-airflow-providers-dingding":[9,0,1,"std-provider-apache-airflow-providers-dingding"],"apache-airflow-providers-discord":[9,0,1,"std-provider-apache-airflow-providers-discord"],"apache-airflow-providers-docker":[9,0,1,"std-provider-apache-airflow-providers-docker"],"apache-airflow-providers-elasticsearch":[9,0,1,"std-provider-apache-airflow-providers-elasticsearch"],"apache-airflow-providers-exasol":[9,0,1,"std-provider-apache-airflow-providers-exasol"],"apache-airflow-providers-facebook":[9,0,1,"std-provider-apache-airflow-providers-facebook"],"apache-airflow-providers-ftp":[9,0,1,"std-provider-apache-airflow-providers-ftp"],"apache-airflow-providers-google":[9,0,1,"std-provider-apache-airflow-providers-google"],"apache-airflow-providers-grpc":[9,0,1,"std-provider-apache-airflow-providers-grpc"],"apache-airflow-providers-hashicorp":[9,0,1,"std-provider-apache-airflow-providers-hashicorp"],"apache-airflow-providers-http":[9,0,1,"std-provider-apache-airflow-providers-http"],"apache-airflow-providers-imap":[9,0,1,"std-provider-apache-airflow-providers-imap"],"apache-airflow-providers-jdbc":[9,0,1,"std-provider-apache-airflow-providers-jdbc"],"apache-airflow-providers-jenkins":[9,0,1,"std-provider-apache-airflow-providers-jenkins"],"apache-airflow-providers-jira":[9,0,1,"std-provider-apache-airflow-providers-jira"],"apache-airflow-providers-microsoft-azure":[9,0,1,"std-provider-apache-airflow-providers-microsoft-azure"],"apache-airflow-providers-microsoft-mssql":[9,0,1,"std-provider-apache-airflow-providers-microsoft-mssql"],"apache-airflow-providers-microsoft-winrm":[9,0,1,"std-provider-apache-airflow-providers-microsoft-winrm"],"apache-airflow-providers-mongo":[9,0,1,"std-provider-apache-airflow-providers-mongo"],"apache-airflow-providers-mysql":[9,0,1,"std-provider-apache-airflow-providers-mysql"],"apache-airflow-providers-odbc":[9,0,1,"std-provider-apache-airflow-providers-odbc"],"apache-airflow-providers-openfaas":[9,0,1,"std-provider-apache-airflow-providers-openfaas"],"apache-airflow-providers-opsgenie":[9,0,1,"std-provider-apache-airflow-providers-opsgenie"],"apache-airflow-providers-oracle":[9,0,1,"std-provider-apache-airflow-providers-oracle"],"apache-airflow-providers-pagerduty":[9,0,1,"std-provider-apache-airflow-providers-pagerduty"],"apache-airflow-providers-papermill":[9,0,1,"std-provider-apache-airflow-providers-papermill"],"apache-airflow-providers-plexus":[9,0,1,"std-provider-apache-airflow-providers-plexus"],"apache-airflow-providers-postgres":[9,0,1,"std-provider-apache-airflow-providers-postgres"],"apache-airflow-providers-presto":[9,0,1,"std-provider-apache-airflow-providers-presto"],"apache-airflow-providers-qubole":[9,0,1,"std-provider-apache-airflow-providers-qubole"],"apache-airflow-providers-redis":[9,0,1,"std-provider-apache-airflow-providers-redis"],"apache-airflow-providers-salesforce":[9,0,1,"std-provider-apache-airflow-providers-salesforce"],"apache-airflow-providers-samba":[9,0,1,"std-provider-apache-airflow-providers-samba"],"apache-airflow-providers-segment":[9,0,1,"std-provider-apache-airflow-providers-segment"],"apache-airflow-providers-sendgrid":[9,0,1,"std-provider-apache-airflow-providers-sendgrid"],"apache-airflow-providers-sftp":[9,0,1,"std-provider-apache-airflow-providers-sftp"],"apache-airflow-providers-singularity":[9,0,1,"std-provider-apache-airflow-providers-singularity"],"apache-airflow-providers-slack":[9,0,1,"std-provider-apache-airflow-providers-slack"],"apache-airflow-providers-snowflake":[9,0,1,"std-provider-apache-airflow-providers-snowflake"],"apache-airflow-providers-sqlite":[9,0,1,"std-provider-apache-airflow-providers-sqlite"],"apache-airflow-providers-ssh":[9,0,1,"std-provider-apache-airflow-providers-ssh"],"apache-airflow-providers-telegram":[9,0,1,"std-provider-apache-airflow-providers-telegram"],"apache-airflow-providers-vertica":[9,0,1,"std-provider-apache-airflow-providers-vertica"],"apache-airflow-providers-yandex":[9,0,1,"std-provider-apache-airflow-providers-yandex"],"apache-airflow-providers-zendesk":[9,0,1,"std-provider-apache-airflow-providers-zendesk"]}},objnames:{"0":["std","provider","provider"]},objtypes:{"0":"std:provider"},terms:{"3rd":0,"break":0,"case":0,"class":0,"import":0,"long":0,"new":0,"return":0,"try":0,"while":0,AWS:[5,9],Adding:0,Ads:9,But:0,For:0,GCS:[1,3,7,8],The:0,There:0,These:[1,2,3,4,6,7,8],_default:0,abl:0,absolut:0,accept:0,access:9,add:0,added:0,adding:0,addit:0,adls_list:3,adls_to_gc:[3,4],ads:[4,7],ads_to_gc:4,advertis:0,advis:0,adx:3,after:0,afterward:0,again:0,airflow:[1,2,3,4,6,7,8],all:[0,2,4],allow:[1,2,3,4,6,7,8],alreadi:0,also:[0,4],alwai:0,amazon:[0,5],analyt:4,analyz:4,ani:0,anymor:0,anyth:0,apach:[0,3,5,7],apache_airflow_provid:0,api:[1,2,3,6,7,8,9],approach:0,appropri:0,area:0,around:0,asf:5,ask:0,atlassian:9,attach:[2,6],authent:3,autom:0,automat:0,avail:[0,9],aws:[0,1,2,4,6,8],aws_default:0,aws_dynamodb:2,azur:[5,8],azure_batch:3,azure_blob_to_gc:[3,4],azure_container_inst:3,azure_container_registri:3,azure_container_volum:3,azure_cosmo:3,azure_data_lak:3,azure_fileshar:3,azure_fileshare_to_gc:[3,4],back:0,backward:0,base:[2,3,4],base_aw:2,base_azur:3,base_googl:4,batch_client:2,batch_wait:2,becaus:0,becom:0,behaviour:0,besid:0,best:0,between:0,beyond:0,bigquery_dt:4,bigquery_to_bigqueri:4,bigquery_to_gc:4,bigquery_to_mysql:[4,8],build:0,built:0,busi:0,call:0,callabl:0,campaign_manag:4,can:[0,4],capabl:0,cassandra_to_gc:[1,4],certain:0,chang:0,charg:0,choic:0,choos:0,cli:0,client:[0,3],cloud:[0,1,3,5,8,9],cloud_build:4,cloud_form:2,cloud_memorystor:4,cloud_sql:4,cloud_storage_transfer_servic:4,cncf:8,code:4,come:0,command:0,commerci:0,common:4,commun:[0,6],compat:0,compute_ssh:4,configur:4,conflict:0,connect:[4,9],consid:0,constrain:0,contain:0,continu:0,contribut:0,control:0,convent:0,copi:[1,2,3,4,6,8],core:0,correspond:0,creat:1,cross:0,dag:4,data:[0,1,6,7,8],databas:9,databrickssubmitrunoper:7,datacatalog:4,datafus:4,defin:0,definit:0,deliv:0,depend:0,descript:0,detail:0,develop:[0,1],dictionari:0,differ:0,discord_webhook:7,discov:0,discover:0,discovery_api:4,display_video:4,distribut:9,docker_swarm:8,document:[0,1,2,3,4,6,7,8],doing:0,domain:0,don:0,downgrad:0,download:4,druid_check:1,dynamodb:1,dynamodb_to_s3:2,each:0,ec2_start_inst:2,ec2_stop_inst:2,ecosystem:0,ecs:2,either:0,elasticache_replication_group:2,emr_add_step:2,emr_create_job_flow:2,emr_modify_clust:2,emr_terminate_job_flow:2,enabl:[0,9],enough:0,entri:0,environ:0,etc:0,evalu:0,eventu:0,everi:0,exampl:[0,4],exist:0,expect:0,extens:[0,4],extern:0,facebook_ads_to_gc:[4,7],featur:0,feel:0,few:0,field:0,file:9,file_to_wasb:3,filesystem:[3,4],find:0,fine:0,firebas:[4,9],first:0,fix:0,follow:0,form:0,format:0,formerli:9,foundat:5,free:0,friendli:0,from:[0,1,2,3,4],gcp:9,gcs:4,gcs_to_bigqueri:4,gcs_to_gc:4,gcs_to_gdriv:4,gcs_to_loc:4,gcs_to_s3:[2,4],gcs_to_sftp:[4,6],gcs_to_sheet:4,gdm:4,gener:0,get:0,given:0,glacier_to_gc:[2,4],glad:0,glue_catalog:2,going:0,good:0,googl:[0,1,3,5,7],google_api_to_s3:2,google_cloud_default:0,google_cloud_platform:0,googlebasehook:4,guid:[1,2,3,4,6,7,8],hadoop:9,handl:0,happen:0,has:[0,2,3,4],have:0,here:[0,9],hive_stat:1,hive_to_druid:1,hive_to_dynamodb:[1,2],hive_to_mysql:[1,8],hive_to_samba:[1,6],hook:0,how:4,howev:0,hypertext:9,ibm:9,imap_attachment_to_s3:[2,6],impact:0,implement:0,includ:[0,9],incompat:0,increment:0,independ:0,instal:[0,9],integr:[1,2,3,4,5,7,9],intent:0,interfac:[0,6],intern:0,internet:9,introduc:0,its:0,java:9,jdbcoper:6,jenkins_job_trigg:8,job:7,json:0,just:0,keep:0,kind:0,kms:4,know:0,kubernetes_engin:4,kubernetes_pod:8,kubernetespodoper:8,kylin_cub:1,lake:8,lambda_funct:2,later:0,latest:0,librari:0,life_sci:4,lightli:0,like:0,limit:[0,3],line:0,list:[0,9],local_to_adl:3,local_to_gc:4,main:0,maintain:0,major:0,make:0,manag:[0,9],mani:0,manual:0,market:[5,9],marketing_platform:4,matter:0,mean:0,mechan:0,memcach:4,merg:0,messag:9,meta:0,microsoft:[5,6],might:0,migrat:0,mlengin:4,modif:0,mongo:8,mongo_to_s3:[2,8],mongodb:9,month:0,more:0,most:0,mssql:0,mssql_to_gc:[4,8],mssql_to_hiv:[1,8],multipl:0,multitud:0,mysql:7,mysql_to_gc:[4,8],mysql_to_h:[1,8],mysql_to_s3:[2,8],mysqloper:8,name:0,natural_languag:4,need:0,never:0,newer:0,non:0,note:0,number:0,often:0,older:0,onc:0,one:0,onli:0,oper:0,opsgenie_alert:7,oracle_to_azure_data_lak:[3,8],oracle_to_oracl:8,order:0,os_login:4,other:[0,5],our:0,outsid:0,page:0,parti:0,particular:0,pass:0,per:0,perform:[1,2,3,4,6,7,8],pip:9,platform:[5,9],point:0,port:0,posit:0,possibl:0,postgr:8,postgres_to_gc:[4,8],postgresql:9,practic:0,prefer:0,presto_to_gc:[4,8],presto_to_mysql:[7,8],previou:0,probabl:0,problem:0,proc:7,product:[1,2,3,4,6,7,8],project:0,properli:0,protocol:[5,9],provid:[1,2,3,4,6,7,8],publish:0,pubsub:4,purpos:0,pypi:[0,9],python:[0,1,2,3,4,6,7,8,9],qubole_check:7,queri:0,question:0,quit:0,reason:0,recent:0,recogn:0,redis_publish:8,redshift_to_s3:2,refer:0,regist:0,releas:0,reli:0,remot:9,replac:0,repositori:9,requir:0,right:0,round:0,run:[0,9],s3_bucket:2,s3_copy_object:2,s3_delete_object:2,s3_file_transform:2,s3_list:2,s3_to_gc:[2,4],s3_to_hiv:[1,2],s3_to_mysql:[2,8],s3_to_redshift:2,s3_to_sftp:[2,6],s3_to_snowflak:[2,7],s3tosnowflakeoper:[2,7],safer:0,sagemaker_bas:2,sagemaker_endpoint:2,sagemaker_endpoint_config:2,sagemaker_model:2,sagemaker_process:2,sagemaker_train:2,sagemaker_transform:2,sagemaker_tun:2,salesforc:0,salesforce_to_gc:[4,7],samba:1,same:0,schedul:0,schema:0,scheme:0,scope:0,sdk:3,search_ad:4,secret_manag:4,secrets_manag:2,secur:9,see:[0,4],segment_track_ev:7,semi:0,semver:0,sensor:0,separ:0,seri:0,server:9,servic:[5,9],ses:2,sever:0,sftp_to_gc:[4,6],sftp_to_s3:[2,6],share:0,sheet:4,sheets_to_gc:4,shell:9,should:0,simpli:0,slack_webhook:7,snowflak:2,snowflake_to_slack:7,snowflakeoper:7,snowflaketoslackoper:7,sns:2,softwar:[0,5],some:[0,3,4],someth:0,sourc:[1,2,3,4,6,7,8],spark_jdbc:1,spark_jdbc_script:1,spark_kubernet:8,spark_sql:1,spark_submit:1,speak:0,special:0,specif:0,speech_to_text:4,sql:9,sql_to_gc:4,sqs:2,stabl:0,stage:0,standard:[0,6],start:0,step:0,step_funct:2,step_function_get_execution_output:2,step_function_start_execut:2,stop:0,structur:0,sub:0,succe:0,suit:[4,9],support:[1,2,3,4],system:[0,9],tableau:7,tableau_refresh_workbook:7,target:[1,2,3,4,6,7,8],telegramoper:7,test:0,text_to_speech:4,thei:[0,9],them:0,thi:0,those:0,time:0,togeth:0,transfer:[0,5,9],translate_speech:4,two:0,type:[0,4],under:0,uniqu:0,unless:0,unlik:0,updat:0,upload:[3,4],use:[0,4],used:0,useful:0,user:0,using:[0,6,8],usual:0,valid:0,vari:0,variabl:0,variou:[1,2,3,4,6,7,8],vault:9,veri:0,verif:0,verifi:0,version:[0,9],vertica_to_h:[1,8],vertica_to_mysql:8,video_intellig:4,view:0,wai:0,want:0,wasb:3,wasb_delete_blob:3,web:[5,9],webhdf:9,websit:0,well:0,were:0,what:[0,9],whatev:0,when:0,where:0,whether:0,which:[0,3],window:9,within:[1,2,3,4,6,7],without:0,work:0,workspac:9,would:0,write:0,yandexcloud_dataproc:7,you:[0,1,2,3,4,6,7,8]},titles:["Provider packages","ASF: Apache Software Foundation","AWS: Amazon Web Services","Azure: Microsoft Azure","Google","Operators and Hooks Reference","Protocol integrations","Services","Software integrations","Providers packages reference"],titleterms:{"360":4,"function":[0,2,4],AWS:2,Ads:[4,7],ECS:2,GCS:[2,4,6],KMS:4,SES:2,SNS:2,SQS:2,Using:0,access:[2,6],airflow:[0,9],amazon:[1,2,4,6,7,8,9],analytics360:4,apach:[1,2,4,6,8,9],api:4,asf:1,athena:2,atlassian:8,automl:4,azur:[3,4,9],backport:0,batch:[2,3],bigqueri:[4,8],bigtabl:4,blob:[3,4],build:4,campaign:4,cassandra:[1,4,9],catalog:4,celeri:9,cloud:[2,4,6,7],cloudant:[7,9],cloudform:2,cloudwatch:2,cncf:9,comput:4,connect:[0,6],contain:3,content:0,context:0,cosmo:3,creat:0,custom:0,data:[2,3,4],databas:6,databrick:[7,9],datadog:[7,9],dataflow:4,dataprep:4,dataproc:[4,7],datastor:4,datasync:2,deploy:4,dingd:[7,9],discord:[7,9],discoveri:4,displai:4,distribut:1,dlp:4,docker:[8,9],drive:4,druid:[1,9],dynamodb:2,ec2:2,elasticach:2,elasticsearch:[8,9],email:2,emr:2,engin:4,exasol:[8,9],explor:3,extend:0,extra:0,facebook:[4,7,9],file:[1,2,4,6],fileshar:[3,4],firehos:2,firestor:4,foundat:1,ftp:[6,9],fusion:4,glacier:[2,4],glue:2,googl:[2,4,6,8,9],grpc:[6,9],hadoop:1,hashicorp:[8,9],hdf:[1,9],hive:[1,2,6,8,9],hook:[1,2,3,4,5,6,7,8],how:0,http:[6,9],hypertext:6,ibm:7,imap:[2,6,9],instanc:3,integr:[6,8],intellig:4,internet:[2,6],java:6,jdbc:[6,9],jenkin:[8,9],jira:[8,9],kei:4,kinesi:2,kubernet:[4,8,9],kylin:[1,9],lake:[3,4],lambda:2,languag:4,learn:4,life:4,link:0,livi:[1,9],local:[3,4],log:2,login:4,loss:4,machin:4,manag:[4,6],market:4,memorystor:4,messag:[2,6],microsoft:[1,3,4,8,9],mongo:9,mongodb:[2,8],mssql:[1,4,8,9],mysql:[1,2,4,8,9],natur:4,notif:2,odbc:[6,9],openfaa:[8,9],oper:[1,2,3,4,5,6,7,8],opsgeni:[7,9],oracl:[3,8,9],other:4,own:0,packag:[0,9],pagerduti:[7,9],papermil:[8,9],pig:[1,9],pinot:[1,9],platform:4,plexu:[7,9],postgr:9,postgresql:[4,8],presto:[4,8,9],prevent:4,protocol:[2,4,6],provid:[0,9],pub:4,qubol:[7,9],queue:2,redi:[8,9],redshift:2,refer:[5,9],remot:6,sagemak:2,salesforc:[4,7,9],samba:[6,9],scienc:4,search:4,secret:4,secretsmanag:2,secur:6,segment:[7,9],sendgrid:9,server:[1,4,8],servic:[1,2,3,4,6,7,8],sftp:[2,4,6,9],shell:6,simpl:[1,2,4,6,7,8],singular:[8,9],slack:[7,9],snowflak:[7,8,9],softwar:[1,8],spanner:4,spark:[1,9],speech:4,spreadsheet:4,sql:[1,4,8],sqlite:[8,9],sqoop:[1,9],ssh:[2,4,6,9],stackdriv:4,step:2,storag:[1,2,3,4,6,7,8],sub:4,swarm:8,system:1,task:4,telegram:[7,9],text:4,transfer:[1,2,3,4,6,7,8],translat:4,upgrad:0,vault:8,vertica:[1,8,9],via:0,video:4,vision:4,web:2,webhdf:1,window:6,winrm:[6,9],yandex:[7,9],your:0,zendesk:[8,9]}})