# DataStoreFactory

Artifact: [androidx.datastore:datastore-core](https://developer.android.com/jetpack/androidx/releases/datastore) [View Source](https://cs.android.com/search?q=file:androidx/datastore/core/DataStoreFactory.+class:androidx.datastore.core.DataStoreFactory) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/datastore#1.0.0)

*** ** * ** ***

Kotlin \|[Java](https://developer.android.com/reference/androidx/datastore/core/DataStoreFactory "View this page in Java") Common/AllAndroid/JVMNative/C/iOSJavaScript
- Cmn

  ```
  object DataStoreFactory
  ```

*** ** * ** ***

Public factory for creating DataStore instances.

## Summary

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStore<T>` | `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?> https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStoreFactory#create(androidx.datastore.core.Storage,androidx.datastore.core.handlers.ReplaceFileCorruptionHandler,kotlin.collections.List,kotlinx.coroutines.CoroutineScope)( storage: https://developer.android.com/reference/kotlin/androidx/datastore/core/Storage<T>, corruptionHandler: https://developer.android.com/reference/kotlin/androidx/datastore/core/handlers/ReplaceFileCorruptionHandler<T>?, migrations: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/datastore/core/DataMigration<T>>, scope: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html )` | Cmn android N JS |
| `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStore<T>` | `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?> https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStoreFactory#create(androidx.datastore.core.Serializer,androidx.datastore.core.handlers.ReplaceFileCorruptionHandler,kotlin.collections.List,kotlinx.coroutines.CoroutineScope,kotlin.Function0)( serializer: https://developer.android.com/reference/kotlin/androidx/datastore/core/Serializer<T>, corruptionHandler: https://developer.android.com/reference/kotlin/androidx/datastore/core/handlers/ReplaceFileCorruptionHandler<T>?, migrations: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/datastore/core/DataMigration<T>>, scope: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html, produceFile: () -> https://developer.android.com/reference/java/io/File.html )` Create an instance of SingleProcessDataStore. | android |
| `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStore<T>` | `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?> https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStoreFactory#create(androidx.datastore.core.Serializer,androidx.datastore.core.handlers.ReplaceFileCorruptionHandler,kotlin.collections.List,kotlinx.coroutines.CoroutineScope,kotlin.Function0)( serializer: https://developer.android.com/reference/kotlin/androidx/datastore/core/Serializer<T>, corruptionHandler: https://developer.android.com/reference/kotlin/androidx/datastore/core/handlers/ReplaceFileCorruptionHandler<T>?, migrations: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/datastore/core/DataMigration<T>>, scope: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html, produceFile: () -> https://developer.android.com/reference/java/io/File.html )` Create an instance of SingleProcessDataStore. | android |
| `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStore<T>` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 24) <T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?> https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStoreFactory#createInDeviceProtectedStorage(android.content.Context,kotlin.String,androidx.datastore.core.Serializer,androidx.datastore.core.handlers.ReplaceFileCorruptionHandler,kotlin.collections.List,kotlinx.coroutines.CoroutineScope)( context: https://developer.android.com/reference/android/content/Context.html, fileName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, serializer: https://developer.android.com/reference/kotlin/androidx/datastore/core/Serializer<T>, corruptionHandler: https://developer.android.com/reference/kotlin/androidx/datastore/core/handlers/ReplaceFileCorruptionHandler<T>?, migrations: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/datastore/core/DataMigration<T>>, scope: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html )` Create an instance of SingleProcessDataStore that can be used during direct boot. | android |

## Public functions

### create

Cmn android N JS

```
fun <T : Any?> create(
    storage: Storage<T>,
    corruptionHandler: ReplaceFileCorruptionHandler<T>? = null,
    migrations: List<DataMigration<T>> = listOf(),
    scope: CoroutineScope = CoroutineScope(ioDispatcher() + SupervisorJob())
): DataStore<T>
```

### create

android

```
fun <T : Any?> create(
    serializer: Serializer<T>,
    corruptionHandler: ReplaceFileCorruptionHandler<T>? = null,
    migrations: List<DataMigration<T>> = listOf(),
    scope: CoroutineScope = CoroutineScope(Dispatchers.IO + SupervisorJob()),
    produceFile: () -> File
): DataStore<T>
```

Create an instance of SingleProcessDataStore. Never create more than one instance of DataStore for a given file; doing so can break all DataStore functionality. You should consider managing your DataStore instance as a singleton. If there are multiple DataStores active, DataStore will throw IllegalStateException when reading or updating data. A DataStore is considered active as long as its scope is active.

T is the type DataStore acts on. The type T must be immutable. Mutating a type used in DataStore invalidates any guarantees that DataStore provides and will result in potentially serious, hard-to-catch bugs. We strongly recommend using protocol buffers: https://developers.google.com/protocol-buffers/docs/javatutorial - which provides immutability guarantees, a simple API and efficient serialization.

It is important to note that if a `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStoreFactory#create(androidx.datastore.core.Serializer,androidx.datastore.core.handlers.ReplaceFileCorruptionHandler,kotlin.collections.List,kotlinx.coroutines.CoroutineScope,kotlin.Function0)` lambda to produce a file in the User Encrypted (UE) storage via a `https://developer.android.com/reference/android/content/Context.html` is used, this file will not be available during direct boot, and may result in a `https://developer.android.com/reference/kotlin/androidx/datastore/core/DirectBootUsageException` via a `https://developer.android.com/reference/java/io/FileNotFoundException.html` or a silent failure. To create an instance of a DataStore to be used safely during direct boot mode, please use `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStoreFactory#createInDeviceProtectedStorage(android.content.Context,kotlin.String,androidx.datastore.core.Serializer,androidx.datastore.core.handlers.ReplaceFileCorruptionHandler,kotlin.collections.List,kotlinx.coroutines.CoroutineScope)`.

| Parameters |
|---|---|
| `serializer: https://developer.android.com/reference/kotlin/androidx/datastore/core/Serializer<T>` | Serializer for the type T used with DataStore. The type T must be immutable. |
| `corruptionHandler: https://developer.android.com/reference/kotlin/androidx/datastore/core/handlers/ReplaceFileCorruptionHandler<T>? = null` | The corruptionHandler is invoked if DataStore encounters a `https://developer.android.com/reference/kotlin/androidx/datastore/core/CorruptionException` when attempting to read data. CorruptionExceptions are thrown by serializers when data can not be de-serialized. |
| `migrations: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/datastore/core/DataMigration<T>> = listOf()` | Migrations are run before any access to data can occur. Migrations must be idempotent. |
| `scope: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html = CoroutineScope(Dispatchers.IO + SupervisorJob())` | The scope in which IO operations and transform functions will execute. |
| `produceFile: () -> https://developer.android.com/reference/java/io/File.html` | Function which returns the file that the new DataStore will act on. The function must return the same path every time. No two instances of DataStore should act on the same file at the same time. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStore<T>` | a new DataStore instance with the provided configuration |

### create

android

```
fun <T : Any?> create(
    serializer: Serializer<T>,
    corruptionHandler: ReplaceFileCorruptionHandler<T>? = null,
    migrations: List<DataMigration<T>> = listOf(),
    scope: CoroutineScope = CoroutineScope(Dispatchers.IO + SupervisorJob()),
    produceFile: () -> File
): DataStore<T>
```

Create an instance of SingleProcessDataStore. Never create more than one instance of DataStore for a given file; doing so can break all DataStore functionality. You should consider managing your DataStore instance as a singleton. If there are multiple DataStores active, DataStore will throw IllegalStateException when reading or updating data. A DataStore is considered active as long as its scope is active.

T is the type DataStore acts on. The type T must be immutable. Mutating a type used in DataStore invalidates any guarantees that DataStore provides and will result in potentially serious, hard-to-catch bugs. We strongly recommend using protocol buffers: https://developers.google.com/protocol-buffers/docs/javatutorial - which provides immutability guarantees, a simple API and efficient serialization.

| Parameters |
|---|---|
| `serializer: https://developer.android.com/reference/kotlin/androidx/datastore/core/Serializer<T>` | Serializer for the type T used with DataStore. The type T must be immutable. |
| `corruptionHandler: https://developer.android.com/reference/kotlin/androidx/datastore/core/handlers/ReplaceFileCorruptionHandler<T>? = null` | The corruptionHandler is invoked if DataStore encounters a `https://developer.android.com/reference/kotlin/androidx/datastore/core/CorruptionException` when attempting to read data. CorruptionExceptions are thrown by serializers when data can not be de-serialized. |
| `migrations: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/datastore/core/DataMigration<T>> = listOf()` | Migrations are run before any access to data can occur. Migrations must be idempotent. |
| `scope: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html = CoroutineScope(Dispatchers.IO + SupervisorJob())` | The scope in which IO operations and transform functions will execute. |
| `produceFile: () -> https://developer.android.com/reference/java/io/File.html` | Function which returns the file that the new DataStore will act on. The function must return the same path every time. No two instances of DataStore should act on the same file at the same time. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStore<T>` | a new DataStore instance with the provided configuration |

### createInDeviceProtectedStorage

android

```
@RequiresApi(value = 24)
fun <T : Any?> createInDeviceProtectedStorage(
    context: Context,
    fileName: String,
    serializer: Serializer<T>,
    corruptionHandler: ReplaceFileCorruptionHandler<T>? = null,
    migrations: List<DataMigration<T>> = listOf(),
    scope: CoroutineScope = CoroutineScope(Dispatchers.IO + SupervisorJob())
): DataStore<T>
```

Create an instance of SingleProcessDataStore that can be used during direct boot.

This API always creates the DataStore in the Device Encrypted storage.

| Parameters |
|---|---|
| `context: https://developer.android.com/reference/android/content/Context.html` | The DeviceProtectedStorageContext which will be used to create the file that the new DataStore will act on. |
| `fileName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | the filename relative to Context.createDeviceProtectedStorageContext().filesDir that DataStore acts on. The File is obtained from `https://developer.android.com/reference/kotlin/androidx/datastore/core/package-summary#(android.content.Context).deviceProtectedDataStoreFile(kotlin.String)`. It is created in the "/datastore" subdirectory, in the device encrypted storage. |
| `serializer: https://developer.android.com/reference/kotlin/androidx/datastore/core/Serializer<T>` | Serializer for the type T used with DataStore. The type T must be immutable. |
| `corruptionHandler: https://developer.android.com/reference/kotlin/androidx/datastore/core/handlers/ReplaceFileCorruptionHandler<T>? = null` | The corruptionHandler is invoked if DataStore encounters a `https://developer.android.com/reference/kotlin/androidx/datastore/core/CorruptionException` when attempting to read data. CorruptionExceptions are thrown by serializers when data can not be de-serialized. |
| `migrations: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/datastore/core/DataMigration<T>> = listOf()` | Migrations are run before any access to data can occur. Migrations must be idempotent. |
| `scope: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html = CoroutineScope(Dispatchers.IO + SupervisorJob())` | The scope in which IO operations and transform functions will execute. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStore<T>` | a new DataStore instance with the provided configuration |