[maven-release-plugin] prepare for next development iteration

[xerial/sqlite-jdbc.git] / SQLiteJDBC.wiki

[[PageOutline]]\r
\r
= SQLite JDBC Driver =\r
\r
SQLite JDBC driver, which is developed by [wiki:leo Taro L. Saito], is an extension of [http://www.zentus.com/sqlitejdbc Zentus's SQLite JDBC driver] that enables you to access [http://sqlite.org SQLite] database files in Java codes.\r
\r
Our SQLiteJDBC library, which is developed as a part of [http://www.xerial.org Xerial project], requires no configuration, since all native libraries for Windows, Mac OS X, Linux, Soralis, etc. and the pure-java SQLite, which works in any enviroment, are assembled into a single JAR (Java Archive) file. Usage is quite simple; [#Download Download] our sqlite-jdbc library, then append the jar file to your class path. \r
\r
== What is different from Zentus's SQLite JDBC? ==\r
\r
The original Zentus's SQLite JDBC driver http://www.zentus.com/sqlitejdbc/ itself is an excellent utility for using [http://sqlite.org SQLite] databases from Java language, and our SQLiteJDBC library also relies on its implementation. However, SQLite JDBC driver's pure-java version, which totally translates c/c++ codes of SQLite into Java, is significantly slower than its native version, which uses SQLite native binaries compiled for each OS (win, mac, linux). \r
\r
On the other hand, in order to use the native version, user has to set a path to the native codes (dll, jnilib, so files, which are JNDI C programs) by using command-line arguments, e.g., -Djava.library.path=(path to the dll, jnilib, etc.), or -Dorg.sqlite.lib.path, etc. This process is error-prone, and bothersome to tell every user to set these variables. Our SQLiteJDBC library completely does away these inconveniences. \r
\r
\r
== Public Discussion Forum == \r
 * Post bug reports or feature requests to [http://groups.google.com/group/xerial Xerial Public Discussion Group] \r
\r
== News ==\r
 * 2008 October 14th: sqlite-jdbc-3.6.3 released. Compatible with SQLite 3.6.3.\r
 * 2008 September 18th: sqlite-jdbc-3.6.2 released. Compatible with SQLite 3.6.2 and contains pure-java and native versions.\r
 * 2008 July 17th: sqlite-jdbc-3.6.0 released. Compatible with SQLite 3.6.0, and includes both pure-java and native versions. \r
 * 2008 July 3rd: [http://www.xerial.org/maven/repository/artifact/org/xerial/sqlite-jdbc/3.5.9-universal sqlite-jdbc-3.5.9-universal] released. This version contains both native and pure-java SQLite libraries, so it probably works in any OS environment.  \r
\r
 * 2008 May 29th: Current development revision (sqlite-jdbc-3.5.9-1) can be compiled with JDK 6. No need to use JDK 1.5 for compiling SQLiteJDBC. \r
 * 2008 May 20th: sqlite-jdbc-3.5.9 released.\r
 * 2008 May 20th: sqlite-jdbc-3.5.8 released (corresponding to SQLite 3.5.8 and sqlite-jdbc-v047). From this release, Windows, Mac OS X, Linux (i386, amd64) and Solaris (SunOS, sparcv9) libraries are bundled into one jar file.\r
 * 2008 May 1st: sqlite-jdbc is now in the maven central repository! [#UsingSQLiteJDBCwithMaven2 How to use SQLiteJDBC with Maven2]\r
 * 2008 Mar. 18th: sqlite-jdbc-3.5.7 released. This version corresponds to [http://www.sqlite.org/releaselog/3_5_7.html SQLite 3.5.7].\r
\r
 * 2008 Mar. 10th: sqlite-jdbc-v042 released. Corresponding to SQLite 3.5.6, which integrates FTS3 (full text search). \r
 * 2008 Jan. 31st: sqlite-jdbc-v038.4 released.   SQLiteJDBCLoder.initialize() is no longer requried. \r
 * 2008 Jan. 11th: The Jar files for Windows, Mac OS X and Linux are packed into a single Jar file! So, no longer need to use an OS-specific jar file.\r
 * 2007 Dec. 31th: Upgraded to sqlitejdbc-v038\r
\r
== Download ==\r
Download the latest version of SQLiteJDBC from [http://www.xerial.org/maven/repository/artifact/org/xerial/sqlite-jdbc here]. \r
 * version 3.6.3 is the latest one. \r
  * Do not use sqlite-jdbc-v0xx.jar, which are obsolete libraries but left here for users still using these versions. \r
\r
If your are an [http://maven.apache.org Maven] user, follow the instruction described [#UsingSQLiteJDBCwithMaven2 here].\r
\r
== Supported Operating Systems ==\r
Since the sqlite-jdbc-3.5.9-universal, any OSs that can run Java programs are supported. The natively compiled SQLite engines will be used in the following operating systems:\r
\r
 * Windows XP, Vista  (Windows, x86 architecture)\r
 * Mac OS X 10.4 (Tiger), 10.5(Leopard) (for i386, Intel CPU machines)\r
 * Linux i386 (Intel), amd64 (64-bit X86 Intel processor) \r
\r
In the other OSs not listed above, the pure-java SQLite is used.\r
\r
If you want to use the native library for your OS, [#BuildfromSource build the source from scratch].\r
\r
\r
== Usage ==\r
\r
 1. Download sqlite-jdbc-(VERSION).jar from [http://www.xerial.org/maven/repository/artifact/org/xerial/sqlite-jdbc/], then append this jar file into your classpath. \r
 1. load the JDBC driver org.sqlite.JDBC from your code. (see the example below)\r
\r
 * Usage Example (Assuming sqlite-jdbc-(VERSION).jar is placed in the current directory)\r
{{{\r
> javac Sample.java\r
> java -classpath ".:sqlite-jdbc-(VERSION).jar" Sample \r
name = leo\r
id = 1\r
name = yui\r
id = 2\r
}}}\r
 * Sample.java\r
{{{\r
#!java\r
import java.sql.Connection;\r
import java.sql.DriverManager;\r
import java.sql.ResultSet;\r
import java.sql.SQLException;\r
import java.sql.Statement;\r
\r
\r
public class Sample\r
{\r
  public static void main(String[] args) throws ClassNotFoundException\r
  {\r
    // load the sqlite-JDBC driver using the current class loader\r
    Class.forName("org.sqlite.JDBC");\r
    \r
    Connection connection = null;\r
    try\r
    {\r
      // create a database connection\r
      connection = DriverManager.getConnection("jdbc:sqlite:sample.db");\r
      Statement statement = connection.createStatement();\r
      statement.setQueryTimeout(30);  // set timeout to 30 sec.\r
      \r
      statement.executeUpdate("drop table if exists person");\r
      statement.executeUpdate("create table person (id integer, name string)");\r
      statement.executeUpdate("insert into person values(1, 'leo')");\r
      statement.executeUpdate("insert into person values(2, 'yui')");\r
      ResultSet rs = statement.executeQuery("select * from person");\r
      while(rs.next())\r
      {\r
        // read the result set\r
        System.out.println("name = " + rs.getString("name"));\r
        System.out.println("id = " + rs.getInt("id"));\r
      }\r
    }\r
    catch(SQLException e)\r
    {\r
      // if the error message is "out of memory", \r
      // it probably means no database file is found\r
      System.err.println(e.getMessage());\r
    }\r
    finally\r
    {\r
      try\r
      {\r
        if(connection != null)\r
          connection.close();\r
      }\r
      catch(SQLException e)\r
      {\r
        // connection close failed.\r
        System.err.println(e);\r
      }\r
    }\r
  }\r
}\r
}}}\r
\r
The usage of SQLite-JDBC driver is the same with the original version. See http://www.zentus.com/sqlitejdbc/ for the general usage. For usage of JDBC, see  [http://www.xerial.org/trac/Xerial/wiki/WebApplication/JDBC my article] about JDBC.\r
\r
== How to Specify Database Files ==\r
Here is an example to select a file C:\work\mydatabase.db (in Windows)\r
{{{\r
#!java\r
Connection connection = DriverManager.getConnection("jdbc:sqlite:C:/work/mydatabase.db");\r
}}}\r
\r
A UNIX (Linux, Mac OS X, etc) file /home/leo/work/mydatabase.db\r
{{{\r
#!java\r
Connection connection = DriverManager.getConnection("jdbc:sqlite:/home/leo/work/mydatabase.db");\r
}}}\r
\r
== How to Use Memory Databases ==\r
SQLite supports on-memory database management, which does not create any database files. To use a memory database in your Java code, get the database connection as follows:\r
{{{\r
#!java\r
Connection connection = DriverManager.getConnection("jdbc:sqlite::memory:");\r
}}}\r
\r
== How to test the running mode: Native or Pure-Java Version? ==\r
{{{\r
#!java\r
import org.xerial.db.sql.sqlite.SQLiteJDBCLoader;\r
\r
// in your function ...\r
void test()\r
{\r
  System.out.println(String.format("running in %s mode", SQLiteJDBCLoader.isNativeMode() ? "native" : "pure-java"));\r
}\r
\r
\r
}}}\r
\r
== Run in Pure-Java mode ==\r
\r
In some OS (e.g., old Linux kernel), loading native library causes JVM crashes. In this case, set sqlite.purejava=true JVM variable:\r
{{{\r
 > java -Dsqlite.purejava=true -cp .:sqlite-jdbc-3.6.3.jar Sample\r
}}}\r
\r
Or, set this System property before loading the JDBC driver:\r
{{{\r
  System.setProperty("sqlite.purejava", "true");\r
  Class.forName("org.sqlite.JDBC");\r
}}}\r
\r
In this mode, sqlite-jdbc never uses native SQLite libraries.\r
\r
== How does SQLiteJDBC work? ==\r
\r
Our SQLite JDBC driver package (i.e., sqlite-jdbc-(VERSION).jar) contains three types of native SQLite libraries (sqlite-jdbc.dll, sqlite-jdbc.jnilib, sqlite-jdbc.so), each of them is compiled for Windows, Mac OS and Linux. An appropriate native library file is automatically extracted into your OS's temporary folder, when your program loads "org.sqlite.JDBC" driver.  \r
\r
== Source Codes ==\r
 * Subversion Repository: http://www.xerial.org/svn/project/XerialJ/trunk/sqlite-jdbc/\r
   * version 3.6.3 snapshot: http://www.xerial.org/svn/project/XerialJ/tags/sqlite-jdbc/sqlite-jdbc-3.6.3\r
\r
web viewer: http://www.xerial.org/trac/Xerial/browser/XerialJ/trunk/sqlite-jdbc\r
\r
== License ==\r
\r
This program follows the Apache License version 2.0 (http://www.apache.org/licenses/ )\r
That means:\r
\r
It allows you to:\r
    * freely download and use this software, in whole or in part, for personal, company internal, or commercial purposes;\r
    * use this software in packages or distributions that you create.\r
\r
It forbids you to:\r
    * redistribute any piece of our originated software without proper attribution;\r
    * use any marks owned by us in any way that might state or imply that we xerial.org endorse your distribution;\r
    * use any marks owned by us in any way that might state or imply that you created this software in question.\r
\r
It requires you to:\r
    * include a copy of the license in any redistribution you may make that includes this software;\r
    * provide clear attribution to us, xerial.org for any distributions that include this software\r
\r
It does not require you to:\r
    * include the source of this software itself, or of any modifications you may have made to it, in any redistribution you may assemble that includes it;\r
    * submit changes that you make to the software back to this software (though such feedback is encouraged).\r
\r
See License FAQ http://www.apache.org/foundation/licence-FAQ.html for more details.\r
\r
== Using SQLiteJDBC with Maven2 ==\r
If you are familier with [http://maven.apache.org Maven2], add the following XML fragments into your pom.xml file. With those settings, your Maven will automatically download our SQLiteJDBC library into your local Maven repository, since our sqlite-jdbc libraries are synchronized with the [http://repo1.maven.org/maven2/org/xerial/sqlite-jdbc/ Maven's central repository]. \r
\r
{{{\r
#!xml\r
  <dependencies>\r
    <dependency>\r
      <groupId>org.xerial</groupId>\r
      <artifactId>sqlite-jdbc</artifactId>\r
      <version>3.6.3</version>\r
    </dependency>\r
  </dependencies>\r
}}}\r
\r
== Using SQLiteJDBC with Tomcat6 Web Server ==\r
Do not include sqlite-jdbc-(version).jar in WEB-INF/lib folder of your web application package, since multiple web applications hosted by the same Tomcat server cannot load the sqlite-jdbc native library more than once. That is the specification of JNI (Java Native Interface). You will observe UnsatisfiedLinkError exception with the message "no SQLite library found".\r
\r
Work-around of this problem is to put sqlite-jdbc-(version).jar file into (TOMCAT_HOME)/lib direcotry, in which multiple web applications can share the same native library file (.dll, .jnilib, .so) extracted from this sqlite-jdbc jar file. \r
\r
If you are using Maven for your web application, set the dependency scope as 'provided', and manually put the SQLite JDBC jar file into (TOMCAT_HOME)/lib folder.\r
{{{\r
    <dependency>\r
      <groupId>org.xerial</groupId>\r
      <artifactId>sqlite-jdbc</artifactId>\r
      <version>3.6.3</version>\r
      <scope>provided</scope>\r
    </dependency>\r
}}}\r
\r
== Build from Source ==\r
\r
If your OS is not supported, consider to build the [#SourceCodes source] from scratch. \r
\r
  * Install Java SDK (1.5 or higher) http://java.sun.com\r
  * Install [wiki:Subversion Subversion]\r
  * Install Maven2 (2.0.7 or higher) http://maven.apache.org\r
     * You need to set PATH variable so as to run mvn command. Here is an example setting for maven:\r
{{{\r
export MAVEN_HOME=$HOME/local/maven-2.0.7\r
export PATH=$MAVEN_HOME/bin:$PATH\r
}}}\r
  * Checkout the subversion repository\r
{{{ \r
 svn checkout http://www.xerial.org/svn/project/XerialJ/trunk/sqlite-jdbc sqlite-jdbc\r
}}}\r
  * (If necessary) set the JAVA_HOME environment variable as your JDK folder (e.g. /usr/java/jdk1.5.0_13), and PATH so that you can run the javac command.\r
{{{\r
 > export JAVA_HOME=/usr/java/jdk1.5.0_13/; export PATH=$JAVA_HOME/bin:$PATH\r
 > javac -version\r
 javac 1.5.0_13\r
}}}\r
  * Type make in the sqlite-jdbc folder:\r
{{{\r
 > make \r
}}}\r
  * An SQLite JDBC JAR file that can additionally support your OS is generated in target/sqlite-jdbc-(version).jar\r
\r
=== Dependency Tests ===\r
 * Windows XP (32-bit)\r
   * dependency check\r
{{{\r
> DUMPBIN /DEPENDENTS sqlitejdbc.dll\r
\r
  KERNEL32.dll\r
  msvcrt.dll\r
}}}\r
 * Mac OS X (10.4.10 Tiger ~ 10.5 Leopard)\r
   * dependency check\r
{{{\r
> otool -L libsqlitejdbc.jnilib  \r
libsqlitejdbc.jnilib:\r
        build/Darwin-i386/libsqlitejdbc.jnilib (compatibility version 0.0.0, current version 0.0.0)\r
        /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 88.3.9)\r
}}}\r
 * Linux (glibc-2.5.12)\r
   * Dependency check\r
{{{\r
> ldd libsqlitejdbc.so    \r
        linux-gate.so.1 =>  (0x00b45000)\r
        libc.so.6 => /lib/i686/nosegneg/libc.so.6 (0x002dd000)\r
        /lib/ld-linux.so.2 (0x47969000)\r
}}}\r
\r