Skip to main content

rusqlite/
limits.rs

1//! Run-Time Limits
2
3use crate::{Connection, Result, ffi};
4use std::ffi::c_int;
5
6/// Run-Time limit categories, for use with [`Connection::limit`] and
7/// [`Connection::set_limit`].
8///
9/// See the official documentation for more information:
10/// - <https://www.sqlite.org/c3ref/c_limit_attached.html>
11/// - <https://www.sqlite.org/limits.html>
12#[derive(Copy, Clone, Debug)]
13#[repr(i32)]
14#[non_exhaustive]
15#[expect(non_camel_case_types)]
16pub enum Limit {
17    /// The maximum size of any string or BLOB or table row, in bytes.
18    SQLITE_LIMIT_LENGTH = ffi::SQLITE_LIMIT_LENGTH,
19    /// The maximum length of an SQL statement, in bytes.
20    SQLITE_LIMIT_SQL_LENGTH = ffi::SQLITE_LIMIT_SQL_LENGTH,
21    /// The maximum number of columns in a table definition or in the result set
22    /// of a SELECT or the maximum number of columns in an index or in an
23    /// ORDER BY or GROUP BY clause.
24    SQLITE_LIMIT_COLUMN = ffi::SQLITE_LIMIT_COLUMN,
25    /// The maximum depth of the parse tree on any expression.
26    SQLITE_LIMIT_EXPR_DEPTH = ffi::SQLITE_LIMIT_EXPR_DEPTH,
27    /// The maximum number of terms in a compound SELECT statement.
28    SQLITE_LIMIT_COMPOUND_SELECT = ffi::SQLITE_LIMIT_COMPOUND_SELECT,
29    /// The maximum number of instructions in a virtual machine program used to
30    /// implement an SQL statement.
31    SQLITE_LIMIT_VDBE_OP = ffi::SQLITE_LIMIT_VDBE_OP,
32    /// The maximum number of arguments on a function.
33    SQLITE_LIMIT_FUNCTION_ARG = ffi::SQLITE_LIMIT_FUNCTION_ARG,
34    /// The maximum number of attached databases.
35    SQLITE_LIMIT_ATTACHED = ffi::SQLITE_LIMIT_ATTACHED,
36    /// The maximum length of the pattern argument to the LIKE or GLOB
37    /// operators.
38    SQLITE_LIMIT_LIKE_PATTERN_LENGTH = ffi::SQLITE_LIMIT_LIKE_PATTERN_LENGTH,
39    /// The maximum index number of any parameter in an SQL statement.
40    SQLITE_LIMIT_VARIABLE_NUMBER = ffi::SQLITE_LIMIT_VARIABLE_NUMBER,
41    /// The maximum depth of recursion for triggers.
42    SQLITE_LIMIT_TRIGGER_DEPTH = ffi::SQLITE_LIMIT_TRIGGER_DEPTH,
43    /// The maximum number of auxiliary worker threads that a single prepared
44    /// statement may start.
45    SQLITE_LIMIT_WORKER_THREADS = ffi::SQLITE_LIMIT_WORKER_THREADS,
46    /// The maximum depth of the parse tree on any expression.
47    SQLITE_LIMIT_PARSER_DEPTH = 12, // 3.53.0
48    /// The maximum number of objects (tables, indexes, triggers, and views) defined by the database schema.
49    SQLITE_LIMIT_SCHEMA = 13, // 3.54.0
50    ///The maximum number of SQL statements that can be contained within a single trigger.
51    SQLITE_LIMIT_TRIGGER_STEPS = 14, // 3.54.0
52    /// Only used for testing
53    #[cfg(test)]
54    INVALID = -1,
55}
56
57impl Connection {
58    /// Returns the current value of a [`Limit`].
59    #[inline]
60    pub fn limit(&self, limit: Limit) -> Result<i32> {
61        let c = self.db.borrow();
62        let rc = unsafe { ffi::sqlite3_limit(c.db(), limit as c_int, -1) };
63        if rc < 0 {
64            return Err(err!(ffi::SQLITE_RANGE, "{limit:?} is invalid"));
65        }
66        Ok(rc)
67    }
68
69    /// Changes the [`Limit`] to `new_val`, returning the prior
70    /// value of the limit.
71    #[inline]
72    pub fn set_limit(&self, limit: Limit, new_val: i32) -> Result<i32> {
73        if new_val < 0 {
74            return Err(err!(ffi::SQLITE_RANGE, "{new_val} is invalid"));
75        }
76        let c = self.db.borrow_mut();
77        let rc = unsafe { ffi::sqlite3_limit(c.db(), limit as c_int, new_val) };
78        if rc < 0 {
79            return Err(err!(ffi::SQLITE_RANGE, "{limit:?} is invalid"));
80        }
81        Ok(rc)
82    }
83}
84
85#[cfg(test)]
86mod test {
87    #[cfg(all(target_family = "wasm", target_os = "unknown"))]
88    use wasm_bindgen_test::wasm_bindgen_test as test;
89
90    use super::*;
91    use crate::Result;
92
93    #[test]
94    fn test_limit_values() {
95        assert_eq!(Limit::SQLITE_LIMIT_LENGTH as i32, ffi::SQLITE_LIMIT_LENGTH,);
96        assert_eq!(
97            Limit::SQLITE_LIMIT_SQL_LENGTH as i32,
98            ffi::SQLITE_LIMIT_SQL_LENGTH,
99        );
100        assert_eq!(Limit::SQLITE_LIMIT_COLUMN as i32, ffi::SQLITE_LIMIT_COLUMN,);
101        assert_eq!(
102            Limit::SQLITE_LIMIT_EXPR_DEPTH as i32,
103            ffi::SQLITE_LIMIT_EXPR_DEPTH,
104        );
105        assert_eq!(
106            Limit::SQLITE_LIMIT_COMPOUND_SELECT as i32,
107            ffi::SQLITE_LIMIT_COMPOUND_SELECT,
108        );
109        assert_eq!(
110            Limit::SQLITE_LIMIT_VDBE_OP as i32,
111            ffi::SQLITE_LIMIT_VDBE_OP,
112        );
113        assert_eq!(
114            Limit::SQLITE_LIMIT_FUNCTION_ARG as i32,
115            ffi::SQLITE_LIMIT_FUNCTION_ARG,
116        );
117        assert_eq!(
118            Limit::SQLITE_LIMIT_ATTACHED as i32,
119            ffi::SQLITE_LIMIT_ATTACHED,
120        );
121        assert_eq!(
122            Limit::SQLITE_LIMIT_LIKE_PATTERN_LENGTH as i32,
123            ffi::SQLITE_LIMIT_LIKE_PATTERN_LENGTH,
124        );
125        assert_eq!(
126            Limit::SQLITE_LIMIT_VARIABLE_NUMBER as i32,
127            ffi::SQLITE_LIMIT_VARIABLE_NUMBER,
128        );
129        assert_eq!(
130            Limit::SQLITE_LIMIT_TRIGGER_DEPTH as i32,
131            ffi::SQLITE_LIMIT_TRIGGER_DEPTH,
132        );
133        assert_eq!(
134            Limit::SQLITE_LIMIT_WORKER_THREADS as i32,
135            ffi::SQLITE_LIMIT_WORKER_THREADS,
136        );
137    }
138
139    #[test]
140    #[cfg_attr(miri, ignore)]
141    fn test_limit() -> Result<()> {
142        let db = Connection::open_in_memory()?;
143        db.set_limit(Limit::SQLITE_LIMIT_LENGTH, 1024)?;
144        assert_eq!(1024, db.limit(Limit::SQLITE_LIMIT_LENGTH)?);
145
146        db.set_limit(Limit::SQLITE_LIMIT_SQL_LENGTH, 1024)?;
147        assert_eq!(1024, db.limit(Limit::SQLITE_LIMIT_SQL_LENGTH)?);
148
149        db.set_limit(Limit::SQLITE_LIMIT_COLUMN, 64)?;
150        assert_eq!(64, db.limit(Limit::SQLITE_LIMIT_COLUMN)?);
151
152        db.set_limit(Limit::SQLITE_LIMIT_EXPR_DEPTH, 256)?;
153        assert_eq!(256, db.limit(Limit::SQLITE_LIMIT_EXPR_DEPTH)?);
154
155        db.set_limit(Limit::SQLITE_LIMIT_COMPOUND_SELECT, 32)?;
156        assert_eq!(32, db.limit(Limit::SQLITE_LIMIT_COMPOUND_SELECT)?);
157
158        db.set_limit(Limit::SQLITE_LIMIT_FUNCTION_ARG, 32)?;
159        assert_eq!(32, db.limit(Limit::SQLITE_LIMIT_FUNCTION_ARG)?);
160
161        db.set_limit(Limit::SQLITE_LIMIT_ATTACHED, 2)?;
162        assert_eq!(2, db.limit(Limit::SQLITE_LIMIT_ATTACHED)?);
163
164        db.set_limit(Limit::SQLITE_LIMIT_LIKE_PATTERN_LENGTH, 128)?;
165        assert_eq!(128, db.limit(Limit::SQLITE_LIMIT_LIKE_PATTERN_LENGTH)?);
166
167        db.set_limit(Limit::SQLITE_LIMIT_VARIABLE_NUMBER, 99)?;
168        assert_eq!(99, db.limit(Limit::SQLITE_LIMIT_VARIABLE_NUMBER)?);
169
170        db.set_limit(Limit::SQLITE_LIMIT_TRIGGER_DEPTH, 32)?;
171        assert_eq!(32, db.limit(Limit::SQLITE_LIMIT_TRIGGER_DEPTH)?);
172
173        db.set_limit(Limit::SQLITE_LIMIT_WORKER_THREADS, 2)?;
174        #[cfg(not(all(target_family = "wasm", target_os = "unknown")))]
175        assert_eq!(2, db.limit(Limit::SQLITE_LIMIT_WORKER_THREADS)?);
176
177        // wasm build with DSQLITE_THREADSAFE=0, so limit not working
178        // see <https://sqlite.org/threadsafe.html>
179        #[cfg(all(target_family = "wasm", target_os = "unknown"))]
180        assert_eq!(0, db.limit(Limit::SQLITE_LIMIT_WORKER_THREADS)?);
181
182        assert!(
183            db.set_limit(Limit::SQLITE_LIMIT_WORKER_THREADS, -1)
184                .is_err()
185        );
186        assert!(db.set_limit(Limit::INVALID, 0).is_err());
187        assert!(db.limit(Limit::INVALID).is_err());
188        Ok(())
189    }
190}