io.requery.android.sqlite

Class DatabaseSource

java.lang.Object

android.database.sqlite.SQLiteOpenHelper

io.requery.android.sqlite.DatabaseSource

All Implemented Interfaces:

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

public class DatabaseSource
extends android.database.sqlite.SQLiteOpenHelper
implements DatabaseProvider<android.database.sqlite.SQLiteDatabase>

Wrapper for working with Android SQLite databases. This provides a Connection wrapping the standard java SQLite API turning it into standard JDBC APIs.

This class extends the standard 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
DatabaseSource(android.content.Context context, io.requery.meta.EntityModel model, int version) Creates a new DatabaseSource instance.
DatabaseSource(android.content.Context context, io.requery.meta.EntityModel model, java.lang.String name, int version) Creates a new DatabaseSource instance.
DatabaseSource(android.content.Context context, io.requery.meta.EntityModel model, java.lang.String name, android.database.sqlite.SQLiteDatabase.CursorFactory factory, int version) Creates a new DatabaseSource instance.
DatabaseSource(android.content.Context context, io.requery.meta.EntityModel model, java.lang.String name, android.database.sqlite.SQLiteDatabase.CursorFactory factory, int version, io.requery.sql.platform.SQLite platform) Creates a new DatabaseSource instance.

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) Override to modify the configuration before it is built.
void	onConfigure(android.database.sqlite.SQLiteDatabase db) Callback for when the database should be configured.
void	onCreate(android.database.sqlite.SQLiteDatabase db) Callback for when the database schema is to be created.
protected io.requery.sql.Mapping	onCreateMapping(io.requery.sql.Platform platform) Override to change the default Mapping.
void	onUpgrade(android.database.sqlite.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 android.database.sqlite.SQLiteOpenHelper

close, getDatabaseName, getReadableDatabase, getWritableDatabase, onDowngrade, onOpen, setWriteAheadLoggingEnabled

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

DatabaseSource

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

Creates a new DatabaseSource instance.

Parameters:

context - context

model - the entity model

version - the schema version

DatabaseSource

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

Creates a new DatabaseSource instance.

Parameters:

context - context

model - the entity model

name - database filename

version - the schema version

DatabaseSource

public DatabaseSource(android.content.Context context,
                      io.requery.meta.EntityModel model,
                      @Nullable
                      java.lang.String name,
                      @Nullable
                      android.database.sqlite.SQLiteDatabase.CursorFactory factory,
                      int version)

Creates a new DatabaseSource instance.

Parameters:

context - context

model - the entity model

name - database filename

factory - optional SQLiteDatabase.CursorFactory

version - the schema version

DatabaseSource

public DatabaseSource(android.content.Context context,
                      io.requery.meta.EntityModel model,
                      @Nullable
                      java.lang.String name,
                      @Nullable
                      android.database.sqlite.SQLiteDatabase.CursorFactory factory,
                      int version,
                      io.requery.sql.platform.SQLite platform)

Creates a new DatabaseSource instance.

Parameters:

context - context

model - the entity model

name - database filename

factory - optional SQLiteDatabase.CursorFactory

version - the schema version

platform - platform instance

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<android.database.sqlite.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<android.database.sqlite.SQLiteDatabase>

Parameters:

mode - to use

onCreateMapping

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

Override to change the default Mapping.

Parameters:

platform - platform instance

Returns:

the configured mapping.

onConfigure

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

Override to modify the configuration before it is built.

Parameters:

builder - instance to configure.

getConfiguration

public io.requery.sql.Configuration getConfiguration()

Specified by:

getConfiguration in interface DatabaseProvider<android.database.sqlite.SQLiteDatabase>

Returns:

Configuration used by the provider

onCreate

public void onCreate(android.database.sqlite.SQLiteDatabase db)

Description copied from interface: DatabaseProvider

Callback for when the database schema is to be created.

Specified by:

onCreate in interface DatabaseProvider<android.database.sqlite.SQLiteDatabase>

Specified by:

onCreate in class android.database.sqlite.SQLiteOpenHelper

Parameters:

db - instance

onConfigure

public void onConfigure(android.database.sqlite.SQLiteDatabase db)

Description copied from interface: DatabaseProvider

Callback for when the database should be configured.

Specified by:

onConfigure in interface DatabaseProvider<android.database.sqlite.SQLiteDatabase>

Overrides:

onConfigure in class android.database.sqlite.SQLiteOpenHelper

Parameters:

db - instance

onUpgrade

public void onUpgrade(android.database.sqlite.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<android.database.sqlite.SQLiteDatabase>

Specified by:

onUpgrade in class android.database.sqlite.SQLiteOpenHelper

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