Fix some declarations after code
[jimtcl.git] / sqlite3 / README
blobd1094dddf224770d81911b513f6f9242ee4153fb
1 Full sqlite3 Extension for Jim Tcl
2 ==================================
4 Author: Steve Bennett <steveb@workware.net.au>
5 Date: Thu 24 Nov 2011
7 This directory builds a Jim Tcl extension containing a complete sqlite3 implementation and binding.
9 Building
10 --------
12 Ensure that you have configured and built jim in the source directory, then:
14 $ make
16 ./build-ext -o sqlite3.so -I.. -L.. -DSQLITE_OMIT_LOAD_EXTENSION=1 ... jim-sqlite3.c sqlite3.c
17 Building sqlite3.so from jim-sqlite3.c sqlite3.c
19 Warning: libjim is static. Dynamic module may not work on some platforms.
21 Compile: jim-sqlite3.o
22 Compile: sqlite3.o
23 Link:    sqlite3.so
25 Success!
27 Testing
28 -------
30 $ make test
32 Installing
33 ----------
35 Copy sqlite3.so to your jim library directory, typically /usr/local/lib/jim or
36 where $JIMLIB points to.
38 Using
39 -----
40 In your Jim Tcl code, ensure that sqlite3.so is in a directory on $auto_path.
41 Then:
43   package require sqlite3
45   sqlite3 db test.db
46   ...etc..
48 Documentation
49 -------------
51 The Jim Tcl binding is almost exactly identical to the Tcl binding.
52 See http://www.sqlite.org/tclsqlite.html for documentation.
54 Differences:
55 - INCRBLOB is not supported as Jim Tcl does not support channels
56 - No attempt is made to change encoding between Jim Tcl and sqlite
57 - Jim Tcl doesn't differentiate between binary data (bytearray) and
58   string, so only the @field syntax causes a fieldsto be bound
59   as a blob rather than text.
60 - Jim Tcl doesn't have a boolean type