Added type oracledb.DB_TYPE_XMLTYPE to represent data of type

anthony-tuininga · anthony-tuininga · commit dc2365ce9559 · 2023-11-24T14:41:09.000-07:00
"SYS.XMLTYPE" in the database.
diff --git a/doc/src/api_manual/module.rst b/doc/src/api_manual/module.rst
@@ -2347,6 +2347,12 @@ when binding data.
     type VARCHAR2. It will compare equal to the DB API type :data:`STRING`.
 
 
+.. data:: DB_TYPE_XMLTYPE
+
+    Describes columns, attributes or array elements in a database that are of
+    type SYS.XMLTYPE.
+
+
 .. _dbtypesynonyms:
 
 Database Type Synonyms
diff --git a/doc/src/release_notes.rst b/doc/src/release_notes.rst
@@ -44,6 +44,11 @@ Common Changes
     associated with columns that are being fetched. SQL domains and annotations
     require Oracle Database 23c. If using python-oracledb Thick mode, Oracle
     Client 23c is also required.
+#)  Added type :data:`~oracledb.DB_TYPE_XMLTYPE` to represent data of type
+    ``SYS.XMLTYPE`` in the database. Previously the value of
+    :data:`FetchInfo.type_code` for data of this type was
+    :data:`~oracledb.DB_TYPE_LONG` in Thick mode and
+    :data:`~oracledb.DB_TYPE_OBJECT` in Thin mode.
 #)  Added support for parsing the ``FAILOVER`` clause in full connect
     descriptors.
 #)  Fixed bug with getting unknown attributes from DbObject instances.
diff --git a/src/oracledb/__init__.py b/src/oracledb/__init__.py
@@ -221,6 +221,7 @@
     DB_TYPE_UNKNOWN as DB_TYPE_UNKNOWN,
     DB_TYPE_UROWID as DB_TYPE_UROWID,
     DB_TYPE_VARCHAR as DB_TYPE_VARCHAR,
+    DB_TYPE_XMLTYPE as DB_TYPE_XMLTYPE,
     # API types
     BINARY as BINARY,
     DATETIME as DATETIME,
diff --git a/src/oracledb/base_impl.pxd b/src/oracledb/base_impl.pxd
@@ -70,6 +70,7 @@ cdef enum:
     DB_TYPE_NUM_UNKNOWN = 0
     DB_TYPE_NUM_UROWID = 2030
     DB_TYPE_NUM_VARCHAR = 2001
+    DB_TYPE_NUM_XMLTYPE = 2032
 
 
 cdef class ApiType:
diff --git a/src/oracledb/impl/base/types.pyx b/src/oracledb/impl/base/types.pyx
@@ -164,6 +164,8 @@ DB_TYPE_UNKNOWN = DbType(DB_TYPE_NUM_UNKNOWN, "DB_TYPE_UNKNOWN", "UNKNOWN")
 DB_TYPE_UROWID = DbType(DB_TYPE_NUM_UROWID, "DB_TYPE_UROWID", "UROWID", 208)
 DB_TYPE_VARCHAR = DbType(DB_TYPE_NUM_VARCHAR, "DB_TYPE_VARCHAR", "VARCHAR2",
                          1, 4000, csfrm=1, buffer_size_factor=4)
+DB_TYPE_XMLTYPE = DbType(DB_TYPE_NUM_XMLTYPE, "DB_TYPE_XMLTYPE", "XMLTYPE",
+                         109, csfrm=1, buffer_size_factor=2147483647)
 
 # additional aliases
 db_type_by_ora_name["DOUBLE PRECISION"] = DB_TYPE_NUMBER
diff --git a/src/oracledb/impl/thick/odpi b/src/oracledb/impl/thick/odpi
@@ -1 +1 @@
-Subproject commit 3102b45c6712c9b6d53eb770b1314c06102c69e0
+Subproject commit 3d5bd6f5af856577605368c792187ed8c49e7bea
diff --git a/src/oracledb/impl/thick/odpi.pxd b/src/oracledb/impl/thick/odpi.pxd
@@ -130,6 +130,7 @@ cdef extern from "impl/thick/odpi/embed/dpi.c":
         DPI_ORACLE_TYPE_TIMESTAMP_LTZ
         DPI_ORACLE_TYPE_TIMESTAMP_TZ
         DPI_ORACLE_TYPE_VARCHAR
+        DPI_ORACLE_TYPE_XMLTYPE
 
     # SODA flags
     enum:
diff --git a/src/oracledb/impl/thick/utils.pyx b/src/oracledb/impl/thick/utils.pyx
@@ -279,7 +279,8 @@ cdef object _convert_to_python(ThickConnImpl conn_impl, DbType dbtype,
             or oracle_type == DPI_ORACLE_TYPE_VARCHAR \
             or oracle_type == DPI_ORACLE_TYPE_NVARCHAR \
             or oracle_type == DPI_ORACLE_TYPE_LONG_VARCHAR \
-            or oracle_type == DPI_ORACLE_TYPE_LONG_NVARCHAR:
+            or oracle_type == DPI_ORACLE_TYPE_LONG_NVARCHAR \
+            or oracle_type == DPI_ORACLE_TYPE_XMLTYPE:
         as_bytes = &dbvalue.asBytes
         return as_bytes.ptr[:as_bytes.length].decode()
     elif oracle_type == DPI_ORACLE_TYPE_NUMBER:
diff --git a/src/oracledb/impl/thin/messages.pyx b/src/oracledb/impl/thin/messages.pyx
@@ -607,7 +607,7 @@ cdef class MessageWithData(Message):
             column_value = buf.read_oson()
         elif ora_type_num == TNS_DATA_TYPE_INT_NAMED:
             typ_impl = var_impl.objtype
-            if typ_impl.is_xml_type:
+            if typ_impl is None:
                 column_value = buf.read_xmltype(self.conn_impl)
             else:
                 obj_impl = buf.read_dbobject(typ_impl)
@@ -720,7 +720,10 @@ cdef class MessageWithData(Message):
                 self.type_cache = get_dbobject_type_cache(cache_num)
             typ_impl = self.type_cache.get_type_for_info(oid, schema, None,
                                                          name)
-            fetch_info.objtype = typ_impl
+            if typ_impl.is_xml_type:
+                fetch_info.dbtype = DB_TYPE_XMLTYPE
+            else:
+                fetch_info.objtype = typ_impl
         return fetch_info
 
     cdef int _process_describe_info(self, ReadBuffer buf,
diff --git a/src/oracledb/thin_impl.pyx b/src/oracledb/thin_impl.pyx
@@ -83,6 +83,7 @@ from .base_impl cimport ConnectParamsImpl, PoolParamsImpl, BaseDbObjectAttrImpl
 from .base_impl cimport BaseDbObjectImpl, BaseDbObjectTypeImpl
 from .base_impl import DB_TYPE_BLOB, DB_TYPE_CLOB, DB_TYPE_NCLOB
 from .base_impl import DB_TYPE_BINARY_INTEGER, DB_TYPE_CURSOR, DB_TYPE_OBJECT
+from .base_impl import DB_TYPE_XMLTYPE
 
 ctypedef unsigned char char_type
 
diff --git a/tests/test_2500_string_var.py b/tests/test_2500_string_var.py
@@ -486,13 +486,17 @@ def test_2530_short_xml_as_string(self):
         "2530 - test fetching XMLType (< 1K) as a string"
         self.cursor.execute(
             """
-            select XMLElement("string", stringCol)
+            select XMLElement("string", stringCol) as xml
             from TestStrings
             where intCol = 1
             """
         )
         (actual_value,) = self.cursor.fetchone()
         self.assertEqual(actual_value, "<string>String 1</string>")
+        self.assertEqual(
+            self.cursor.description,
+            [("XML", oracledb.DB_TYPE_XMLTYPE, None, None, None, None, True)],
+        )
 
     def test_2531_long_xml_as_string(self):
         "2531 - test inserting and fetching XMLType (1K) as a string"
