[tarantool-patches] [PATCH v6 3/5] lua: create method dump_lua for port_sql

[imeevma@tarantool.org]

Hi! Thank you for review! My answers, diff between versions and
new version below.

On 12/25/18 5:57 PM, Vladislav Shpilevoy wrote:
> Thanks for the patch! See 7 comments below.

> 1. Use lua_pushstring. 
Fixed.

> 2. It is strange, that this function creates a table and sets it
> as a member of some externally created table. Please, move this line
> to a caller function. 
Fixed.

> 3. Just inline keys 2. 
Fixed.

> 4. Why 1 array element? And why do you separate fixed/optional keys?
> lua_createtable does not take statis/dynamic key count. It takes
> array/map key count. 
Fixed. Now it takes 1 or 2 as map key count.

> 5. I think, port_sql_destroy should call sqlite3_finalize. 
Fixed in patch #2.

> 6. Impossible. It isn't? 
Removed.

> 7. Please, start message with a capital letter. 
Fixed.


Diff between versions:

commit 2d1f7aca7dc5a8526f6916bf4d782d0e4ff5f5da
Author: Mergen Imeev <imeevma@gmail.com>
Date:   Thu Dec 27 16:26:25 2018 +0300

    Temporary: review fixes

diff --git a/src/box/execute.c b/src/box/execute.c
index bab0048..4606239 100644
--- a/src/box/execute.c
+++ b/src/box/execute.c
@@ -697,13 +697,12 @@ lua_sql_get_description(struct sqlite3_stmt *stmt, struct lua_State *L,
 		 * column_name simply returns them.
 		 */
 		assert(name != NULL);
-		lua_pushlstring(L, name, strlen(name));
+		lua_pushstring(L, name);
 		lua_setfield(L, -2, "name");
-		lua_pushlstring(L, type, strlen(type));
+		lua_pushstring(L, type);
 		lua_setfield(L, -2, "type");
 		lua_rawseti(L, -2, i + 1);
 	}
-	lua_setfield(L, -2, "metadata");
 }
 
 /**
@@ -721,18 +720,20 @@ port_sql_dump_lua(struct port *port, struct lua_State *L)
 	struct sqlite3_stmt *stmt = ((struct port_sql *)port)->stmt;
 	int column_count = sqlite3_column_count(stmt);
 	if (column_count > 0) {
-		int keys = 2;
-		lua_createtable(L, 0, keys);
+		lua_createtable(L, 0, 2);
 		lua_sql_get_description(stmt, L, column_count);
+		lua_setfield(L, -2, "metadata");
+		/*
+		 * We can use the port_tuple methods, since
+		 * port_sql was inherited from it.
+		 */
 		port_tuple_vtab.dump_lua(port, L);
 		lua_setfield(L, -2, "rows");
 	} else {
 		assert(((struct port_tuple *)port)->size == 0);
 		struct stailq *autoinc_id_list =
 			vdbe_autoinc_id_list((struct Vdbe *)stmt);
-
-		int dynamic_keys = stailq_empty(autoinc_id_list) ? 0 : 1;
-		lua_createtable(L, 1, dynamic_keys);
+		lua_createtable(L, 0, stailq_empty(autoinc_id_list) ? 1 : 2);
 
 		luaL_pushuint64(L, db->nChange);
 		lua_setfield(L, -2, "rowcount");
diff --git a/src/box/lua/sql.c b/src/box/lua/sql.c
index 318f331..a55566e 100644
--- a/src/box/lua/sql.c
+++ b/src/box/lua/sql.c
@@ -119,13 +119,12 @@ lbox_execute(struct lua_State *L)
 	size_t length;
 	struct port port;
 
-	struct sqlite3 *db = sql_get();
-	if (db == NULL)
-		return luaL_error(L, "not ready");
+	if (lua_type(L, 1) != LUA_TSTRING)
+		return luaL_error(L, "Usage: box.execute(sqlstring)");
 
 	const char *sql = lua_tolstring(L, 1, &length);
 	if (sql == NULL)
-		return luaL_error(L, "usage: box.execute(sqlstring)");
+		return luaL_error(L, "Usage: box.execute(sqlstring)");
 
 	if (sql_prepare_and_execute(sql, length, bind, bind_count, &port,
 				    &fiber()->gc) != 0)


New version:

commit 74f30d133b34ea86dc145f6ffee347abfd489cf2
Author: Mergen Imeev <imeevma@gmail.com>
Date:   Fri Dec 21 16:48:37 2018 +0300

    lua: create method dump_lua for port_sql
    
    This patch creates the dump_lua method for port_sql. It also
    defines a new function box.sql.new_execute(), which will be
    converted to box.sql.execute().
    
    Part of #3505

diff --git a/src/box/execute.c b/src/box/execute.c
index c6fcb50..4606239 100644
--- a/src/box/execute.c
+++ b/src/box/execute.c
@@ -43,6 +43,7 @@
 #include "port.h"
 #include "tuple.h"
 #include "sql/vdbe.h"
+#include "lua/utils.h"
 
 const char *sql_type_strs[] = {
 	NULL,
@@ -102,12 +103,14 @@ static_assert(sizeof(struct port_sql) <= sizeof(struct port),
 static int
 port_sql_dump_msgpack(struct port *port, struct obuf *out);
 static void
+port_sql_dump_lua(struct port *port, struct lua_State *L);
+static void
 port_sql_destroy(struct port *base);
 
 const struct port_vtab port_sql_vtab = {
 	.dump_msgpack = port_sql_dump_msgpack,
 	.dump_msgpack_16 = NULL,
-	.dump_lua = NULL,
+	.dump_lua = port_sql_dump_lua,
 	.dump_plain = NULL,
 	.destroy = port_sql_destroy,
 };
@@ -671,6 +674,87 @@ finish:
 	return rc;
 }
 
+/**
+ * Push a metadata of the prepared statement to Lua stack.
+ *
+ * @param stmt Prepared statement.
+ * @param L Lua stack.
+ * @param column_count Statement's column count.
+ */
+static inline void
+lua_sql_get_description(struct sqlite3_stmt *stmt, struct lua_State *L,
+			int column_count)
+{
+	assert(column_count > 0);
+	lua_createtable(L, column_count, 0);
+	for (int i = 0; i < column_count; ++i) {
+		lua_createtable(L, 2, 0);
+		const char *name = sqlite3_column_name(stmt, i);
+		const char *type = sqlite3_column_datatype(stmt, i);
+		/*
+		 * Can not fail, since all column names are
+		 * preallocated during prepare phase and the
+		 * column_name simply returns them.
+		 */
+		assert(name != NULL);
+		lua_pushstring(L, name);
+		lua_setfield(L, -2, "name");
+		lua_pushstring(L, type);
+		lua_setfield(L, -2, "type");
+		lua_rawseti(L, -2, i + 1);
+	}
+}
+
+/**
+ * Dump a built response into Lua stack. The response is
+ * destroyed.
+ *
+ * @param port port with EXECUTE response.
+ * @param L Lua stack.
+ */
+static void
+port_sql_dump_lua(struct port *port, struct lua_State *L)
+{
+	assert(port->vtab == &port_sql_vtab);
+	sqlite3 *db = sql_get();
+	struct sqlite3_stmt *stmt = ((struct port_sql *)port)->stmt;
+	int column_count = sqlite3_column_count(stmt);
+	if (column_count > 0) {
+		lua_createtable(L, 0, 2);
+		lua_sql_get_description(stmt, L, column_count);
+		lua_setfield(L, -2, "metadata");
+		/*
+		 * We can use the port_tuple methods, since
+		 * port_sql was inherited from it.
+		 */
+		port_tuple_vtab.dump_lua(port, L);
+		lua_setfield(L, -2, "rows");
+	} else {
+		assert(((struct port_tuple *)port)->size == 0);
+		struct stailq *autoinc_id_list =
+			vdbe_autoinc_id_list((struct Vdbe *)stmt);
+		lua_createtable(L, 0, stailq_empty(autoinc_id_list) ? 1 : 2);
+
+		luaL_pushuint64(L, db->nChange);
+		lua_setfield(L, -2, "rowcount");
+
+		if (!stailq_empty(autoinc_id_list)) {
+			lua_newtable(L);
+			int i = 1;
+			struct autoinc_id_entry *id_entry;
+			stailq_foreach_entry(id_entry, autoinc_id_list, link) {
+				if (id_entry->id >= 0)
+					luaL_pushuint64(L, id_entry->id);
+				else
+					luaL_pushint64(L, id_entry->id);
+				lua_rawseti(L, -2, i++);
+			}
+			lua_setfield(L, -2, "autoincrement_ids");
+		}
+	}
+	port_destroy(port);
+}
+
 static void
 port_sql_destroy(struct port *base)
 {
diff --git a/src/box/lua/sql.c b/src/box/lua/sql.c
index 6923666..a55566e 100644
--- a/src/box/lua/sql.c
+++ b/src/box/lua/sql.c
@@ -6,6 +6,7 @@
 #include <info.h>
 #include "lua/info.h"
 #include "lua/utils.h"
+#include "box/execute.h"
 
 static void
 lua_push_column_names(struct lua_State *L, struct sqlite3_stmt *stmt)
@@ -111,6 +112,28 @@ sqlerror:
 }
 
 static int
+lbox_execute(struct lua_State *L)
+{
+	struct sql_bind *bind = NULL;
+	int bind_count = 0;
+	size_t length;
+	struct port port;
+
+	if (lua_type(L, 1) != LUA_TSTRING)
+		return luaL_error(L, "Usage: box.execute(sqlstring)");
+
+	const char *sql = lua_tolstring(L, 1, &length);
+	if (sql == NULL)
+		return luaL_error(L, "Usage: box.execute(sqlstring)");
+
+	if (sql_prepare_and_execute(sql, length, bind, bind_count, &port,
+				    &fiber()->gc) != 0)
+		return luaT_error(L);
+	port_dump_lua(&port, L);
+	return 1;
+}
+
+static int
 lua_sql_debug(struct lua_State *L)
 {
 	struct info_handler info;
@@ -124,6 +147,7 @@ box_lua_sqlite_init(struct lua_State *L)
 {
 	static const struct luaL_Reg module_funcs [] = {
 		{"execute", lua_sql_execute},
+		{"new_execute", lbox_execute},
 		{"debug", lua_sql_debug},
 		{NULL, NULL}
 	};
-- 
2.7.4