Added support for internal use of JSON in SODA with Oracle Client 23.

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -48,6 +48,8 @@ Thin Mode Changes
 Thick Mode Changes
 ++++++++++++++++++
 
+#)  Added support for internal use of JSON in SODA with Oracle Client 23. This
+    allows for seamless transfer of extended data types.
 #)  Fixed bug when calling :meth:`SodaDoc.getContent()` for SODA documents
     that do not contain JSON.
 #)  Errors ``DPY-4011: the database or network closed the connection`` and

src/oracledb/base_impl.pxd

@@ -657,6 +657,7 @@ cdef class BaseDbObjectImpl:
 
 cdef class BaseSodaDbImpl:
     cdef:
+        public bint supports_json
         object _conn
 
 

src/oracledb/impl/base/soda.pyx

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2020, 2022, Oracle and/or its affiliates.
+# Copyright (c) 2020, 2024, Oracle and/or its affiliates.
 #
 # This software is dual-licensed to you under the Universal Permissive License
 # (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
@@ -35,10 +35,14 @@ cdef class BaseSodaDbImpl:
     def create_collection(self, str name, str metadata, bint map_mode):
         pass
 
-    @utils.CheckImpls("creating a SODA document")
+    @utils.CheckImpls("creating a SODA binary/text document")
     def create_document(self, bytes content, str key, str media_type):
         pass
 
+    @utils.CheckImpls("creating a SODA JSON document")
+    def create_json_document(self, object content, str key):
+        pass
+
     @utils.CheckImpls("getting a list of SODA collection names")
     def get_collection_names(self, str start_name, uint32_t limit):
         pass

src/oracledb/impl/thick/connection.pyx

@@ -344,7 +344,7 @@ cdef class ThickConnImpl(BaseConnImpl):
                 params.private_key_len = <uint32_t> len(params.private_key)
 
         # set up common creation parameters
-        if dpiContext_initCommonCreateParams(driver_context,
+        if dpiContext_initCommonCreateParams(driver_info.context,
                                              &common_params) < 0:
             _raise_from_odpi()
         common_params.createMode |= DPI_MODE_CREATE_THREADED
@@ -361,7 +361,8 @@ cdef class ThickConnImpl(BaseConnImpl):
             common_params.accessToken = &access_token
 
         # set up connection specific creation parameters
-        if dpiContext_initConnCreateParams(driver_context, &conn_params) < 0:
+        if dpiContext_initConnCreateParams(driver_info.context,
+                                           &conn_params) < 0:
             _raise_from_odpi()
         if params.username_len == 0 and params.password_len == 0:
             conn_params.externalAuth = 1
@@ -394,12 +395,12 @@ cdef class ThickConnImpl(BaseConnImpl):
 
         # perform connection
         with nogil:
-            status = dpiConn_create(driver_context, params.username_ptr,
+            status = dpiConn_create(driver_info.context, params.username_ptr,
                                     params.username_len, params.password_ptr,
                                     params.password_len, params.dsn_ptr,
                                     params.dsn_len, &common_params,
                                     &conn_params, &self._handle)
-            dpiContext_getError(driver_context, &error_info)
+            dpiContext_getError(driver_info.context, &error_info)
         if status < 0:
             _raise_from_info(&error_info)
         elif error_info.isWarning:
@@ -416,7 +417,7 @@ cdef class ThickConnImpl(BaseConnImpl):
             version_info.portReleaseNum,
             version_info.portUpdateNum
         )
-        if client_version_info.versionNum >= 23 \
+        if driver_info.client_version_info.versionNum >= 23 \
                 and version_info.versionNum >= 23:
             self.supports_bool = True
             self._oson_max_fname_size = 65535
@@ -448,6 +449,7 @@ cdef class ThickConnImpl(BaseConnImpl):
 
     def create_soda_database_impl(self, conn):
         cdef ThickSodaDbImpl impl = ThickSodaDbImpl.__new__(ThickSodaDbImpl)
+        impl.supports_json = driver_info.soda_use_json_desc
         impl._conn = conn
         if dpiConn_getSodaDb(self._handle, &impl._handle) < 0:
             _raise_from_odpi()

src/oracledb/impl/thick/cursor.pyx

@@ -302,7 +302,7 @@ cdef class ThickCursorImpl(BaseCursorImpl):
         with nogil:
             status = dpiStmt_execute(self._handle, mode, &num_query_cols)
             if status == DPI_SUCCESS:
-                dpiContext_getError(driver_context, &error_info)
+                dpiContext_getError(driver_info.context, &error_info)
                 if not self._stmt_info.isPLSQL:
                     status = dpiStmt_getRowCount(self._handle, &rowcount)
         if status < 0:
@@ -340,7 +340,7 @@ cdef class ThickCursorImpl(BaseCursorImpl):
         if num_execs_int > 0:
             with nogil:
                 status = dpiStmt_executeMany(self._handle, mode, num_execs_int)
-                dpiContext_getError(driver_context, &error_info)
+                dpiContext_getError(driver_info.context, &error_info)
                 dpiStmt_getRowCount(self._handle, &rowcount)
             if not self._stmt_info.isPLSQL:
                 self.rowcount = rowcount

src/oracledb/impl/thick/odpi.pxd

@@ -341,6 +341,7 @@ cdef extern from "impl/thick/odpi/embed/dpi.c":
         const char *loadErrorUrl
         const char *oracleClientLibDir
         const char *oracleClientConfigDir
+        bint sodaUseJsonDesc
 
     ctypedef union dpiDataBuffer:
         bint asBoolean
@@ -843,6 +844,8 @@ cdef extern from "impl/thick/odpi/embed/dpi.c":
     int dpiJson_getValue(dpiJson *json, uint32_t options,
             dpiJsonNode **topNode) nogil
 
+    int dpiJson_release(dpiJson *json) nogil
+
     int dpiJson_setValue(dpiJson *json, dpiJsonNode *topNode)
 
     int dpiLob_addRef(dpiLob *lob) nogil
@@ -1142,6 +1145,10 @@ cdef extern from "impl/thick/odpi/embed/dpi.c":
             const char *mediaType, uint32_t mediaTypeLength, uint32_t flags,
             dpiSodaDoc **doc) nogil
 
+    int dpiSodaDb_createJsonDocument(dpiSodaDb *db, const char *key,
+            uint32_t keyLength, const dpiJsonNode *content, uint32_t flags,
+            dpiSodaDoc **doc) nogil
+
     int dpiSodaDb_getCollectionNames(dpiSodaDb *db,
             const char *startName, uint32_t startNameLength, uint32_t limit,
             uint32_t flags, dpiStringList *names) nogil
@@ -1157,6 +1164,10 @@ cdef extern from "impl/thick/odpi/embed/dpi.c":
     int dpiSodaDoc_getCreatedOn(dpiSodaDoc *doc, const char **value,
             uint32_t *valueLength) nogil
 
+    int dpiSodaDoc_getIsJson(dpiSodaDoc *doc, bint *isJson) nogil
+
+    int dpiSodaDoc_getJsonContent(dpiSodaDoc *doc, dpiJson **value) nogil
+
     int dpiSodaDoc_getKey(dpiSodaDoc *doc, const char **value,
             uint32_t *valueLength) nogil
 

src/oracledb/impl/thick/pool.pyx

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2020, 2023, Oracle and/or its affiliates.
+# Copyright (c) 2020, 2024, Oracle and/or its affiliates.
 #
 # This software is dual-licensed to you under the Universal Permissive License
 # (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
@@ -83,7 +83,7 @@ cdef class ThickPoolImpl(BasePoolImpl):
                 private_key_len = <uint32_t> len(private_key_bytes)
 
         # set up common creation parameters
-        if dpiContext_initCommonCreateParams(driver_context,
+        if dpiContext_initCommonCreateParams(driver_info.context,
                                              &common_params) < 0:
             _raise_from_odpi()
         common_params.createMode |= DPI_MODE_CREATE_THREADED
@@ -101,7 +101,8 @@ cdef class ThickPoolImpl(BasePoolImpl):
             common_params.accessToken = &access_token
 
         # set up pool creation parameters
-        if dpiContext_initPoolCreateParams(driver_context, &create_params) < 0:
+        if dpiContext_initPoolCreateParams(driver_info.context,
+                                           &create_params) < 0:
             _raise_from_odpi()
         create_params.minSessions = self.min
         create_params.maxSessions = self.max
@@ -142,11 +143,11 @@ cdef class ThickPoolImpl(BasePoolImpl):
 
         # create pool
         with nogil:
-            status = dpiPool_create(driver_context, user_ptr, user_len,
+            status = dpiPool_create(driver_info.context, user_ptr, user_len,
                                     password_ptr, password_len, dsn_ptr,
                                     dsn_len, &common_params, &create_params,
                                     &self._handle)
-            dpiContext_getError(driver_context, &error_info)
+            dpiContext_getError(driver_info.context, &error_info)
         if status < 0:
             _raise_from_info(&error_info)
         elif error_info.isWarning:

src/oracledb/impl/thick/soda.pyx

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2020, 2023, Oracle and/or its affiliates.
+# Copyright (c) 2020, 2024, Oracle and/or its affiliates.
 #
 # This software is dual-licensed to you under the Universal Permissive License
 # (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
@@ -74,7 +74,8 @@ cdef class ThickSodaDbImpl(BaseSodaDbImpl):
 
     def create_document(self, bytes content, str key, str media_type):
         """
-        Internal method for creating a document.
+        Internal method for creating a document containing binary or encoded
+        text data.
         """
         cdef:
             StringBuffer media_type_buf = StringBuffer()
@@ -93,6 +94,24 @@ cdef class ThickSodaDbImpl(BaseSodaDbImpl):
             _raise_from_odpi()
         return doc_impl
 
+    def create_json_document(self, object content, str key):
+        """
+        Internal method for creating a document containing JSON.
+        """
+        cdef:
+            StringBuffer key_buf = StringBuffer()
+            JsonBuffer json_buf = JsonBuffer()
+            ThickSodaDocImpl doc_impl
+        key_buf.set_value(key)
+        json_buf.from_object(content)
+        doc_impl = ThickSodaDocImpl.__new__(ThickSodaDocImpl)
+        if dpiSodaDb_createJsonDocument(self._handle, key_buf.ptr,
+                                        key_buf.length, &json_buf._top_node,
+                                        DPI_SODA_FLAGS_DEFAULT,
+                                        &doc_impl._handle) < 0:
+            _raise_from_odpi()
+        return doc_impl
+
     def get_collection_names(self, str start_name, uint32_t limit):
         """
         Internal method for getting the list of collection names.
@@ -163,7 +182,7 @@ cdef class ThickSodaCollImpl(BaseSodaCollImpl):
         Internal method for populating the SODA operations structure with the
         information provided by the user.
         """
-        if dpiContext_initSodaOperOptions(driver_context, options) < 0:
+        if dpiContext_initSodaOperOptions(driver_info.context, options) < 0:
             _raise_from_odpi()
         options.hint = ptr
         options.hintLength = length
@@ -489,20 +508,29 @@ cdef class ThickSodaDocImpl(BaseSodaDocImpl):
         Internal method for returning the content of the document.
         """
         cdef:
-            bytes out_content = None
+            object out_content = None
             str out_encoding = None
             const char *encoding
             uint32_t content_len
             const char *content
-        if dpiSodaDoc_getContent(self._handle, &content, &content_len,
-                                 &encoding) < 0:
+            dpiJson *json
+            bint is_json
+        if dpiSodaDoc_getIsJson(self._handle, &is_json) < 0:
             _raise_from_odpi()
-        if content != NULL:
-            out_content = content[:content_len]
-        if encoding != NULL:
-            out_encoding = encoding.decode()
+        if is_json:
+            if dpiSodaDoc_getJsonContent(self._handle, &json) < 0:
+                _raise_from_odpi()
+            out_content = _convert_json_to_python(json)
         else:
-            out_encoding = "UTF-8"
+            if dpiSodaDoc_getContent(self._handle, &content, &content_len,
+                                    &encoding) < 0:
+                _raise_from_odpi()
+            if content != NULL:
+                out_content = content[:content_len]
+            if encoding != NULL:
+                out_encoding = encoding.decode()
+            else:
+                out_encoding = "UTF-8"
         return (out_content, out_encoding)
 
     def get_created_on(self):
@@ -637,7 +665,7 @@ cdef class ThickSodaOpImpl:
             uint32_t i
         impl._buffers = []
         options = &impl._options
-        if dpiContext_initSodaOperOptions(driver_context, options) < 0:
+        if dpiContext_initSodaOperOptions(driver_info.context, options) < 0:
             _raise_from_odpi()
         if op._keys:
             options.numKeys = <uint32_t> len(op._keys)

src/oracledb/impl/thick/subscr.pyx

@@ -146,7 +146,7 @@ cdef class ThickSubscrImpl(BaseSubscrImpl):
             int status
         name_buf.set_value(self.name)
         ip_address_buf.set_value(self.ip_address)
-        if dpiContext_initSubscrCreateParams(driver_context, &params) < 0:
+        if dpiContext_initSubscrCreateParams(driver_info.context, &params) < 0:
             _raise_from_odpi()
         params.subscrNamespace = self.namespace
         params.protocol = self.protocol