Struct tarantool::index::Index

pub struct Index { /* private fields */ }

An index is a group of key values and pointers.

Implementations

impl Index

pub const unsafe fn from_ids_unchecked( space_id: SpaceId, index_id: IndexId ) -> Self

Create an Index with corresponding space and index ids.

Safety

ids must be valid tarantool space/index id. Only use this function with ids acquired from tarantool in some way, e.g. from lua code.

pub fn id(&self) -> u32

Return id of this index.

pub fn space_id(&self) -> u32

Return the space id of this index.

pub fn meta(&self) -> Result<Metadata<'_>, Error>

pub fn drop(&self) -> Result<(), Error>

pub fn get<K>(&self, key: &K) -> Result<Option<Tuple>, Error>

where K: ToTupleBuffer + ?Sized,

Get a tuple from index by the key.

Please note that this function works much faster than select

• key - encoded key in MsgPack Array format ([part1, part2, ...]).

Returns a tuple or None if index is empty

pub fn select<K>( &self, iterator_type: IteratorType, key: &K ) -> Result<IndexIterator, Error>

where K: ToTupleBuffer + ?Sized,

Allocate and initialize iterator for index.

This is an alternative to space.select() which goes via a particular index and can make use of additional parameter that specify the iterator type.

• type - iterator type
• key - encoded key in MsgPack Array format ([part1, part2, ...]).

pub fn delete<K>(&self, key: &K) -> Result<Option<Tuple>, Error>

where K: ToTupleBuffer + ?Sized,

Delete a tuple identified by a key.

Same as space.delete(), but a key is searched in this index instead of in the primary-key index. This index ought to be unique.

• key - encoded key in MsgPack Array format ([part1, part2, ...]).

Returns the deleted tuple

pub fn update<K, Op>( &self, key: &K, ops: impl AsRef<[Op]> ) -> Result<Option<Tuple>, Error>

where K: ToTupleBuffer + ?Sized, Op: ToTupleBuffer,

Update a tuple.

Same as space.update(), but a key is searched in this index instead of primary key. This index ought to be unique.

• 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: index.upsert()

pub unsafe fn update_mp<K>( &self, key: &K, ops: &[Vec<u8>] ) -> Result<Option<Tuple>, Error>

where K: ToTupleBuffer + ?Sized,

👎Deprecated: use update_raw instead

Safety

ops must be a slice of valid msgpack arrays.

pub unsafe fn update_raw( &self, key: &[u8], ops: &[u8] ) -> Result<Option<Tuple>, Error>

Safety

key must be a valid msgpack array. ops must be a valid msgpack array of msgpack arrays.

pub fn upsert<T, Op>( &self, value: &T, ops: impl AsRef<[Op]> ) -> Result<(), Error>

where T: ToTupleBuffer + ?Sized, Op: ToTupleBuffer,

Execute an UPSERT request.

Will try to insert tuple. Update if already exists.

• value - encoded tuple in MsgPack Array format ([field1, field2, ...])
• ops - encoded operations in MsgPack array format, e.g. [['=', field_id, value], ['!', 2, 'xxx']]

See also: index.update()

pub unsafe fn upsert_mp<T>( &self, value: &T, ops: &[Vec<u8>] ) -> Result<(), Error>

where T: ToTupleBuffer + ?Sized,

👎Deprecated: use upsert_raw instead

Safety

ops must be a slice of valid msgpack arrays.

pub unsafe fn upsert_raw(&self, value: &[u8], ops: &[u8]) -> Result<(), Error>

Safety

value must be a valid msgpack array. ops must be a valid msgpack array of msgpack arrays.

pub fn len(&self) -> Result<usize, Error>

Return the number of elements in the index.

pub fn is_empty(&self) -> Result<bool, Error>

pub fn bsize(&self) -> Result<usize, Error>

Return the number of bytes used in memory by the index.

pub fn random(&self, seed: u32) -> Result<Option<Tuple>, Error>

Return a random tuple from the index (useful for statistical analysis).

• rnd - random seed

pub fn min<K>(&self, key: &K) -> Result<Option<Tuple>, Error>

where K: ToTupleBuffer + ?Sized,

Return a first (minimal) tuple that matched the provided key.

• key - encoded key in MsgPack Array format ([part1, part2, ...]).

Returns a tuple or None if index is empty

pub fn max<K>(&self, key: &K) -> Result<Option<Tuple>, Error>

where K: ToTupleBuffer + ?Sized,

Return a last (maximal) tuple that matched the provided key.

• key - encoded key in MsgPack Array format ([part1, part2, ...]).

Returns a tuple or None if index is empty

pub fn count<K>( &self, iterator_type: IteratorType, key: &K ) -> Result<usize, Error>

where K: ToTupleBuffer + ?Sized,

Count the number of tuples that matched the provided key.

• type - iterator type
• key - encoded key in MsgPack Array format ([part1, part2, ...]).

pub unsafe fn extract_key(&self, tuple: Tuple) -> Tuple

Extract key from tuple according to key definition of given index.

Safety

The current index & it’s space must exist and tuple must conform to the space format.

You should probably use KeyDef::extract_key instead.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Index

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Index

fn eq(&self, other: &Index) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Index

impl StructuralEq for Index

impl StructuralPartialEq for Index