Add more doc redirects.

This commit is contained in:
Anthony Tuininga 2023-06-03 09:37:29 -06:00
parent 5cfbb7d9e4
commit a05b9a5233
31 changed files with 217 additions and 7 deletions

View File

@ -4,6 +4,13 @@
Advanced Queuing (AQ) Advanced Queuing (AQ)
********************* *********************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
See :ref:`aqusermanual` for more information about using AQ in cx_Oracle. See :ref:`aqusermanual` for more information about using AQ in cx_Oracle.
.. note:: .. note::

View File

@ -4,6 +4,13 @@
Connection Object Connection Object
***************** *****************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
.. note:: .. note::
Any outstanding changes will be rolled back when the connection object Any outstanding changes will be rolled back when the connection object

View File

@ -5,6 +5,13 @@ Cursor Object
************* *************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
.. method:: Cursor.__enter__() .. method:: Cursor.__enter__()
The entry point for the cursor as a context manager. It returns itself. The entry point for the cursor as a context manager. It returns itself.

View File

@ -4,6 +4,13 @@
Deprecations Deprecations
************ ************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
The following tables contains all of the deprecations in the cx_Oracle API, The following tables contains all of the deprecations in the cx_Oracle API,
when they were first deprecated and a comment on what should be used instead, when they were first deprecated and a comment on what should be used instead,
if applicable. The most recent deprecations are listed first. if applicable. The most recent deprecations are listed first.

View File

@ -4,6 +4,13 @@
LOB Objects LOB Objects
*********** ***********
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
See :ref:`lobdata` for more information about using LOBs. See :ref:`lobdata` for more information about using LOBs.
.. note:: .. note::

View File

@ -4,6 +4,13 @@
Object Type Objects Object Type Objects
******************* *******************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
.. note:: .. note::
This object is an extension to the DB API. It is returned by the This object is an extension to the DB API. It is returned by the

View File

@ -4,6 +4,13 @@
SessionPool Object SessionPool Object
****************** ******************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
.. note:: .. note::
This object is an extension to the DB API. This object is an extension to the DB API.

View File

@ -4,6 +4,13 @@
SODA SODA
**** ****
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
`Oracle Database Simple Oracle Document Access (SODA) `Oracle Database Simple Oracle Document Access (SODA)
<https://docs.oracle.com/en/database/oracle/simple-oracle-document-access>`__ <https://docs.oracle.com/en/database/oracle/simple-oracle-document-access>`__
allows documents to be inserted, queried, and retrieved from Oracle Database allows documents to be inserted, queried, and retrieved from Oracle Database

View File

@ -4,6 +4,13 @@
Subscription Object Subscription Object
******************* *******************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
.. note:: .. note::
This object is an extension the DB API. This object is an extension the DB API.

View File

@ -4,6 +4,13 @@
Variable Objects Variable Objects
**************** ****************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
.. note:: .. note::
The DB API definition does not define this object. The DB API definition does not define this object.

View File

@ -1,6 +1,13 @@
Welcome to cx_Oracle's documentation! Welcome to cx_Oracle's documentation!
===================================== =====================================
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
**cx_Oracle** is a module that enables access to Oracle Database and conforms **cx_Oracle** is a module that enables access to Oracle Database and conforms
to the Python database API specification. This module is currently tested to the Python database API specification. This module is currently tested
against Oracle Client 21c, 19c, 18c, 12c, and 11.2, and Python 3.6, 3.7, 3.8, against Oracle Client 21c, 19c, 18c, 12c, and 11.2, and Python 3.6, 3.7, 3.8,
@ -11,13 +18,6 @@ releases.
(the BSD license). A detailed description of cx_Oracle changes can be found in (the BSD license). A detailed description of cx_Oracle changes can be found in
the :ref:`release notes <releasenotes>`. the :ref:`release notes <releasenotes>`.
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Contents: Contents:
User Guide User Guide

View File

@ -5,6 +5,13 @@
cx_Oracle Release Notes cx_Oracle Release Notes
======================= =======================
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
For any deprecations, see :ref:`Deprecations <deprecations>`. For any deprecations, see :ref:`Deprecations <deprecations>`.
Version 8.3 (November 2021) Version 8.3 (November 2021)

View File

@ -4,6 +4,13 @@
Oracle Advanced Queuing (AQ) Oracle Advanced Queuing (AQ)
**************************** ****************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
`Oracle Advanced Queuing `Oracle Advanced Queuing
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=ADQUE>`__ is a highly <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=ADQUE>`__ is a highly
configurable and scalable messaging feature of Oracle Database. It has configurable and scalable messaging feature of Oracle Database. It has

View File

@ -4,6 +4,13 @@
Batch Statement Execution and Bulk Loading Batch Statement Execution and Bulk Loading
****************************************** ******************************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Inserting or updating multiple rows can be performed efficiently with Inserting or updating multiple rows can be performed efficiently with
:meth:`Cursor.executemany()`, making it easy to work with large data sets with :meth:`Cursor.executemany()`, making it easy to work with large data sets with
cx_Oracle. This method can significantly outperform repeated calls to cx_Oracle. This method can significantly outperform repeated calls to

View File

@ -4,6 +4,13 @@
Using Bind Variables Using Bind Variables
******************** ********************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
SQL and PL/SQL statements that pass data to and from Oracle Database should use SQL and PL/SQL statements that pass data to and from Oracle Database should use
placeholders in SQL and PL/SQL statements that mark where data is supplied or placeholders in SQL and PL/SQL statements that mark where data is supplied or
returned. These placeholders are referred to as bind variables or bind returned. These placeholders are referred to as bind variables or bind

View File

@ -4,6 +4,13 @@
Connecting to Oracle Database Connecting to Oracle Database
***************************** *****************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Connections between cx_Oracle and Oracle Database are used for executing Connections between cx_Oracle and Oracle Database are used for executing
:ref:`SQL <sqlexecution>`, :ref:`PL/SQL <plsqlexecution>`, and :ref:`SODA :ref:`SQL <sqlexecution>`, :ref:`PL/SQL <plsqlexecution>`, and :ref:`SODA
<sodausermanual>`. <sodausermanual>`.

View File

@ -4,6 +4,13 @@
Continuous Query Notification (CQN) Continuous Query Notification (CQN)
*********************************** ***********************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
`Continuous Query Notification (CQN) `Continuous Query Notification (CQN)
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest& <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&
id=GUID-373BAF72-3E63-42FE-8BEA-8A2AEFBF1C35>`__ allows applications to receive id=GUID-373BAF72-3E63-42FE-8BEA-8A2AEFBF1C35>`__ allows applications to receive

View File

@ -4,6 +4,13 @@
Exception Handling Exception Handling
****************** ******************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
All exceptions raised by cx_Oracle are inherited from :attr:`cx_Oracle.Error`. All exceptions raised by cx_Oracle are inherited from :attr:`cx_Oracle.Error`.
See :ref:`Exceptions <exceptions>` for more details on the various exceptions See :ref:`Exceptions <exceptions>` for more details on the various exceptions
defined by cx_Oracle. See the exception handling section in the defined by cx_Oracle. See the exception handling section in the

View File

@ -4,6 +4,13 @@
Character Sets and Globalization Character Sets and Globalization
******************************** ********************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Data fetched from, and sent to, Oracle Database will be mapped between the Data fetched from, and sent to, Oracle Database will be mapped between the
database character set and the "Oracle client" character set of the Oracle database character set and the "Oracle client" character set of the Oracle
Client libraries used by cx_Oracle. If data cannot be correctly mapped between Client libraries used by cx_Oracle. If data cannot be correctly mapped between

View File

@ -4,6 +4,13 @@
High Availability with cx_Oracle High Availability with cx_Oracle
******************************** ********************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Applications can utilize many features for high availability (HA) during planned and Applications can utilize many features for high availability (HA) during planned and
unplanned outages in order to: unplanned outages in order to:

View File

@ -4,6 +4,13 @@
cx_Oracle 8 Initialization cx_Oracle 8 Initialization
************************** **************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
The cx_Oracle module loads Oracle Client libraries which communicate over The cx_Oracle module loads Oracle Client libraries which communicate over
Oracle Net to an existing database. The Oracle Client libraries need to be Oracle Net to an existing database. The Oracle Client libraries need to be
installed separately. See :ref:`installation`. Oracle Net is not a separate installed separately. See :ref:`installation`. Oracle Net is not a separate

View File

@ -4,6 +4,13 @@
Working with the JSON Data Type Working with the JSON Data Type
******************************* *******************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Native support for JSON data was introduced in Oracle Database 12c. You can Native support for JSON data was introduced in Oracle Database 12c. You can
use JSON with relational database features, including transactions, indexing, use JSON with relational database features, including transactions, indexing,
declarative querying, and views. You can project JSON data relationally, declarative querying, and views. You can project JSON data relationally,

View File

@ -4,6 +4,13 @@
Using CLOB and BLOB Data Using CLOB and BLOB Data
************************ ************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Oracle Database uses :ref:`lobobj` to store large data such as text, images, Oracle Database uses :ref:`lobobj` to store large data such as text, images,
videos and other multimedia formats. The maximum size of a LOB is limited to videos and other multimedia formats. The maximum size of a LOB is limited to
the size of the tablespace storing it. the size of the tablespace storing it.

View File

@ -4,6 +4,13 @@
PL/SQL Execution PL/SQL Execution
**************** ****************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
PL/SQL stored procedures, functions and anonymous blocks can be called from PL/SQL stored procedures, functions and anonymous blocks can be called from
cx_Oracle. cx_Oracle.

View File

@ -4,6 +4,13 @@
Simple Oracle Document Access (SODA) Simple Oracle Document Access (SODA)
************************************ ************************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Overview Overview
======== ========

View File

@ -4,6 +4,13 @@
SQL Execution SQL Execution
************* *************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Executing SQL statements is the primary way in which a Python application Executing SQL statements is the primary way in which a Python application
communicates with Oracle Database. Statements are executed using the methods communicates with Oracle Database. Statements are executed using the methods
:meth:`Cursor.execute()` or :meth:`Cursor.executemany()`. Statements include :meth:`Cursor.execute()` or :meth:`Cursor.executemany()`. Statements include

View File

@ -4,6 +4,13 @@
Starting and Stopping Oracle Database Starting and Stopping Oracle Database
************************************* *************************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
This chapter covers how to start up and shutdown Oracle Database using This chapter covers how to start up and shutdown Oracle Database using
cx_Oracle. cx_Oracle.

View File

@ -4,6 +4,13 @@
Tracing SQL and PL/SQL Statements Tracing SQL and PL/SQL Statements
********************************* *********************************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Subclass Connections Subclass Connections
==================== ====================

View File

@ -4,6 +4,13 @@
Tuning cx_Oracle Tuning cx_Oracle
**************** ****************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Some general tuning tips are: Some general tuning tips are:
* Tune your application architecture. * Tune your application architecture.

View File

@ -4,6 +4,13 @@
Transaction Management Transaction Management
********************** **********************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
A database transaction is a grouping of SQL statements that make a logical data A database transaction is a grouping of SQL statements that make a logical data
change to the database. change to the database.

View File

@ -4,6 +4,13 @@
Working with XMLTYPE Working with XMLTYPE
******************** ********************
.. note::
**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.
**New projects should install python-oracledb instead of cx_Oracle.**
Oracle XMLType columns are fetched as strings by default. This is currently Oracle XMLType columns are fetched as strings by default. This is currently
limited to the maximum length of a ``VARCHAR2`` column. To return longer XML limited to the maximum length of a ``VARCHAR2`` column. To return longer XML
values, they must be queried as LOB values instead. values, they must be queried as LOB values instead.