pglib 5.8.2__tar.gz → 5.9.0__tar.gz

{pglib-5.8.2/pglib.egg-info → pglib-5.9.0}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: pglib
-Version: 5.8.2
+Version: 5.9.0
 Summary: A PostgreSQL interface
 Home-page: https://gitlab.com/mkleehammer/pglib
 Maintainer: Michael Kleehammer
 Maintainer-email: michael@kleehammer.com
 License: MIT
 Keywords: postgresql postgres
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Database
@@ -21,5 +20,3 @@ A PostgreSQL interface for Python.
 This provides an interface to the libpq library.  It is not an DB API
 library, but is instead designed to match the interface PostgreSQL
 offers.
-
-

{pglib-5.8.2 → pglib-5.9.0/pglib.egg-info}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: pglib
-Version: 5.8.2
+Version: 5.9.0
 Summary: A PostgreSQL interface
 Home-page: https://gitlab.com/mkleehammer/pglib
 Maintainer: Michael Kleehammer
 Maintainer-email: michael@kleehammer.com
 License: MIT
 Keywords: postgresql postgres
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Database
@@ -21,5 +20,3 @@ A PostgreSQL interface for Python.
 This provides an interface to the libpq library.  It is not an DB API
 library, but is instead designed to match the interface PostgreSQL
 offers.
-
-

{pglib-5.8.2 → pglib-5.9.0}/setup.py

@@ -130,7 +130,7 @@ def _get_settings():
 
 setup(
     name='pglib',
-    version='5.8.2',
+    version='5.9.0',
     description='A PostgreSQL interface',
     long_description=long_description,
     maintainer='Michael Kleehammer',

{pglib-5.8.2 → pglib-5.9.0}/src/getdata.cpp

@@ -286,8 +286,10 @@ static PyObject* GetInterval(const char* p) // , bool integer_datetimes)
     uint32_t month = swaps4(pinterval->month);
     uint32_t year = month / 12;
 
-    if (month || year)
-        return PyErr_Format(Error, "Years and months are not supported in intervals");
+    if (month || year) {
+        PyErr_SetString(Error, "Years and months are not supported in intervals");
+        return 0;
+    }
 
     int seconds = (second) + (60 * minute) + (3600 * hour);
     int days    = day;
@@ -399,6 +401,9 @@ PyObject* ConvertValue(PGresult* result, int iRow, int iCol, bool integer_dateti
     case TEXTARRAYOID:
         return GetTextArray(p);
 
+    case JSONBARRAYOID:
+        return GetJSONBArray(p);
+
     case DATEARRAYOID:
         return GetDateArray(p);
 

{pglib-5.8.2 → pglib-5.9.0}/src/pgarrays.cpp

@@ -1,4 +1,3 @@
-
 // Sending and receiving arrays.  Right now we only support strings and integers, but there is
 // no reason we can't add more types.
 //
@@ -28,6 +27,7 @@
 #include "params.h"
 #include "juliandate.h"
 #include "errors.h"
+#include "runtime.h"
 #include "debug.h"
 
 
@@ -39,6 +39,12 @@ void Arrays_Init()
 
 struct ArrayHeader
 {
+    // The fields in a PostgreSQL array.  We use this when writing an array.  All int fields
+    // will be in host / big endian, so use ntohl and htonl.
+    //
+    // Technically an array header only includes the first 3 fields.  Each dimension then has a
+    // count and lbound.  Since we only support one dimension right now, I've put them together.
+
     uint32_t ndim;   // number of dimensions - we support 1
     uint32_t flags;  // binary format? 0 or 1, but unused by the server?
     Oid oid;         // type of elements
@@ -47,6 +53,46 @@ struct ArrayHeader
     char buffer[0];
 };
 
+
+struct ArrayInfo {
+    // The important array fields, copied and converted to native endianess (so don't use ntohl
+    // or htonl).
+    Oid oid;                    // type of elements
+    uint32_t len;               // number of elements
+    const char* data;           // pointer to first element
+};
+
+
+inline uint8_t ReadU8(const char ** pp) {
+    // Reads an unsigned int from `pp` *and* increments the pointer *pp.
+    uint8_t n = **(uint8_t**)pp;
+    *pp += sizeof(char);
+    return n;
+}
+
+inline int64_t Read64(const char ** pp) {
+    // Reads an int64 from `pp` *and* increments the pointer *pp.
+    uint64_t n = **(uint64_t**)pp;
+    *pp += sizeof(uint64_t);
+    return swaps8(n);
+}
+
+inline int32_t Read32(const char ** pp) {
+    // Reads an int from `pp` *and* increments the pointer *pp.
+    uint32_t n = **(uint32_t**)pp;
+    *pp += sizeof(uint32_t);
+    return (int32_t)htonl(n);
+}
+
+inline uint32_t ReadU32(const char ** pp) {
+    // Reads an unsigned int from `pp` *and* increments the pointer *pp.
+    uint32_t n = **(uint32_t**)pp;
+    *pp += sizeof(uint32_t);
+    return htonl(n);
+}
+
+
+
 static PyObject* FindFirstParam(Object& seq)
 {
     // Returns a *borrowed* reference to the first non-None parameter in the sequence.  Returns
@@ -63,6 +109,40 @@ static PyObject* FindFirstParam(Object& seq)
 }
 
 
+static bool ReadArrayInfo(const char* p, ArrayInfo &info, Oid expected_type) {
+    // Read the array header from `p` into `info` and return true if valid and something pglib
+    // can handle.  If there is an error, an exception will be set and false will be returned.
+    
+    uint32_t ndim = ReadU32(&p);
+    if (ndim > 1) {
+        SetStringError(Error, "pglib can only read single dimensional arrays (ndim=%d)", (int)ndim);
+        return false;
+    }
+
+    ReadU32(&p);  // format: 0 or 1.  Not used right now.
+
+    info.oid = (Oid)ReadU32(&p);
+    if (info.oid != expected_type) {
+        SetStringError(Error, "Unable to read array.  Expected element type %u not %u",
+                       (uint)expected_type, (uint)info.oid);
+        return false;
+    }
+
+    // The length is within the dimension header, which we don't have if there are no dimensions.
+
+    if (ndim != 0) {
+        info.len = ReadU32(&p);
+        ReadU32(&p);  // lower bound
+    } else {
+        info.len = 0;
+    }
+
+    info.data = p;
+
+    return true;
+}
+
+
 static bool BindDateArray(Params& params, Object& seq, Py_ssize_t cItems)
 {
     // Loop through the array and make sure each entry is a date.
@@ -328,26 +408,22 @@ bool BindArray(Params& params, PyObject* param)
 PyObject* GetDateArray(const char* p)
 {
     // Reads a DATEARRAYOID array result and returns a list of datetime.date objects.
+    ArrayInfo info;
+    if (!ReadArrayInfo(p, info, DATEOID)) {
+        return 0;
+    }
 
-    const ArrayHeader* phdr = (const ArrayHeader*)p;
-
-    if (ntohl(phdr->ndim) > 1)
-        return SetStringError(Error, "pglib can only read single dimensional arrays (ndim=%d)",
-                              ntohl(phdr->ndim));
-
-    Py_ssize_t dim = ntohl(phdr->ndim) == 0 ? 0 : ntohl(phdr->dim);
-
-    Object list(PyList_New(dim));
+    Object list(PyList_New(info.len));
     if (!list)
         return 0;
 
-    if (dim > 0)
-    {
-        int32_t* pT = (int32_t*)&phdr->buffer[0];
+    if (info.len) {
+        const char* data = info.data;
 
-        for (int i = 0; i < dim; i++)
+        for (uint32_t i = 0; i < info.len; i++)
         {
-            int32_t len = ntohl(*pT++);
+            int32_t len = Read32(&data);
+
             if (len == -1)
             {
                 Py_INCREF(Py_None);
@@ -355,7 +431,7 @@ PyObject* GetDateArray(const char* p)
             }
             else
             {
-                uint32_t value = swapu4(*pT++) + JULIAN_START;
+                uint32_t value = Read32(&data) + JULIAN_START;
                 int year, month, date;
                 julianToDate(value, year, month, date);
                 PyObject* d = PyDate_FromDate(year, month, date);
@@ -374,25 +450,22 @@ PyObject* GetInt4Array(const char* p)
 {
     // Reads an INT4ARRAYOID array result and returns a list of integers.
 
-    const ArrayHeader* phdr = (const ArrayHeader*)p;
-
-    if (ntohl(phdr->ndim) > 1)
-        return SetStringError(Error, "pglib can only read single dimensional arrays (ndim=%d)",
-                              ntohl(phdr->ndim));
-
-    Py_ssize_t dim = ntohl(phdr->ndim) == 0 ? 0 : ntohl(phdr->dim);
+    ArrayInfo info;
+    if (!ReadArrayInfo(p, info, INT4OID)) {
+        return 0;
+    }
 
-    Object list(PyList_New(dim));
+    Object list(PyList_New(info.len));
     if (!list)
         return 0;
 
-    if (dim > 0)
-    {
-        int32_t* pT = (int32_t*)&phdr->buffer[0];
+    if (info.len) {
+        const char* data = info.data;
 
-        for (int i = 0; i < dim; i++)
+        for (uint32_t i = 0; i < info.len; i++)
         {
-            int32_t len = ntohl(*pT++);
+            int32_t len = Read32(&data);
+
             if (len == -1)
             {
                 Py_INCREF(Py_None);
@@ -400,10 +473,11 @@ PyObject* GetInt4Array(const char* p)
             }
             else
             {
-                int32_t val = ntohl(*pT++);
+                int32_t val = Read32(&data);
                 PyObject* l = PyLong_FromLong(val);
                 if (!l)
                     return 0;
+
                 PyList_SET_ITEM(list.Get(), i, l);
             }
         }
@@ -416,26 +490,21 @@ PyObject* GetInt8Array(const char* p)
 {
     // Reads an INT4ARRAYOID array result and returns a list of integers.
 
-    const ArrayHeader* phdr = (const ArrayHeader*)p;
-
-    if (ntohl(phdr->ndim) > 1)
-        return SetStringError(Error, "pglib can only read single dimensional arrays (ndim=%d)",
-                              ntohl(phdr->ndim));
-
-    Py_ssize_t dim = ntohl(phdr->ndim) == 0 ? 0 : ntohl(phdr->dim);
+    ArrayInfo info;
+    if (!ReadArrayInfo(p, info, INT8OID)) {
+        return 0;
+    }
 
-    Object list(PyList_New(dim));
+    Object list(PyList_New(info.len));
     if (!list)
         return 0;
 
-    if (dim > 0)
-    {
-        const char* pT = &phdr->buffer[0];
+    if (info.len) {
+        const char* data = info.data;
 
-        for (int i = 0; i < dim; i++)
+        for (uint32_t i = 0; i < info.len; i++)
         {
-            int32_t len = ntohl(*(int32_t*)pT);
-            pT += 4;
+            int32_t len = Read32(&data);
 
             if (len == -1)
             {
@@ -444,11 +513,11 @@ PyObject* GetInt8Array(const char* p)
             }
             else
             {
-                int64_t val = swapu8(*(uint64_t*)pT);
-                pT += 8;
+                int64_t val = Read64(&data);
                 PyObject* l = PyLong_FromLongLong(val);
                 if (!l)
                     return 0;
+
                 PyList_SET_ITEM(list.Get(), i, l);
             }
         }
@@ -458,28 +527,25 @@ PyObject* GetInt8Array(const char* p)
 }
 
 
+
 PyObject* GetTextArray(const char* p)
 {
-    const ArrayHeader* phdr = (const ArrayHeader*)p;
-
-    if (ntohl(phdr->ndim) > 1)
-        return SetStringError(Error, "pglib can only read single dimensional arrays (ndim=%d)",
-                              ntohl(phdr->ndim));
-
-    Py_ssize_t dim = ntohl(phdr->ndim) == 0 ? 0 : ntohl(phdr->dim);
+    ArrayInfo info;
+    if (!ReadArrayInfo(p, info, TEXTOID)) {
+        return 0;
+    }
 
-    Object list(PyList_New(dim));
+    Object list(PyList_New(info.len));
     if (!list)
         return 0;
 
-    if (dim > 0)
+    if (info.len > 0)
     {
-        const char* pT = &phdr->buffer[0];
+        const char* pT = info.data;
 
-        for (int i = 0; i < dim; i++)
+        for (uint32_t i = 0; i < info.len; i++)
         {
-            int32_t len = ntohl(*(uint32_t*)pT);
-            pT += 4;
+            int32_t len = Read32(&pT);
 
             if (len == -1)
             {
@@ -499,3 +565,50 @@ PyObject* GetTextArray(const char* p)
 
     return list.Detach();
 }
+
+
+PyObject* GetJSONBArray(const char* p) {
+    ArrayInfo info;
+    if (!ReadArrayInfo(p, info, JSONBOID)) {
+        return 0;
+    }
+
+    Object list(PyList_New(info.len));
+    if (!list)
+        return 0;
+
+    if (info.len > 0) {
+        PyObject* func = GetFunction("json.loads");
+        if (!func)
+            return 0;
+
+        const char* data = info.data;
+
+        for (uint32_t i = 0; i < info.len; i++) {
+            // Each element is (len, version (1), cstr)
+
+            int32_t len = Read32(&data);
+
+            PyObject* value = 0;
+            if (len == -1) {
+                value = Py_None;
+                Py_INCREF(Py_None);
+            } else {
+                uint8_t version = ReadU8(&data);
+
+                if (version != 1) {
+                    return SetStringError(Error, "Unexpected JSONB version %u in array", (uint32_t)version);
+                }
+
+                value = PyObject_CallFunction(func, "s", data);
+                if (!value)
+                    return 0;
+                data += len - 1;  // -1 because we already incremented past version
+            }
+
+            PyList_SET_ITEM(list.Get(), i, value);
+        }
+    }
+
+    return list.Detach();
+}

{pglib-5.8.2 → pglib-5.9.0}/src/pgarrays.h

@@ -14,5 +14,6 @@ PyObject* GetInt4Array(const char* p);
 PyObject* GetInt8Array(const char* p);
 PyObject* GetTextArray(const char* p);
 PyObject* GetDateArray(const char* p);
+PyObject* GetJSONBArray(const char* p);
 
 #endif

{pglib-5.8.2 → pglib-5.9.0}/src/pglib.h

@@ -57,7 +57,7 @@ inline void UNUSED(...) { }
 
 extern PyObject* Error;
 
-// From pg_type.h
+// From src/include/catalog/pg_type.dat
 
 #define ANYARRAYOID    2277
 #define ANYOID         2276
@@ -89,6 +89,7 @@ extern PyObject* Error;
 #define VARCHAROID     1043
 #define JSONOID        114
 #define JSONBOID       3802
+#define JSONBARRAYOID  3807
 
 //  #define TIMESTAMPARRAYOID 1115
 //  #define TIMEARRAYOID 1183

{pglib-5.8.2 → pglib-5.9.0}/test/test_sync.py

@@ -1230,6 +1230,16 @@ def test_empty_jsonb(cnxn):
     assert value == result
 
 
+def test_jsonb_array(cnxn):
+    # REVIEW: We can only read these for now.
+    value = [{"a": 1}, {"a": 22}]
+    cnxn.execute("create table t1(j jsonb)")
+    cnxn.execute("""insert into t1 values('{"a": 1}')""")
+    cnxn.execute("""insert into t1 values('{"a": 22}')""")
+
+    result = cnxn.fetchval("select array_agg(j) from t1")
+    assert result == value
+
 def test_info(cnxn):
     info = cnxn.info()
     assert info['dbname'] == 'test'