com.cloudant.sync.sqlite

Class SQLDatabaseFactory

java.lang.Object

com.cloudant.sync.sqlite.SQLDatabaseFactory

public class SQLDatabaseFactory
extends java.lang.Object

Factory class to create SQLDatabase, and update schema

API Status: Private - API users are discouraged from using this class as fields, method signatures, and implementation details may be subject to change

Constructor Summary

Constructors

Constructor and Description
SQLDatabaseFactory()

Method Summary

Modifier and Type	Method and Description
static SQLDatabase	createSQLDatabase(java.lang.String dbFilename, KeyProvider provider) SQLCipher-based implementation for creating database.
static SQLDatabase	openSqlDatabase(java.lang.String dbFilename, KeyProvider provider) SQLCipher-based implementation for opening database.
static void	updateSchema(SQLDatabase database, Migration migration, int version) Update schema for SQLDatabase

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLDatabaseFactory

public SQLDatabaseFactory()

Method Detail

createSQLDatabase

public static SQLDatabase createSQLDatabase(java.lang.String dbFilename,
                                            KeyProvider provider)
                                     throws java.io.IOException,
                                            java.sql.SQLException

SQLCipher-based implementation for creating database.

Parameters:

dbFilename - full file path of the db file

provider - Key provider object storing the SQLCipher key Supply a NullKeyProvider to use a non-encrypted database.

Returns:

SQLDatabase for the given filename

Throws:

java.io.IOException - if the file does not exists, and also can not be created

java.sql.SQLException - if the database cannot be opened.

openSqlDatabase

public static SQLDatabase openSqlDatabase(java.lang.String dbFilename,
                                          KeyProvider provider)
                                   throws java.io.IOException,
                                          java.sql.SQLException

SQLCipher-based implementation for opening database.

Parameters:

dbFilename - full file path of the db file

provider - Key provider object storing the SQLCipher key Supply a NullKeyProvider to use a non-encrypted database.

Returns:

SQLDatabase for the given filename

Throws:

java.io.IOException - if the file does not exists, and also can not be created

java.sql.SQLException - If the database could not be opened.

updateSchema

public static void updateSchema(SQLDatabase database,
                                Migration migration,
                                int version)
                         throws java.sql.SQLException

Update schema for SQLDatabase

Each input schema has a version, if the database's version is smaller than version, the schema statements are executed.

SQLDatabase's version is defined stored in user_version in the database:

PRAGMA user_version;

This method updates user_version if the migration is successful.

Parameters:

database - database to perform migration in.

migration - migration to perform.

version - the version this migration migrates to.

Throws:

java.sql.SQLException - if migration fails

See Also:

SQLDatabase.getVersion()