Firestore - Delete a field inside an object

Question

I'm using Firestore and I would like to delete a field that is in a specific object. I can delete a field in a document thanks to :

fieldName: firebase.firestore.FieldValue.delete()

But if I have an object like :

songList {
songName1: "HelloWorld",
songName2: "AnotherSong",
songName3: "andTheLastOne"
}

In order to delete the field songName3, I won't be able to do something like :

songList.songName3: firebase.firestore.FieldValue.delete()

Is there a way to delete a field inside an object ? Or should I delete the whole object, rebuild it without the 3rd field and save it ?

Thanks in advance,

This worked for me: https://stackoverflow.com/a/47555348/5532513 — Yossi, Feb 05 '19 at 13:05

score 43 · Answer 1 · answered Jan 10 '18 at 21:35

The "dot notation" with the special "FieldValue.delete()" should work.

Try this:

    Map<String, Object> deleteSong = new HashMap<>();
    deleteSong.put("songList.songName3", FieldValue.delete());

    FirebaseFirestore.getInstance()
        .collection("yourCollection")
        .document("yourDocument")
        .update(deleteSong);

It worked for me.

See: https://firebase.google.com/docs/firestore/manage-data/delete-data https://firebase.google.com/docs/firestore/manage-data/add-data

score 23 · Answer 2 · answered Sep 28 '19 at 22:39

23

This work for me in general

firebase
  .firestore()
  .collection('collection-name')
  .doc('doc-id')
  .set({ songlist : {
    [songName]: firebase.firestore.FieldValue.delete()
  }
  }, { merge: true });

answered Sep 28 '19 at 22:39

Manuel Borja

231
2
2

score 10 · Answer 3 · edited Sep 25 '21 at 02:11

Found this topic today and want to add my solution. I am using the dot notation. The following will remove the specific song from the songlist by using firestore.FieldValue.delete();. I am using the Node.js firebase-admin package written in TypeScript:

import * as admin from 'firebase-admin';
export async function removeSong(trackId: string, song: string) {
    try {
        const updates = {};
        // Dot Notation - will delete the specific song from songList
        updates[`songList.${song}`] = admin.firestore.FieldValue.delete();
        // Not necessary, but it's always a good practice
        updates['updatedAt'] = admin.firestore.FieldValue.serverTimestamp();

        await firestore.collection('songs').doc(trackId).update(updates);
        return true
    } catch (error) {
        return null;
    }
}

Using your solution I was able to delete a nested field inside an object. However, I used firebase.firestore instead of admin.firestore. It seems to be working just as well. — Phrosen, Feb 14 '21 at 10:54

N Kurt · Answer 4 · 2021-03-15T20:51:16.380

It did not allow me to comment above, but Manuel Borja's solution works and is pretty clean. Here is how I used it:

db.collection("coolcollection")
  .doc(id)
  .set(
    {
      users: {
        [firebase.auth().currentUser
          .email]: firebase.firestore.FieldValue.delete(),
      },
    },
    { merge: true }
  );

A few things to add: this works when the given field of the map exists and when it does not exist.

score 2 · Answer 5 · answered Feb 10 '19 at 22:07

I had the same issue from Android using Kotlin, and I solved it with dot notation as well. For Android Kotlin users, that is:

 val songName: String = "songName3"
 val updatesMap = HashMap<String, Any>()
 updatesMap["songList.${songName}"] = FieldValue.delete()
 FirebaseFirestore.getInstance()
                  .collection("Your Collection")
                  .document("Your Document")
                  .update(updatesMap)

Hope this helps!

score 2 · Answer 6 · answered Jun 08 '20 at 19:37

Simpler approach to handle maps/object

db.collection('Users').doc('key')
        .update({
            'products.keytext' : firebase.firestore.FieldValue.delete()
        })
        .then(() => {
            console.log('Success');
        })
        .catch((e) => {
            console.log('Error---->', e);
        });

This will remove object with a key keytext from products map.

score 2 · Answer 7 · answered Mar 09 '22 at 14:04

2

The new recommended way is to use the exported method deleteField:

import { updateDoc, deleteField } from "firebase/firestore";

// Remove the 'songName3' field from the songList map in the document
await updateDoc(yourRef, {
    ['songList.songName3']: deleteField()
});

answered Mar 09 '22 at 14:04

Antonin Beaufort

333
3
8

it's the "v9" way – Antoine Weber Jul 17 '22 at 21:27

morgler · Answer 8 · 2019-02-06T19:35:56.863

1

Caution: This does not work for Maps, only for Arrays!

You might be able to implement SongList as an array instead of a Map. Because for Arrays Firestore now has a dedicated function to remove an element from an array:

yourRef.update({
    songList: firebase.firestore.FieldValue.arrayRemove("SongName3")
});

Source: https://cloud.google.com/firestore/docs/manage-data/add-data#update_elements_in_an_array

edited Feb 06 '19 at 19:35

answered Feb 06 '19 at 19:17

morgler

1,669
1
18
26

score 1 · Answer 9 · answered Jun 06 '21 at 12:27

Update the document with a Map which has a key you want to get deleted and value FieldValue.delete().

var collection = FirebaseFirestore.instance.collection('collection');
collection
  .doc('document_id')
  .update(
    {
      'songList.songName3': FieldValue.delete(),
    }
);

score 0 · Answer 10 · answered Jul 16 '21 at 16:38

0

const deleteField = async () => {
    const FieldValue = firestore.FieldValue;
    const itemRef = firestore().collection('COLLECTION-NAME').doc('DOCUMENT-NAME');                                
    const res = await itemRef.update(
    'ELEMENT-NAME', FieldValue.delete() //'ELEMENT-NAME' OR Object.Field which equals to Parent Field Name.
)};
e.g.
{ 
    12345: { you: 'You', me: 'Me', we: '12345' },
    56789: { you: 'You', me: 'Me', we: '56789' },
}
const res = await itemRef.update(
    object.we, FieldValue.delete() //OR '12345', FieldValue.delete()
);

answered Jul 16 '21 at 16:38

Chirag Dave

786
6
5

While this code may solve the question, [including an explanation](//meta.stackexchange.com/q/114762) of how and why this solves the problem would really help to improve the quality of your post, and probably result in more up-votes. Remember that you are answering the question for readers in the future, not just the person asking now. Please [edit] your answer to add explanations and give an indication of what limitations and assumptions apply. – Kevin M. Mansour Jul 17 '21 at 14:47

Firestore - Delete a field inside an object

10 Answers10

Linked