eladkal commented on a change in pull request #18930:
URL: https://github.com/apache/airflow/pull/18930#discussion_r730226523
##########
File path: docs/apache-airflow-providers-apache-beam/operators.rst
##########
@@ -76,6 +76,7 @@ Python Pipelines with DataflowRunner
:start-after: [START
howto_operator_start_python_dataflow_runner_pipeline_async_gcs_file]
:end-before: [END
howto_operator_start_python_dataflow_runner_pipeline_async_gcs_file]
+
Review comment:
```suggestion
```
##########
File path: docs/apache-airflow/concepts/operators.rst
##########
@@ -16,7 +16,7 @@
under the License.
Operators
-=========
+==========
Review comment:
```suggestion
=========
```
##########
File path: docs/apache-airflow-providers-apache-pinot/operators.rst
##########
@@ -0,0 +1,75 @@
+ .. 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.
+
+``airflow.providers.apache.pinot.hooks.pinot``
+==============================================
+
+Content
+-------
+
+Apache Pinot Hooks
+==================
+
+`Apache Pinot <https://pinot.apache.org/>`__ is a column-oriented,
open-source,distributed data store written in Java. Pinot is designed to
execute OLAP querieswith low latency. It is suited in contexts where fast
analytics, such as aggregations,are needed on immutable data, possibly, with
real-time data ingestion.
+
+Prerequisite
+------------
+
+.. To use Pinot hooks, you must configure :doc:`Pinot Connection
<connections/pinot>`.
+
+.. _howto/operator:PinotHooks:
+
+PinotAdminHook
+--------------
+
+This hook is a wrapper around the pinot-admin.sh script. For now, only small
subset of its subcommands are implemented, which are required to ingest offline
data into Apache Pinot (i.e., AddSchema, AddTable, CreateSegment, and
UploadSegment). Their command options are based on Pinot v0.1.0.
+
+Parameters
+----------
+
+For parameter definition, take a look at
:class:`~airflow.providers.apache.pinot.hooks.pinot.PinotAdminHook`
+
+.. exampleinclude::
/../../airflow/providers/apache/pinot/example_dags/example_pinot_dag.py
+ :language: python
+ :start-after: [START howto_operator_pinot_admin_hook]
+ :end-before: [END howto_operator_pinot_admin_hook]
+
+Reference
+^^^^^^^^^
+For more information,please see the documentation at `Apache Pinot
improvements for
PinotAdminHook<https://github.com/apache/incubator-pinot/pull/4110>`
+
+PinotDbApiHook
+--------------
+
+This hook uses standard-SQL endpoint since PQL endpoint is soon to be
deprecated.
Review comment:
```suggestion
This hook uses standard-SQL endpoint. PQL endpoint is removed in updated
versions of pinotdb library. For more information see `library documentation
<https://docs.pinot.apache.org/users/clients/python>`
```
##########
File path: airflow/providers/apache/pinot/example_dags/example_pinot_dag.py
##########
@@ -0,0 +1,49 @@
+# 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.
+
+"""Example DAG demonstrating the usage of the PinotAdminHook and
PinotDbApiHook."""
+
+from airflow import DAG
+from airflow.providers.apache.pinot.hooks.pinot import PinotAdminHook
+from airflow.providers.apache.pinot.hooks.pinot import PinotDbApiHook
Review comment:
```suggestion
from airflow.providers.apache.pinot.hooks.pinot import PinotAdminHook,
PinotDbApiHook
```
##########
File path: docs/apache-airflow-providers-apache-pinot/operators.rst
##########
@@ -0,0 +1,75 @@
+ .. 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.
+
+``airflow.providers.apache.pinot.hooks.pinot``
+==============================================
+
+Content
+-------
+
+Apache Pinot Hooks
+==================
+
+`Apache Pinot <https://pinot.apache.org/>`__ is a column-oriented,
open-source,distributed data store written in Java. Pinot is designed to
execute OLAP querieswith low latency. It is suited in contexts where fast
analytics, such as aggregations,are needed on immutable data, possibly, with
real-time data ingestion.
+
+Prerequisite
+------------
+
+.. To use Pinot hooks, you must configure :doc:`Pinot Connection
<connections/pinot>`.
+
+.. _howto/operator:PinotHooks:
+
+PinotAdminHook
+--------------
+
+This hook is a wrapper around the pinot-admin.sh script. For now, only small
subset of its subcommands are implemented, which are required to ingest offline
data into Apache Pinot (i.e., AddSchema, AddTable, CreateSegment, and
UploadSegment). Their command options are based on Pinot v0.1.0.
+
+Parameters
+----------
+
+For parameter definition, take a look at
:class:`~airflow.providers.apache.pinot.hooks.pinot.PinotAdminHook`
+
+.. exampleinclude::
/../../airflow/providers/apache/pinot/example_dags/example_pinot_dag.py
+ :language: python
+ :start-after: [START howto_operator_pinot_admin_hook]
+ :end-before: [END howto_operator_pinot_admin_hook]
+
+Reference
+^^^^^^^^^
+For more information,please see the documentation at `Apache Pinot
improvements for
PinotAdminHook<https://github.com/apache/incubator-pinot/pull/4110>`
Review comment:
Why do we link to a PR and not to official documentation?
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
