java.lang.Object
- org.sqlite.core.DB

All Implemented Interfaces:

Codes

Direct Known Subclasses:

NativeDB
```
public abstract class DB
extends Object
implements Codes
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DB.ProgressObserver

Field Summary
- Fields inherited from interface org.sqlite.core.Codes
  SQLITE_ABORT, SQLITE_AUTH, SQLITE_BLOB, SQLITE_BUSY, SQLITE_CANTOPEN, SQLITE_CONSTRAINT, SQLITE_CORRUPT, SQLITE_DONE, SQLITE_EMPTY, SQLITE_ERROR, SQLITE_FLOAT, SQLITE_FULL, SQLITE_INTEGER, SQLITE_INTERNAL, SQLITE_INTERRUPT, SQLITE_IOERR, SQLITE_LOCKED, SQLITE_MISMATCH, SQLITE_MISUSE, SQLITE_NOLFS, SQLITE_NOMEM, SQLITE_NOTFOUND, SQLITE_NULL, SQLITE_OK, SQLITE_PERM, SQLITE_PROTOCOL, SQLITE_READONLY, SQLITE_ROW, SQLITE_SCHEMA, SQLITE_TEXT, SQLITE_TOOBIG

Constructor Summary

Constructors
Constructor Description

DB(String url, String fileName, SQLiteConfig config)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract void`	`_close()`	Closes the SQLite interface to a database.
`abstract int`	`_exec(String sql)`	Complies, evaluates, executes and commits an SQL statement.
`protected abstract void`	`_open(String filename, int openFlags)`	Creates an SQLite interface to a database with the provided open flags.
`void`	`addCommitListener(SQLiteCommitListener listener)`
`void`	`addUpdateListener(SQLiteUpdateListener listener)`
`abstract int`	`backup(String dbName, String destFileName, DB.ProgressObserver observer)`
`abstract int`	`backup(String dbName, String destFileName, DB.ProgressObserver observer, int sleepTimeMillis, int nTimeouts, int pagesPerStep)`
`abstract void`	`busy_handler(BusyHandler busyHandler)`	Sets a busy handler that sleeps for a specified amount of time when a table is locked.
`abstract void`	`busy_timeout(int ms)`	Sets a busy handler that sleeps for a specified amount of time when a table is locked.
`abstract long`	`changes()`
`abstract int`	`clear_bindings(long stmt)`	Reset all bindings on a prepared statement (reset all host parameters to NULL).
`abstract void`	`clear_progress_handler()`
`void`	`close()`	Closes a database connection and finalizes any remaining statements before the closing operation.
`abstract byte[]`	`column_blob(long stmt, int col)`
`abstract int`	`column_count(long stmt)`
`abstract String`	`column_decltype(long stmt, int col)`
`abstract double`	`column_double(long stmt, int col)`
`abstract int`	`column_int(long stmt, int col)`
`abstract long`	`column_long(long stmt, int col)`
`abstract String`	`column_name(long stmt, int col)`
`String[]`	`column_names(long stmt)`	Returns an array of column names in the result set of the SELECT statement.
`abstract String`	`column_table_name(long stmt, int col)`
`abstract String`	`column_text(long stmt, int col)`
`abstract int`	`column_type(long stmt, int col)`
`abstract int`	`create_collation(String name, Collation c)`	Create a user defined collation with given collation name and the collation object.
`abstract int`	`create_function(String name, Function f, int nArgs, int flags)`	Create a user defined function with given function name and the function object.
`abstract int`	`destroy_collation(String name)`	Create a user defined collation with given collation name and the collation object.
`abstract int`	`destroy_function(String name)`	De-registers a user defined function
`abstract int`	`enable_load_extension(boolean enable)`	Enables or disables loading of SQLite extensions.
`void`	`exec(String sql, boolean autoCommit)`	Executes an SQL statement using the process of compiling, evaluating, and destroying the prepared statement object.
`boolean`	`execute(CoreStatement stmt, Object[] vals)`
`long`	`executeUpdate(CoreStatement stmt, Object[] vals)`	Execute an SQL INSERT, UPDATE or DELETE statement with the Stmt object and an array of parameter values of the SQL statement..
`protected abstract int`	`finalize(long stmt)`	Destroys a prepared statement.
`int`	`finalize(SafeStmtPtr safePtr, long ptr)`	Destroys a statement.
`SQLiteConfig`	`getConfig()`
`String`	`getUrl()`
`abstract void`	`interrupt()`	Aborts any pending operation and returns at its earliest opportunity.
`boolean`	`isClosed()`
`abstract String`	`libversion()`	Returns the value for SQLITE_VERSION, SQLITE_VERSION_NUMBER, and SQLITE_SOURCE_ID C preprocessor macros that are associated with the library.
`abstract int`	`limit(int id, int value)`
`static SQLiteException`	`newSQLException(int errorCode, String errorMessage)`	Throws formatted SQLException with error code and message.
`void`	`open(String file, int openFlags)`	Creates an SQLite interface to a database for the given connection.
`protected abstract SafeStmtPtr`	`prepare(String sql)`	Complies an SQL statement.
`void`	`prepare(CoreStatement stmt)`	Complies the an SQL statement.
`abstract void`	`register_progress_handler(int vmCalls, ProgressHandler progressHandler)`	Progress handler
`void`	`removeCommitListener(SQLiteCommitListener listener)`
`void`	`removeUpdateListener(SQLiteUpdateListener listener)`
`abstract int`	`reset(long stmt)`	Sets a prepared statement object back to its initial state, ready to be re-executed.
`abstract int`	`restore(String dbName, String sourceFileName, DB.ProgressObserver observer)`
`abstract int`	`restore(String dbName, String sourceFileName, DB.ProgressObserver observer, int sleepTimeMillis, int nTimeouts, int pagesPerStep)`
`abstract void`	`result_blob(long context, byte[] val)`	Sets the result of an SQL function as blob data type with the pointer to the SQLite database context and the the result value of byte array.
`abstract void`	`result_double(long context, double val)`	Sets the result of an SQL function as double data type with the pointer to the SQLite database context and the the result value of double.
`abstract void`	`result_error(long context, String err)`	Sets the result of an SQL function as an error with the pointer to the SQLite database context and the the error of String.
`abstract void`	`result_int(long context, int val)`	Sets the result of an SQL function as int data type with the pointer to the SQLite database context and the the result value of int.
`abstract void`	`result_long(long context, long val)`	Sets the result of an SQL function as long data type with the pointer to the SQLite database context and the the result value of long.
`abstract void`	`result_null(long context)`	Sets the result of an SQL function as NULL with the pointer to the SQLite database context.
`abstract void`	`result_text(long context, String val)`	Sets the result of an SQL function as text data type with the pointer to the SQLite database context and the the result value of String.
`abstract int`	`shared_cache(boolean enable)`	Enables or disables the sharing of the database cache and schema data structures between connections to the same database.
`abstract int`	`step(long stmt)`	Evaluates a statement.
`void`	`throwex(int errorCode)`	Throws SQLException with error code.
`abstract long`	`total_changes()`
`abstract byte[]`	`value_blob(Function f, int arg)`
`abstract double`	`value_double(Function f, int arg)`
`abstract int`	`value_int(Function f, int arg)`	Accesses the parameter values on the function or aggregate in int data type with the function object and the parameter value.
`abstract long`	`value_long(Function f, int arg)`
`abstract String`	`value_text(Function f, int arg)`
`abstract int`	`value_type(Function f, int arg)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DB
```
public DB(String url,
          String fileName,
          SQLiteConfig config)
   throws SQLException
```
    Throws:
    
    SQLException
- Method Detail
  - getUrl
```
public String getUrl()
```
  - isClosed
```
public boolean isClosed()
```
  - getConfig
```
public SQLiteConfig getConfig()
```
  - interrupt
```
public abstract void interrupt()
                        throws SQLException
```
    Aborts any pending operation and returns at its earliest opportunity.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/interrupt.html
  - busy_timeout
```
public abstract void busy_timeout(int ms)
                           throws SQLException
```
    Sets a busy handler that sleeps for a specified amount of time when a table is locked.
    
    Parameters:
    
    ms - Time to sleep in milliseconds.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/busy_timeout.html
  - busy_handler
```
public abstract void busy_handler(BusyHandler busyHandler)
                           throws SQLException
```
    Sets a busy handler that sleeps for a specified amount of time when a table is locked.
    
    Parameters:
    
    busyHandler -
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/busy_timeout.html
  - libversion
```
public abstract String libversion()
                           throws SQLException
```
    Returns the value for SQLITE_VERSION, SQLITE_VERSION_NUMBER, and SQLITE_SOURCE_ID C preprocessor macros that are associated with the library.
    
    Returns:
    
    Compile-time SQLite version information.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/libversion.html, https://www.sqlite.org/c3ref/c_source_id.html
  - changes
```
public abstract long changes()
                      throws SQLException
```
    Returns:
    
    Number of rows that were changed, inserted or deleted by the last SQL statement
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/changes.html
  - total_changes
```
public abstract long total_changes()
                            throws SQLException
```
    Returns:
    
    Number of row changes caused by INSERT, UPDATE or DELETE statements since the database connection was opened.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/total_changes.html
  - shared_cache
```
public abstract int shared_cache(boolean enable)
                          throws SQLException
```
    Enables or disables the sharing of the database cache and schema data structures between connections to the same database.
    
    Parameters:
    
    enable - True to enable; false otherwise.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/enable_shared_cache.html, SQLiteErrorCode
  - enable_load_extension
```
public abstract int enable_load_extension(boolean enable)
                                   throws SQLException
```
    Enables or disables loading of SQLite extensions.
    
    Parameters:
    
    enable - True to enable; false otherwise.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/load_extension.html
  - exec
```
public final void exec(String sql,
                       boolean autoCommit)
                throws SQLException
```
    Executes an SQL statement using the process of compiling, evaluating, and destroying the prepared statement object.
    
    Parameters:
    
    sql - SQL statement to be executed.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/exec.html
  - open
```
public final void open(String file,
                       int openFlags)
                throws SQLException
```
    Creates an SQLite interface to a database for the given connection.
    
    Parameters:
    
    file - The database.
    
    openFlags - File opening configurations (https://www.sqlite.org/c3ref/c_open_autoproxy.html)
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/open.html
  - close
```
public final void close()
                 throws SQLException
```
    Closes a database connection and finalizes any remaining statements before the closing operation.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/close.html
  - prepare
```
public final void prepare(CoreStatement stmt)
                   throws SQLException
```
    Complies the an SQL statement.
    
    Parameters:
    
    stmt - The SQL statement to compile.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/prepare.html
  - finalize
```
public int finalize(SafeStmtPtr safePtr,
                    long ptr)
             throws SQLException
```
    Destroys a statement.
    
    Parameters:
    
    safePtr - the pointer wrapper to remove from internal structures
    
    ptr - the raw pointer to free
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException - if finalization fails
    
    See Also:
    
    https://www.sqlite.org/c3ref/finalize.html
  - _open
```
protected abstract void _open(String filename,
                              int openFlags)
                       throws SQLException
```
    Creates an SQLite interface to a database with the provided open flags.
    
    Parameters:
    
    filename - The database to open.
    
    openFlags - File opening configurations (https://www.sqlite.org/c3ref/c_open_autoproxy.html)
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/open.html
  - _close
```
protected abstract void _close()
                        throws SQLException
```
    Closes the SQLite interface to a database.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/close.html
  - _exec
```
public abstract int _exec(String sql)
                   throws SQLException
```
    Complies, evaluates, executes and commits an SQL statement.
    
    Parameters:
    
    sql - An SQL statement.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/exec.html
  - prepare
```
protected abstract SafeStmtPtr prepare(String sql)
                                throws SQLException
```
    Complies an SQL statement.
    
    Parameters:
    
    sql - An SQL statement.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/prepare.html
  - finalize
```
protected abstract int finalize(long stmt)
                         throws SQLException
```
    Destroys a prepared statement.
    
    Parameters:
    
    stmt - Pointer to the statement pointer.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/finalize.html
  - step
```
public abstract int step(long stmt)
                  throws SQLException
```
    Evaluates a statement.
    
    Parameters:
    
    stmt - Pointer to the statement.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/step.html
  - reset
```
public abstract int reset(long stmt)
                   throws SQLException
```
    Sets a prepared statement object back to its initial state, ready to be re-executed.
    
    Parameters:
    
    stmt - Pointer to the statement.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/reset.html
  - clear_bindings
```
public abstract int clear_bindings(long stmt)
                            throws SQLException
```
    Reset all bindings on a prepared statement (reset all host parameters to NULL).
    
    Parameters:
    
    stmt - Pointer to the statement.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/clear_bindings.html
  - column_count
```
public abstract int column_count(long stmt)
                          throws SQLException
```
    Parameters:
    
    stmt - Pointer to the statement.
    
    Returns:
    
    Number of columns in the result set returned by the prepared statement.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/column_count.html
  - column_type
```
public abstract int column_type(long stmt,
                                int col)
                         throws SQLException
```
    Parameters:
    
    stmt - Pointer to the statement.
    
    col - Number of column.
    
    Returns:
    
    Datatype code for the initial data type of the result column.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/column_blob.html
  - column_decltype
```
public abstract String column_decltype(long stmt,
                                       int col)
                                throws SQLException
```
    Parameters:
    
    stmt - Pointer to the statement.
    
    col - Number of column.
    
    Returns:
    
    Declared type of the table column for prepared statement.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/column_decltype.html
  - column_table_name
```
public abstract String column_table_name(long stmt,
                                         int col)
                                  throws SQLException
```
    Parameters:
    
    stmt - Pointer to the statement.
    
    col - Number of column.
    
    Returns:
    
    Original text of column name which is the declared in the CREATE TABLE statement.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/column_database_name.html
  - column_name
```
public abstract String column_name(long stmt,
                                   int col)
                            throws SQLException
```
    Parameters:
    
    stmt - Pointer to the statement.
    
    col - The number of column.
    
    Returns:
    
    Name assigned to a particular column in the result set of a SELECT statement.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/column_name.html
  - column_text
```
public abstract String column_text(long stmt,
                                   int col)
                            throws SQLException
```
    Parameters:
    
    stmt - Pointer to the statement.
    
    col - Number of column.
    
    Returns:
    
    Value of the column as text data type in the result set of a SELECT statement.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/column_blob.html
  - column_blob
```
public abstract byte[] column_blob(long stmt,
                                   int col)
                            throws SQLException
```
    Parameters:
    
    stmt - Pointer to the statement.
    
    col - Number of column.
    
    Returns:
    
    BLOB value of the column in the result set of a SELECT statement
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/column_blob.html
  - column_double
```
public abstract double column_double(long stmt,
                                     int col)
                              throws SQLException
```
    Parameters:
    
    stmt - Pointer to the statement.
    
    col - Number of column.
    
    Returns:
    
    DOUBLE value of the column in the result set of a SELECT statement
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/column_blob.html
  - column_long
```
public abstract long column_long(long stmt,
                                 int col)
                          throws SQLException
```
    Parameters:
    
    stmt - Pointer to the statement.
    
    col - Number of column.
    
    Returns:
    
    LONG value of the column in the result set of a SELECT statement.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/column_blob.html
  - column_int
```
public abstract int column_int(long stmt,
                               int col)
                        throws SQLException
```
    Parameters:
    
    stmt - Pointer to the statement.
    
    col - Number of column.
    
    Returns:
    
    INT value of column in the result set of a SELECT statement.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/column_blob.html
  - result_null
```
public abstract void result_null(long context)
                          throws SQLException
```
    Sets the result of an SQL function as NULL with the pointer to the SQLite database context.
    
    Parameters:
    
    context - Pointer to the SQLite database context.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/result_blob.html
  - result_text
```
public abstract void result_text(long context,
                                 String val)
                          throws SQLException
```
    Sets the result of an SQL function as text data type with the pointer to the SQLite database context and the the result value of String.
    
    Parameters:
    
    context - Pointer to the SQLite database context.
    
    val - Result value of an SQL function.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/result_blob.html
  - result_blob
```
public abstract void result_blob(long context,
                                 byte[] val)
                          throws SQLException
```
    Sets the result of an SQL function as blob data type with the pointer to the SQLite database context and the the result value of byte array.
    
    Parameters:
    
    context - Pointer to the SQLite database context.
    
    val - Result value of an SQL function.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/result_blob.html
  - result_double
```
public abstract void result_double(long context,
                                   double val)
                            throws SQLException
```
    Sets the result of an SQL function as double data type with the pointer to the SQLite database context and the the result value of double.
    
    Parameters:
    
    context - Pointer to the SQLite database context.
    
    val - Result value of an SQL function.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/result_blob.html
  - result_long
```
public abstract void result_long(long context,
                                 long val)
                          throws SQLException
```
    Sets the result of an SQL function as long data type with the pointer to the SQLite database context and the the result value of long.
    
    Parameters:
    
    context - Pointer to the SQLite database context.
    
    val - Result value of an SQL function.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/result_blob.html
  - result_int
```
public abstract void result_int(long context,
                                int val)
                         throws SQLException
```
    Sets the result of an SQL function as int data type with the pointer to the SQLite database context and the the result value of int.
    
    Parameters:
    
    context - Pointer to the SQLite database context.
    
    val - Result value of an SQL function.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/result_blob.html
  - result_error
```
public abstract void result_error(long context,
                                  String err)
                           throws SQLException
```
    Sets the result of an SQL function as an error with the pointer to the SQLite database context and the the error of String.
    
    Parameters:
    
    context - Pointer to the SQLite database context.
    
    err - Error result of an SQL function.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/result_blob.html
  - value_text
```
public abstract String value_text(Function f,
                                  int arg)
                           throws SQLException
```
    Parameters:
    
    f - SQLite function object.
    
    arg - Pointer to the parameter of the SQLite function or aggregate.
    
    Returns:
    
    Parameter value of the given SQLite function or aggregate in text data type.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/value_blob.html
  - value_blob
```
public abstract byte[] value_blob(Function f,
                                  int arg)
                           throws SQLException
```
    Parameters:
    
    f - SQLite function object.
    
    arg - Pointer to the parameter of the SQLite function or aggregate.
    
    Returns:
    
    Parameter value of the given SQLite function or aggregate in blob data type.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/value_blob.html
  - value_double
```
public abstract double value_double(Function f,
                                    int arg)
                             throws SQLException
```
    Parameters:
    
    f - SQLite function object.
    
    arg - Pointer to the parameter of the SQLite function or aggregate.
    
    Returns:
    
    Parameter value of the given SQLite function or aggregate in double data type
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/value_blob.html
  - value_long
```
public abstract long value_long(Function f,
                                int arg)
                         throws SQLException
```
    Parameters:
    
    f - SQLite function object.
    
    arg - Pointer to the parameter of the SQLite function or aggregate.
    
    Returns:
    
    Parameter value of the given SQLite function or aggregate in long data type.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/value_blob.html
  - value_int
```
public abstract int value_int(Function f,
                              int arg)
                       throws SQLException
```
    Accesses the parameter values on the function or aggregate in int data type with the function object and the parameter value.
    
    Parameters:
    
    f - SQLite function object.
    
    arg - Pointer to the parameter of the SQLite function or aggregate.
    
    Returns:
    
    Parameter value of the given SQLite function or aggregate.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/value_blob.html
  - value_type
```
public abstract int value_type(Function f,
                               int arg)
                        throws SQLException
```
    Parameters:
    
    f - SQLite function object.
    
    arg - Pointer to the parameter of the SQLite function or aggregate.
    
    Returns:
    
    Parameter datatype of the function or aggregate in int data type.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/value_blob.html
  - create_function
```
public abstract int create_function(String name,
                                    Function f,
                                    int nArgs,
                                    int flags)
                             throws SQLException
```
    Create a user defined function with given function name and the function object.
    
    Parameters:
    
    name - The function name to be created.
    
    f - SQLite function object.
    
    flags - Extra flags to use when creating the function, such as Function.FLAG_DETERMINISTIC
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/create_function.html
  - destroy_function
```
public abstract int destroy_function(String name)
                              throws SQLException
```
    De-registers a user defined function
    
    Parameters:
    
    name - Name of the function to de-registered.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
  - create_collation
```
public abstract int create_collation(String name,
                                     Collation c)
                              throws SQLException
```
    Create a user defined collation with given collation name and the collation object.
    
    Parameters:
    
    name - The collation name to be created.
    
    c - SQLite collation object.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/create_collation.html
  - destroy_collation
```
public abstract int destroy_collation(String name)
                               throws SQLException
```
    Create a user defined collation with given collation name and the collation object.
    
    Parameters:
    
    name - The collation name to be created.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
  - backup
```
public abstract int backup(String dbName,
                           String destFileName,
                           DB.ProgressObserver observer)
                    throws SQLException
```
    Parameters:
    
    dbName - Database name to be backed up.
    
    destFileName - Target backup file name.
    
    observer - ProgressObserver object.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
  - backup
```
public abstract int backup(String dbName,
                           String destFileName,
                           DB.ProgressObserver observer,
                           int sleepTimeMillis,
                           int nTimeouts,
                           int pagesPerStep)
                    throws SQLException
```
    Parameters:
    
    dbName - Database name to be backed up.
    
    destFileName - Target backup file name.
    
    observer - ProgressObserver object.
    
    sleepTimeMillis - time to wait during a backup/restore operation if sqlite3_backup_step returns SQLITE_BUSY before continuing
    
    nTimeouts - the number of times sqlite3_backup_step can return SQLITE_BUSY before failing
    
    pagesPerStep - the number of pages to copy in each sqlite3_backup_step. If this is negative, the entire DB is copied at once.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
  - restore
```
public abstract int restore(String dbName,
                            String sourceFileName,
                            DB.ProgressObserver observer)
                     throws SQLException
```
    Parameters:
    
    dbName - Database name for restoring data.
    
    sourceFileName - Source file name.
    
    observer - ProgressObserver object.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
  - restore
```
public abstract int restore(String dbName,
                            String sourceFileName,
                            DB.ProgressObserver observer,
                            int sleepTimeMillis,
                            int nTimeouts,
                            int pagesPerStep)
                     throws SQLException
```
    Parameters:
    
    dbName - the name of the db to restore
    
    sourceFileName - the filename of the source db to restore
    
    observer - ProgressObserver object.
    
    sleepTimeMillis - time to wait during a backup/restore operation if sqlite3_backup_step returns SQLITE_BUSY before continuing
    
    nTimeouts - the number of times sqlite3_backup_step can return SQLITE_BUSY before failing
    
    pagesPerStep - the number of pages to copy in each sqlite3_backup_step. If this is negative, the entire DB is copied at once.
    
    Returns:
    
    Result Codes
    
    Throws:
    
    SQLException
  - limit
```
public abstract int limit(int id,
                          int value)
                   throws SQLException
```
    Parameters:
    
    id - The id of the limit.
    
    value - The new value of the limit.
    
    Returns:
    
    The prior value of the limit
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c3ref/limit.html
  - register_progress_handler
```
public abstract void register_progress_handler(int vmCalls,
                                               ProgressHandler progressHandler)
                                        throws SQLException
```
    Progress handler
    
    Throws:
    
    SQLException
  - clear_progress_handler
```
public abstract void clear_progress_handler()
                                     throws SQLException
```
    Throws:
    
    SQLException
  - column_names
```
public final String[] column_names(long stmt)
                            throws SQLException
```
    Returns an array of column names in the result set of the SELECT statement.
    
    Parameters:
    
    stmt - Stmt object.
    
    Returns:
    
    String array of column names.
    
    Throws:
    
    SQLException
  - execute
```
public final boolean execute(CoreStatement stmt,
                             Object[] vals)
                      throws SQLException
```
    Parameters:
    
    stmt - Stmt object.
    
    vals - Array of parameter values.
    
    Returns:
    
    True if a row of ResultSet is ready; false otherwise.
    
    Throws:
    
    SQLException
    
    See Also:
    
    https://www.sqlite.org/c_interface.html#sqlite_exec
  - executeUpdate
```
public final long executeUpdate(CoreStatement stmt,
                                Object[] vals)
                         throws SQLException
```
    Execute an SQL INSERT, UPDATE or DELETE statement with the Stmt object and an array of parameter values of the SQL statement..
    
    Parameters:
    
    stmt - Stmt object.
    
    vals - Array of parameter values.
    
    Returns:
    
    Number of database rows that were changed or inserted or deleted by the most recently completed SQL.
    
    Throws:
    
    SQLException
  - addUpdateListener
```
public void addUpdateListener(SQLiteUpdateListener listener)
```
  - addCommitListener
```
public void addCommitListener(SQLiteCommitListener listener)
```
  - removeUpdateListener
```
public void removeUpdateListener(SQLiteUpdateListener listener)
```
  - removeCommitListener
```
public void removeCommitListener(SQLiteCommitListener listener)
```
  - throwex
```
public final void throwex(int errorCode)
                   throws SQLException
```
    Throws SQLException with error code.
    
    Parameters:
    
    errorCode - Error code to be passed.
    
    Throws:
    
    SQLException - Formatted SQLException with error code.
  - newSQLException
```
public static SQLiteException newSQLException(int errorCode,
                                              String errorMessage)
```
    Throws formatted SQLException with error code and message.
    
    Parameters:
    
    errorCode - Error code to be passed.
    
    errorMessage - Error message to be passed.
    
    Returns:
    
    Formatted SQLException with error code and message.

Class DB

Nested Class Summary

Field Summary

Fields inherited from interface org.sqlite.core.Codes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DB

Method Detail

getUrl

isClosed

getConfig

interrupt

busy_timeout

busy_handler

libversion

changes

total_changes

shared_cache

enable_load_extension

exec

open

close

prepare

finalize

_open

_close

_exec

prepare

finalize

step

reset

clear_bindings

column_count

column_type

column_decltype

column_table_name

column_name

column_text

column_blob

column_double

column_long

column_int

result_null

result_text

result_blob

result_double

result_long

result_int

result_error

value_text

value_blob

value_double

value_long

value_int

value_type

create_function

destroy_function

create_collation

destroy_collation

backup

backup

restore

restore

limit

register_progress_handler

clear_progress_handler

column_names

execute

executeUpdate

addUpdateListener

addCommitListener

removeUpdateListener

removeCommitListener

throwex

newSQLException