flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

APIDump: Reformatted the sqlite docs.

Browse Source
This commit is contained in:
madmaxoft 2013-11-23 21:32:18 +01:00
parent d9dc241e6f
commit 3ef7f2008f
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
MCServer/Plugins/APIDump/APIDesc.lua
View File

@ -2439,11 +2439,23 @@ Parser:close();
Functions = Functions =
{ {
complete = { Params = "string", Return = "bool", Notes = "Returns true if the string sql comprises one or more complete SQL statements and false otherwise." }, complete = { Params = "string", Return = "bool", Notes = "Returns true if the string sql comprises one or more complete SQL statements and false otherwise." },
open = { Params = "string", Return = "Userdata", Notes = [[Opens (or creates if it does not exist) an SQLite database with name filename and returns its handle as userdata (the returned object should be used for all further method calls in connection with this specific database, see {{http://lua.sqlite.org/index.cgi/doc/tip/doc/lsqlite3.wiki#database_methods|Database methods}}). Example: <pre class="prettyprint lang-lua">myDB=sqlite3.open('MyDatabase.sqlite3') -- open open = { Params = "FileName", Return = "DBClass", Notes = [[
Opens (or creates if it does not exist) an SQLite database with name filename and returns its
handle as userdata (the returned object should be used for all further method calls in connection
with this specific database, see
{{http://lua.sqlite.org/index.cgi/doc/tip/doc/lsqlite3.wiki#database_methods|Database methods}}).
Example:
<pre class="prettyprint lang-lua">
-- open the database:
myDB = sqlite3.open('MyDatabaseFile.sqlite3')
-- do some database calls... -- do some database calls...
myDB:close() -- close
TakeDamageInfo =</pre>]], }, -- Close the database:
open_memory = { Return = "userdata", Notes = "Opens an SQLite database in memory and returns its handle as userdata. In case of an error, the function returns nil, an error code and an error message. (In-memory databases are volatile as they are never stored on disk.)" }, myDB:close()
</pre>
]], },
open_memory = { Return = "DBClass", Notes = "Opens an SQLite database in memory and returns its handle as userdata. In case of an error, the function returns nil, an error code and an error message. (In-memory databases are volatile as they are never stored on disk.)" },
temp_directory = { Params = "string", Notes = "Opens an SQLite database in memory and returns its handle as userdata. In case of an error, the function returns nil, an error code and an error message. (In-memory databases are volatile as they are never stored on disk.)" }, temp_directory = { Params = "string", Notes = "Opens an SQLite database in memory and returns its handle as userdata. In case of an error, the function returns nil, an error code and an error message. (In-memory databases are volatile as they are never stored on disk.)" },
version = { Return = "string", Notes = "Returns a string with SQLite version information, in the form 'x.y[.z]'." }, version = { Return = "string", Notes = "Returns a string with SQLite version information, in the form 'x.y[.z]'." },
}, },