LuaSQLite3

Check-in [f294c77828]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Documentation updates.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: f294c77828b4a72d075bd3bcbe65b0bddfb601ac
User & Date: e 2016-11-14 14:18:50
Context
2016-11-15
17:53
Change conditional tests from WIN32 to _WIN32 for lsqlite_temp_directory. check-in: 6fc7943d1d user: e tags: fsl_9x, trunk
2016-11-14
14:18
Documentation updates. check-in: f294c77828 user: e tags: trunk
02:13
Documentation cleanup. check-in: dbd7159ee5 user: e tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to README.

6
7
8
9
10
11
12
13
14
15
16
SQLite3 dynamically, the other statically.

The module lsqlite3 links SQLite3 dynamically.
To use this module you need the SQLite3 library.
You can get it from http://www.sqlite.org/

The module lsqlite3complete links SQLite3 statically.
The SQLite3 amalgamation souuce code is included in 
the LuaSQLite3 distribution.

Lua 5 is available from http://www.lua.org/







|



6
7
8
9
10
11
12
13
14
15
16
SQLite3 dynamically, the other statically.

The module lsqlite3 links SQLite3 dynamically.
To use this module you need the SQLite3 library.
You can get it from http://www.sqlite.org/

The module lsqlite3complete links SQLite3 statically.
The SQLite3 amalgamation source code is included in 
the LuaSQLite3 distribution.

Lua 5 is available from http://www.lua.org/

Changes to doc/lsqlite3.wiki.

128
129
130
131
132
133
134









135
136

137
138
139
140
141
142
143

144

145
146
147
148
149
150
151
152

153
154
155
156
157
158
159
160

161

162
163
164
165
166
167
168
...
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<p><strong>LuaSQLite 3</strong> - a Lua 5.1 to 5.3 wrapper for the SQLite3 library</p>
<p>
</p>
<hr />
<h1><a name="overview">OVERVIEW</a></h1>
<p><strong>LuaSQLite 3</strong> is a thin wrapper around the public domain SQLite3
database engine.</p>









<p>The <code>lsqlite3</code> module supports the creation and manipulation of 
SQLite3 databases. After a <code>sqlite3 = require('lsqlite3')</code> the exported 

functions are called with prefix <code>sqlite3</code>. However, most sqlite3 
functions are called via an object-oriented interface to either 
database or SQL statement objects; see below for details.</p>
<p>This documentation does not attempt to describe how SQLite3 itself
works, it just describes the Lua binding and the available functions.
For more information about the SQL features supported by SQLite3 and
details about the syntax of SQL statements and queries, please see the

<strong>SQLite3 documentation</strong> <a href="http://www.sqlite.org/">http://www.sqlite.org/</a>. Using some of the

advanced features (how to use callbacks, for instance) will require 
some familiarity with the SQLite3 API.</p>
<p>
</p>
<hr />
<h1><a name="download">DOWNLOAD</a></h1>
<p><strong>LuaSQLite 3</strong> source code can be downloaded from its 
Fossil (<a href="http://lua.sqlite.org/">http://lua.sqlite.org/</a>) page.</p>

<p>You will also need to build or obtain an SQLite3 loadable library 
(DLL or .so). See <a href="http://www.sqlite.org/">http://www.sqlite.org/</a> for obtaining SQLite3 
source code or downloading a binary SQLite3 library.</p>
<p>
</p>
<hr />
<h1><a name="installation">INSTALLATION</a></h1>
<p>Luarocks (<a href="http://luarocks.org/">http://luarocks.org/</a>) is the preferred mechanism 

to build and install <code>lsqlite3</code>; it assumes an SQLite3 library is already installed.</p>

<p>
</p>
<hr />
<h1><a name="examples">EXAMPLES</a></h1>
<p>The distribution contains an <em>examples</em> directory. The unit tests
also show some example use.</p>
<p>
................................................................................
<hr />
<h1><a name="verification_tests">VERIFICATION TESTS</a></h1>
<p>The distribution contains a <em>tests</em> directory with some units tests using 
an enhanced version of Michael Roth's <code>lunit</code> called <code>lunitx</code>. Some of the 
tests were also derived from Michael's <strong>lua-sqlite3</strong> module, and more unit tests 
added by Doug Currie. Get <code>lunitx</code> using Luarocks.</p>
<p>The distribution also contains some functional tests by Tiago.</p>
<p>This version of <code>lsqlite3</code> was tested with SQLite 3.11.0 and 3.15.0.</p>
<p>
</p>
<hr />
<h1><a name="reference">REFERENCE</a></h1>
<p>
</p>
<hr />







>
>
>
>
>
>
>
>
>
|
|
>







>
|
>








>
|
|






>
|
>







 







|







128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
...
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<p><strong>LuaSQLite 3</strong> - a Lua 5.1 to 5.3 wrapper for the SQLite3 library</p>
<p>
</p>
<hr />
<h1><a name="overview">OVERVIEW</a></h1>
<p><strong>LuaSQLite 3</strong> is a thin wrapper around the public domain SQLite3
database engine.</p>
<p>There are two modules, identical except that one links SQLite3 dynamically, the other 
statically.</p>
<p>The module <code>lsqlite3</code> links SQLite3 dynamically. 
To use this module you need the SQLite3 library (DLL or .so).
You can get it from <a href="http://www.sqlite.org/">http://www.sqlite.org/</a>
</p>
<p>The module <code>lsqlite3complete</code> links SQLite3 statically.
The SQLite3 amalgamation source code is included in 
the LuaSQLite 3 distribution.</p>
<p>Both modules support the creation and manipulation of 
SQLite3 databases. After a <code>sqlite3 = require('lsqlite3')</code> 
(or <code>sqlite3 = require('lsqlite3complete')</code>) the exported 
functions are called with prefix <code>sqlite3</code>. However, most sqlite3 
functions are called via an object-oriented interface to either 
database or SQL statement objects; see below for details.</p>
<p>This documentation does not attempt to describe how SQLite3 itself
works, it just describes the Lua binding and the available functions.
For more information about the SQL features supported by SQLite3 and
details about the syntax of SQL statements and queries, please see the
<strong>SQLite3 documentation</strong> 
<a href="http://www.sqlite.org/">http://www.sqlite.org/</a>. 
Using some of the
advanced features (how to use callbacks, for instance) will require 
some familiarity with the SQLite3 API.</p>
<p>
</p>
<hr />
<h1><a name="download">DOWNLOAD</a></h1>
<p><strong>LuaSQLite 3</strong> source code can be downloaded from its 
Fossil (<a href="http://lua.sqlite.org/">http://lua.sqlite.org/</a>) page.</p>
<p>For <code>lsqlite3</code> (but not for <code>lsqlite3complete</code>) you will also need to 
build or obtain an SQLite3 loadable library (DLL or .so). 
See <a href="http://www.sqlite.org/">http://www.sqlite.org/</a> for obtaining SQLite3 
source code or downloading a binary SQLite3 library.</p>
<p>
</p>
<hr />
<h1><a name="installation">INSTALLATION</a></h1>
<p>Luarocks (<a href="http://luarocks.org/">http://luarocks.org/</a>) is the preferred mechanism 
to build and install <code>lsqlite3</code> or <code>lsqlite3complete</code>; for 
<code>lsqlite3</code> it assumes an SQLite3 library is already installed. For 
<code>lsqlite3complete</code> no SQLite3 library is needed.</p>
<p>
</p>
<hr />
<h1><a name="examples">EXAMPLES</a></h1>
<p>The distribution contains an <em>examples</em> directory. The unit tests
also show some example use.</p>
<p>
................................................................................
<hr />
<h1><a name="verification_tests">VERIFICATION TESTS</a></h1>
<p>The distribution contains a <em>tests</em> directory with some units tests using 
an enhanced version of Michael Roth's <code>lunit</code> called <code>lunitx</code>. Some of the 
tests were also derived from Michael's <strong>lua-sqlite3</strong> module, and more unit tests 
added by Doug Currie. Get <code>lunitx</code> using Luarocks.</p>
<p>The distribution also contains some functional tests by Tiago.</p>
<p>This version of <code>lsqlite3</code> was tested with SQLite 3.11.0 and 3.15.1.</p>
<p>
</p>
<hr />
<h1><a name="reference">REFERENCE</a></h1>
<p>
</p>
<hr />