1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
//! Box: spaces //! //! **CRUD operations** in Tarantool are implemented by the box.space submodule. //! It has the data-manipulation functions select, insert, replace, update, upsert, delete, get, put. //! //! See also: //! - [Lua reference: Submodule box.space](https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/) //! - [C API reference: Module box](https://www.tarantool.io/en/doc/latest/dev_guide/reference_capi/box/) use std::os::raw::c_char; use std::ptr::null_mut; use num_traits::ToPrimitive; use crate::error::{Error, TarantoolError}; use crate::index::{Index, IndexIterator, IteratorType}; use crate::tuple::{AsTuple, Tuple}; /// Provides access to system spaces /// /// Example: /// ```rust /// use tarantool_module::space::SystemSpace; /// let schema_space = SystemSpace::Schema.into(); /// ``` #[repr(u32)] #[derive(Debug, Clone, PartialEq, ToPrimitive)] pub enum SystemSpace { /// Space if of _vinyl_deferred_delete. VinylDeferredDelete = 257, /// Space id of _schema. Schema = 272, /// Space id of _collation. Collation = 276, /// Space id of _vcollation. VCollation = 277, /// Space id of _space. Space = 280, /// Space id of _vspace view. VSpace = 281, /// Space id of _sequence. Sequence = 284, /// Space id of _sequence_data. SequenceData = 285, /// Space id of _vsequence view. VSequence = 286, /// Space id of _index. Index = 288, /// Space id of _vindex view. VIndex = 289, /// Space id of _func. Func = 296, /// Space id of _vfunc view. VFunc = 297, /// Space id of _user. User = 304, /// Space id of _vuser view. VUser = 305, /// Space id of _priv. Priv = 312, /// Space id of _vpriv view. VPriv = 313, /// Space id of _cluster. Cluster = 320, /// Space id of _trigger. Trigger = 328, /// Space id of _truncate. Truncate = 330, /// Space id of _space_sequence. SpaceSequence = 340, /// Space id of _fk_constraint. FkConstraint = 356, /// Space id of _ck_contraint. CkConstraint = 364, /// Space id of _func_index. FuncIndex = 372, /// Space id of _session_settings. SessionSettings = 380, } impl Into<Space> for SystemSpace { fn into(self) -> Space { Space { id: self.to_u32().unwrap(), } } } pub struct Space { id: u32, } impl Space { /// Find space by name. /// /// This function performs SELECT request to `_vspace` system space. /// - `name` - space name /// /// Returns: /// - `None` if not found /// - `Some(space)` otherwise pub fn find(name: &str) -> Option<Self> { let id = unsafe { ffi::box_space_id_by_name(name.as_ptr() as *const c_char, name.len() as u32) }; if id == ffi::BOX_ID_NIL { None } else { Some(Self { id }) } } /// Find index by name. /// /// This function performs SELECT request to _vindex system space. /// - `name` - index name /// /// Returns: /// - `None` if not found /// - `Some(index)` otherwise pub fn index(&self, name: &str) -> Option<Index> { let index_id = unsafe { ffi::box_index_id_by_name(self.id, name.as_ptr() as *const c_char, name.len() as u32) }; if index_id == ffi::BOX_ID_NIL { None } else { Some(Index::new(self.id, index_id)) } } /// Returns index with id = 0 #[inline(always)] pub fn primary_key(&self) -> Index { Index::new(self.id, 0) } /// Insert a tuple into a space. /// /// - `value` - tuple value to insert /// /// Returns a new tuple. /// /// See also: `box.space[space_id]:insert(tuple)` pub fn insert<T>(&mut self, value: &T) -> Result<Option<Tuple>, Error> where T: AsTuple, { let buf = value.serialize_as_tuple().unwrap(); let buf_ptr = buf.as_ptr() as *const c_char; let mut result_ptr = null_mut::<ffi::BoxTuple>(); if unsafe { ffi::box_insert( self.id, buf_ptr, buf_ptr.offset(buf.len() as isize), &mut result_ptr, ) } < 0 { return Err(TarantoolError::last().into()); } Ok(if result_ptr.is_null() { None } else { Some(Tuple::from_ptr(result_ptr)) }) } /// Insert a tuple into a space. /// If a tuple with the same primary key already exists, [space.replace()](#method.replace) replaces the existing /// tuple with a new one. The syntax variants [space.replace()](#method.replace) and [space.put()](#method.put) /// have the same effect; /// the latter is sometimes used to show that the effect is the converse of [space.get()](#method.get). /// /// - `value` - tuple value to replace with /// /// Returns a new tuple. pub fn replace<T>(&mut self, value: &T) -> Result<Option<Tuple>, Error> where T: AsTuple, { let buf = value.serialize_as_tuple().unwrap(); let buf_ptr = buf.as_ptr() as *const c_char; let mut result_ptr = null_mut::<ffi::BoxTuple>(); if unsafe { ffi::box_replace( self.id, buf_ptr, buf_ptr.offset(buf.len() as isize), &mut result_ptr, ) } < 0 { return Err(TarantoolError::last().into()); } Ok(if result_ptr.is_null() { None } else { Some(Tuple::from_ptr(result_ptr)) }) } /// Insert a tuple into a space. If a tuple with the same primary key already exists, replaces the existing tuple /// with a new one. Alias for [space.replace()](#method.replace) #[inline(always)] pub fn put<T>(&mut self, value: &T) -> Result<Option<Tuple>, Error> where T: AsTuple, { self.replace(value) } /// Deletes all tuples. The method is performed in background and doesn’t block consequent requests. pub fn truncate(&mut self) -> Result<(), Error> { if unsafe { ffi::box_truncate(self.id) } < 0 { return Err(TarantoolError::last().into()); } Ok(()) } /// Return the number of tuples in the space. /// /// If compared with [space.count()](#method.count), this method works faster because [space.len()](#method.len) /// does not scan the entire space to count the tuples. #[inline(always)] pub fn len(&self) -> Result<usize, Error> { self.primary_key().len() } /// Number of bytes in the space. /// /// This number, which is stored in Tarantool’s internal memory, represents the total number of bytes in all tuples, /// not including index keys. For a measure of index size, see [index.bsize()](../index/struct.Index.html#method.bsize). #[inline(always)] pub fn bsize(&self) -> Result<usize, Error> { self.primary_key().bsize() } /// Search for a tuple in the given space. #[inline(always)] pub fn get<K>(&self, key: &K) -> Result<Option<Tuple>, Error> where K: AsTuple, { self.primary_key().get(key) } /// Search for a tuple or a set of tuples in the given space. This method doesn’t yield /// (for details see [Сooperative multitasking](https://www.tarantool.io/en/doc/latest/book/box/atomic_index/#atomic-cooperative-multitasking)). /// /// - `type` - iterator type /// - `key` - encoded key in MsgPack Array format (`[part1, part2, ...]`). #[inline(always)] pub fn select<K>(&self, iterator_type: IteratorType, key: &K) -> Result<IndexIterator, Error> where K: AsTuple, { self.primary_key().select(iterator_type, key) } /// Return the number of tuples. If compared with [space.len()](#method.len), this method works slower because /// [space.count()](#method.count) scans the entire space to count the tuples. /// /// - `type` - iterator type /// - `key` - encoded key in MsgPack Array format (`[part1, part2, ...]`). pub fn count<K>(&self, iterator_type: IteratorType, key: &K) -> Result<usize, Error> where K: AsTuple, { self.primary_key().count(iterator_type, key) } /// Delete a tuple identified by a primary key. /// /// - `key` - encoded key in MsgPack Array format (`[part1, part2, ...]`). /// /// Returns the deleted tuple #[inline(always)] pub fn delete<K>(&mut self, key: &K) -> Result<Option<Tuple>, Error> where K: AsTuple, { self.primary_key().delete(key) } /// Update a tuple. /// /// The `update` function supports operations on fields — assignment, arithmetic (if the field is numeric), /// cutting and pasting fragments of a field, deleting or inserting a field. Multiple operations can be combined in /// a single update request, and in this case they are performed atomically and sequentially. Each operation /// requires specification of a field number. When multiple operations are present, the field number for each /// operation is assumed to be relative to the most recent state of the tuple, that is, as if all previous /// operations in a multi-operation update have already been applied. /// In other words, it is always safe to merge multiple `update` invocations into a single invocation, with no /// change in semantics. /// /// - `key` - encoded key in MsgPack Array format (`[part1, part2, ...]`). /// - `ops` - encoded operations in MsgPack array format, e.g. `[['=', field_id, value], ['!', 2, 'xxx']]` /// /// Returns a new tuple. /// /// See also: [space.upsert()](#method.upsert) #[inline(always)] pub fn update<K, Op>(&mut self, key: &K, ops: &Vec<Op>) -> Result<Option<Tuple>, Error> where K: AsTuple, Op: AsTuple, { self.primary_key().update(key, ops) } /// Update or insert a tuple. /// /// If there is an existing tuple which matches the key fields of tuple, then the request has the same effect as /// [space.update()](#method.update) and the `{{operator, field_no, value}, ...}` parameter is used. /// If there is no existing tuple which matches the key fields of tuple, then the request has the same effect as /// [space.insert()](#method.insert) and the `{tuple}` parameter is used. /// However, unlike `insert` or `update`, `upsert` will not read a tuple and perform error checks before /// returning – this is a design feature which enhances throughput but requires more caution on the part of the /// user. /// /// - `value` - encoded tuple in MsgPack Array format (`[field1, field2, ...]`) /// - `ops` - encoded operations in MsgPack array format, e.g. `[['=', field_id, value], ['!', 2, 'xxx']]` /// /// Returns a new tuple. /// /// See also: [space.update()](#method.update) #[inline(always)] pub fn upsert<T, Op>(&mut self, value: &T, ops: &Vec<Op>) -> Result<Option<Tuple>, Error> where T: AsTuple, Op: AsTuple, { self.primary_key().upsert(value, ops) } } mod ffi { use std::os::raw::{c_char, c_int}; pub use crate::tuple::ffi::BoxTuple; pub const BOX_ID_NIL: u32 = 2147483647; extern "C" { pub fn box_space_id_by_name(name: *const c_char, len: u32) -> u32; pub fn box_index_id_by_name(space_id: u32, name: *const c_char, len: u32) -> u32; pub fn box_insert( space_id: u32, tuple: *const c_char, tuple_end: *const c_char, result: *mut *mut BoxTuple, ) -> c_int; pub fn box_replace( space_id: u32, tuple: *const c_char, tuple_end: *const c_char, result: *mut *mut BoxTuple, ) -> c_int; pub fn box_truncate(space_id: u32) -> c_int; } }