Add support for binding arrays by index

Signed-off-by: Salil Chandra <[email protected]>

Author: chands10

comdb2/_ccdb2.pyx

@@ -421,13 +421,13 @@ cdef class Handle(object):
                                                      cval.type, cval.data, cval.size)
                     else:
                         if bind_by_index:
-                            raise ValueError(
-                                "Binding arrays by index is currently unsupported."
-                                " You must bind by name when binding arrays."
-                            )
-                        rc = lib.cdb2_bind_array(self.hndl, <char*>ckey,
-                                                 cval.type, cval.data,
-                                                 cval.list_size, cval.size)
+                            rc = lib.cdb2_bind_array_index(self.hndl, ckey,
+                                                           cval.type, cval.data,
+                                                           cval.list_size, cval.size)
+                        else:
+                            rc = lib.cdb2_bind_array(self.hndl, <char*>ckey,
+                                                     cval.type, cval.data,
+                                                     cval.list_size, cval.size)
                     _errchk(rc, self.hndl)
 
             with nogil:

comdb2/_cdb2api.pxd

@@ -78,5 +78,6 @@ cdef extern from "cdb2api.h" nogil:
     int cdb2_bind_param(cdb2_hndl_tp *hndl, const char *name, int type, const void *varaddr, int length) except +
     int cdb2_bind_index(cdb2_hndl_tp *hndl, int index, int type, const void *varaddr, int length) except +
     int cdb2_bind_array(cdb2_hndl_tp *hndl, const char *name, cdb2_coltype, const void *varaddr, size_t count, size_t typelen) except +
+    int cdb2_bind_array_index(cdb2_hndl_tp *hndl, int index, cdb2_coltype, const void *varaddr, size_t count, size_t typelen) except +
     int cdb2_clearbindings(cdb2_hndl_tp *hndl) except +
     int cdb2_clear_ack(cdb2_hndl_tp *hndl) except +

comdb2/cdb2.py

@@ -107,10 +107,6 @@
     >>> print(list(hndl.execute(query, [20, 42])))
     [[1]]
 
-Note:
-
-    Arrays can currently only be bound by name, not positionally.
-
 Types
 -----
 
@@ -400,7 +396,6 @@ def execute(
                 you must pass a mapping from parameter name to value.
                 If the SQL statement has ``?`` style placeholders, you must
                 instead pass an ordered sequence of parameter values.
-                Note that arrays can currently only be bound by name.
             column_types (Sequence[int]): An optional sequence of types (values
                 of the `ColumnType` enumeration) which the columns of the
                 result set will be coerced to.

comdb2/dbapi2.py

@@ -137,10 +137,6 @@
 In this example, we execute the query with the first ``?`` bound to 20 and the
 second ``?`` bound to 42, so a ``1`` is returned like in the previous example.
 
-Note:
-
-    Arrays can currently only be bound by name, not positionally.
-
 Types
 -----
 
@@ -1057,7 +1053,6 @@ def execute(
                 you must pass a mapping from parameter name to value.
                 If the SQL statement has ``?`` style placeholders, you must
                 instead pass an ordered sequence of parameter values.
-                Note that arrays can currently only be bound by name.
             column_types (Sequence[int]): An optional sequence of types (values
                 of the `ColumnType` enumeration) which the columns of the
                 result set will be coerced to.

tests/test_cdb2.py

@@ -307,18 +307,6 @@ def test_parameter_name_in_binding_errors_noexception():
     )
 
 
-def test_binding_array_by_index():
-    hndl = cdb2.Handle("mattdb", "dev")
-
-    with pytest.raises(Exception) as exc:
-        hndl.execute("select * from carray(?)", [[1, 2, 3]])
-
-    assert exc.value.args[0] == (
-        "Binding arrays by index is currently unsupported. "
-        "You must bind by name when binding arrays."
-    )
-
-
 def test_specifying_column_types():
     # GIVEN
     hndl = cdb2.Handle("mattdb", "dev")

tests/test_dbapi2.py

@@ -990,6 +990,13 @@ def test_parameter_binding_arrays(values):
     cursor.execute("select * from carray(%(values)s)", dict(values=values))
     results = cursor.fetchall()
 
+    # THEN
+    assert results == [[v] for v in values]
+
+    # WHEN
+    cursor.execute("select * from carray(?)", [values])
+    results = cursor.fetchall()
+
     # THEN
     assert results == [[v] for v in values]
     conn.close()
@@ -1000,27 +1007,27 @@ def test_parameter_binding_arrays(values):
     [
         (
             [],
-            "Can't bind list value [] for parameter 'values': "
+            "Can't bind list value [] for parameter {}: "
             + "ValueError: empty lists cannot be bound",
         ),
         (
             (),
-            "Can't bind tuple value () for parameter 'values': "
+            "Can't bind tuple value () for parameter {}: "
             + "ValueError: empty tuples cannot be bound",
         ),
         (
             [1, "hello"],
-            "Can't bind list value [1, 'hello'] for parameter 'values': "
+            "Can't bind list value [1, 'hello'] for parameter {}: "
             + "ValueError: all list elements must be the same type",
         ),
         (
             (1j,),
-            "Can't bind tuple value (1j,) for parameter 'values': "
+            "Can't bind tuple value (1j,) for parameter {}: "
             + "ValueError: Cannot bind a tuple of complex",
         ),
         (
             ((1, 2, 3),),
-            "Can't bind tuple value ((1, 2, 3),) for parameter 'values': "
+            "Can't bind tuple value ((1, 2, 3),) for parameter {}: "
             + "ValueError: Cannot bind a tuple of tuple",
         ),
     ],
@@ -1031,18 +1038,12 @@ def test_parameter_binding_invalid_arrays(values, exc_msg):
     cursor = conn.cursor()
 
     # WHEN/THEN
-    with pytest.raises(DataError, match=re.escape(exc_msg)):
+    with pytest.raises(DataError, match=re.escape(exc_msg.format("'values'"))):
         cursor.execute("select * from carray(%(values)s)", dict(values=values))
 
-
-def test_parameter_binding_arrays_by_index():
-    # GIVEN
-    conn = connect("mattdb", "dev")
-    cursor = conn.cursor()
-
     # WHEN/THEN
-    with pytest.raises(ValueError) as exc:
-        cursor.execute("select * from carray(?)", [[1, 2, 3]])
+    with pytest.raises(DataError, match=re.escape(exc_msg.format("1"))):
+        cursor.execute("select * from carray(?)", [values])
 
 
 def test_specifying_column_types():