dnrops
/
python-oracledb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc improvements.

This commit is contained in:
Anthony Tuininga 2023-05-24 09:21:15 -06:00
parent 73cf3b6658
commit 1f1418baf3
3 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/src/index.rst
View File

@ -9,7 +9,7 @@ Database. It conforms to the `Python Database API v2.0 Specification
additions and a couple of exclusions.
This module is currently tested with Python 3.6, 3.7, 3.8, 3.9, 3.10 and 3.11
against Oracle Database 21c, 19c, 18c, 12c, and 11.2.
against Oracle Database 23c, 21c, 19c, 18c, 12c, and 11.2.
**python-oracledb** is distributed under an open-source
:ref:`license <license>`. Changes in python-oracledb releases can be found in

2
doc/src/user_guide/appendix_b.rst
View File

@ -152,7 +152,7 @@ In python-oracledb Thin mode, using the ``POOL_CONNECTION_CLASS`` or
equivalent attributes when creating a connection or connection pool.
In python-oracledb Thick mode, the ``POOL_CONNECTION_CLASS`` or ``POOL_PURITY``
values will only work when connected to Oracle Database 21c. Note if
values will only work when connected to Oracle Database 21c, or later. Note if
``POOL_PURITY=SELF`` is used in a connect string, then python-oracledb Thick
mode applications will ignore the action to drop the session when attempting to
remove an unusable connections from a pool in some uncommon error cases. It is

54
doc/src/user_guide/json_data_type.rst
View File

@ -15,13 +15,34 @@ For more information about using JSON in Oracle Database see the `Database JSON
Developer's Guide
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=ADJSN>`__.
**Oracle Database 21c JSON Data Type**
Oracle Database 21c introduced a dedicated JSON data type with a new `binary
storage format <https://blogs.oracle.com/jsondb/osonformat>`__ that improves
performance and functionality compared with earlier releases. To take
advantage of the dedicated JSON type with Oracle Database 21c, or later, you
can use python-oracledb in Thin or Thick modes. With Thick mode the Oracle
Client libraries should be version 21, or later.
To create a table with a column called ``JSON_DATA`` for JSON data you might
use:
.. code-block:: sql
create table CustomersAsJson (
id integer not null primary key,
json_data json
);
**Oracle Database 12c JSON Data Type**
In Oracle Database 12c, JSON in relational tables is stored as BLOB, CLOB or
VARCHAR2 data. All of these types can be used with python-oracledb in Thin or
Thick modes.
In Oracle Database 12c, or later, JSON in relational tables can be stored as
BLOB, CLOB or VARCHAR2 data. All of these types can be used with
python-oracledb in Thin or Thick modes. BLOB is preferred to avoid character
set conversion overheads.
The older syntax to create a table with a JSON column is like:
The syntax to create a table with a JSON column using BLOB storage is like:
.. code-block:: sql
@ -33,29 +54,8 @@ The older syntax to create a table with a JSON column is like:
The check constraint with the clause ``IS JSON`` ensures only JSON data is
stored in that column.
The older syntax can still be used in Oracle Database 21c; however, the
recommendation is to move to the new JSON type. With the old syntax, the
storage can be BLOB, CLOB, or VARCHAR2. Of these, BLOB is preferred to avoid
character set conversion overheads.
**Oracle Database 21c JSON Data Type**
Oracle Database 21c introduced a dedicated JSON data type with a new `binary
storage format <https://blogs.oracle.com/jsondb/osonformat>`__ that improves
performance and functionality. To take advantage of the dedicated JSON type
you can use python-oracledb in Thin or Thick modes. With Thick mode the Oracle
Client libraries should be version 21, or later.
In Oracle Database 21, to create a table with a column called ``JSON_DATA`` for
JSON data you might use:
.. code-block:: sql
create table CustomersAsJson (
id integer not null primary key,
json_data json
);
This older syntax can still be used in Oracle Database 21c (and later);
however, the recommendation is to move to the new JSON type.
Using the Oracle Database 21c JSON Type in python-oracledb
==========================================================