Skip to content

feat: adds a SharedPreferencesMigration example (preferences) #761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
telpirion wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: adds a SharedPreferencesMigration example (preferences) #761

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d351f29
feat: adds android_datastore_preferences_migrate snippet
telpirion Jan 6, 2026
d59a701
addresses reviewer comments
telpirion Jan 6, 2026
3311268
undo changes to PreferencesDataStore.kt
telpirion Jan 6, 2026
680096b
Apply Spotless
telpirion Jan 6, 2026
865a392
Merge branch 'main' into shared-preferences-migration
telpirion Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions datastore/src/main/java/com/example/datastore/snippets/preferences/PreferencesDataStore.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,20 @@ import kotlinx.coroutines.flow.map
val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = "settings")
// [END android_datastore_preferences_create]

/*
// [START android_datastore_preferences_migrate]
// Be sure to pass the original SharePreferences name when creating the migration.
private val SETTINGS_NAME = "settings"

private val Context.dataStore by preferencesDataStore(
name = SETTINGS_NAME,
produceMigrations = { context ->
listOf(SharedPreferencesMigration(context, SETTINGS_NAME))
}
)
// [END android_datastore_preferences_migrate]
*/

class PreferencesDataStore(private val context: Context) {

// [START android_datastore_preferences_read]
Expand Down
Loading