You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/01/25 10:24:41 UTC

[GitHub] [airflow] eladkal commented on a change in pull request #13871: Updates Oracle.rst documentation

eladkal commented on a change in pull request #13871:
URL: https://github.com/apache/airflow/pull/13871#discussion_r563611501



##########
File path: docs/apache-airflow-providers-oracle/connections/oracle.rst
##########
@@ -60,8 +63,35 @@ Extra (optional)
     * ``purity`` - one of ``new``, ``self``, ``default``. Specify the session acquired from the pool.
       configuration parameter.
 
-    More details on all Oracle connect parameters supported can be found in
-    `cx_Oracle documentation <https://cx-oracle.readthedocs.io/en/latest/module.html#cx_Oracle.connect>`_.
+    Connect using Dsn and Sid, Dsn and Service_name, or only Host `(OracleHook.getconn Documentation) <https://airflow.apache.org/docs/apache-airflow-providers-oracle/stable/_modules/airflow/providers/oracle/hooks/oracle.html#OracleHook.get_conn>`_.
+
+    For example:
+
+    .. code-block:: python
+
+        Host = "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=dbhost.example.com)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=orclpdb1)))"
+
+    or
+
+    .. code-block:: python
+
+        Dsn = "dbhost.example.com"
+        Service_name = "orclpdb1"
+
+    or
+
+    .. code-block:: python
+
+        Dsn = "dbhost.example.com"
+        Sid = "orcl"
+
+
+    More details on all Oracle connect parameters supported can be found in `cx_Oracle documentation
+    <https://cx-oracle.readthedocs.io/en/latest/api_manual/module.html#cx_Oracle.connect>`_.
+
+    Information on creating an Oracle Connection through the web user interface can be found in Airflow's `Managing Connections Documentation
+    <https://airflow.apache.org/docs/apache-airflow/stable/howto/connection.html>`_.

Review comment:
       Do we use http links for internal reference in our docs?
   shouldn't this be  like the security section [here](https://github.com/apache/airflow/blob/master/docs/apache-airflow/howto/connection.rst#securing-connections) 
   So I believe it should be:
   :doc:`/howto/connection/index`
   




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org