OpenParams
class OpenParams
| kotlin.Any | |
| ↳ | android.database.sqlite.SQLiteDatabase.OpenParams |
Wrapper for configuration parameters that are used for opening SQLiteDatabase
Summary
| Nested classes | |
|---|---|
|
Builder for |
|
| Public methods | |
|---|---|
| SQLiteDatabase.CursorFactory? |
Returns an optional factory class that is called to instantiate a cursor when query is called |
| DatabaseErrorHandler? |
Returns handler for database corruption errors |
| Long |
Returns maximum number of milliseconds that SQLite connection is allowed to be idle before it is closed and removed from the pool. |
| String? |
Returns journal mode. |
| Int |
Returns total number of lookaside memory slots per database connection or -1 if not set. |
| Int |
Returns size in bytes of each lookaside slot or -1 if not set. |
| Int |
Returns flags to control database access mode. |
| String? |
Returns synchronous mode. |
Public methods
getCursorFactory
fun getCursorFactory(): SQLiteDatabase.CursorFactory?
Returns an optional factory class that is called to instantiate a cursor when query is called
| Return | |
|---|---|
SQLiteDatabase.CursorFactory? |
This value may be null. |
getErrorHandler
fun getErrorHandler(): DatabaseErrorHandler?
Returns handler for database corruption errors
| Return | |
|---|---|
DatabaseErrorHandler? |
This value may be null. |
getIdleConnectionTimeout
fun getIdleConnectionTimeout(): Long
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
| Return | |
|---|---|
Long |
timeout in milliseconds or -1 if the value wasn't set. |
getJournalMode
fun getJournalMode(): String?
Returns journal mode. set via Builder.setJournalMode(String).
| Return | |
|---|---|
String? |
This value may be null. |
getLookasideSlotCount
fun getLookasideSlotCount(): Int
Returns total number of lookaside memory slots per database connection or -1 if not set.
| Return | |
|---|---|
Int |
Value is -1 or greater |
getLookasideSlotSize
fun getLookasideSlotSize(): Int
Returns size in bytes of each lookaside slot or -1 if not set.
| Return | |
|---|---|
Int |
Value is -1 or greater |
getOpenFlags
fun getOpenFlags(): Int
Returns flags to control database access mode. Default value is 0.
| Return | |
|---|---|
Int |
Value is either 0 or a combination of android.database.sqlite.SQLiteDatabase#OPEN_READWRITE, android.database.sqlite.SQLiteDatabase#OPEN_READONLY, android.database.sqlite.SQLiteDatabase#CREATE_IF_NECESSARY, android.database.sqlite.SQLiteDatabase#NO_LOCALIZED_COLLATORS, android.database.sqlite.SQLiteDatabase.NO_DOUBLE_QUOTED_STRS, and android.database.sqlite.SQLiteDatabase#ENABLE_WRITE_AHEAD_LOGGING |
getSynchronousMode
fun getSynchronousMode(): String?
Returns synchronous mode. If not set, a system wide default will be used.
| Return | |
|---|---|
String? |
This value may be null. |