tarantool 11.0.0

Tarantool rust bindings
Documentation 
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

use crate::c_ptr;
use crate::error::{Error, TarantoolError};
use crate::ffi::lua;
use crate::ffi::tarantool::luaT_call;
use crate::index::{Index, IndexOptions};
use tlua::AsLua as _;
use tlua::{
    LuaError::{self, ExecutionError},
    LuaFunction, LuaTable,
};

/// Create new index for space.
///
/// - `space_id`   - ID of existing space.
/// - `index_name` - name of index to create, which should conform to the rules for object names.
/// - `opts`       - see IndexOptions struct.
///
/// For details see [space_object:create_index](https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/create_index/)
pub fn create_index(space_id: u32, index_name: &str, opts: &IndexOptions) -> Result<Index, Error> {
    let lua = crate::lua_state();
    let b: LuaTable<_> = lua
        .get("box")
        .ok_or_else(|| ExecutionError("box == nil".into()))?;
    let b_schema: LuaTable<_> = b
        .get("schema")
        .ok_or_else(|| ExecutionError("box.schema == nil".into()))?;
    let b_s_index: LuaTable<_> = b_schema
        .get("index")
        .ok_or_else(|| ExecutionError("box.schema.index == nil".into()))?;
    let index_create: LuaFunction<_> = b_s_index
        .get("create")
        .ok_or_else(|| ExecutionError("box.schema.index.create == nil".into()))?;
    let new_index: LuaTable<_> = index_create
        .call_with_args((space_id, index_name, opts))
        .map_err(LuaError::from)?;
    let index_id: u32 = new_index.get("id").ok_or_else(|| {
        ExecutionError(format!("box.space[{space_id}].index['{index_name}'] == nil").into())
    })?;
    Ok(Index::new(space_id, index_id))
}

/// Drop existing index.
///
/// - `space_id` - ID of existing space.
/// - `index_name` - ID of existing index.
pub fn drop_index(space_id: u32, index_id: u32) -> Result<(), Error> {
    unsafe {
        // Create new stack (just in case - in order no to mess things
        // in current stack).
        let lua = crate::lua_state();
        let drop_state = lua.as_lua();

        // Execute the following Lua code:
        // -- space = box.space._space:get(space_id)
        // -- space_name = space.name
        // -- index = box.space._index:get({space_id, index_id})
        // -- index_name = index.name
        // -- box.space.space_name.index.index_name:drop()

        // -- space = box.space._space:get({"id": space_id})
        lua::lua_getglobal(drop_state, c_ptr!("box"));
        lua::lua_getfield(drop_state, -1, c_ptr!("space"));
        lua::lua_getfield(drop_state, -1, c_ptr!("_space"));
        lua::lua_getfield(drop_state, -1, c_ptr!("get"));
        lua::lua_pushvalue(drop_state, -2);
        lua::lua_pushinteger(drop_state, space_id as isize);
        if luaT_call(drop_state, 2, 1) == 1 {
            return Err(TarantoolError::last().into());
        }

        // -- space_name = space.name
        lua::lua_getfield(drop_state, -1, c_ptr!("name"));
        let space_name = lua::lua_tostring(drop_state, -1);
        lua::lua_remove(drop_state, -1);

        // -- index = box.space._index:get({space_id, index_id})
        lua::lua_getglobal(drop_state, c_ptr!("box"));
        lua::lua_getfield(drop_state, -1, c_ptr!("space"));
        lua::lua_getfield(drop_state, -1, c_ptr!("_index"));
        lua::lua_getfield(drop_state, -1, c_ptr!("get"));
        lua::lua_pushvalue(drop_state, -2);
        lua::lua_newtable(drop_state);
        lua::lua_pushinteger(drop_state, 1);
        lua::lua_pushinteger(drop_state, space_id as isize);
        lua::lua_settable(drop_state, -3);
        lua::lua_pushinteger(drop_state, 2);
        lua::lua_pushinteger(drop_state, index_id as isize);
        lua::lua_settable(drop_state, -3);
        if luaT_call(drop_state, 2, 1) == 1 {
            return Err(TarantoolError::last().into());
        }

        // -- index_name = index.name
        lua::lua_getfield(drop_state, -1, c_ptr!("name"));
        let index_name = lua::lua_tostring(drop_state, -1);
        lua::lua_remove(drop_state, -1);

        // -- box.space.space_name.index.index_name:drop()
        lua::lua_getglobal(drop_state, c_ptr!("box"));
        lua::lua_getfield(drop_state, -1, c_ptr!("space"));
        lua::lua_getfield(drop_state, -1, space_name);
        lua::lua_getfield(drop_state, -1, c_ptr!("index"));
        lua::lua_getfield(drop_state, -1, index_name);
        lua::lua_getfield(drop_state, -1, c_ptr!("drop"));
        lua::lua_pushvalue(drop_state, -2);
        if luaT_call(drop_state, 1, 1) == 1 {
            return Err(TarantoolError::last().into());
        }

        // No need to clean drop_state. It will be gc'ed.
    }

    Ok(())
}