josh-fell commented on a change in pull request #19356: URL: https://github.com/apache/airflow/pull/19356#discussion_r748548197
########## File path: airflow/providers/influxdb/operators/influxdb.py ########## @@ -0,0 +1,54 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from typing import Dict + +from airflow.models import BaseOperator +from airflow.providers.influxdb.hooks.influxdb import InfluxDBHook + + +class InfluxDBOperator(BaseOperator): + """ + Executes sql code in a specific InfluxDB database + + .. seealso:: + For more information on how to use this operator, take a look at the guide: + :ref:`howto/operator:InfluxDBOperator` + + :param sql: the sql code to be executed. Can receive a str representing a + sql statement + :type sql: str + :param influxdb_conn_id: Reference to :ref:`Influxdb connection id <howto/connection:influxdb>`. + :type influxdb_conn_id: str + """ + + def __init__( + self, + *, + sql: str, + influxdb_conn_id: str = 'influxdb_default', + **kwargs, + ) -> None: + super().__init__(**kwargs) + self.influxdb_conn_id = influxdb_conn_id + self.sql = sql + self.hook = None Review comment: ```suggestion ``` This can be removed since the hook object is being instantiated only in the `execute()` method. ########## File path: airflow/providers/influxdb/example_dags/example_influxdb_query.py ########## @@ -0,0 +1,39 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from datetime import datetime + +from airflow.models.dag import DAG +from airflow.providers.influxdb.operators.influxdb import InfluxDBOperator + +dag = DAG( + 'example_influxdb_operator', + start_date=datetime(2021, 1, 1), + tags=['example'], + catchup=False, +) + +# [START howto_operator_influxdb] Review comment: These `# [START/END howto_...]` tags are for including code snippets in docs using the `.. exampleinclude::` directive. This reference should be in the operator doc too to provide some more context for the `InfluxDBOperator`. Here is an example of how these tags are typically used in operator docs: https://github.com/apache/airflow/blob/main/docs/apache-airflow-providers-airbyte/operators/airbyte.rst -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
