-
Notifications
You must be signed in to change notification settings - Fork 16.3k
Description
Body
Some of Hooks provide connection ability, however quite a few of them do not provide any documentation and/or connection type (missing in the UI). It would be nice if we add missing parts which might help Airflow users.
Hooks Class Attributes reference:
conn_type: Unique connection type, should be also listed in providers.yamlconn_name_attr: Name of connection attribute, mainly uses for test connectionsdefault_conn_name: Name of default connection, it doesn't do anything if you do not set it directly toconn_name_attr, see as reference SlackHookhook_name, connection name in dropdown list in the UI
List of Providers and missing/inconsistent hooks class attributes or/and documentation:
Note
If someone would like to work on one (or many) just let us know in comments or create PR with reference to this Issue.
alibaba
Mixin connections documentation in the single page
- AnalyticDBSparkHook (conn_type = "adb_spark", conn_name_attr = "alibabacloud_conn_id" this one Inconsistent with actual hook attribute "oss_conn_id", hook_name = "AnalyticDB Spark") Fix inconsistent conn_name_attr on Alibaba Hooks #51112
- OSSHook (conn_type = "oss", conn_name_attr = "alibabacloud_conn_id" this one Inconsistent with actual hook attribute "oss_conn_id", hook_name = "OSS") Fix inconsistent conn_name_attr on Alibaba Hooks #51112
- DruidHook (Missing conn_type, conn_name_attr = "druid_ingest_conn_id").
- Missing Conn Type/Names: Add druid ingestion connection test #33796 enhance druid connection parameters #35244
- Documentation
- DruidDbApiHook (conn_type = "druid_broker", conn_name_attr = "druid_broker_conn_id", hook_name = "Druid Broker").
- Documentation
apache.hdfs
Mixin connections documentation in the single page
-
HDFSHook (conn_type = "hdfs", conn_name_attr = "hdfs_conn_id", hook_name = "HDFS")Removed in 4.0.0 - WebHDFSHook (Missing conn_type, conn_name_attr = "webhdfs_conn_id") fix connection type webhdfs #36145
- KylinHook (Missing conn_type, conn_name_attr = "kylin_conn_id") Add apache kylin conn type and kylin connection docs #36413
- LivyHook (conn_type = "livy", conn_name_attr = "livy_conn_id", hook_name = "Apache Livy") Add Apache Livy connection documentation #36412
- PigCliHook (conn_type = "pig_cli", conn_name_attr = "pig_cli_conn_id", hook_name = "Pig Client Wrapper")
- PinotAdminHook (conn_type = "pinot_admin", conn_name_attr = "conn_id", hook_name = "Pinot Admin").
- Missing Conn Type/Names: Referencing correct hooks for Apache Pinot #33601 (thanks @alexbegg)
- Documentation
- PinotDbApiHook (conn_type = "pinot", conn_name_attr = "pinot_broker_conn_id", hook_name = "Pinot")
- Missing Conn Type/Names: Referencing correct hooks for Apache Pinot #33601 (thanks @alexbegg)
- Documentation
apache.spark
Mixin connections documentation in the single page.
- SparkSubmitHook (conn_type = "spark", conn_name_attr = "conn_id", hook_name = "Spark") change spark connection form and add spark connections docs #36419
- SparkJDBCHook (conn_type = "spark_jdbc", conn_name_attr = "spark_conn_id", hook_name = "Spark JDBC") change spark connection form and add spark connections docs #36419
- SparkSqlHook (conn_type = "spark_sql", conn_name_attr = "conn_id", hook_name = "Spark SQL") change spark connection form and add spark connections docs #36419
-
SqoopHook (conn_type = "sqoop", conn_name_attr = "conn_id", hook_name = "Sqoop")Removed in Remove Plexus and sqoop providers #36460
- DatadogHook (Missing conn_type, conn_name_attr = "datadog_conn_id") Support creating Datadog connection from the UI and add documentation for this conn #30059
- DingdingHook (conn_type = "dingding", conn_name_attr = "dingding_conn_id", hook_name = "Dingding")
discord
Discord built in top of HTTP Connection with specific settings, which only described in docstring
- DiscordWebhookHook (conn_type = "discord", conn_name_attr = "http_conn_id", hook_name = "Discord") Add docs for discord webhook connection #36720
- ExasolHook (conn_type = "exasol", conn_name_attr = "exasol_conn_id", hook_name = "Exasol")
- FacebookAdsReportingHook (conn_type = "facebook_social", conn_name_attr = "facebook_conn_id", hook_name = "Facebook Ads"), Add documentation for Facebook Ads connection type #25495
- GoogleAdsHook (Missing conn_type, conn_name_attr = "google_ads_conn_id") Add GoogleAdsHook connection types and documentation #50755
- LookerHook (Missing conn_type, conn_name_attr = "looker_conn_id", Note: Connection Type has documentation) Add Looker connection types and LevelDB documentation #51058
- LevelDBHook (conn_type = "leveldb", conn_name_attr = "leveldb_conn_id", hook_name = "LevelDB") Add Looker connection types and LevelDB documentation #51058 Add extra fields and hide unnecessary fields for LevelDB #51343
- BigQueryHook (conn_type = "gcpbigquery", conn_name_attr = "gcp_conn_id", hook_name = "Google Bigquery"), Google Bigquery connection type is not working #29286 (comment) Fix BigQuery connection and add docs #38430
- VaultHook (conn_type = "vault", conn_name_attr = "vault_conn_id", hook_name = "Hashicorp Vault") Improve creating Vault connection from the UI and add documentation for this conn #30057
- CloudantHook (conn_type = "cloudant", conn_name_attr = "cloudant_conn_id", hook_name = "Cloudant")
- JiraHook (conn_type = "jira", conn_name_attr = "jira_conn_id", hook_name = "JIRA") Add jira connection docs and UI form #36458
- AzureContainerInstanceHook (conn_type = "azure_container_instance", conn_name_attr = "azure_conn_id", hook_name = "Azure Container Instance")
- PsrpHook (Missing conn_type, conn_name_attr = "psrp_conn_id") Add PSRP connection type #34766
microsoft.winrm
I'm not familiar with WinRM Protocol, but seems like it actually doesn't use SSH Connection, however connection attribute is ssh_conn_id which might confuse end users.
- WinRMHook (Missing conn_type, conn_name_attr = "ssh_conn_id")
- OpenFaasHook (Missing conn_type, conn_name_attr = "conn_id")
- OpsgenieAlertHook (conn_type = "opsgenie", conn_name_attr = "opsgenie_conn_id", hook_name = "Opsgenie") Add docs for opsgenie connection #36519
- PagerdutyHook (conn_type = "pagerduty", conn_name_attr = "pagerduty_conn_id", hook_name = "Pagerduty")
- PagerdutyEventsHook (conn_type = "pagerduty_events", conn_name_attr = "pagerduty_events_conn_id", hook_name = "Pagerduty Events")
- PrestoHook (conn_type = "presto", conn_name_attr = "presto_conn_id", hook_name = "Presto") Add presto connection documentation #37536
[ ] QuboleHook (conn_type = "qubole", conn_name_attr = "qubole_conn_id", hook_name = "Qubole")suspended provider
- RedisHook (conn_type = "redis", conn_name_attr = "redis_conn_id", hook_name = "Redis") Add docs to redis connection #36581
- SambaHook (conn_type = "samba", conn_name_attr = "samba_conn_id", hook_name = "Samba") Add docs and user-friendly connection form for Samba connection #36543
- SegmentHook (conn_type = "segment", conn_name_attr = "segment_conn_id", hook_name = "Segment")
- TelegramHook (Missing conn_type, conn_name_attr = "telegram_conn_id") Add telegram connection with documnetation #37515
- VerticaHook (conn_type = "vertica", conn_name_attr = "vertica_conn_id", hook_name = "Vertica")
- Zendesk (conn_type = "zendesk", conn_name_attr = "zendesk_conn_id", hook_name = "Zendesk") Add docs about zendesk connection and creating dedicated connection form #36423
Committer
- I acknowledge that I am a maintainer/committer of the Apache Airflow project.