diff --git a/src/box/lua/tuple.c b/src/box/lua/tuple.c
index 5139e444b1257e3ce2248de47b22d76590a90430..3e6f043b48e29a4bf013e84cba7fedc7e2ae7504 100644
--- a/src/box/lua/tuple.c
+++ b/src/box/lua/tuple.c
@@ -265,15 +265,15 @@ luaT_tuple_encode(struct lua_State *L, int idx, size_t *tuple_len_ptr)
/* }}} Encode a Lua table as an MsgPack array */
-struct tuple *
+box_tuple_t *
luaT_tuple_new(struct lua_State *L, int idx, box_tuple_format_t *format)
{
size_t tuple_len;
char *tuple_data = luaT_tuple_encode_on_lua_ibuf(L, idx, &tuple_len);
if (tuple_data == NULL)
return NULL;
- struct tuple *tuple = box_tuple_new(format, tuple_data,
- tuple_data + tuple_len);
+ box_tuple_t *tuple = box_tuple_new(format, tuple_data,
+ tuple_data + tuple_len);
if (tuple == NULL)
return NULL;
ibuf_reinit(tarantool_lua_ibuf);
diff --git a/src/box/lua/tuple.h b/src/box/lua/tuple.h
index aadcf7f59e2e310a3399fadf730850b53accdef1..f6384ddb8932caee20ea472ee7ba090e6436c737 100644
--- a/src/box/lua/tuple.h
+++ b/src/box/lua/tuple.h
@@ -92,21 +92,35 @@ luaT_istuple(struct lua_State *L, int idx);
* should call <box_region_truncate>() to release the data.
*
* In case of an error set a diag and return NULL.
+ *
+ * @sa luaT_tuple_new()
*/
API_EXPORT char *
luaT_tuple_encode(struct lua_State *L, int idx, size_t *tuple_len_ptr);
-/** \endcond public */
-
/**
* Create a new tuple with specific format from a Lua table or a
* tuple.
*
+ * The new tuple is referenced in the same way as one created by
+ * <box_tuple_new>(). There are two possible usage scenarious:
+ *
+ * 1. A short living tuple may not be referenced explicitly and
+ * will be collected automatically at the next module API call
+ * that yields or returns a tuple.
+ * 2. A long living tuple must be referenced using
+ * <box_tuple_ref>() and unreferenced then with
+ * <box_tuple_unref>().
+ *
+ * @sa box_tuple_ref()
+ *
* In case of an error set a diag and return NULL.
*/
-struct tuple *
+API_EXPORT box_tuple_t *
luaT_tuple_new(struct lua_State *L, int idx, box_tuple_format_t *format);
+/** \endcond public */
+
static inline int
luaT_pushtupleornil(struct lua_State *L, struct tuple *tuple)
{
diff --git a/src/exports.h b/src/exports.h
index 9bad229463f084634d0fef8416b3bcc3b83b6ab1..612f60598fcc8db11e25490c2d257393ccf726bc 100644
--- a/src/exports.h
+++ b/src/exports.h
@@ -407,6 +407,7 @@ EXPORT(luaT_pushtuple)
EXPORT(luaT_state)
EXPORT(luaT_tolstring)
EXPORT(luaT_tuple_encode)
+EXPORT(luaT_tuple_new)
EXPORT(mp_char2escape)
EXPORT(mp_decode_double)
EXPORT(mp_decode_extl)
diff --git a/test/app-tap/module_api.c b/test/app-tap/module_api.c
index 169c676d2b8afc2e1422aa8d57a3556a1f8d0eec..47a2d8ba587c2e7af8c02d3db5586c8d8ca9ea43 100644
--- a/test/app-tap/module_api.c
+++ b/test/app-tap/module_api.c
@@ -560,6 +560,9 @@ test_box_region(struct lua_State *L)
static void
check_tuple_data(char *tuple_data, size_t tuple_size, int retvals)
{
+ (void)tuple_data;
+ (void)tuple_size;
+ (void)retvals;
assert(tuple_size == 4);
assert(tuple_data != NULL);
assert(!strncmp(tuple_data, "\x93\x01\x02\x03", 4));
@@ -570,8 +573,13 @@ static void
check_encode_error(char *tuple_data, int retvals, const char *exp_err_type,
const char *exp_err_msg)
{
+ (void)tuple_data;
+ (void)retvals;
+ (void)exp_err_type;
+ (void)exp_err_msg;
assert(tuple_data == NULL);
box_error_t *e = box_error_last();
+ (void)e;
assert(strcmp(box_error_type(e), exp_err_type) == 0);
assert(strcmp(box_error_message(e), exp_err_msg) == 0);
assert(retvals == 0);
@@ -669,6 +677,46 @@ test_tuple_encode(struct lua_State *L)
/* }}} test_tuple_encode */
+/* {{{ test_tuple_new */
+
+/**
+ * Create a tuple from a Lua table or another tuple.
+ *
+ * Just basic test. More cases in the luaT_tuple_new.c unit test.
+ */
+static int
+test_tuple_new(struct lua_State *L)
+{
+ box_tuple_format_t *default_format = box_tuple_format_default();
+
+ /* Prepare the Lua stack. */
+ luaL_loadstring(L, "return {1, 2, 3}");
+ lua_call(L, 0, 1);
+
+ /* Create a tuple. */
+ int top = lua_gettop(L);
+ box_tuple_t *tuple = luaT_tuple_new(L, -1, default_format);
+
+ /* Verify size, data and Lua stack top. */
+ size_t region_svp = box_region_used();
+ size_t tuple_size = box_tuple_bsize(tuple);
+ char *tuple_data = box_region_alloc(tuple_size);
+ ssize_t rc = box_tuple_to_buf(tuple, tuple_data, tuple_size);
+ (void)rc;
+ assert(rc == (ssize_t)tuple_size);
+ check_tuple_data(tuple_data, tuple_size, lua_gettop(L) - top);
+
+ /* Clean up. */
+ box_region_truncate(region_svp);
+ lua_pop(L, 1);
+ assert(lua_gettop(L) == 0);
+
+ lua_pushboolean(L, 1);
+ return 1;
+}
+
+/* }}} test_tuple_new */
+
LUA_API int
luaopen_module_api(lua_State *L)
{
@@ -700,6 +748,7 @@ luaopen_module_api(lua_State *L)
{"iscdata", test_iscdata},
{"test_box_region", test_box_region},
{"test_tuple_encode", test_tuple_encode},
+ {"test_tuple_new", test_tuple_new},
{NULL, NULL}
};
luaL_register(L, "module_api", lib);
diff --git a/test/app-tap/module_api.test.lua b/test/app-tap/module_api.test.lua
index e5cac9eb629bc8e105f510457cb631cd38509d77..f1b377e171b04484dcc30cefc7079d281e1522de 100755
--- a/test/app-tap/module_api.test.lua
+++ b/test/app-tap/module_api.test.lua
@@ -177,7 +177,7 @@ local function test_iscdata(test, module)
end
local test = require('tap').test("module_api", function(test)
- test:plan(27)
+ test:plan(28)
local status, module = pcall(require, 'module_api')
test:is(status, true, "module")
test:ok(status, "module is loaded")