io.requery.android.sqlitex

Class SqlitexDatabaseSource

java.lang.Object

SQLiteOpenHelper

io.requery.android.sqlitex.SqlitexDatabaseSource

All Implemented Interfaces:

DatabaseProvider<SQLiteDatabase>, io.requery.sql.ConnectionProvider, java.lang.AutoCloseable

public class SqlitexDatabaseSource
extends SQLiteOpenHelper
implements DatabaseProvider<SQLiteDatabase>

Wrapper for working with Android SQLite databases. That use the requery Android SQLite support library.

This class extends the support version of SQLiteOpenHelper and is used to create the database. onCreate(SQLiteDatabase) will create the database tables & columns automatically.

onUpgrade(SQLiteDatabase, int, int) will create any missing tables/columns, however it will not remove any tables/columns more complex upgrades should be handled by overriding onUpgrade(SQLiteDatabase, int, int) and implementing a script to handle the migration.

Constructor Summary

Constructors

Constructor and Description
SqlitexDatabaseSource(android.content.Context context, io.requery.meta.EntityModel model, int version)
SqlitexDatabaseSource(android.content.Context context, io.requery.meta.EntityModel model, java.lang.String name, int version)

Method Summary

Modifier and Type	Method and Description
io.requery.sql.Configuration	getConfiguration()
java.sql.Connection	getConnection()
protected void	onConfigure(io.requery.sql.ConfigurationBuilder builder) Callback for when the database should be configured.
void	onCreate(SQLiteDatabase db) Callback for when the database schema is to be created.
protected io.requery.sql.Mapping	onCreateMapping(io.requery.sql.Platform platform)
void	onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) Callback for when the database should be upgraded from an previous version to a new version.
void	setLoggingEnabled(boolean enable) Enables statement logging.
void	setTableCreationMode(io.requery.sql.TableCreationMode mode) Sets the TableCreationMode to use when the database is created or upgraded.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.requery.android.sqlite.DatabaseProvider

close, getReadableDatabase, getWritableDatabase

Constructor Detail

SqlitexDatabaseSource

public SqlitexDatabaseSource(android.content.Context context,
                             io.requery.meta.EntityModel model,
                             int version)

SqlitexDatabaseSource

public SqlitexDatabaseSource(android.content.Context context,
                             io.requery.meta.EntityModel model,
                             java.lang.String name,
                             int version)

Method Detail

setLoggingEnabled

public void setLoggingEnabled(boolean enable)

Description copied from interface: DatabaseProvider

Enables statement logging. Not use for debugging only as it impacts performance.

Specified by:

setLoggingEnabled in interface DatabaseProvider<SQLiteDatabase>

Parameters:

enable - true to enable, false otherwise default is false.

setTableCreationMode

public void setTableCreationMode(io.requery.sql.TableCreationMode mode)

Description copied from interface: DatabaseProvider

Sets the TableCreationMode to use when the database is created or upgraded.

Specified by:

setTableCreationMode in interface DatabaseProvider<SQLiteDatabase>

Parameters:

mode - to use

onCreateMapping

protected io.requery.sql.Mapping onCreateMapping(io.requery.sql.Platform platform)

onConfigure

protected void onConfigure(io.requery.sql.ConfigurationBuilder builder)

Description copied from interface: DatabaseProvider

Callback for when the database should be configured.

Specified by:

onConfigure in interface DatabaseProvider<SQLiteDatabase>

Parameters:

builder - instance

getConfiguration

public io.requery.sql.Configuration getConfiguration()

Specified by:

getConfiguration in interface DatabaseProvider<SQLiteDatabase>

Returns:

Configuration used by the provider

onCreate

public void onCreate(SQLiteDatabase db)

Description copied from interface: DatabaseProvider

Callback for when the database schema is to be created.

Specified by:

onCreate in interface DatabaseProvider<SQLiteDatabase>

Parameters:

db - instance

onUpgrade

public void onUpgrade(SQLiteDatabase db,
                      int oldVersion,
                      int newVersion)

Description copied from interface: DatabaseProvider

Callback for when the database should be upgraded from an previous version to a new version.

Specified by:

onUpgrade in interface DatabaseProvider<SQLiteDatabase>

Parameters:

db - instance

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Specified by:

getConnection in interface io.requery.sql.ConnectionProvider

Throws:

java.sql.SQLException