mksqlite documentation

mksqlite

mksqlite is an open source project to implement an interface between MATLAB and SQLite.

You can use the command "mksqlite" to benefit from all features of SQLite.
Simply issue the command "mksqlite('SELECT * FROM database')" and you get an array of
structures with the results of the query.

Versions

mksqlite is build on top of SQLite.
As MATLAB versions the releases R13SP1, R14SP2, 2006a, 2008b, 2009a, 2010a..2014b were tested.
mksqlite runs on Windows, Linux and MAC OS-X systems.

Installation

You can get the windows binaries from https://sourceforge.net/projects/mksqlite/files/
Unzip the contents of the ZIP file into a directory and insert this directory to
the MATLAB search path.
You can create other versions of mksqlite via the source package.

Use the sourcecode

You can find the sourcecode of mksqlite at https://sourceforge.net/projects/mksqlite/files/
The Microsoft Visual C++ Compiler version 2003, 2005, 2010 or 2014 is needed to compile mksqlite on windows systems.
Just use the MATLAB script "buildit.m" to compile them to a MEX-DLL.

Online help

There is a german online help available, just type "help mksqlite" in the MATLAB command window.

Usage

You can use mksqlite like any other M-Script command:

dbid = mksqlite([dbid, ] SQLQuery [, Argument])

The parameter dbid is optional and is needed only if you want
to use several data bases at the same time. If dbid was omitted,
then the data base id 1 is used.

Function calls:

mksqlite('open', 'databasefile' [,'ro'|'rw'|'rwc'] [,'single'|'multi'|'serial'])

or

dbid = mksqlite(0, 'open', 'databasefile' [,...])

Opens the database "databasefile". If there is no such database, then it will
be created. If you use the dbid of an already opened database, than this db will be
closed first. If you use the dbid 0, then the next free dbid will be
used and returned by the function call.

mksqlite('close')

or

mksqlite(dbid, 'close')

or

mksqlite(0, 'close')

Closes the databasefile. If you use dbid 0, then all databases will be closed.

mksqlite('SQL-Query')

or

mksqlite(dbid, 'SQL-Query')

Executes the query and returns the results..

FAQ

My Windows MATLAB doesn't find mksqlite.

Be sure that you have placed mksqlite.mexw32 inside the MATLAB path
or in the current directory.

MATLAB shows "Attempt to execute SCRIPT mksqlite as a function"

It seems that you are using an older version of MATLAB.
Try to rename the file "mksqlite.mexw32" to "mksqlite.dll"
or build a new version of mksqlite from the source package.

Does mksqlite work on 64Bit MATLAB, on Solaris, Linux, OS-X, ...

Yes, there are 64Bit versions inside the binary package.
(mksqlite.mexw64, mksqlite.mexa64)

How can I rebuild mksqlite?

You need MATLAB and a compiler. The compiler must be useable to build
MATLAB MEX-extensions. You can use on of the Microsoft Compiler
on Windows, or a GNU compiler on other Systems.
You will find the MATLAB script "buildit.m" inside the source package. Just
start it from the MATLAB prompt.

The SQLite database seems to be very slow. Can I speedup my operations?

SQLite uses a journal file for every write operation. This slows down any
change on the database. Try to use transactions for a block of change operations
or change the journal functions with SQLite pragma commands.
You can find more informations inside of the SQLite documentation.

How can I catch mksqlite errors?

You can use the standard MATLAB try ... catch functions.

What does mksqlite costs?

You can use mksqlite without any cost.
But if you mean that this software is worth a donation,
Just send me a mail with your offer.

I need a new functionality, what's about new functions?

If you have implemented a new function or have an idea how something can
made better, just send me an email. Maybe I will implement this function
or I can give you a hint how you can work with the current functionality.

Can I do something to help develop mksqlite?

Sure, documentation, translation, extensions, give me notes about errors, ...
Or just give me a note how do you use mksqlite.

Which license does mksqlite have?

mksqlite is LGPL

eMail Contact:
Martin Kortmann, mail@kortmann.de Andreas Martin, andimartin@users.sourceforge.net