1
0
mirror of https://github.com/sqlite/sqlite.git synced 2025-07-29 08:01:23 +03:00

Add update-hook support to JNI wrapper1.

FossilOrigin-Name: 6c584cf27179d16deee84e9699493cf29bebef123fa2a7493aad0324bead1618
This commit is contained in:
stephan
2023-11-05 01:14:07 +00:00
parent 2c930e3b86
commit 0ee7ae72a1
6 changed files with 153 additions and 15 deletions

View File

@ -18,8 +18,9 @@ package org.sqlite.jni.capi;
*/
public interface RollbackHookCallback extends CallbackProxy {
/**
Works as documented for the C-level sqlite3_rollback_hook()
callback.
Must function as documented for the C-level sqlite3_rollback_hook()
callback. If it throws, the exception is translated into
a db-level error.
*/
void call();
}

View File

@ -19,7 +19,8 @@ package org.sqlite.jni.capi;
public interface UpdateHookCallback extends CallbackProxy {
/**
Must function as described for the C-level sqlite3_update_hook()
callback.
callback. If it throws, the exception is translated into
a db-level error.
*/
void call(int opId, String dbName, String tableName, long rowId);
}

View File

@ -112,6 +112,42 @@ public final class Sqlite implements AutoCloseable {
public static final int BUSY = CApi.SQLITE_BUSY;
public static final int LOCKED = CApi.SQLITE_LOCKED;
public static final int DENY = CApi.SQLITE_DENY;
public static final int IGNORE = CApi.SQLITE_IGNORE;
public static final int CREATE_INDEX = CApi.SQLITE_CREATE_INDEX;
public static final int CREATE_TABLE = CApi.SQLITE_CREATE_TABLE;
public static final int CREATE_TEMP_INDEX = CApi.SQLITE_CREATE_TEMP_INDEX;
public static final int CREATE_TEMP_TABLE = CApi.SQLITE_CREATE_TEMP_TABLE;
public static final int CREATE_TEMP_TRIGGER = CApi.SQLITE_CREATE_TEMP_TRIGGER;
public static final int CREATE_TEMP_VIEW = CApi.SQLITE_CREATE_TEMP_VIEW;
public static final int CREATE_TRIGGER = CApi.SQLITE_CREATE_TRIGGER;
public static final int CREATE_VIEW = CApi.SQLITE_CREATE_VIEW;
public static final int DELETE = CApi.SQLITE_DELETE;
public static final int DROP_INDEX = CApi.SQLITE_DROP_INDEX;
public static final int DROP_TABLE = CApi.SQLITE_DROP_TABLE;
public static final int DROP_TEMP_INDEX = CApi.SQLITE_DROP_TEMP_INDEX;
public static final int DROP_TEMP_TABLE = CApi.SQLITE_DROP_TEMP_TABLE;
public static final int DROP_TEMP_TRIGGER = CApi.SQLITE_DROP_TEMP_TRIGGER;
public static final int DROP_TEMP_VIEW = CApi.SQLITE_DROP_TEMP_VIEW;
public static final int DROP_TRIGGER = CApi.SQLITE_DROP_TRIGGER;
public static final int DROP_VIEW = CApi.SQLITE_DROP_VIEW;
public static final int INSERT = CApi.SQLITE_INSERT;
public static final int PRAGMA = CApi.SQLITE_PRAGMA;
public static final int READ = CApi.SQLITE_READ;
public static final int SELECT = CApi.SQLITE_SELECT;
public static final int TRANSACTION = CApi.SQLITE_TRANSACTION;
public static final int UPDATE = CApi.SQLITE_UPDATE;
public static final int ATTACH = CApi.SQLITE_ATTACH;
public static final int DETACH = CApi.SQLITE_DETACH;
public static final int ALTER_TABLE = CApi.SQLITE_ALTER_TABLE;
public static final int REINDEX = CApi.SQLITE_REINDEX;
public static final int ANALYZE = CApi.SQLITE_ANALYZE;
public static final int CREATE_VTABLE = CApi.SQLITE_CREATE_VTABLE;
public static final int DROP_VTABLE = CApi.SQLITE_DROP_VTABLE;
public static final int FUNCTION = CApi.SQLITE_FUNCTION;
public static final int SAVEPOINT = CApi.SQLITE_SAVEPOINT;
public static final int RECURSIVE = CApi.SQLITE_RECURSIVE;
//! Used only by the open() factory functions.
private Sqlite(sqlite3 db){
this.db = db;
@ -1353,5 +1389,53 @@ public final class Sqlite implements AutoCloseable {
: null;
}
public interface UpdateHook {
/**
Must function as described for the C-level sqlite3_update_hook()
callback.
*/
void call(int opId, String dbName, String tableName, long rowId);
}
/**
A level of indirection to permit setUpdateHook() to have similar
semantics as the C API, returning the previous hook. The caveat
is that if the low-level API is used to install a hook, it will
have a different hook type than Sqlite.UpdateHook so
setUpdateHook() will return null instead of that object.
*/
private static class UpdateHookProxy
implements org.sqlite.jni.capi.UpdateHookCallback {
final UpdateHook updateHook;
UpdateHookProxy(UpdateHook ch){
this.updateHook = ch;
}
@Override public void call(int opId, String dbName, String tableName, long rowId){
updateHook.call(opId, dbName, tableName, rowId);
}
}
/**
Analog to sqlite3_update_hook(). Returns the previous hook, if
any (else null). Throws if this db is closed.
Minor caveat: if a update hook is set on this object's underlying
db handle using the lower-level SQLite API, this function may
return null when replacing it, despite there being a hook,
because it will have a different callback type. So long as the
handle is only manipulated via the high-level API, this caveat
does not apply.
*/
UpdateHook setUpdateHook( UpdateHook c ){
UpdateHookProxy chp = null;
if( null!=c ){
chp = new UpdateHookProxy(c);
}
final org.sqlite.jni.capi.UpdateHookCallback rv =
CApi.sqlite3_update_hook(thisDb(), chp);
return (rv instanceof UpdateHookProxy)
? ((UpdateHookProxy)rv).updateHook
: null;
}
}

View File

@ -133,6 +133,9 @@ public class Tester2 implements Runnable {
Executes all SQL statements in the given string. If throwOnError
is true then it will throw for any prepare/step errors, else it
will return the corresponding non-0 result code.
TODO: reimplement this in the high-level API once it has the
multi-prepare capability.
*/
public static int execSql(Sqlite dbw, boolean throwOnError, String sql){
final sqlite3 db = dbw.nativeHandle();
@ -163,7 +166,7 @@ public class Tester2 implements Runnable {
}
CApi.sqlite3_finalize(stmt);
affirm(0 == stmt.getNativePointer());
if(CApi.SQLITE_DONE!=rc){
if(Sqlite.DONE!=rc){
break;
}
}
@ -181,7 +184,7 @@ public class Tester2 implements Runnable {
@SingleThreadOnly /* because it's thread-agnostic */
private void test1(){
affirm(CApi.sqlite3_libversion_number() == CApi.SQLITE_VERSION_NUMBER);
affirm(Sqlite.libVersionNumber() == CApi.SQLITE_VERSION_NUMBER);
}
/* Copy/paste/rename this to add new tests. */
@ -818,6 +821,55 @@ public class Tester2 implements Runnable {
db.close();
}
private void testUpdateHook(){
final Sqlite db = openDb();
final ValueHolder<Integer> counter = new ValueHolder<>(0);
final ValueHolder<Integer> expectedOp = new ValueHolder<>(0);
final Sqlite.UpdateHook theHook = new Sqlite.UpdateHook(){
@Override
public void call(int opId, String dbName, String tableName, long rowId){
++counter.value;
if( 0!=expectedOp.value ){
affirm( expectedOp.value == opId );
}
}
};
Sqlite.UpdateHook oldHook = db.setUpdateHook(theHook);
affirm( null == oldHook );
expectedOp.value = Sqlite.INSERT;
execSql(db, "CREATE TABLE t(a); INSERT INTO t(a) VALUES('a'),('b'),('c')");
affirm( 3 == counter.value );
expectedOp.value = Sqlite.UPDATE;
execSql(db, "update t set a='d' where a='c';");
affirm( 4 == counter.value );
oldHook = db.setUpdateHook(theHook);
affirm( theHook == oldHook );
expectedOp.value = Sqlite.DELETE;
execSql(db, "DELETE FROM t where a='d'");
affirm( 5 == counter.value );
oldHook = db.setUpdateHook(null);
affirm( theHook == oldHook );
execSql(db, "update t set a='e' where a='b';");
affirm( 5 == counter.value );
oldHook = db.setUpdateHook(null);
affirm( null == oldHook );
final Sqlite.UpdateHook newHook = new Sqlite.UpdateHook(){
@Override public void call(int opId, String dbName, String tableName, long rowId){
}
};
oldHook = db.setUpdateHook(newHook);
affirm( null == oldHook );
execSql(db, "update t set a='h' where a='a'");
affirm( 5 == counter.value );
oldHook = db.setUpdateHook(theHook);
affirm( newHook == oldHook );
expectedOp.value = Sqlite.UPDATE;
execSql(db, "update t set a='i' where a='h'");
affirm( 6 == counter.value );
db.close();
}
private void runTests(boolean fromThread) throws Exception {
List<java.lang.reflect.Method> mlist = testMethods;
affirm( null!=mlist );