How to clear jetpack datastore data on specific condition

Question

i've been using jetpack datastore for a while, but then i got a problem. I want to clear data in datastore when the app is destroyed. Im using jetpack datastore to persist data only in form

i've searched that sharedPreferences has a clear() function, is there a similar function for Jetpack Datastore ? and how can i use it ?

i found clear function in datastore documentation but there is no explanation on how to use it

Manohar · Accepted Answer · 2022-07-05T05:19:07.547

48

Use this

dataStore.edit { 
        it.clear()
    }

Method description states

Removes all preferences from this MutablePreferences.

For proto datastore (Thanks to Amir Raza for comment)

datastore.updateData { 
    it.toBuilder().clear().build()
}

edited Jul 05 '22 at 05:19

answered Nov 16 '20 at 03:52

Manohar

22,116
9
108
144

how can i use this on proto datastore ? – Pif Nov 16 '20 at 06:11
10

for proto datastore -> `datastore.updateData { it.toBuilder().clear().build() }` – Amir Raza Dec 16 '20 at 20:42
2

How to delete for specific preferences key? – A. Albrg Jan 13 '21 at 11:39
1

@A.Albrg you can set to null – Ade Dyas Jan 19 '21 at 06:24
1

@AdeDyas Can u write a sample code, please :) – A. Albrg Jan 19 '21 at 14:42
@AdeDyas - no you can't. But if you'd like to show us how, that'd be greatly appreciated. – Sakiboy Feb 27 '21 at 02:02
@A.Albrg check out [my answer](https://stackoverflow.com/a/66746767/2212770) – Wirling Mar 22 '21 at 13:17

score 40 · Answer 2 · answered Mar 22 '21 at 13:10

40

In case anyone wants to know how to remove a specific preference

context.dataStore.edit {
    it.remove(key)
}

answered Mar 22 '21 at 13:10

Wirling

4,810
3
48
78

score 7 · Answer 3 · answered Nov 24 '20 at 19:06

7

Try this (for Proto DataStore):

 dataStore.updateData { obj ->
    obj.toBuilder()
        .clear()
        .build()
 }

answered Nov 24 '20 at 19:06

Lev Krasovsky

71
2

score 6 · Answer 4 · 2021-03-26T10:41:32.223

6

If you want to delete a specific key then try this

dataStore.edit {
        if (it.contains(key)) {
            it.remove(key)
        }
    }

edited Mar 26 '21 at 10:41

answered Feb 28 '21 at 11:48

But `it` refers to `MutablePreferences`. So `it.clear()` would clear all preferences instead of a specific key. – Wirling Mar 22 '21 at 11:08
It should be `it.remove(key)`, I also posted an [answer](https://stackoverflow.com/a/66746767/2212770). The contains check is also not necessary because no exception will be thrown. – Wirling Mar 22 '21 at 13:14

score 1 · Answer 5 · answered Nov 20 '20 at 20:31

1

For Proto DataStore you can do:

dataStore.updateData { it.getDefaultInstance() }

It doesn't delete the file, but it's effectively the same.

answered Nov 20 '20 at 20:31

Rohit Sathyanarayana

41
2

so, this method means it will make dataStore to default data ? – Pif Nov 21 '20 at 03:10

How to clear jetpack datastore data on specific condition

5 Answers5

Linked

Related