Skip to content

Clarify documentation of the Oracle connection-url string #11656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hashhar merged 1 commit into from
Mar 26, 2022
Merged

Clarify documentation of the Oracle connection-url string #11656

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/src/main/sphinx/connector/oracle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,20 @@ properties in the file:
.. code-block:: text

connector.name=oracle
# The exact format of the connection-url varies by Oracle version. Refer to
# the Oracle Database documentation for version-specific information on the
# JDBC Thin driver.
connection-url=jdbc:oracle:thin:@//example.net:1521/ORCLCDB
# The correct syntax of the connection-url varies by Oracle version and
# configuration. The following example URL connects to an Oracle SID named
# "orcl".
connection-url=jdbc:oracle:thin:@example.net:1521:orcl
connection-user=root
connection-password=secret

The ``connection-url`` defines the connection information and parameters to pass
to the Oracle JDBC Thin driver. See the `Oracle Database JDBC driver
documentation <https://docs.oracle.com/cd/B28359_01/java.111/b31224/urls.htm#BEIDHCBA>`_
to the JDBC driver. The Oracle connector uses the Oracle JDBC Thin driver,
and the syntax of the URL may be different depending on your Oracle
configuration. For example, the connection URL is different if you are
connecting to an Oracle SID or an Oracle service name. See the `Oracle
Database JDBC driver documentation
<https://docs.oracle.com/en/database/oracle/oracle-database/21/jjdbc/data-sources-and-URLs.html#GUID-088B1600-C6C2-4F19-A020-2DAF8FE1F1C3>`_
for more information.

The ``connection-user`` and ``connection-password`` are typically required and
Expand Down