bpo-45243: Add support for setting/getting sqlite3 connection limits

python · erlend-aasland · Oct 7, 2021 · Oct 7, 2021 · Oct 7, 2021 · Oct 7, 2021
commit f4b9fcdc3a3f8434ee3df28e9b09f8531239f5d4
@@ -624,6 +624,78 @@ Connection Objects
       .. versionadded:: 3.7
 
 
+   .. attribute:: SQLITE_LIMIT_SQL_LENGTH
+
+      The maximum length of an SQL statement, in bytes.
+
+      .. versionadded:: 3.11
+
+   .. attribute:: SQLITE_LIMIT_COLUMN
+
+      The maximum number of columns in a table definition or in the result set
+      of a SELECT or the maximum number of columns in an index or in an ORDER
+      BY or GROUP BY clause.
+
+      .. versionadded:: 3.11
+
+   .. attribute:: SQLITE_LIMIT_EXPR_DEPTH
+
+      The maximum depth of the parse tree on any expression.
+
+      .. versionadded:: 3.11
+
+   .. attribute:: SQLITE_LIMIT_COMPOUND_SELECT
+
+      The maximum number of terms in a compound SELECT statement.
+
+      .. versionadded:: 3.11
+
+   .. attribute:: SQLITE_LIMIT_VDBE_OP
+
+      The maximum number of instructions in a virtual machine program used to
+      implement an SQL statement.
+
+      .. versionadded:: 3.11
+
+   .. attribute:: SQLITE_LIMIT_FUNCTION_ARG
+
+      The maximum number of arguments on a function.
+
+      .. versionadded:: 3.11
+
+   .. attribute:: SQLITE_LIMIT_ATTACHED
+
+      The maximum number of attached databases.
+
+      .. versionadded:: 3.11
+
+   .. attribute:: SQLITE_LIMIT_LIKE_PATTERN_LENGTH
+
+      The maximum length of the pattern argument to the LIKE or GLOB operators.
+
+      .. versionadded:: 3.11
+
+    )
+   .. attribute:: SQLITE_LIMIT_VARIABLE_NUMBER
+
+      The maximum index number of any parameter in an SQL statement.
+
+      .. versionadded:: 3.11
+
+   .. attribute:: SQLITE_LIMIT_TRIGGER_DEPTH
+
+      The maximum depth of recursion for triggers.
+
+      .. versionadded:: 3.11
+
+   .. attribute:: SQLITE_LIMIT_WORKER_THREADS
+
+      The maximum number of auxiliary worker threads that a single prepared
+      statement may start. Only available for SQLite 3.8.3 or newer.
+
+      .. versionadded:: 3.11
+
+
 .. _sqlite3-cursor-objects:
 
 Cursor Objects

diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
@@ -239,6 +239,11 @@ sqlite3
   (Contributed by Aviv Palivoda, Daniel Shahaf, and Erlend E. Aasland in
   :issue:`16379`.)
 
+* Connection limits are now exposed as :class:`sqlite3.Connection`
+  attributes.
+  (Contributed by Erlend E. Aasland in :issue:`45243`.)
+
+
 threading
 ---------
 

@@ -332,6 +332,18 @@ def test_drop_unused_refs(self):
             cu = self.cx.execute(f"select {n}")
             self.assertEqual(cu.fetchone()[0], n)
 
+    def test_connection_limits(self):
+        setval = 10
+        limit = self.cx.SQLITE_LIMIT_SQL_LENGTH
+        try:
+            self.cx.SQLITE_LIMIT_SQL_LENGTH = setval
+            self.assertEqual(self.cx.SQLITE_LIMIT_SQL_LENGTH, setval)
+            msg = "string or blob too big"
+            self.assertRaisesRegex(sqlite.DataError, msg,
+                                   self.cx.execute, "select 1 as '16'")
+        finally:  # restore old limit
+            self.cx.SQLITE_LIMIT_SQL_LENGTH = limit
+
 
 class UninitialisedConnectionTests(unittest.TestCase):
     def setUp(self):

diff --git a/Misc/NEWS.d/next/Library/2021-09-20-01-25-09.bpo-45243.0pJf0U.rst b/Misc/NEWS.d/next/Library/2021-09-20-01-25-09.bpo-45243.0pJf0U.rst
@@ -0,0 +1,2 @@
+SQLite connection limits are now exposed as :class:`sqlite3.Connection`
+attributes. Patch by Erlend E. Aasland.
@@ -1866,13 +1866,101 @@ pysqlite_connection_exit_impl(pysqlite_Connection *self, PyObject *exc_type,
     Py_RETURN_FALSE;
 }
 
+static
+PyObject *get_limit(pysqlite_Connection *self, void *limit)
+{
+    if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
+        return NULL;
+    }
+
+    int value = sqlite3_limit(self->db, (int)limit, -1);
+    return PyLong_FromLong(value);
+}
+
+static int
+set_limit(pysqlite_Connection *self, PyObject *value, void *limit)
+{
+    if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
+        return -1;
+    }
+    if (value == NULL) {
+        PyErr_SetString(self->ProgrammingError,
+                        "Cannot delete limit attributes");
+        return -1;
+    }
+    int setval = _PyLong_AsInt(value);
+    if (setval == -1 && PyErr_Occurred()) {
+        return -1;
+    }
+    (void)sqlite3_limit(self->db, (int)limit, setval);
+    return 0;
+}
+
 static const char connection_doc[] =
 PyDoc_STR("SQLite database connection object.");
 
+#define DEF_LIMIT_GETSET(limit, doc) \
+    {#limit, (getter)get_limit, (setter)set_limit, doc, (void *)limit},
+
 static PyGetSetDef connection_getset[] = {
     {"isolation_level",  (getter)pysqlite_connection_get_isolation_level, (setter)pysqlite_connection_set_isolation_level},
     {"total_changes",  (getter)pysqlite_connection_get_total_changes, (setter)0},
     {"in_transaction",  (getter)pysqlite_connection_get_in_transaction, (setter)0},
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_LENGTH,
+        "The maximum size of any string or BLOB or table row, in bytes."
+    )
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_SQL_LENGTH,
+        "The maximum length of an SQL statement, in bytes."
+    )
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_COLUMN,
+        "The maximum number of columns in a table definition or in the result "
+        "set of a SELECT or the maximum number of columns in an index or in an "
+        "ORDER BY or GROUP BY clause."
+    )
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_EXPR_DEPTH,
+        "The maximum depth of the parse tree on any expression."
+    )
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_COMPOUND_SELECT,
+        "The maximum number of terms in a compound SELECT statement."
+    )
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_VDBE_OP,
+        "The maximum number of instructions in a virtual machine program used "
+        "to implement an SQL statement."
    )
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_FUNCTION_ARG,
+        "The maximum number of arguments on a function."
+    )
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_ATTACHED,
+        "The maximum number of attached databases."
+    )
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_LIKE_PATTERN_LENGTH,
+        "The maximum length of the pattern argument to the LIKE or GLOB "
+        "operators."
+    )
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_VARIABLE_NUMBER,
+        "The maximum index number of any parameter in an SQL statement."
+    )
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_TRIGGER_DEPTH,
+        "The maximum depth of recursion for triggers."
+    )
+#if SQLITE_VERSION_NUMBER >= 3008003
+    DEF_LIMIT_GETSET(
+        SQLITE_LIMIT_WORKER_THREADS,
+        "The maximum number of auxiliary worker threads that a single "
+        "prepared statement may start."
+    )
+#endif
     {NULL}
 };
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		SQLite connection limits are now exposed as :class:`sqlite3.Connection`
		attributes. Patch by Erlend E. Aasland.