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 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
//! 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::cell::RefCell;
use std::collections::HashMap;
use std::os::raw::c_char;
use num_derive::ToPrimitive;
use num_traits::ToPrimitive;
use serde::Serialize;
use serde_json::{Map, Value};
use crate::error::{Error, TarantoolError};
use crate::ffi::tarantool as ffi;
use crate::index::{Index, IndexIterator, IteratorType};
#[cfg(feature = "schema")]
use crate::schema::space::SpaceMetadata;
use crate::tuple::{Encode, ToTupleBuffer, Tuple, TupleBuffer};
use crate::tuple_from_box_api;
/// End of the reserved range of system spaces.
pub const SYSTEM_ID_MAX: u32 = 511;
/// Provides access to system spaces
///
/// Example:
/// ```rust
/// use tarantool::space::SystemSpace;
/// use num_traits::ToPrimitive;
/// assert_eq!(SystemSpace::Schema.to_u32(), Some(272))
/// ```
#[repr(u32)]
#[derive(Copy, Clone, Debug, PartialEq, Eq, 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 From<SystemSpace> for Space {
fn from(ss: SystemSpace) -> Self {
Space {
id: ss.to_u32().unwrap(),
}
}
}
crate::define_str_enum! {
#![coerce_from_str]
/// Type of engine, used by space.
pub enum SpaceEngineType {
Memtx = "memtx",
Vinyl = "vinyl",
}
}
/// Options for new space, used by Space::create.
/// (for details see [Options for box.schema.space.create](https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_schema/space_create/)).
///
/// `format` option is not supported at this moment.
#[derive(Clone, Debug, Serialize)]
pub struct SpaceCreateOptions {
pub if_not_exists: bool,
pub engine: SpaceEngineType,
pub id: Option<u32>,
pub field_count: u32,
pub user: Option<String>,
pub is_local: bool,
pub is_temporary: bool,
pub is_sync: bool,
pub format: Option<Vec<Field>>,
}
impl Default for SpaceCreateOptions {
fn default() -> Self {
SpaceCreateOptions {
if_not_exists: false,
engine: SpaceEngineType::Memtx,
id: None,
field_count: 0,
user: None,
is_local: false,
is_temporary: false,
is_sync: false,
format: None,
}
}
}
////////////////////////////////////////////////////////////////////////////////
// Field
////////////////////////////////////////////////////////////////////////////////
#[deprecated = "Use `space::Field` instead"]
pub type SpaceFieldFormat = Field;
#[derive(Clone, Debug, Serialize)]
pub struct Field {
pub name: String, // TODO(gmoshkin): &str
#[serde(alias = "type")]
pub field_type: FieldType,
pub is_nullable: bool,
}
impl<S> From<(S, FieldType, IsNullable)> for Field
where
String: From<S>,
{
fn from(args: (S, FieldType, IsNullable)) -> Self {
let (name, field_type, is_nullable) = args;
let name = name.into();
let is_nullable = is_nullable.is_nullable();
Self {
name,
field_type,
is_nullable,
}
}
}
impl<S> From<(S, FieldType)> for Field
where
String: From<S>,
{
fn from(args: (S, FieldType)) -> Self {
let (name, field_type) = args;
let name = name.into();
let is_nullable = false;
Self {
name,
field_type,
is_nullable,
}
}
}
macro_rules! define_constructors {
($($constructor:ident ($type:path))+) => {
$(
#[doc = ::std::concat!(
"Create a new field format specifier with the given `name` and ",
"type \"", ::std::stringify!($constructor), "\""
)]
pub fn $constructor(name: impl Into<String>) -> Self {
Self {
name: name.into(),
field_type: $type,
is_nullable: false,
}
}
)+
}
}
impl Field {
#[deprecated = "Use one of `Field::any`, `Field::unsigned`, `Field::string`, etc. instead"]
/// Create a new field format specifier.
///
/// You should use one of the other constructors instead
pub fn new(name: &str, ft: FieldType) -> Self {
Self {
name: name.to_string(),
field_type: ft,
is_nullable: false,
}
}
/// Specify if the current field can be nullable or not. This method
/// captures `self` by value and returns it, so it should be used in a
/// builder fashion.
/// ```rust
/// use tarantool::space::Field;
/// let f = Field::string("middle name").is_nullable(true);
/// ```
pub fn is_nullable(mut self, is_nullable: bool) -> Self {
self.is_nullable = is_nullable;
self
}
define_constructors! {
any(FieldType::Any)
unsigned(FieldType::Unsigned)
string(FieldType::String)
number(FieldType::Number)
double(FieldType::Double)
integer(FieldType::Integer)
boolean(FieldType::Boolean)
varbinary(FieldType::Varbinary)
scalar(FieldType::Scalar)
decimal(FieldType::Decimal)
uuid(FieldType::Uuid)
datetime(FieldType::Datetime)
interval(FieldType::Interval)
array(FieldType::Array)
map(FieldType::Map)
}
}
////////////////////////////////////////////////////////////////////////////////
// FieldType
////////////////////////////////////////////////////////////////////////////////
#[deprecated = "use space::FieldType instead"]
pub type SpaceFieldType = FieldType;
crate::define_str_enum! {
#![coerce_from_str]
/// Type of a field in the space format definition.
pub enum FieldType {
Any = "any",
Unsigned = "unsigned",
String = "string",
Number = "number",
Double = "double",
Integer = "integer",
Boolean = "boolean",
Varbinary = "varbinary",
Scalar = "scalar",
Decimal = "decimal",
Uuid = "uuid",
Datetime = "datetime",
Interval = "interval",
Array = "array",
Map = "map",
}
}
////////////////////////////////////////////////////////////////////////////////
// IsNullable
////////////////////////////////////////////////////////////////////////////////
/// An enum specifying whether or not the given space field can be null.
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum IsNullable {
NonNullalbe,
Nullable,
}
impl IsNullable {
const fn is_nullable(&self) -> bool {
matches!(self, Self::Nullable)
}
}
////////////////////////////////////////////////////////////////////////////////
// ...
////////////////////////////////////////////////////////////////////////////////
#[derive(Clone, Debug, Serialize)]
pub struct FuncMetadata {
pub id: u32,
pub owner: u32,
pub name: String,
pub setuid: u32,
pub language: String,
pub body: String,
pub routine_type: String,
pub param_list: Vec<Value>,
pub returns: String,
pub aggregate: String,
pub sql_data_access: String,
pub is_deterministic: bool,
pub is_sandboxed: bool,
pub is_null_call: bool,
pub exports: Vec<String>,
pub opts: Map<String, Value>,
pub comment: String,
pub created: String,
pub last_altered: String,
}
impl Encode for FuncMetadata {}
#[derive(Clone, Debug, Serialize)]
pub struct Privilege {
pub grantor: u32,
pub grantee: u32,
pub object_type: String,
pub object_id: u32,
pub privilege: u32,
}
impl Encode for Privilege {}
struct SpaceCache {
spaces: RefCell<HashMap<String, Space>>,
indexes: RefCell<HashMap<(u32, String), Index>>,
}
impl SpaceCache {
fn new() -> Self {
Self {
spaces: RefCell::new(HashMap::new()),
indexes: RefCell::new(HashMap::new()),
}
}
fn clear(&self) {
self.spaces.borrow_mut().clear();
self.indexes.borrow_mut().clear();
}
fn space(&self, name: &str) -> Option<Space> {
let mut cache = self.spaces.borrow_mut();
cache.get(name).cloned().or_else(|| {
Space::find(name).map(|space| {
cache.insert(name.to_string(), space.clone());
space
})
})
}
fn index(&self, space: &Space, name: &str) -> Option<Index> {
let mut cache = self.indexes.borrow_mut();
cache
.get(&(space.id, name.to_string()))
.cloned()
.or_else(|| {
space.index(name).map(|index| {
cache.insert((space.id, name.to_string()), index.clone());
index
})
})
}
}
thread_local! {
static SPACE_CACHE: SpaceCache = SpaceCache::new();
}
/// Clear the space and index cache so that the next call to
/// [`Space::find_cached`] & [`Space::index_cached`] will have to update the
/// cache.
pub fn clear_cache() {
SPACE_CACHE.with(SpaceCache::clear)
}
#[derive(Clone, Debug)]
pub struct Space {
id: u32,
}
impl Space {
/// Return a space builder.
///
/// - `name` - name of space to be created
pub fn builder(name: &str) -> Builder {
Builder::new(name)
}
/// Create a space.
/// (for details see [box.schema.space.create()](https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_schema/space_create/)).
///
/// - `name` - name of space, which should conform to the rules for object names.
/// - `opts` - see SpaceCreateOptions struct.
///
/// Returns a new space.
#[cfg(feature = "schema")]
pub fn create(name: &str, opts: &SpaceCreateOptions) -> Result<Space, Error> {
crate::schema::space::create_space(name, opts)
}
/// Drop a space.
#[cfg(feature = "schema")]
pub fn drop(&self) -> Result<(), Error> {
crate::schema::space::drop_space(self.id)
}
/// 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 })
}
}
/// Memorized version of [`Space::find`] function.
///
/// The function performs SELECT request to `_vspace` system space only if
/// it was never called for target space.
/// - `name` - space name
///
/// **NOTE** the cache can become invalid for a number of reasons. If an
/// operation with a space returned from this function results in a
/// [`TarantoolError`] with code [`NoSuchSpace`], try calling [`clear_cache`]
/// before trying to find the space again.
///
/// Returns:
/// - `None` if not found
/// - `Some(space)` otherwise
///
/// [`NoSuchSpace`]: crate::error::TarantoolErrorCode::NoSuchSpace
pub fn find_cached(name: &str) -> Option<Self> {
SPACE_CACHE.with(|cache| cache.space(name))
}
/// Get space ID.
pub const fn id(&self) -> u32 {
self.id
}
/// Create new index.
///
/// - `name` - name of index to create, which should conform to the rules for object names.
/// - `opts` - see schema::IndexOptions struct.
#[cfg(feature = "schema")]
pub fn create_index(
&self,
name: &str,
opts: &crate::index::IndexOptions,
) -> Result<Index, Error> {
crate::schema::index::create_index(self.id, name, opts)
}
/// Return an index builder.
///
/// - `name` - name of index to create, which should conform to the rules for object names.
#[cfg(feature = "schema")]
pub fn index_builder<'a>(&self, name: &'a str) -> crate::index::Builder<'a> {
crate::index::Builder::new(self.id, name)
}
/// 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))
}
}
/// Memorized version of [`Space::index`] function.
///
/// This function performs SELECT request to `_vindex` system space.
/// - `name` - index name
///
/// **NOTE** the cache can become invalid for a number of reasons. If an
/// operation with an index returned from this function results in a
/// [`TarantoolError`] with code [`NoSuchSpace`] or [`NoSuchIndexID`], try
/// calling [`clear_cache`] before trying to get the index again.
///
/// Returns:
/// - `None` if not found
/// - `Some(index)` otherwise
///
/// [`NoSuchSpace`]: crate::error::TarantoolErrorCode::NoSuchSpace
/// [`NoSuchIndexID`]: crate::error::TarantoolErrorCode::NoSuchIndexID
pub fn index_cached(&self, name: &str) -> Option<Index> {
SPACE_CACHE.with(|cache| cache.index(self, name))
}
/// 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>(&self, value: &T) -> Result<Tuple, Error>
where
T: ToTupleBuffer,
{
let buf = value.to_tuple_buffer().unwrap();
let buf_ptr = buf.as_ptr() as *const c_char;
tuple_from_box_api!(
ffi::box_insert[
self.id,
buf_ptr,
buf_ptr.add(buf.len()),
@out
]
)
.map(|t| t.expect("Returned tuple cannot be null"))
}
/// 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>(&self, value: &T) -> Result<Tuple, Error>
where
T: ToTupleBuffer,
{
let buf = value.to_tuple_buffer().unwrap();
let buf_ptr = buf.as_ptr() as *const c_char;
tuple_from_box_api!(
ffi::box_replace[
self.id,
buf_ptr,
buf_ptr.add(buf.len()),
@out
]
)
.map(|t| t.expect("Returned tuple cannot be null"))
}
/// Insert a tuple into a space. If a tuple with the same primary key already exists, it replaces the existing tuple
/// with a new one. Alias for [space.replace()](#method.replace)
#[inline(always)]
pub fn put<T>(&self, value: &T) -> Result<Tuple, Error>
where
T: ToTupleBuffer,
{
self.replace(value)
}
/// Deletes all tuples. The method is performed in background and doesn’t block consequent requests.
pub fn truncate(&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.
///
/// 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()
}
#[inline(always)]
pub fn is_empty(&self) -> Result<bool, Error> {
self.len().map(|l| l == 0)
}
/// 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,
/// excluding 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: ToTupleBuffer,
{
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 the MsgPack Array format (`[part1, part2, ...]`).
#[inline(always)]
pub fn select<K>(&self, iterator_type: IteratorType, key: &K) -> Result<IndexIterator, Error>
where
K: ToTupleBuffer,
{
self.primary_key().select(iterator_type, key)
}
/// Return the number of tuples. 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 the MsgPack Array format (`[part1, part2, ...]`).
pub fn count<K>(&self, iterator_type: IteratorType, key: &K) -> Result<usize, Error>
where
K: ToTupleBuffer,
{
self.primary_key().count(iterator_type, key)
}
/// Delete a tuple identified by a primary key.
///
/// - `key` - encoded key in the MsgPack Array format (`[part1, part2, ...]`).
///
/// Returns the deleted tuple
#[inline(always)]
pub fn delete<K>(&self, key: &K) -> Result<Option<Tuple>, Error>
where
K: ToTupleBuffer,
{
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 the MsgPack Array format (`[part1, part2, ...]`).
/// - `ops` - encoded operations in the 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>(&self, key: &K, ops: impl AsRef<[Op]>) -> Result<Option<Tuple>, Error>
where
K: ToTupleBuffer,
Op: ToTupleBuffer,
{
self.primary_key().update(key, ops)
}
/// Update a tuple using `ops` already encoded in the message pack format.
///
/// This function is similar to [`update`](#method.update) but instead
/// of a generic type parameter `Op` it accepts preencoded message pack
/// values. This is usefull when the operations have values of different
/// types.
///
/// Returns a new tuple.
///
/// # Safety
/// `ops` must be a slice of valid msgpack arrays.
#[inline(always)]
#[deprecated = "use update_raw instead"]
pub unsafe fn update_mp<K>(&self, key: &K, ops: &[Vec<u8>]) -> Result<Option<Tuple>, Error>
where
K: ToTupleBuffer,
{
#[allow(deprecated)]
self.primary_key().update_mp(key, ops)
}
/// Update a tuple using already encoded arguments.
///
/// This function is similar to [`update`](#method.update) but instead
/// of generic type parameters `T` & `Op` it accepts preencoded message
/// pack arrays. This is usefull when the operations have values of
/// different types.
///
/// # Safety
/// `key` must be a valid msgpack array.
/// `ops` must be a valid msgpack array of msgpack arrays.
#[inline(always)]
pub unsafe fn update_raw(&self, key: &[u8], ops: &[u8]) -> Result<Option<Tuple>, Error> {
self.primary_key().update_raw(key, ops)
}
/// Update or insert a tuple.
///
/// If there is an existing tuple which matches the tuple key fields, 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 tuple key fields, 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 cautious use.
///
/// - `value` - encoded tuple in the MsgPack Array format (`[field1, field2, ...]`)
/// - `ops` - encoded operations in the MsgPack array format, e.g. `[['=', field_id, value], ['!', 2, 'xxx']]`
///
/// See also: [space.update()](#method.update)
#[inline(always)]
pub fn upsert<T, Op>(&self, value: &T, ops: impl AsRef<[Op]>) -> Result<(), Error>
where
T: ToTupleBuffer,
Op: ToTupleBuffer,
{
self.primary_key().upsert(value, ops)
}
/// Upsert a tuple using `ops` already encoded in the message pack format.
///
/// This function is similar to [`upsert`](#method.upsert) but instead
/// of a generic type parameter `Op` it accepts preencoded message pack
/// values. This is usefull when the operations have values of different
/// types.
///
/// # Safety
/// `ops` must be a slice of valid msgpack arrays.
#[inline(always)]
#[deprecated = "use upsert_raw instead"]
pub unsafe fn upsert_mp<K>(&self, key: &K, ops: &[Vec<u8>]) -> Result<(), Error>
where
K: ToTupleBuffer,
{
#[allow(deprecated)]
self.primary_key().upsert_mp(key, ops)
}
/// Upsert a tuple using already encoded arguments.
///
/// This function is similar to [`upsert`](#method.upsert) but instead
/// of generic type parameters `T` & `Op` it accepts preencoded message
/// pack arrays. This is usefull when the operations have values of
/// different types.
///
/// # Safety
/// `value` must be a valid msgpack array.
/// `ops` must be a valid msgpack array of msgpack arrays.
#[inline(always)]
pub unsafe fn upsert_raw(&self, value: &[u8], ops: &[u8]) -> Result<(), Error> {
self.primary_key().upsert_raw(value, ops)
}
// Return space metadata from system `_space` space.
#[cfg(feature = "schema")]
pub fn meta(&self) -> Result<SpaceMetadata, Error> {
let sys_space: Space = SystemSpace::Space.into();
let tuple = sys_space.get(&(self.id,))?.ok_or(Error::MetaNotFound)?;
tuple.decode::<SpaceMetadata>()
}
}
////////////////////////////////////////////////////////////////////////////////
// Builder
////////////////////////////////////////////////////////////////////////////////
#[allow(dead_code)]
pub struct Builder<'a> {
name: &'a str,
opts: SpaceCreateOptions,
}
macro_rules! define_setters {
($( $setter:ident ( $field:ident : $ty:ty ) )+) => {
$(
#[inline(always)]
pub fn $setter(mut self, $field: $ty) -> Self {
self.opts.$field = $field.into();
self
}
)+
}
}
impl<'a> Builder<'a> {
pub fn new(name: &'a str) -> Self {
Self {
name,
opts: Default::default(),
}
}
define_setters! {
if_not_exists(if_not_exists: bool)
engine(engine: SpaceEngineType)
id(id: u32)
field_count(field_count: u32)
user(user: String)
is_local(is_local: bool)
is_temporary(is_temporary: bool)
is_sync(is_sync: bool)
}
/// Add a field to the space's format.
///
/// Use this method to set each field individually or use [`format`] to set
/// fields in bulk. The difference is purely syntactical.
///
/// [`format`]: Self::format
#[inline]
pub fn field(mut self, field: impl Into<Field>) -> Self {
self.opts
.format
.get_or_insert_with(|| Vec::with_capacity(16))
.push(field.into());
self
}
/// Add fields to the space's format.
///
/// Use this method to set fields in bulk or use [`field`] to set
/// each field individually. The difference is purely syntactical.
///
/// ```no_run
/// use tarantool::space::{Space, FieldType as FT, IsNullable};
///
/// let space = Space::builder("user_names")
/// .format([
/// ("id", FT::Unsigned),
/// ("name", FT::String),
/// ])
/// .field(("nickname", FT::String, IsNullable::Nullable))
/// .create();
/// ```
///
/// [`field`]: Self::field
#[inline]
pub fn format(mut self, format: impl IntoIterator<Item = impl Into<Field>>) -> Self {
let iter = format.into_iter();
let (size, _) = iter.size_hint();
self.opts
.format
.get_or_insert_with(|| Vec::with_capacity(size))
.extend(iter.map(Into::into));
self
}
#[cfg(feature = "schema")]
pub fn create(self) -> crate::Result<Space> {
crate::schema::space::create_space(self.name, &self.opts)
}
/// Destructure the builder struct into a tuple of name and space options.
#[inline(always)]
pub fn into_parts(self) -> (&'a str, SpaceCreateOptions) {
(self.name, self.opts)
}
}
////////////////////////////////////////////////////////////////////////////////
// UpdateOps
////////////////////////////////////////////////////////////////////////////////
/// A builder-style helper struct for [`Space::update`], [`Space::upsert`],
/// [`Index::update`], [`Index::upsert`] methods.
///
/// Start by calling the [`new`] function, then chain as many operations as
/// needed ([`add`], [`assign`], [`insert`], etc.) after that you can either
/// pass the resulting expression directly into one of the supported methods,
/// or use the data directly after calling [`encode`] or [`into_inner`].
///
/// # Examples
/// ```no_run
/// use tarantool::space::{Space, UpdateOps};
/// let mut space = Space::find("employee").unwrap();
/// space.update(
/// &[1337],
/// UpdateOps::new()
/// .add("strikes", 1).unwrap()
/// .assign("days-since-last-mistake", 0).unwrap(),
/// )
/// .unwrap();
/// ```
///
/// [`new`]: UpdateOps::new
/// [`add`]: UpdateOps::add
/// [`assign`]: UpdateOps::assign
/// [`insert`]: UpdateOps::insert
/// [`encode`]: UpdateOps::encode
/// [`into_inner`]: UpdateOps::into_inner
pub struct UpdateOps {
ops: Vec<TupleBuffer>,
}
macro_rules! define_bin_ops {
($( $(#[$meta:meta])* $op_name:ident, $op_code:literal; )+) => {
$(
$(#[$meta])*
#[inline]
pub fn $op_name<K, V>(&mut self, field: K, value: V) -> crate::Result<&mut Self>
where
K: Serialize,
V: Serialize,
{
self.ops.push(($op_code, field, value).to_tuple_buffer()?);
Ok(self)
}
)+
}
}
impl UpdateOps {
#[inline]
pub fn new() -> Self {
Self { ops: Vec::new() }
}
#[inline]
pub fn with_capacity(capacity: usize) -> Self {
Self {
ops: Vec::with_capacity(capacity),
}
}
define_bin_ops! {
/// Assignment operation.
/// Corresponds to tarantool's `{'=', field, value}`.
///
/// Field indexing is zero based (first field has index 0).
/// Negative indexes are offset from array's end (last field has index -1).
assign, '=';
/// Insertion operation.
/// Corresponds to tarantool's `{'!', field, value}`.
///
/// Field indexing is zero based (first field has index 0).
/// Negative indexes are offset from array's end (last field has index -1).
insert, '!';
/// Numeric addition operation.
/// Corresponds to tarantool's `{'+', field, value}`.
///
/// Field indexing is zero based (first field has index 0).
/// Negative indexes are offset from array's end (last field has index -1).
add, '+';
/// Numeric subtraction operation.
/// Corresponds to tarantool's `{'-', field, value}`.
///
/// Field indexing is zero based (first field has index 0).
/// Negative indexes are offset from array's end (last field has index -1).
sub, '-';
/// Bitwise AND operation.
/// Corresponds to tarantool's `{'&', field, value}`.
///
/// Field indexing is zero based (first field has index 0).
/// Negative indexes are offset from array's end (last field has index -1).
and, '&';
/// Bitwise OR operation.
/// Corresponds to tarantool's `{'|', field, value}`.
///
/// Field indexing is zero based (first field has index 0).
/// Negative indexes are offset from array's end (last field has index -1).
or, '|';
/// Bitwise XOR operation.
/// Corresponds to tarantool's `{'^', field, value}`.
///
/// Field indexing is zero based (first field has index 0).
/// Negative indexes are offset from array's end (last field has index -1).
xor, '^';
}
/// Deletion operation.
/// Corresponds to tarantool's `{'#', field, count}`.
///
/// Field indexing is zero based (first field has index 0).
/// Negative indexes are offset from array's end (last field has index -1).
#[inline]
pub fn delete<K>(&mut self, field: K, count: usize) -> crate::Result<&mut Self>
where
K: Serialize,
{
self.ops.push(('#', field, count).to_tuple_buffer()?);
Ok(self)
}
/// String splicing operation.
/// Corresponds to tarantool's `{':', field, start, count, value}`.
///
/// Field indexing is zero based (first field has index 0).
/// Negative indexes are offset from array's end (last field has index -1).
#[inline]
pub fn splice<K>(
&mut self,
field: K,
start: isize,
count: usize,
value: &str,
) -> crate::Result<&mut Self>
where
K: Serialize,
{
self.ops
.push((':', field, start, count, value).to_tuple_buffer()?);
Ok(self)
}
#[inline]
pub fn as_slice(&self) -> &[TupleBuffer] {
&self.ops
}
#[inline]
pub fn into_inner(self) -> Vec<TupleBuffer> {
self.ops
}
#[inline]
pub fn encode(&self) -> Vec<u8> {
let mut res = Vec::with_capacity(4 + 4 * self.ops.len());
self.encode_to(&mut res).expect("memory allocation failed");
res
}
#[inline]
pub fn encode_to(&self, w: &mut impl std::io::Write) -> crate::Result<()> {
crate::msgpack::write_array_len(w, self.ops.len() as _)?;
for op in &self.ops {
op.write_tuple_data(w)?;
}
Ok(())
}
}
impl Default for UpdateOps {
fn default() -> Self {
Self::new()
}
}
impl AsRef<[TupleBuffer]> for UpdateOps {
#[inline]
fn as_ref(&self) -> &[TupleBuffer] {
&self.ops
}
}
impl From<UpdateOps> for Vec<TupleBuffer> {
#[inline]
fn from(ops: UpdateOps) -> Vec<TupleBuffer> {
ops.ops
}
}
impl IntoIterator for UpdateOps {
type Item = TupleBuffer;
type IntoIter = std::vec::IntoIter<TupleBuffer>;
fn into_iter(self) -> Self::IntoIter {
self.ops.into_iter()
}
}
////////////////////////////////////////////////////////////////////////////////
// macros
////////////////////////////////////////////////////////////////////////////////
/// Update a tuple or index.
///
/// The helper macro with the same semantic as `space.update()`/`index.update()` functions, but supports
/// different types in `ops` argument.
///
/// - `target` - updated space or index.
/// - `key` - encoded key in the MsgPack Array format (`[part1, part2, ...]`).
/// - `ops` - encoded operations in the MsgPack array format, e.g. `[['=', field_id, 100], ['!', 2, 'xxx']]`
///
/// Returns a new tuple.
///
/// See also: [space.update()](#method.update)
#[macro_export]
macro_rules! update {
($target:expr, $key:expr, $($op:expr),+ $(,)?) => {{
use $crate::tuple::ToTupleBuffer;
let mut f = || -> $crate::Result<Option<$crate::tuple::Tuple>> {
let key_buf = $key.to_tuple_buffer()?;
const len: u32 = $crate::expr_count!($($op),+);
let mut ops_buf = Vec::with_capacity((4 + len * 4) as _);
$crate::msgpack::write_array_len(&mut ops_buf, len)?;
$( $op.write_tuple_data(&mut ops_buf)?; )+
#[allow(unused_unsafe)]
unsafe {
$target.update_raw(key_buf.as_ref(), ops_buf.as_ref())
}
};
f()
}};
}
/// Upsert a tuple or index.
///
/// The helper macro with the same semantic as `space.upsert()`/`index.upsert()` functions, but supports
/// different types in `ops` argument.
///
/// - `target` - updated space or index.
/// - `value` - encoded tuple in the MsgPack Array format (`[part1, part2, ...]`).
/// - `ops` - encoded operations in the MsgPack array format, e.g. `[['=', field_id, 100], ['!', 2, 'xxx']]`
///
/// See also: [space.update()](#method.update)
#[macro_export]
macro_rules! upsert {
($target:expr, $value: expr, $($op:expr),+ $(,)?) => {{
use $crate::tuple::ToTupleBuffer;
let mut f = || -> $crate::Result<()> {
let value_buf = $value.to_tuple_buffer()?;
const len: u32 = $crate::expr_count!($($op),+);
let mut ops_buf = Vec::with_capacity((4 + len * 4) as _);
$crate::msgpack::write_array_len(&mut ops_buf, len)?;
$( $op.write_tuple_data(&mut ops_buf)?; )+
#[allow(unused_unsafe)]
unsafe {
$target.upsert_raw(value_buf.as_ref(), ops_buf.as_ref())
}
};
f()
}};
}