Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#nestedclasses) \| [Methods](https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#inhmethods)

# SQLiteDatabase.OpenParams

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/database/sqlite/SQLiteDatabase.OpenParams "View this page in Kotlin") \|Java


`
public
static
final

class
SQLiteDatabase.OpenParams
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.database.sqlite.SQLiteDatabase.OpenParams |

<br />

*** ** * ** ***

Wrapper for configuration parameters that are used for opening `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase`

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams.Builder` Builder for `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams`. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.CursorFactory` | ` https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#getCursorFactory()() ` Returns an optional factory class that is called to instantiate a cursor when query is called |
| ` https://developer.android.com/reference/android/database/DatabaseErrorHandler` | ` https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#getErrorHandler()() ` Returns handler for database corruption errors |
| ` long` | ` https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#getIdleConnectionTimeout()() ` Returns maximum number of milliseconds that SQLite connection is allowed to be idle before it is closed and removed from the pool. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#getJournalMode()() ` Returns [journal mode](https://sqlite.org/pragma.html#pragma_journal_mode). |
| ` int` | ` https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#getLookasideSlotCount()() ` Returns total number of lookaside memory slots per database connection or -1 if not set. |
| ` int` | ` https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#getLookasideSlotSize()() ` Returns size in bytes of each lookaside slot or -1 if not set. |
| ` int` | ` https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#getOpenFlags()() ` Returns flags to control database access mode. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams#getSynchronousMode()() ` Returns [synchronous mode](https://sqlite.org/pragma.html#pragma_synchronous). |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public SQLiteDatabase.CursorFactory getCursorFactory ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.CursorFactory` | This value may be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams.Builder#setCursorFactory(android.database.sqlite.SQLiteDatabase.CursorFactory)`

### getErrorHandler

Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public DatabaseErrorHandler getErrorHandler ()
```

Returns handler for database corruption errors

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/database/DatabaseErrorHandler` | This value may be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams.Builder#setErrorHandler(android.database.DatabaseErrorHandler)`

### getIdleConnectionTimeout

Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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

<br />

| Returns ||
|---|---|
| `long` | timeout in milliseconds or -1 if the value wasn't set. <br /> |

### getJournalMode

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getJournalMode ()
```

Returns [journal mode](https://sqlite.org/pragma.html#pragma_journal_mode).
set via `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams.Builder#setJournalMode(java.lang.String)`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`. <br /> |

### getLookasideSlotCount

Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getLookasideSlotCount ()
```

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

<br />

| Returns ||
|---|---|
| `int` | Value is -1 or greater <br /> |

**See also:**

- `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams.Builder#setLookasideConfig(int,%20int)`

### getLookasideSlotSize

Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getLookasideSlotSize ()
```

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

<br />

| Returns ||
|---|---|
| `int` | Value is -1 or greater <br /> |

**See also:**

- `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams.Builder#setLookasideConfig(int,%20int)`

### getOpenFlags

Added in [API level 27](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getOpenFlags ()
```

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

<br />

| Returns ||
|---|---|
| `int` | Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase#OPEN_READWRITE` - `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase#OPEN_READONLY` - `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase#CREATE_IF_NECESSARY` - `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase#NO_LOCALIZED_COLLATORS` - `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase#ENABLE_WRITE_AHEAD_LOGGING` |

**See also:**

- `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams.Builder#setOpenFlags(int)`

### getSynchronousMode

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getSynchronousMode ()
```

Returns [synchronous mode](https://sqlite.org/pragma.html#pragma_synchronous).
If not set, a system wide default will be used.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.OpenParams.Builder#setSynchronousMode(java.lang.String)`