Package net.zetetic.database.sqlcipher

Class SQLiteOpenHelper

  • All Implemented Interfaces:
    androidx.sqlite.db.SupportSQLiteOpenHelper , java.io.Closeable , java.lang.AutoCloseable 
    
public abstract class SQLiteOpenHelper
 implements SupportSQLiteOpenHelper

    A helper class to manage database creation and version management.

    You create a subclass implementing onCreate, onUpgrade and optionally onOpen, and this class takes care of opening the database if it exists, creating it if it does not, and upgrading it as necessary. Transactions are used to make sure the database is always in a sensible state.

    This class makes it easy for android.content.ContentProvider implementations to defer opening and upgrading the database until first use, to avoid blocking application startup with long-running database upgrades.

    For an example, see the NotePadProvider class in the NotePad sample application, in the samples/ directory of the SDK.

    Note: this class assumes monotonically increasing version numbers for upgrades.

    • Constructor Detail

      • SQLiteOpenHelper

        SQLiteOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version)

        Create a helper object to create, open, and/or manage a database. This method always returns very quickly. The database is not actually created or opened until one of getWritableDatabase or getReadableDatabase is called.

        Parameters:
        context - to use to open or create the database
        name - of the database file, or null for an in-memory database
        factory - to use for creating cursor objects, or null for the default
        version - number of the database (starting at 1); if the database is older, onUpgrade will be used to upgrade the database; if the database is newer, onDowngrade will be used to downgrade the database

      • SQLiteOpenHelper

        SQLiteOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version, DatabaseErrorHandler errorHandler)

        Create a helper object to create, open, and/or manage a database. The database is not actually created or opened until one of getWritableDatabase or getReadableDatabase is called.

        Accepts input param: a concrete instance of DatabaseErrorHandler to be used to handle corruption when sqlite reports database corruption.

        Parameters:
        context - to use to open or create the database
        name - of the database file, or null for an in-memory database
        factory - to use for creating cursor objects, or null for the default
        version - number of the database (starting at 1); if the database is older, onUpgrade will be used to upgrade the database; if the database is newer, onDowngrade will be used to downgrade the database
        errorHandler - the DatabaseErrorHandler to be used when sqlite reports database corruption, or null to use the default error handler.

      • SQLiteOpenHelper

        SQLiteOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version, int minimumSupportedVersion, DatabaseErrorHandler errorHandler)

        Same as SQLiteOpenHelper but also accepts an integer minimumSupportedVersion as a convenience for upgrading very old versions of this database that are no longer supported. If a database with older version that minimumSupportedVersion is found, it is simply deleted and a new database is created with the given name and version

        Parameters:
        context - to use to open or create the database
        name - the name of the database file, null for a temporary in-memory database
        factory - to use for creating cursor objects, null for default
        version - the required version of the database
        minimumSupportedVersion - the minimum version that is supported to be upgraded to version via onUpgrade.
        errorHandler - the DatabaseErrorHandler to be used when sqlite reports database corruption, or null to use the default error handler.

      • SQLiteOpenHelper

        SQLiteOpenHelper(Context context, String name, String password, SQLiteDatabase.CursorFactory factory, int version, int minimumSupportedVersion, DatabaseErrorHandler errorHandler, SQLiteDatabaseHook databaseHook, boolean enableWriteAheadLogging)

        Same as SQLiteOpenHelper but also accepts an integer minimumSupportedVersion as a convenience for upgrading very old versions of this database that are no longer supported. If a database with older version that minimumSupportedVersion is found, it is simply deleted and a new database is created with the given name and version

        Parameters:
        context - to use to open or create the database
        name - the name of the database file, null for a temporary in-memory database
        password - for use with SQLCipher
        factory - to use for creating cursor objects, null for default
        version - the required version of the database
        minimumSupportedVersion - the minimum version that is supported to be upgraded to version via onUpgrade.
        errorHandler - the DatabaseErrorHandler to be used when sqlite reports database corruption, or null to use the default error handler.
        databaseHook - for preKey and postKey events with SQLCipher.

      • SQLiteOpenHelper

        SQLiteOpenHelper(Context context, String name, Array<byte> password, SQLiteDatabase.CursorFactory factory, int version, int minimumSupportedVersion, DatabaseErrorHandler errorHandler, SQLiteDatabaseHook databaseHook, boolean enableWriteAheadLogging)

        Same as SQLiteOpenHelper but also accepts an integer minimumSupportedVersion as a convenience for upgrading very old versions of this database that are no longer supported. If a database with older version that minimumSupportedVersion is found, it is simply deleted and a new database is created with the given name and version

        Parameters:
        context - to use to open or create the database
        name - the name of the database file, null for a temporary in-memory database
        password - for use with SQLCipher
        factory - to use for creating cursor objects, null for default
        version - the required version of the database
        minimumSupportedVersion - the minimum version that is supported to be upgraded to version via onUpgrade.
        errorHandler - the DatabaseErrorHandler to be used when sqlite reports database corruption, or null to use the default error handler.
        databaseHook - for preKey and postKey events with SQLCipher.

    • Method Detail

      • getDatabaseName

         String getDatabaseName()

        Return the name of the SQLite database being opened, as given to the constructor.

      • setWriteAheadLoggingEnabled

         void setWriteAheadLoggingEnabled(boolean enabled)

        Enables or disables the use of write-ahead logging for the database. Write-ahead logging cannot be used with read-only databases so the value of this flag is ignored if the database is opened read-only.

        Parameters:
        enabled - True if write-ahead logging should be enabled, false if it should be disabled.

      • getWritableDatabase

         SQLiteDatabase getWritableDatabase()

        Create and/or open a database that will be used for reading and writing. The first time this is called, the database will be opened and onCreate, onUpgrade and/or onOpen will be called.

        Once opened successfully, the database is cached, so you can call this method every time you need to write to the database. (Make sure to call close when you no longer need the database.) Errors such as bad permissions or a full disk may cause this method to fail, but future attempts may succeed if the problem is fixed.

        Database upgrade may take a long time, you should not call this method from the application main thread, including from ContentProvider.onCreate().

        Returns:

        a read/write database object valid until close is called

      • getReadableDatabase

         SQLiteDatabase getReadableDatabase()

        Create and/or open a database. This will be the same object returned by getWritableDatabase unless some problem, such as a full disk, requires the database to be opened read-only. In that case, a read-only database object will be returned. If the problem is fixed, a future call to getWritableDatabase may succeed, in which case the read-only database object will be closed and the read/write object will be returned in the future.

        Like getWritableDatabase, this method may take a long time to return, so you should not call it from the application main thread, including from ContentProvider.onCreate().

        Returns:

        a database object valid until getWritableDatabase or close is called.

      • close

         synchronized void close()

        Close any open database object.

      • onBeforeDelete

         void onBeforeDelete(SQLiteDatabase db)

        Called before the database is deleted when the version returned by getVersion is lower than the minimum supported version passed (if at all) while creating this helper. After the database is deleted, a fresh database with the given version is created. This will be followed by onConfigure and onCreate being called with a new SQLiteDatabase object

        Parameters:
        db - the database opened with this helper

      • onCreate

         abstract void onCreate(SQLiteDatabase db)

        Called when the database is created for the first time. This is where the creation of tables and the initial population of the tables should happen.

        Parameters:
        db - The database.

      • onUpgrade

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

        Called when the database needs to be upgraded. The implementation should use this method to drop tables, add tables, or do anything else it needs to upgrade to the new schema version.

        The SQLite ALTER TABLE documentation can be found here. If you add new columns you can use ALTER TABLE to insert them into a live table. If you rename or remove columns you can use ALTER TABLE to rename the old table, then create the new table and then populate the new table with the contents of the old table.

        This method executes within a transaction. If an exception is thrown, all changes will automatically be rolled back.

        Parameters:
        db - The database.
        oldVersion - The old database version.
        newVersion - The new database version.

      • onDowngrade

         void onDowngrade(SQLiteDatabase db, int oldVersion, int newVersion)

        Called when the database needs to be downgraded. This is strictly similar to onUpgrade method, but is called whenever current version is newer than requested one. However, this method is not abstract, so it is not mandatory for a customer to implement it. If not overridden, default implementation will reject downgrade and throws SQLiteException

        This method executes within a transaction. If an exception is thrown, all changes will automatically be rolled back.

        Parameters:
        db - The database.
        oldVersion - The old database version.
        newVersion - The new database version.

      • onOpen

         void onOpen(SQLiteDatabase db)

        Called when the database has been opened. The implementation should check isReadOnly before updating the database.

        This method is called after the database connection has been configured and after the database schema has been created, upgraded or downgraded as necessary. If the database connection must be configured in some way before the schema is created, upgraded, or downgraded, do it in onConfigure instead.

        Parameters:
        db - The database.