Stay organized with collections Save and categorize content based on your preferences.

public static final class SQLiteDatabase.OpenParams
extends Object


Wrapper for configuration parameters that are used for opening SQLiteDatabase

Summary

Nested classes

class SQLiteDatabase.OpenParams.Builder

Builder for OpenParams. 

Public methods

SQLiteDatabase.CursorFactory getCursorFactory()

Returns an optional factory class that is called to instantiate a cursor when query is called

DatabaseErrorHandler getErrorHandler()

Returns handler for database corruption errors

long getIdleConnectionTimeout()

Returns maximum number of milliseconds that SQLite connection is allowed to be idle before it is closed and removed from the pool.

String getJournalMode()

Returns journal mode.

int getLookasideSlotCount()

Returns total number of lookaside memory slots per database connection or -1 if not set.

int getLookasideSlotSize()

Returns size in bytes of each lookaside slot or -1 if not set.

int getOpenFlags()

Returns flags to control database access mode.

String getSynchronousMode()

Returns synchronous mode.

Inherited methods

From class java.lang.Object

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

getCursorFactory

Added in API level 27 

public SQLiteDatabase.CursorFactory getCursorFactory ()

Returns an optional factory class that is called to instantiate a cursor when query is called

Returns
SQLiteDatabase.CursorFactory This value may be null.

getErrorHandler

Added in API level 27 

public DatabaseErrorHandler getErrorHandler ()

Returns handler for database corruption errors

Returns
DatabaseErrorHandler This value may be null.

getIdleConnectionTimeout

Added in API level 27 

public long getIdleConnectionTimeout ()

Returns maximum number of milliseconds that SQLite connection is allowed to be idle before it is closed and removed from the pool.

If the value isn't set, the timeout defaults to the system wide timeout

Returns
long timeout in milliseconds or -1 if the value wasn't set.

getJournalMode

Added in API level 28 

public String getJournalMode ()

Returns journal mode. set via Builder#setJournalMode(String).

Returns
String This value may be null.

getLookasideSlotCount

Added in API level 27 

public int getLookasideSlotCount ()

Returns total number of lookaside memory slots per database connection or -1 if not set.

Returns
int Value is -1 or greater

getLookasideSlotSize

Added in API level 27 

public int getLookasideSlotSize ()

Returns size in bytes of each lookaside slot or -1 if not set.

Returns
int Value is -1 or greater

getOpenFlags

Added in API level 27 

public int getOpenFlags ()

Returns flags to control database access mode. Default value is 0.

Returns
int Value is either 0 or a combination of SQLiteDatabase.OPEN_READWRITE, SQLiteDatabase.OPEN_READONLY, SQLiteDatabase.CREATE_IF_NECESSARY, SQLiteDatabase.NO_LOCALIZED_COLLATORS, and SQLiteDatabase.ENABLE_WRITE_AHEAD_LOGGING

getSynchronousMode

Added in API level 28 

public String getSynchronousMode ()

Returns synchronous mode. If not set, a system wide default will be used.

Returns
String This value may be null.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2023-02-08 UTC.