K.5 Delete Data

Delete Data from Cloud Firestore

To delete a document, use the omit() method:

var laRef:DocumentReference = Firestore.collection("cities").document("LA");
laRef.addEventListener(FirestoreEvents.DOCUMENT_DELETE_SUCCESS, onDocDeleteSuccess);
laRef.addEventListener(FirestoreEvents.DOCUMENT_DELETE_FAILURE, onDocDeleteFailure);
laRef.omit();

function onDocDeleteFailure(e:FirestoreEvents):void
{
	var d:DocumentReference = e.target as DocumentReference;
	d.removeEventListener(FirestoreEvents.DOCUMENT_DELETE_SUCCESS, onDocDeleteSuccess);
	d.removeEventListener(FirestoreEvents.DOCUMENT_DELETE_FAILURE, onDocDeleteFailure);
	
	trace("onDocDeleteFailure: " + e.msg);
}

function onDocDeleteSuccess(e:FirestoreEvents):void
{
	var d:DocumentReference = e.target as DocumentReference;
	d.removeEventListener(FirestoreEvents.DOCUMENT_DELETE_SUCCESS, onDocDeleteSuccess);
	d.removeEventListener(FirestoreEvents.DOCUMENT_DELETE_FAILURE, onDocDeleteFailure);
	
	trace("onDocDeleteSuccess");
}

Delete fields

To delete specific fields from a document, use FieldValue.DELETE() method when you update a document:

var document:DocumentReference = Firestore.collection("data").document("one");
document.addEventListener(FirestoreEvents.DOCUMENT_UPDATE_SUCCESS, onFieldDeleteSuccess);
document.addEventListener(FirestoreEvents.DOCUMENT_UPDATE_FAILURE, onFieldDeleteFailure);
	
// Remove the 'stringExample' field from the document
document.update({stringExample: FieldValue.DELETE()});

function onFieldDeleteFailure(e:FirestoreEvents):void
{
	var d:DocumentReference = e.target as DocumentReference;
	d.removeEventListener(FirestoreEvents.DOCUMENT_UPDATE_SUCCESS, onFieldDeleteSuccess);
	d.removeEventListener(FirestoreEvents.DOCUMENT_UPDATE_FAILURE, onFieldDeleteFailure);
	
	trace("onFailure: " + e.msg);
}

function onFieldDeleteSuccess(e:FirestoreEvents):void
{
	var d:DocumentReference = e.target as DocumentReference;
	d.removeEventListener(FirestoreEvents.DOCUMENT_UPDATE_SUCCESS, onFieldDeleteSuccess);
	d.removeEventListener(FirestoreEvents.DOCUMENT_UPDATE_FAILURE, onFieldDeleteFailure);
	
	trace("onSuccess");
}

Delete collections

To delete an entire collection or subcollection in Cloud Firestore, retrieve all the documents within the collection or subcollection and delete them. If you have larger collections, you may want to delete the documents in smaller batches to avoid out-of-memory errors. Repeat the process until you've deleted the entire collection or subcollection.