org.sqlite.core.NativeDB Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2007 David Crawshaw
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package org.sqlite.core;
import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;
import java.sql.SQLException;
import java.text.MessageFormat;
import org.sqlite.BusyHandler;
import org.sqlite.Collation;
import org.sqlite.Function;
import org.sqlite.ProgressHandler;
import org.sqlite.SQLiteConfig;
import org.sqlite.SQLiteJDBCLoader;
import org.sqlite.util.Logger;
import org.sqlite.util.LoggerFactory;
/** This class provides a thin JNI layer over the SQLite3 C API. */
public final class NativeDB extends DB {
private static final Logger logger = LoggerFactory.getLogger(NativeDB.class);
private static final int DEFAULT_BACKUP_BUSY_SLEEP_TIME_MILLIS = 100;
private static final int DEFAULT_BACKUP_NUM_BUSY_BEFORE_FAIL = 3;
private static final int DEFAULT_PAGES_PER_BACKUP_STEP = 100;
/** SQLite connection handle. */
private long pointer = 0;
private static boolean isLoaded;
private static boolean loadSucceeded;
static {
if ("The Android Project".equals(System.getProperty("java.vm.vendor"))) {
System.loadLibrary("sqlitejdbc");
isLoaded = true;
loadSucceeded = true;
} else {
// continue with non Android execution path
isLoaded = false;
loadSucceeded = false;
}
}
public NativeDB(String url, String fileName, SQLiteConfig config) throws SQLException {
super(url, fileName, config);
}
/**
* Loads the SQLite interface backend.
*
* @return True if the SQLite JDBC driver is successfully loaded; false otherwise.
*/
public static boolean load() throws Exception {
if (isLoaded) return loadSucceeded;
try {
loadSucceeded = SQLiteJDBCLoader.initialize();
} finally {
isLoaded = true;
}
return loadSucceeded;
}
// WRAPPER FUNCTIONS ////////////////////////////////////////////
/** @see org.sqlite.core.DB#_open(java.lang.String, int) */
@Override
protected synchronized void _open(String file, int openFlags) throws SQLException {
_open_utf8(stringToUtf8ByteArray(file), openFlags);
}
synchronized native void _open_utf8(byte[] fileUtf8, int openFlags) throws SQLException;
/** @see org.sqlite.core.DB#_close() */
@Override
protected synchronized native void _close() throws SQLException;
/** @see org.sqlite.core.DB#_exec(java.lang.String) */
@Override
public synchronized int _exec(String sql) throws SQLException {
logger.trace(
() ->
MessageFormat.format(
"DriverManager [{0}] [SQLite EXEC] {1}",
Thread.currentThread().getName(), sql));
return _exec_utf8(stringToUtf8ByteArray(sql));
}
synchronized native int _exec_utf8(byte[] sqlUtf8) throws SQLException;
/** @see org.sqlite.core.DB#shared_cache(boolean) */
@Override
public synchronized native int shared_cache(boolean enable);
/** @see org.sqlite.core.DB#enable_load_extension(boolean) */
@Override
public synchronized native int enable_load_extension(boolean enable);
/** @see org.sqlite.core.DB#interrupt() */
@Override
public native void interrupt();
/** @see org.sqlite.core.DB#busy_timeout(int) */
@Override
public synchronized native void busy_timeout(int ms);
/** busy handler pointer to JNI global busyhandler reference. */
private long busyHandler = 0;
/** @see org.sqlite.core.DB#busy_handler(BusyHandler) */
@Override
public synchronized native void busy_handler(BusyHandler busyHandler);
/** @see org.sqlite.core.DB#prepare(java.lang.String) */
@Override
protected synchronized SafeStmtPtr prepare(String sql) throws SQLException {
logger.trace(
() ->
MessageFormat.format(
"DriverManager [{0}] [SQLite EXEC] {1}",
Thread.currentThread().getName(), sql));
return new SafeStmtPtr(this, prepare_utf8(stringToUtf8ByteArray(sql)));
}
synchronized native long prepare_utf8(byte[] sqlUtf8) throws SQLException;
/** @see org.sqlite.core.DB#errmsg() */
@Override
synchronized String errmsg() {
return utf8ByteBufferToString(errmsg_utf8());
}
synchronized native ByteBuffer errmsg_utf8();
/** @see org.sqlite.core.DB#libversion() */
@Override
public synchronized String libversion() {
return utf8ByteBufferToString(libversion_utf8());
}
native ByteBuffer libversion_utf8();
/** @see org.sqlite.core.DB#changes() */
@Override
public synchronized native long changes();
/** @see org.sqlite.core.DB#total_changes() */
@Override
public synchronized native long total_changes();
/** @see org.sqlite.core.DB#finalize(long) */
@Override
protected synchronized native int finalize(long stmt);
/** @see org.sqlite.core.DB#step(long) */
@Override
public synchronized native int step(long stmt);
/** @see org.sqlite.core.DB#reset(long) */
@Override
public synchronized native int reset(long stmt);
/** @see org.sqlite.core.DB#clear_bindings(long) */
@Override
public synchronized native int clear_bindings(long stmt);
/** @see org.sqlite.core.DB#bind_parameter_count(long) */
@Override
synchronized native int bind_parameter_count(long stmt);
/** @see org.sqlite.core.DB#column_count(long) */
@Override
public synchronized native int column_count(long stmt);
/** @see org.sqlite.core.DB#column_type(long, int) */
@Override
public synchronized native int column_type(long stmt, int col);
/** @see org.sqlite.core.DB#column_decltype(long, int) */
@Override
public synchronized String column_decltype(long stmt, int col) {
return utf8ByteBufferToString(column_decltype_utf8(stmt, col));
}
synchronized native ByteBuffer column_decltype_utf8(long stmt, int col);
/** @see org.sqlite.core.DB#column_table_name(long, int) */
@Override
public synchronized String column_table_name(long stmt, int col) {
return utf8ByteBufferToString(column_table_name_utf8(stmt, col));
}
synchronized native ByteBuffer column_table_name_utf8(long stmt, int col);
/** @see org.sqlite.core.DB#column_name(long, int) */
@Override
public synchronized String column_name(long stmt, int col) {
return utf8ByteBufferToString(column_name_utf8(stmt, col));
}
synchronized native ByteBuffer column_name_utf8(long stmt, int col);
/** @see org.sqlite.core.DB#column_text(long, int) */
@Override
public synchronized String column_text(long stmt, int col) {
return utf8ByteBufferToString(column_text_utf8(stmt, col));
}
synchronized native ByteBuffer column_text_utf8(long stmt, int col);
/** @see org.sqlite.core.DB#column_blob(long, int) */
@Override
public synchronized native byte[] column_blob(long stmt, int col);
/** @see org.sqlite.core.DB#column_double(long, int) */
@Override
public synchronized native double column_double(long stmt, int col);
/** @see org.sqlite.core.DB#column_long(long, int) */
@Override
public synchronized native long column_long(long stmt, int col);
/** @see org.sqlite.core.DB#column_int(long, int) */
@Override
public synchronized native int column_int(long stmt, int col);
/** @see org.sqlite.core.DB#bind_null(long, int) */
@Override
synchronized native int bind_null(long stmt, int pos);
/** @see org.sqlite.core.DB#bind_int(long, int, int) */
@Override
synchronized native int bind_int(long stmt, int pos, int v);
/** @see org.sqlite.core.DB#bind_long(long, int, long) */
@Override
synchronized native int bind_long(long stmt, int pos, long v);
/** @see org.sqlite.core.DB#bind_double(long, int, double) */
@Override
synchronized native int bind_double(long stmt, int pos, double v);
/** @see org.sqlite.core.DB#bind_text(long, int, java.lang.String) */
@Override
synchronized int bind_text(long stmt, int pos, String v) {
return bind_text_utf8(stmt, pos, stringToUtf8ByteArray(v));
}
synchronized native int bind_text_utf8(long stmt, int pos, byte[] vUtf8);
/** @see org.sqlite.core.DB#bind_blob(long, int, byte[]) */
@Override
synchronized native int bind_blob(long stmt, int pos, byte[] v);
/** @see org.sqlite.core.DB#result_null(long) */
@Override
public synchronized native void result_null(long context);
/** @see org.sqlite.core.DB#result_text(long, java.lang.String) */
@Override
public synchronized void result_text(long context, String val) {
result_text_utf8(context, stringToUtf8ByteArray(val));
}
synchronized native void result_text_utf8(long context, byte[] valUtf8);
/** @see org.sqlite.core.DB#result_blob(long, byte[]) */
@Override
public synchronized native void result_blob(long context, byte[] val);
/** @see org.sqlite.core.DB#result_double(long, double) */
@Override
public synchronized native void result_double(long context, double val);
/** @see org.sqlite.core.DB#result_long(long, long) */
@Override
public synchronized native void result_long(long context, long val);
/** @see org.sqlite.core.DB#result_int(long, int) */
@Override
public synchronized native void result_int(long context, int val);
/** @see org.sqlite.core.DB#result_error(long, java.lang.String) */
@Override
public synchronized void result_error(long context, String err) {
result_error_utf8(context, stringToUtf8ByteArray(err));
}
synchronized native void result_error_utf8(long context, byte[] errUtf8);
/** @see org.sqlite.core.DB#value_text(org.sqlite.Function, int) */
@Override
public synchronized String value_text(Function f, int arg) {
return utf8ByteBufferToString(value_text_utf8(f, arg));
}
synchronized native ByteBuffer value_text_utf8(Function f, int argUtf8);
/** @see org.sqlite.core.DB#value_blob(org.sqlite.Function, int) */
@Override
public synchronized native byte[] value_blob(Function f, int arg);
/** @see org.sqlite.core.DB#value_double(org.sqlite.Function, int) */
@Override
public synchronized native double value_double(Function f, int arg);
/** @see org.sqlite.core.DB#value_long(org.sqlite.Function, int) */
@Override
public synchronized native long value_long(Function f, int arg);
/** @see org.sqlite.core.DB#value_int(org.sqlite.Function, int) */
@Override
public synchronized native int value_int(Function f, int arg);
/** @see org.sqlite.core.DB#value_type(org.sqlite.Function, int) */
@Override
public synchronized native int value_type(Function f, int arg);
/** @see org.sqlite.core.DB#create_function(java.lang.String, org.sqlite.Function, int, int) */
@Override
public synchronized int create_function(String name, Function func, int nArgs, int flags)
throws SQLException {
return create_function_utf8(nameToUtf8ByteArray("function", name), func, nArgs, flags);
}
synchronized native int create_function_utf8(
byte[] nameUtf8, Function func, int nArgs, int flags);
/** @see org.sqlite.core.DB#destroy_function(java.lang.String) */
@Override
public synchronized int destroy_function(String name) throws SQLException {
return destroy_function_utf8(nameToUtf8ByteArray("function", name));
}
synchronized native int destroy_function_utf8(byte[] nameUtf8);
/** @see org.sqlite.core.DB#create_collation(String, Collation) */
@Override
public synchronized int create_collation(String name, Collation coll) throws SQLException {
return create_collation_utf8(nameToUtf8ByteArray("collation", name), coll);
}
synchronized native int create_collation_utf8(byte[] nameUtf8, Collation coll);
/** @see org.sqlite.core.DB#destroy_collation(String) */
@Override
public synchronized int destroy_collation(String name) throws SQLException {
return destroy_collation_utf8(nameToUtf8ByteArray("collation", name));
}
synchronized native int destroy_collation_utf8(byte[] nameUtf8);
@Override
public synchronized native int limit(int id, int value) throws SQLException;
private byte[] nameToUtf8ByteArray(String nameType, String name) throws SQLException {
final byte[] nameUtf8 = stringToUtf8ByteArray(name);
if (name == null || "".equals(name) || nameUtf8.length > 255) {
throw new SQLException("invalid " + nameType + " name: '" + name + "'");
}
return nameUtf8;
}
/**
* @see org.sqlite.core.DB#backup(java.lang.String, java.lang.String,
* org.sqlite.core.DB.ProgressObserver)
*/
@Override
public int backup(String dbName, String destFileName, ProgressObserver observer)
throws SQLException {
return backup(
stringToUtf8ByteArray(dbName),
stringToUtf8ByteArray(destFileName),
observer,
DEFAULT_BACKUP_BUSY_SLEEP_TIME_MILLIS,
DEFAULT_BACKUP_NUM_BUSY_BEFORE_FAIL,
DEFAULT_PAGES_PER_BACKUP_STEP);
}
/**
* @see org.sqlite.core.DB#backup(String, String, org.sqlite.core.DB.ProgressObserver, int, int,
* int)
*/
@Override
public int backup(
String dbName,
String destFileName,
ProgressObserver observer,
int sleepTimeMillis,
int nTimeouts,
int pagesPerStep)
throws SQLException {
return backup(
stringToUtf8ByteArray(dbName),
stringToUtf8ByteArray(destFileName),
observer,
sleepTimeMillis,
nTimeouts,
pagesPerStep);
}
synchronized native int backup(
byte[] dbNameUtf8,
byte[] destFileNameUtf8,
ProgressObserver observer,
int sleepTimeMillis,
int nTimeouts,
int pagesPerStep)
throws SQLException;
/**
* @see org.sqlite.core.DB#restore(java.lang.String, java.lang.String,
* org.sqlite.core.DB.ProgressObserver)
*/
@Override
public synchronized int restore(String dbName, String sourceFileName, ProgressObserver observer)
throws SQLException {
return restore(
dbName,
sourceFileName,
observer,
DEFAULT_BACKUP_BUSY_SLEEP_TIME_MILLIS,
DEFAULT_BACKUP_NUM_BUSY_BEFORE_FAIL,
DEFAULT_PAGES_PER_BACKUP_STEP);
}
/** @see org.sqlite.core.DB#restore(String, String, ProgressObserver, int, int, int) */
@Override
public synchronized int restore(
String dbName,
String sourceFileName,
ProgressObserver observer,
int sleepTimeMillis,
int nTimeouts,
int pagesPerStep)
throws SQLException {
return restore(
stringToUtf8ByteArray(dbName),
stringToUtf8ByteArray(sourceFileName),
observer,
sleepTimeMillis,
nTimeouts,
pagesPerStep);
}
synchronized native int restore(
byte[] dbNameUtf8,
byte[] sourceFileName,
ProgressObserver observer,
int sleepTimeMillis,
int nTimeouts,
int pagesPerStep)
throws SQLException;
// COMPOUND FUNCTIONS (for optimisation) /////////////////////////
/**
* Provides metadata for table columns.
*
* @returns For each column returns:
* res[col][0] = true if column constrained NOT NULL
* res[col][1] = true if column is part of the primary key
* res[col][2] = true if column is auto-increment.
* @see org.sqlite.core.DB#column_metadata(long)
*/
@Override
synchronized native boolean[][] column_metadata(long stmt);
// pointer to commit listener structure, if enabled.
private long commitListener = 0;
@Override
synchronized native void set_commit_listener(boolean enabled);
// pointer to update listener structure, if enabled.
private long updateListener = 0;
@Override
synchronized native void set_update_listener(boolean enabled);
/**
* Throws an SQLException. Called from native code
*
* @param msg Message for the SQLException.
* @throws SQLException the generated SQLException
*/
static void throwex(String msg) throws SQLException {
throw new SQLException(msg);
}
static byte[] stringToUtf8ByteArray(String str) {
if (str == null) {
return null;
}
return str.getBytes(StandardCharsets.UTF_8);
}
static String utf8ByteBufferToString(ByteBuffer buffer) {
if (buffer == null) {
return null;
}
byte[] buff = new byte[buffer.remaining()];
buffer.get(buff);
return new String(buff, StandardCharsets.UTF_8);
}
/** handler pointer to JNI global progressHandler reference. */
private long progressHandler;
public synchronized native void register_progress_handler(
int vmCalls, ProgressHandler progressHandler) throws SQLException;
public synchronized native void clear_progress_handler() throws SQLException;
/**
* Getter for native pointer to validate memory is properly cleaned up in unit tests
*
* @return a native pointer to validate memory is properly cleaned up in unit tests
*/
long getBusyHandler() {
return busyHandler;
}
/**
* Getter for native pointer to validate memory is properly cleaned up in unit tests
*
* @return a native pointer to validate memory is properly cleaned up in unit tests
*/
long getCommitListener() {
return commitListener;
}
/**
* Getter for native pointer to validate memory is properly cleaned up in unit tests
*
* @return a native pointer to validate memory is properly cleaned up in unit tests
*/
long getUpdateListener() {
return updateListener;
}
/**
* Getter for native pointer to validate memory is properly cleaned up in unit tests
*
* @return a native pointer to validate memory is properly cleaned up in unit tests
*/
long getProgressHandler() {
return progressHandler;
}
@Override
public synchronized native byte[] serialize(String schema) throws SQLException;
@Override
public synchronized native void deserialize(String schema, byte[] buff) throws SQLException;
}