# sqlite-jdbc **Repository Path**: xialh/sqlite-jdbc ## Basic Information - **Project Name**: sqlite-jdbc - **Description**: SQLite JDBC Driver - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 4 - **Forks**: 0 - **Created**: 2020-10-21 - **Last Updated**: 2024-05-28 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README SQLite JDBC Driver [![Build Status](https://travis-ci.org/xerial/sqlite-jdbc.svg?branch=master)](https://travis-ci.org/xerial/sqlite-jdbc) [![Join the chat at https://gitter.im/xerial/sqlite-jdbc](https://badges.gitter.im/xerial/sqlite-jdbc.svg)](https://gitter.im/xerial/sqlite-jdbc?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ================== SQLite JDBC is a library for accessing and creating [SQLite](http://sqlite.org) database files in Java. Our SQLiteJDBC library requires no configuration since native libraries for major OSs, including Windows, Mac OS X, Linux etc., are assembled into a single JAR (Java Archive) file. The usage is quite simple; [download](https://github.com/xerial/sqlite-jdbc/releases) our sqlite-jdbc library, then append the library (JAR file) to your class path. See [the sample code](#usage). [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.xerial/sqlite-jdbc/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.xerial/sqlite-jdbc/) [![javadoc](https://javadoc.io/badge2/org.xerial/sqlite-jdbc/javadoc.svg)](https://javadoc.io/doc/org.xerial/sqlite-jdbc) * Release versions: [Download](https://github.com/xerial/sqlite-jdbc/releases) or Maven https://oss.sonatype.org/content/repositories/releases/org/xerial/sqlite-jdbc/ * Latest snapshot (pre-release) versions are also available: https://oss.sonatype.org/content/repositories/snapshots/org/xerial/sqlite-jdbc/ Post bug reports or feature requests to [Issue Tracker](https://github.com/xerial/sqlite-jdbc/issues) Usage ============ SQLite JDBC is a library for accessing SQLite databases through the JDBC API. For the general usage of JDBC, see [JDBC Tutorial](http://docs.oracle.com/javase/tutorial/jdbc/index.html) or [Oracle JDBC Documentation](http://www.oracle.com/technetwork/java/javase/tech/index-jsp-136101.html). 1. Download sqlite-jdbc-(VERSION).jar from the [download page](https://github.com/xerial/sqlite-jdbc/releases) (or by using [Maven](#using-sqlitejdbc-with-maven2)) then append this jar file into your classpath. 2. Open a SQLite database connection from your code. (see the example below) * More usage examples are available at [Usage](Usage.md) * Usage Example (Assuming `sqlite-jdbc-(VERSION).jar` is placed in the current directory) ``` > javac Sample.java > java -classpath ".;sqlite-jdbc-(VERSION).jar" Sample # in Windows or > java -classpath ".:sqlite-jdbc-(VERSION).jar" Sample # in Mac or Linux name = leo id = 1 name = yui id = 2 ``` **Sample.java** ```java import java.sql.Connection; import java.sql.DriverManager; import java.sql.ResultSet; import java.sql.SQLException; import java.sql.Statement; public class Sample { public static void main(String[] args) { Connection connection = null; try { // create a database connection connection = DriverManager.getConnection("jdbc:sqlite:sample.db"); Statement statement = connection.createStatement(); statement.setQueryTimeout(30); // set timeout to 30 sec. statement.executeUpdate("drop table if exists person"); statement.executeUpdate("create table person (id integer, name string)"); statement.executeUpdate("insert into person values(1, 'leo')"); statement.executeUpdate("insert into person values(2, 'yui')"); ResultSet rs = statement.executeQuery("select * from person"); while(rs.next()) { // read the result set System.out.println("name = " + rs.getString("name")); System.out.println("id = " + rs.getInt("id")); } } catch(SQLException e) { // if the error message is "out of memory", // it probably means no database file is found System.err.println(e.getMessage()); } finally { try { if(connection != null) connection.close(); } catch(SQLException e) { // connection close failed. System.err.println(e.getMessage()); } } } } ``` How to Specify Database Files ----------------------------- Here is an example to select a file `C:\work\mydatabase.db` (in Windows) Connection connection = DriverManager.getConnection("jdbc:sqlite:C:/work/mydatabase.db"); A UNIX (Linux, Mac OS X, etc) file `/home/leo/work/mydatabase.db` Connection connection = DriverManager.getConnection("jdbc:sqlite:/home/leo/work/mydatabase.db"); How to Use Memory Databases --------------------------- 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: Connection connection = DriverManager.getConnection("jdbc:sqlite::memory:"); ## Configuration sqlite-jdbc extracts a native library for your OS to the directory specified by `java.io.tmpdir` JVM property. To use another directory, set `org.sqlite.tmpdir` JVM property to your favorite path. News ==== * 2020-07-28: sqlite-jdbc-3.32.3.2 * Enable SQLITE_MAX_MMAP_SIZE compile option again. * Fixes issues when using Arm Cortex A8, A9 (32-bit architecture) * 2020-07-15: sqlite-jdbc-3.32.3.1 * Remove SQLITE_MAX_MMAP_SIZE compile option, which might be causing performance issuess. * 2020-06-18: sqlite-jdbc-3.32.3 * Fix multiple CVE reported issues https://github.com/xerial/sqlite-jdbc/issues/501 * 2020-05-04: sqlite-jdbc-3.31.1 * Upgrade to sqlite 3.31.1 * Support update/commit/rollback event notifications #350 * Remove sparse index checks #476 * Support alpine linux (Linux-alpine) * Enabled SQLITE_ENABLE_STAT4 flag * 2019-12-23: sqlite-jdbc-3.30.1 * Upgrade to sqlite 3.30.1 * Various fixes * 2019-06-24: sqlite-jdbc-3.28.0 * Upgrade to sqlite 3.28.0 * 2019-03-20: sqlite-jdbc-3.27.2.1 * Make smaller the jar size by using -Os compiler option * Performance improvement for concurrent access. * 2019-03-18: sqlite-jdbc-3.27.2 * Upgrade to SQLite [3.27.2](https://www.sqlite.org/releaselog/3_27_2.html) * 2018-10-01: sqlite-jdbc-3.25.2 * Upgrade to SQLite [3.25.2](https://www.sqlite.org/releaselog/3_25_2.html) * Fixes #74, #318, #349, #363, #365 * Upsert is supported since this version. * 2018-05-25: sqlite-jdbc-3.23.1 * Upgrade to SQLite [3.23.1](https://www.sqlite.org/releaselog/3_23_1.html) * Fixes #312, #321, #323, #328 * Dropped linux armv6 support temporarily * 2017-12-07: sqlite-jdbc-3.21.0.1 * Metadata query fixes * Fix for Android * 2017-11-14: sqlite-jdbc-3.21.0 * Upgrade to SQLite [3.21.0](https://www.sqlite.org/releaselog/3_21_0.html) * Various fixes for metadata queries * 2017-10-08: sqlite-jdbc-3.20.1 * Upgrade to SQLite [3.20.1](https://www.sqlite.org/releaselog/3_20_1.html) * Various bug fixes * 2017-08-04: sqlite-jdbc-3.20.0 * Upgrade to SQLite [3.20.0](https://www.sqlite.org/releaselog/3_20_0.html) * Support Linux aarch64 * Fix #239 * 2017-06-22: sqlite-jdbc-3.19.3 * Upgrade to SQLite [3.19.3](https://www.sqlite.org/releaselog/3_19_3.html) * 2017-05-18: sqlite-jdbc-3.18.0 * Upgrade to SQLite [3.18.0](http://sqlite.org/releaselog/3_18_0.html) * 2017-01-10: sqlite-jdbc-3.16.1 * Upgrade to SQLite [3.16.1](https://sqlite.org/releaselog/3_16_1.html) * Add experimental support for ppc64, armv5, v6 (Raspberry PI), v7 and android-arm. * Fix a bug in prepared statements #74 * Building all native libraries using cross compilers in docker images * 2016-11-04: sqlite-jdbc-3.15.1 * Upgrade to SQLite [3.15.1](https://sqlite.org/releaselog/3_15_1.html) * 2016-11-04: sqlite-jdbc-3.15.0 * Upgrade to SQLite [3.15.0](https://sqlite.org/releaselog/3_15_0.html) * Cleanup extracted temp library files upon start * Fix various metadata problems * 2016-09-30: sqlite-jdbc-3.14.2.1 * Improved the performance for single-threaded applications (#162) * 2016 09-26: sqlite-jdbc-3.14.2 * Updated binaries (Using docker for the ease of cross compiling) * Fixes native libraries for Raspberry-Pi * Dropped support for Mac x86 (The last Mac OS X supporting this architecture was Snow Leopard, 7-year ago!) * Default support of JSON1 extension (#76, #127) * Implement query progress callback (#137) * Use extended error codes (#119) * 2015 Oct 3rd: sqlite-jdbc-3.8.11.2 * Fix for Raspberry-Pi 2 * Add multiple table support for DatabaseMetaData.getColumns * 2015 August 3rd: sqlite-jdbc-3.8.11.1 * Fix for Linux ARM native library * 2015 July 29th: sqlite-jdbc-3.8.11 release. * General performance improvement * warning: No update for FreeBSD binary (need a contribution of native library!) * 2015 July 27th: sqlite-jdbc-3.8.10.2 release (Thread-safe date time) * 2015 May 11th: sqlite-jdbc-3.8.10.1 release * 2015 May 7th: sqlite-jdbc-3.8.9.1 release * 2014 October 20th: [sqlite-jdbc-3.8.7](https://bitbucket.org/xerial/sqlite-jdbc/downloads/sqlite-jdbc-3.8.7.jar) released. * Fixed the native code loading mechanism to allow loading sqlite-jdbc from multiple class loaders. * 2014 October 8th: [sqlite-jdbc-3.8.6](https://bitbucket.org/xerial/sqlite-jdbc/downloads/sqlite-jdbc-3.8.6.jar) released. * 2014 August 7th: [sqlite-jdbc-3.8.5-pre1](https://bitbucket.org/xerial/sqlite-jdbc/downloads/sqlite-jdbc-3.8.5-pre1.jar) released. * 2014 January 5th: [sqlite-jdbc4-3.8.2-SNAPSHOT](https://bitbucket.org/xerial/sqlite-jdbc/downloads/sqlite-jdbc-3.8.2-SNAPSHOT.jar) Introduced JDBC4 version of driver. (Requires at least Java 6). * Source code is on branch [feature/jdbc4](https://bitbucket.org/xerial/sqlite-jdbc/branch/feature/jdbc4) * 2013 August 27th: sqlite-jdbc-3.8.0 snapshot version is [available](https://oss.sonatype.org/content/repositories/snapshots/org/xerial/sqlite-jdbc/3.8.0-SNAPSHOT/) * 2013 August 19th: [sqlite-jdbc-3.7.15-M1](https://bitbucket.org/xerial/sqlite-jdbc/downloads/sqlite-jdbc-3.7.15-M1.jar) * 2013 March 24th : [sqlite-jdbc-3.7.15-SNAPSHOT-2](https://bitbucket.org/xerial/sqlite-jdbc/downloads/sqlite-jdbc-3.7.15-SNAPSHOT-2.jar) * 2013 January 22nd: The repositories and documentations were moved to the bitbucket. * 2012 December 15th: [sqlite-jdbc-3.7.15-SNAPSHOT](https://bitbucket.org/xerial/sqlite-jdbc/downloads/sqlite-jdbc-3.7.15-SNAPSHOT.jar) * Removed pure-java. * 2010 August 27th: [sqlite-jdbc-3.7.2](http://www.xerial.org/maven/repository/snapshot/org/xerial/sqlite-jdbc/) released * 2010 April 3rd: [beta release of sqlite-jdbc-3.6.23.1-SNAPSHOT](http://www.xerial.org/maven/repository/snapshot/org/xerial/sqlite-jdbc/) * Added online backup/restore functions. Syntax: `backup to (file name)`, `restore from (file name)`. * 2009 December 10th: [sqlite-jdbc-3.6.20.1](http://www.xerial.org/maven/repository/artifact/org/xerial/sqlite-jdbc/3.6.20.1/) release. * Read-only connection, recursive trigger, foreign key validation support etc. using SQLiteConfig class. SQLiteConfig config = new SQLiteConfig(); // config.setReadOnly(true); config.setSharedCache(true); config.recursiveTriggers(true); // ... other configuration can be set via SQLiteConfig object Connection conn = DriverManager.getConnection("jdbc:sqlite:sample.db", config.toProperties()); * 2009 November 12th: [sqlite-jdbc-3.6.19](http://www.xerial.org/maven/repository/artifact/org/xerial/sqlite-jdbc/3.6.19/) released. * added 64-bit OS support: 64-bit native SQLite binaries for Windows (x86\_64), Mac (x86\_64) and Linux (adm64) are available. * 2009 August 19th: [sqlite-jdbc-3.6.17.1](http://www.xerial.org/maven/repository/artifact/org/xerial/sqlite-jdbc/3.6.17.1/) released. * 2009 July 2nd: [sqlite-jdbc-3.6.16](http://www.xerial.org/maven/repository/artifact/org/xerial/sqlite-jdbc/3.6.16/) release. * 2009 June 4th: [sqlite-jdbc-3.6.14.2](http://www.xerial.org/maven/repository/artifact/org/xerial/sqlite-jdbc/3.6.14.2/) released. * 2009 May 19th: [sqlite-jdbc-3.6.14.1](http://www.xerial.org/maven/repository/artifact/org/xerial/sqlite-jdbc/3.6.14.1/) released. * This version supports "jdbc:sqlite::resource:" syntax to access read-only DB files contained in JAR archives, or external resources specified via URL, local files address etc. (see also the [details](http://groups.google.com/group/xerial/browse_thread/thread/39acb38f99eb2469/fc6afceabeaa0f76?lnk=gst&q=resource#fc6afceabeaa0f76)) * 2009 February 18th: sqlite-jdbc-3.6.11 released. * Fixed a bug in `PrepStmt`, which does not clear the batch contents after `executeBatch()`. [Discussion](http://groups.google.com/group/xerial/browse_thread/thread/1fa83eb36f6d5dab). * 2009 January 19th: sqlite-jdbc-3.6.10 released. This version is compatible with sqlite version 3.6.10. * Added `READ_UNCOMMITTED` mode support for better query performance: (see also ) // READ_UNCOMMITTED mode works only in shared_cache mode. Properties prop = new Properties(); prop.setProperty("shared_cache", "true"); Connection conn = DriverManager.getConnection("jdbc:sqlite:", prop); conn.setTransactionIsolation(Conn.TRANSACTION_READ_UNCOMMITTED); * 2008 December 17th: sqlite-jdbc-3.6.7 released. * Related information: * 2008 December 1st: sqlite-jdbc-3.6.6.2 released, * Fixed a bug incorporated in the version 3.6.6 * 2008 November 20th: sqlite-jdbc-3.6.6 release. * Related information sqlite-3.6.6 changes: * 2008 November 11th: sqlite-jdbc-3.6.4.1. A bug fix release * Pure-java version didn't work correctly. Fixed in both 3.6.4.1 and 3.6.4. If you have already downloaded 3.6.4, please obtain the latest one on the download page. * 2008 October 16th: sqlite-jdbc-3.6.4 released. * Changes from SQLite 3.6.3: * `R*-Tree` index and `UPDATE/DELTE` syntax with `LIMIT` clause are available from this build. * 2008 October 14th: sqlite-jdbc-3.6.3 released. Compatible with SQLite 3.6.3. * 2008 September 18th: sqlite-jdbc-3.6.2 released. Compatible with SQLite 3.6.2 and contains pure-java and native versions. * 2008 July 17th: sqlite-jdbc-3.6.0 released. Compatible with SQLite 3.6.0, and includes both pure-java and native versions. * 2008 July 3rd: [sqlite-jdbc-3.5.9-universal](http://www.xerial.org/maven/repository/artifact/org/xerial/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. * 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. * 2008 May 20th: sqlite-jdbc-3.5.9 released. * 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. * 2008 May 1st: sqlite-jdbc is now in the maven central repository! [How to use SQLiteJDBC with Maven2](#using-sqlite-jdbc-with-maven2) * 2008 Mar. 18th: sqlite-jdbc-3.5.7 released. * This version corresponds to [SQLite 3.5.7](http://www.sqlite.org/releaselog/3_5_7.html). * 2008 Mar. 10th: sqlite-jdbc-v042 released. * Corresponding to SQLite 3.5.6, which integrates FTS3 (full text search). * 2008 Jan. 31st: sqlite-jdbc-v038.4 released. * SQLiteJDBCLoader.initialize() is no longer required. * 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. * 2007 Dec. 31th: Upgraded to sqlitejdbc-v038 Download ======== Download the latest version of SQLiteJDBC from the [downloads page](https://bitbucket.org/xerial/sqlite-jdbc/downloads). Beta Release ------------ The early releases (beta) of sqlite-jdbc with some advanced features are available from [here](https://bitbucket.org/xerial/sqlite-jdbc/downloads) * The old releases are still available from [here](https://repo1.maven.org/maven2/org/xerial/sqlite-jdbc/), but the site might be closed in future. Supported Operating Systems =========================== Since sqlite-jdbc-3.6.19, the natively compiled SQLite engines will be used for the following operating systems: * Windows (Windows, x86 architecture, x86_64) * Mac OS X x86_64 (Support for SnowLeopard (i386) has been deprecated) * Linux x86, x86_64, arm (v5, v6, v7 and for android), ppc64 In the other OSs not listed above, the pure-java SQLite is used. (Applies to versions before 3.7.15) If you want to use the native library for your OS, [build the source from scratch. How does SQLiteJDBC work? ------------------------- 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. License ------- This program follows the Apache License version 2.0 ( ) That means: It allows you to: * freely download and use this software, in whole or in part, for personal, company internal, or commercial purposes; * use this software in packages or distributions that you create. It forbids you to: * redistribute any piece of our originated software without proper attribution; * use any marks owned by us in any way that might state or imply that we xerial.org endorse your distribution; * use any marks owned by us in any way that might state or imply that you created this software in question. It requires you to: * include a copy of the license in any redistribution you may make that includes this software; * provide clear attribution to us, xerial.org for any distributions that include this software It does not require you to: * 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; * submit changes that you make to the software back to this software (though such feedback is encouraged). See License FAQ for more details. Using SQLiteJDBC with Maven2 ============================ If you are familiar with [Maven2](http://maven.apache.org), 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 [Maven's central repository](https://repo1.maven.org/maven2/org/xerial/sqlite-jdbc/). org.xerial sqlite-jdbc (version) To use snapshot/pre-release versions, add the following repository to your Maven settings: * Pre-release repository: * Snapshot repository: ### Hint for maven-shade-plugin You may need to add shade plugin transformer to solve `No suitable driver found for jdbc:sqlite:` issue. ```xml META-INF/services/java.sql.Driver ``` Using SQLiteJDBC with Tomcat6 Web Server ======================================== (The following note is no longer necessary since sqlite-jdbc-3.8.7) 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". Work-around of this problem is to put `sqlite-jdbc-(version).jar` file into `(TOMCAT_HOME)/lib` directory, in which multiple web applications can share the same native library file (.dll, .jnilib, .so) extracted from this sqlite-jdbc jar file. 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. org.xerial sqlite-jdbc (version) provided What is different from Zentus' SQLite JDBC? -------------------------------------------- The current sqlite-jdbc implementation is forked from [Zentus' SQLite JDBC driver](https://github.com/crawshaw/sqlitejdbc). We have improved it in two ways: * Support major operating systems by embedding native libraries of SQLite, compiled for each of them. * Remove manual configurations In the original version, in order to use the native version of sqlite-jdbc, users had to set a path to the native codes (dll, jnilib, so files, etc.) through the command-line arguments, e.g., `-Djava.library.path=(path to the dll, jnilib, etc.)`, or `-Dorg.sqlite.lib.path`, etc. This process was error-prone and bothersome to tell every user to set these variables. Our SQLiteJDBC library completely does away these inconveniences. Another difference is that we are keeping this SQLiteJDBC library up-to-date to the newest version of SQLite engine, because we are one of the hottest users of this library. For example, SQLite JDBC is a core component of [UTGB (University of Tokyo Genome Browser) Toolkit](http://utgenome.org/), which is our utility to create personalized genome browsers.