Modules

The Modules tab allows you to enable actions to interact with one or more Lua modules. Enabling a checkbox will add the corresponding action categories to the Action Wizard, automatically add any necessary DLL files to your project when you build it, and include the (hidden) Lua script required to make those database actions available at run time.

See Database Actions for more information on how to use databases with LuaSQL in AutoPlay.

LuaSQL

MySQL

Enable support for MySQL databases. Selecting this option will automatically add the LuaSQL-MySQL module functionality to your project and make it available at run time. It will also add the MySQL, MySQLConnection, and MySQLCursor action categories to the Action Wizard.

Note that selecting this will cause 1 .dll file to be added to your Scripts folder at build time: luasql\mysql.dll.

SQLite3

Enable support for SQLite3 databases. Selecting this option will automatically add the LuaSQL-SQLite3 module functionality to your project and make it available at run time. It will also add the SQLite3, SQLite3Connection, and SQLite3Cursor action categories to the Action Wizard.

Note that selecting this will cause 1 .dll file to be added to your Scripts folder at build time: luasql\sqlite3.dll.

Oracle

Enable support for Oracle databases. Selecting this option will automatically add the LuaSQL-Oracle module functionality to your project and make it available at run time. It will also add the Oracle, OracleConnection, and OracleCursor action categories to the Action Wizard.

Note that selecting this will cause 9 .dll files to be added to your Scripts folder at build time:
luasql\oci8.dll
oci.dll
ocijdbc21.dll
ociw32.dll
orannzsbb.dll
oraocc21.dll
oraocc21d.dll
oraociicus.dll
orasql.dll

ODBC

Enable support for ODBC databases. Selecting this option will automatically add the LuaSQL-ODBC module functionality to your project and make it available at run time. It will also add the ODBC, ODBCConnection, and ODBCCursor action categories to the Action Wizard.

Note that selecting this will cause 1 .dll file to be added to your Scripts folder at build time: luasql\odbc.dll.

PostgreSQL

Enable support for PostgreSQL databases. Selecting this option will automatically add the LuaSQL-PostgreSQL module functionality to your project and make it available at run time. It will also add the PostgreSQL, PostgreSQLConnection, and PostgreSQLCursor action categories to the Action Wizard.

Note that selecting this will cause the following 6 .dll files to be added to your Scripts folder at build time:

luasql\postgre.dll
libcrypto-1_1.dll
libssl-1_1.dll
libpq.dll
libiconv-2.dll
libintl-8.dll

Firebird

Enable support for Firebird databases. Selecting this option will automatically add the LuaSQL-Firebird module functionality to your project and make it available at run time. It will also add the Firebird, FirebirdConnection, and FirebirdCursor action categories to the Action Wizard.

Note that selecting this will cause 2 .dll file to be added to your Scripts folder at build time: luasql\firebird.dll and fbclient.dll.

Network

LuaSocket

LuaSocket is a Lua extension library that is composed by two parts: a C core that provides support for the TCP and UDP transport layers, and a set of Lua modules that add support for the SMTP (sending e-mails), HTTP (WWW access) and FTP (uploading and downloading files) protocols and other functionality commonly needed by applications that deal with the Internet. Selecting this option will automatically add theses files to your Scripts folder build time:

socket\core.dll
socket\ftp.lua
socket\headers.lua
socket\http.lua
socket\smtp.lua
socket\tp.lua
socket\url.lua
mime\core.dll
ltn12.lua
mime.lua
socket.lua

LuaSec

LuaSec is a binding for OpenSSL library to provide TLS/SSL communication. It takes an already established TCP connection and creates a secure session between the peers. Note that selecting this option will automatically add theses files to your Scripts folder build time:

ssl\https.lua
libcrypto-3.dll
libssl-3.dll
ssl.dll
ssl.lua

Miscellaneous

LuaFileSystem

LuaFileSystem is a Lua library developed to complement the set of functions related to file systems offered by the standard Lua distribution. LuaFileSystem offers a portable way to access the underlying directory structure and file attributes.
Selecting this option will automatically add one file to your Scripts folder build time: lfs.dll

If you enable this module, this is automatically performed:

lfs = require("lfs");

LuaFileSystem offers the following functions:

lfs.attributes (filepath [, request_name | result_table])

Returns a table with the file attributes corresponding to filepath (or nil followed by an error message and a system-dependent error code in case of error). If the second optional argument is given and is a string, then only the value of the named attribute is returned (this use is equivalent to lfs.attributes(filepath)[request_name], but the table is not created and only one attribute is retrieved from the O.S.). if a table is passed as the second argument, it (result_table) is filled with attributes and returned instead of a new table. The attributes are described as follows; attribute mode is a string, all the others are numbers, and the time related attributes use the same time reference of os.time:

dev: on Unix systems, this represents the device that the inode resides on. On Windows systems, represents the drive number of the disk containing the file
ino: on Unix systems, this represents the inode number. On Windows systems this has no meaning
mode: string representing the associated protection mode (the values could be file, directory, link, socket, named pipe, char device, block device or other)
nlink: number of hard links to the file
uid: user-id of owner (Unix only, always 0 on Windows)
gid: group-id of owner (Unix only, always 0 on Windows)
rdev: on Unix systems, represents the device type, for special file inodes. On Windows systems represents the same as dev
access: time of last access
modification: time of last data modification
change: time of last file status change
size: file size, in bytes
permissions: file permissions string
blocks: block allocated for file; (Unix only)
blksize: optimal file system I/O blocksize; (Unix only)

This function uses stat internally thus if the given filepath is a symbolic link, it is followed (if it points to another link the chain is followed recursively) and the information is about the file it refers to. To obtain information about the link itself, see function lfs.symlinkattributes.

lfs.chdir (path)

Changes the current working directory to the given path.
Returns true in case of success or nil plus an error string.

lfs.lock_dir(path, [seconds_stale])

Creates a lockfile (called lockfile.lfs) in path if it does not exist and returns the lock. If the lock already exists checks if it's stale, using the second parameter (default for the second parameter is INT_MAX, which in practice means the lock will never be stale. To free the the lock call lock:free(). In case of any errors it returns nil and the error message. In particular, if the lock exists and is not stale it returns the "File exists" message.

lfs.currentdir ()

Returns a string with the current working directory or nil plus an error string.

iter, dir_obj = lfs.dir (path)

Lua iterator over the entries of a given directory. Each time the iterator is called with dir_obj it returns a directory entry's name as a string, or nil if there are no more entries. You can also iterate by calling dir_obj:next(), and explicitly close the directory before the iteration finished with dir_obj:close(). Raises an error if path is not a directory.

lfs.lock (filehandle, mode[, start[, length]])

Locks a file or a part of it. This function works on open files; the file handle should be specified as the first argument. The string mode could be either r (for a read/shared lock) or w (for a write/exclusive lock). The optional arguments start and length can be used to specify a starting point and its length; both should be numbers.
Returns true if the operation was successful; in case of error, it returns nil plus an error string.

lfs.link (old, new[, symlink])

Creates a link. The first argument is the object to link to and the second is the name of the link. If the optional third argument is true, the link will by a symbolic link (by default, a hard link is created).

lfs.mkdir (dirname)

Creates a new directory. The argument is the name of the new directory.
Returns true in case of success or nil, an error message and a system-dependent error code in case of error.

lfs.rmdir (dirname)

Removes an existing directory. The argument is the name of the directory.
Returns true in case of success or nil, an error message and a system-dependent error code in case of error.

lfs.setmode (file, mode)

Sets the writing mode for a file. The mode string can be either "binary" or "text". Returns true followed the previous mode string for the file, or nil followed by an error string in case of errors. On non-Windows platforms, where the two modes are identical, setting the mode has no effect, and the mode is always returned as binary.

lfs.symlinkattributes (filepath [, request_name])

Identical to lfs.attributes except that it obtains information about the link itself (not the file it refers to). It also adds a target field, containing the file name that the symlink points to. On Windows this function does not yet support links, and is identical to lfs.attributes.

lfs.touch (filepath [, atime [, mtime]])

Set access and modification times of a file. This function is a bind to utime function. The first argument is the filename, the second argument (atime) is the access time, and the third argument (mtime) is the modification time. Both times are provided in seconds (which should be generated with Lua standard function os.time). If the modification time is omitted, the access time provided is used; if both times are omitted, the current time is used.
Returns true in case of success or nil, an error message and a system-dependent error code in case of error.

lfs.unlock (filehandle[, start[, length]])

Unlocks a file or a part of it. This function works on open files; the file handle should be specified as the first argument. The optional arguments start and length can be used to specify a starting point and its length; both should be numbers.
Returns true if the operation was successful; in case of error, it returns nil plus an error string.

Special Thanks

We would like to thank our users Imagine Programming, DriPro and SupperBin for compiling and testing LuaSQL modules for MySQL, Oracle, ODBC, PostgreSQL and Firebird. Your testing, effort and contributions are greatly appreciated.

Notice

Additional useful Lua modules may be available in the user forums.

The database functionality makes use of the LuaSQL library originally designed and implemented by the Kepler Project team.

The LuaFileSystem library was originally designed and implemented by Roberto Ierusalimschy, Andr� Carregal and Tom�s Guisasola, and has since been maintained over the years by many people -- see the Git history for detailed credits. The implementation is not derived from any other licensed software.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

PostgreSQL Data Base Management System

Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.

IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.