com.couchbase.lite.internal.database.sqlite

Class SQLiteDatabaseConfiguration

java.lang.Object

com.couchbase.lite.internal.database.sqlite.SQLiteDatabaseConfiguration

public final class SQLiteDatabaseConfiguration
extends java.lang.Object

Describes how to configure a database.

The purpose of this object is to keep track of all of the little configuration settings that are applied to a database after it is opened so that they can be applied to all connections in the connection pool uniformly.

Each connection maintains its own copy of this object so it can keep track of which settings have already been applied.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	foreignKeyConstraintsEnabled True if foreign key constraints are enabled.
java.lang.String	label The label to use to describe the database when it appears in logs.
java.util.Locale	locale The database locale.
int	maxSqlCacheSize The maximum size of the prepared statement cache for each database connection.
static java.lang.String	MEMORY_DB_PATH Special path used by in-memory databases.
int	openFlags The flags used to open the database.
java.lang.String	path The database path.
int	walConnectionPoolSize Maximum number of database connections opened and managed by framework layer to handle queries on each database when using Write-Ahead Logging.

Constructor Summary

Constructors

Constructor and Description
SQLiteDatabaseConfiguration(SQLiteDatabaseConfiguration other) Creates a database configuration as a copy of another configuration.
SQLiteDatabaseConfiguration(java.lang.String path, int openFlags, int walConnectionPoolSize) Creates a database configuration with the required parameters for opening a database and default values for all other parameters.

Method Summary

Modifier and Type	Method and Description
boolean	isInMemoryDb() Returns true if the database is in-memory.
boolean	isOpenReadOnly() Returns true of the database is open is in OPEN_READONLY mode.
void	updateParametersFrom(SQLiteDatabaseConfiguration other) Updates the non-immutable parameters of this configuration object from the other configuration object.

Methods inherited from class java.lang.Object

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

Field Detail

MEMORY_DB_PATH

public static final java.lang.String MEMORY_DB_PATH

Special path used by in-memory databases.

See Also:

Constant Field Values

path

public final java.lang.String path

The database path.

label

public final java.lang.String label

The label to use to describe the database when it appears in logs. This is derived from the path but is stripped to remove PII.

openFlags

public int openFlags

The flags used to open the database.

maxSqlCacheSize

public int maxSqlCacheSize

The maximum size of the prepared statement cache for each database connection. Must be non-negative. Default is 25.

locale

public java.util.Locale locale

The database locale. Default is the value returned by Locale.getDefault().

foreignKeyConstraintsEnabled

public boolean foreignKeyConstraintsEnabled

True if foreign key constraints are enabled. Default is false.

walConnectionPoolSize

public int walConnectionPoolSize

Maximum number of database connections opened and managed by framework layer to handle queries on each database when using Write-Ahead Logging.

Constructor Detail

SQLiteDatabaseConfiguration

public SQLiteDatabaseConfiguration(java.lang.String path,
                                   int openFlags,
                                   int walConnectionPoolSize)

Creates a database configuration with the required parameters for opening a database and default values for all other parameters.

Parameters:

path - The database path.

openFlags - Open flags for the database, such as SQLiteDatabase.OPEN_READWRITE.

walConnectionPoolSize -

SQLiteDatabaseConfiguration

public SQLiteDatabaseConfiguration(SQLiteDatabaseConfiguration other)

Creates a database configuration as a copy of another configuration.

Parameters:

other - The other configuration.

Method Detail

updateParametersFrom

public void updateParametersFrom(SQLiteDatabaseConfiguration other)

Updates the non-immutable parameters of this configuration object from the other configuration object.

Parameters:

other - The object from which to copy the parameters.

isInMemoryDb

public boolean isInMemoryDb()

Returns true if the database is in-memory.

Returns:

True if the database is in-memory.

isOpenReadOnly

public boolean isOpenReadOnly()

Returns true of the database is open is in OPEN_READONLY mode.

Returns:

True of the database is open is in OPEN_READONLY mode.