Удалить данные из Cloud Firestore

В следующих примерах показано, как удалять документы, поля и коллекции.

Удалить документы

Чтобы удалить документ, используйте следующие специфичные для языка методы delete() :

Web

Используйте метод deleteDoc() :

import { doc, deleteDoc } from "firebase/firestore";

await deleteDoc(doc(db, "cities", "DC"));
delete_document.js

Web

Используйте метод delete() :

db.collection("cities").doc("DC").delete().then(() => {
    console.log("Document successfully deleted!");
}).catch((error) => {
    console.error("Error removing document: ", error);
});
test.firestore.js
Быстрый

Используйте метод delete() :

Примечание: этот продукт недоступен на устройствах watchOS и App Clip. 
do {
  try await db.collection("cities").document("DC").delete()
  print("Document successfully removed!")
} catch {
  print("Error removing document: \(error)")
}
ViewController.swift
Objective-C

Используйте метод deleteDocumentWithCompletion:

Примечание: этот продукт недоступен на устройствах watchOS и App Clip. 
[[[self.db collectionWithPath:@"cities"] documentWithPath:@"DC"]
    deleteDocumentWithCompletion:^(NSError * _Nullable error) {
      if (error != nil) {
        NSLog(@"Error removing document: %@", error);
      } else {
        NSLog(@"Document successfully removed!");
      }
}];
ViewController.m

Kotlin

Используйте метод delete() :

db.collection("cities").document("DC")
    .delete()
    .addOnSuccessListener { Log.d(TAG, "DocumentSnapshot successfully deleted!") }
    .addOnFailureListener { e -> Log.w(TAG, "Error deleting document", e) }
DocSnippets.kt

Java

Используйте метод delete() :

db.collection("cities").document("DC")
        .delete()
        .addOnSuccessListener(new OnSuccessListener<Void>() {
            @Override
            public void onSuccess(Void aVoid) {
                Log.d(TAG, "DocumentSnapshot successfully deleted!");
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                Log.w(TAG, "Error deleting document", e);
            }
        });
DocSnippets.java

Dart

Используйте метод delete() :

db.collection("cities").doc("DC").delete().then(
      (doc) => print("Document deleted"),
      onError: (e) => print("Error updating document $e"),
    );
firestore.dart
Ява

Используйте метод delete() : 

// asynchronously delete a document
ApiFuture<WriteResult> writeResult = db.collection("cities").document("DC").delete();
// ...
System.out.println("Update time : " + writeResult.get().getUpdateTime());
ManageDataSnippets.java
Питон

Используйте метод delete() : 

db.collection("cities").document("DC").delete()
snippets.py

Python

Используйте метод delete() : 

await db.collection("cities").document("DC").delete()
snippets.py
С++

Используйте метод Delete() : 

db->Collection("cities").Document("DC").Delete().OnCompletion(
    [](const Future<void>& future) {
      if (future.error() == Error::kErrorOk) {
        std::cout << "DocumentSnapshot successfully deleted!" << std::endl;
      } else {
        std::cout << "Error deleting document: " << future.error_message()
                  << std::endl;
      }
    });
snippets.cpp
Node.js

Используйте метод delete() : 

const res = await db.collection('cities').doc('DC').delete();
index.js
Идти

Используйте метод Delete() : 


import (
	"context"
	"log"

	"cloud.google.com/go/firestore"
)

func deleteDoc(ctx context.Context, client *firestore.Client) error {
	_, err := client.Collection("cities").Doc("DC").Delete(ctx)
	if err != nil {
		// Handle any errors in an appropriate way, such as returning them.
		log.Printf("An error has occurred: %s", err)
	}

	return err
}

save_data_delete_doc.go
PHP

Используйте метод delete() : 

$db->collection('samples/php/cities')->document('DC')->delete();
data_delete_doc.php
Единство

Используйте метод DeleteAsync() : 

DocumentReference cityRef = db.Collection("cities").Document("DC");
cityRef.DeleteAsync();
С#

Используйте метод DeleteAsync() : 

DocumentReference cityRef = db.Collection("cities").Document("DC");
await cityRef.DeleteAsync();
Program.cs
Руби

Используйте метод delete() : 

city_ref = firestore.doc "#{collection_path}/DC"
city_ref.delete
delete_data.rb

При удалении документа Cloud Firestore не удаляет автоматически документы в своих подколлекциях. Вы по-прежнему сможете получить доступ к документам в подколлекциях по ссылке. Например, вы можете получить доступ к документу по пути /mycoll/mydoc/mysubcoll/mysubdoc даже если удалите родительский документ по пути /mycoll/mydoc .

Несуществующие предковые документы отображаются в консоли , но не отображаются в результатах запросов и снимках.

Если вы хотите удалить документ и все документы в его подколлекциях, это необходимо сделать вручную. Подробнее см. в разделе Удаление коллекций .

Удалить поля

Чтобы удалить определенные поля из документа, используйте следующие зависящие от языка методы FieldValue.delete() при обновлении документа:

Web

Используйте метод deleteField() : 

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

const cityRef = doc(db, 'cities', 'BJ');

// Remove the 'capital' field from the document
await updateDoc(cityRef, {
    capital: deleteField()
});
update_delete_field.js

Web

Используйте метод FieldValue.delete() : 

var cityRef = db.collection('cities').doc('BJ');

// Remove the 'capital' field from the document
var removeCapital = cityRef.update({
    capital: firebase.firestore.FieldValue.delete()
});
test.firestore.js
Быстрый

Используйте метод FieldValue.delete() :

Примечание: этот продукт недоступен на устройствах watchOS и App Clip. 
do {

  try await db.collection("cities").document("BJ").updateData([
    "capital": FieldValue.delete(),
  ])
  print("Document successfully updated")
} catch {
  print("Error updating document: \(error)")
}
ViewController.swift
Objective-C

Используйте метод fieldValueForDelete:

Примечание: этот продукт недоступен на устройствах watchOS и App Clip. 
[[[self.db collectionWithPath:@"cities"] documentWithPath:@"BJ"] updateData:@{
  @"capital": [FIRFieldValue fieldValueForDelete]
} completion:^(NSError * _Nullable error) {
  if (error != nil) {
    NSLog(@"Error updating document: %@", error);
  } else {
    NSLog(@"Document successfully updated");
  }
}];
ViewController.m

Kotlin

Используйте метод FieldValue.delete() : 

val docRef = db.collection("cities").document("BJ")

// Remove the 'capital' field from the document
val updates = hashMapOf<String, Any>(
    "capital" to FieldValue.delete(),
)

docRef.update(updates).addOnCompleteListener { }
DocSnippets.kt

Java

Используйте метод FieldValue.delete() : 

DocumentReference docRef = db.collection("cities").document("BJ");

// Remove the 'capital' field from the document
Map<String,Object> updates = new HashMap<>();
updates.put("capital", FieldValue.delete());

docRef.update(updates).addOnCompleteListener(new OnCompleteListener<Void>() {
    // ...
    // ...
DocSnippets.java

Dart

Используйте метод FieldValue.delete() : 

final docRef = db.collection("cities").doc("BJ");

// Remove the 'capital' field from the document
final updates = <String, dynamic>{
  "capital": FieldValue.delete(),
};

docRef.update(updates);
firestore.dart
Ява

Используйте метод FieldValue.delete() : 

DocumentReference docRef = db.collection("cities").document("BJ");
Map<String, Object> updates = new HashMap<>();
updates.put("capital", FieldValue.delete());
// Update and delete the "capital" field in the document
ApiFuture<WriteResult> writeResult = docRef.update(updates);
System.out.println("Update time : " + writeResult.get());
ManageDataSnippets.java
Питон

Используйте метод firestore.DELETE_FIELD : 

city_ref = db.collection("cities").document("BJ")
city_ref.update({"capital": firestore.DELETE_FIELD})
snippets.py

Python

Используйте метод firestore.DELETE_FIELD : 

city_ref = db.collection("cities").document("BJ")
await city_ref.update({"capital": firestore.DELETE_FIELD})
snippets.py
С++

Используйте метод FieldValue::Delete() : 

DocumentReference doc_ref = db->Collection("cities").Document("BJ");
doc_ref.Update({{"capital", FieldValue::Delete()}})
    .OnCompletion([](const Future<void>& future) { /*...*/ });
snippets.cpp
Node.js

Используйте метод FieldValue.delete() : 

// Create a document reference
const cityRef = db.collection('cities').doc('BJ');

// Remove the 'capital' field from the document
const res = await cityRef.update({
  capital: FieldValue.delete()
});
index.js
Идти

Используйте метод firestore.Delete : 


import (
	"context"
	"log"

	"cloud.google.com/go/firestore"
)

func deleteField(ctx context.Context, client *firestore.Client) error {
	_, err := client.Collection("cities").Doc("BJ").Update(ctx, []firestore.Update{
		{
			Path:  "capital",
			Value: firestore.Delete,
		},
	})
	if err != nil {
		// Handle any errors in an appropriate way, such as returning them.
		log.Printf("An error has occurred: %s", err)
	}

	// ...
	return err
}

save_data_delete_field.go
PHP

Используйте метод FieldValue::deleteField() : 

$cityRef = $db->collection('samples/php/cities')->document('BJ');
$cityRef->update([
    ['path' => 'capital', 'value' => FieldValue::deleteField()]
]);
data_delete_field.php
Единство

Используйте метод FieldValue.Delete : 

DocumentReference cityRef = db.Collection("cities").Document("BJ");
Dictionary<string, object> updates = new Dictionary<string, object>
{
    { "Capital", FieldValue.Delete }
};
С#

Используйте метод FieldValue.Delete : 

DocumentReference cityRef = db.Collection("cities").Document("BJ");
Dictionary<string, object> updates = new Dictionary<string, object>
{
    { "Capital", FieldValue.Delete }
};
await cityRef.UpdateAsync(updates);
Program.cs
Руби

Используйте метод firestore.field_delete : 

city_ref = firestore.doc "#{collection_path}/BJ"
city_ref.update({ capital: firestore.field_delete })
delete_data.rb

Удалить коллекции

Чтобы удалить всю коллекцию или подколлекцию в Cloud Firestore , извлеките (прочитайте) все документы из этой коллекции или подколлекций и удалите их. Этот процесс влечёт за собой расходы как на чтение, так и на удаление. Если у вас большие коллекции, рекомендуется удалять документы небольшими партиями, чтобы избежать ошибок нехватки памяти. Повторяйте этот процесс, пока не удалите всю коллекцию или подколлекцию.

Удаление коллекции требует координации неограниченного количества отдельных запросов на удаление. Если вам нужно удалить всю коллекцию целиком, делайте это только из доверенной серверной среды. Хотя удалить коллекцию из мобильного/веб-клиента возможно, это негативно скажется на безопасности и производительности.

Приведённые ниже фрагменты кода несколько упрощены и не затрагивают вопросы обработки ошибок, безопасности, удаления подколлекций или повышения производительности. Подробнее об одном из рекомендуемых подходов к удалению коллекций в рабочей среде см. в разделе «Удаление коллекций и подколлекций» .

Интернет 
// Deleting collections from a Web client is not recommended.
Быстрый
Примечание: этот продукт недоступен на устройствах watchOS и App Clip. 
// Deleting collections from an Apple client is not recommended.
Objective-C
Примечание: этот продукт недоступен на устройствах watchOS и App Clip. 
// Deleting collections from an Apple client is not recommended.

Kotlin 

// Deleting collections from an Android client is not recommended.

Java 

// Deleting collections from an Android client is not recommended.

Dart

Удалять коллекции из клиента не рекомендуется.

Ява 
/**
 * Delete a collection in batches to avoid out-of-memory errors. Batch size may be tuned based on
 * document size (atmost 1MB) and application requirements.
 */
void deleteCollection(CollectionReference collection, int batchSize) {
  try {
    // retrieve a small batch of documents to avoid out-of-memory errors
    ApiFuture<QuerySnapshot> future = collection.limit(batchSize).get();
    int deleted = 0;
    // future.get() blocks on document retrieval
    List<QueryDocumentSnapshot> documents = future.get().getDocuments();
    for (QueryDocumentSnapshot document : documents) {
      document.getReference().delete();
      ++deleted;
    }
    if (deleted >= batchSize) {
      // retrieve and delete another batch
      deleteCollection(collection, batchSize);
    }
  } catch (Exception e) {
    System.err.println("Error deleting collection : " + e.getMessage());
  }
}

ManageDataSnippets.java
Питон 
def delete_collection(coll_ref, batch_size):
    if batch_size == 0:
        return

    docs = coll_ref.list_documents(page_size=batch_size)
    deleted = 0

    for doc in docs:
        print(f"Deleting doc {doc.id} => {doc.get().to_dict()}")
        doc.delete()
        deleted = deleted + 1

    if deleted >= batch_size:
        return delete_collection(coll_ref, batch_size)

snippets.py

Python 

async def delete_collection(coll_ref, batch_size):
    docs = coll_ref.limit(batch_size).stream()
    deleted = 0

    async for doc in docs:
        print(f"Deleting doc {doc.id} => {doc.to_dict()}")
        await doc.reference.delete()
        deleted = deleted + 1

    if deleted >= batch_size:
        return delete_collection(coll_ref, batch_size)

snippets.py
С++ 
// This is not supported. Delete data using CLI as discussed below.
Node.js 
async function deleteCollection(db, collectionPath, batchSize) {
  const collectionRef = db.collection(collectionPath);
  const query = collectionRef.orderBy('__name__').limit(batchSize);

  return new Promise((resolve, reject) => {
    deleteQueryBatch(db, query, resolve).catch(reject);
  });
}

async function deleteQueryBatch(db, query, resolve) {
  const snapshot = await query.get();

  const batchSize = snapshot.size;
  if (batchSize === 0) {
    // When there are no documents left, we are done
    resolve();
    return;
  }

  // Delete documents in a batch
  const batch = db.batch();
  snapshot.docs.forEach((doc) => {
    batch.delete(doc.ref);
  });
  await batch.commit();

  // Recurse on the next process tick, to avoid
  // exploding the stack.
  process.nextTick(() => {
    deleteQueryBatch(db, query, resolve);
  });
}

index.js
Идти 

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/firestore"
	"google.golang.org/api/iterator"
)

func deleteCollection(w io.Writer, projectID, collectionName string,
	batchSize int) error {

	// Instantiate a client
	ctx := context.Background()
	client, err := firestore.NewClient(ctx, projectID)
	if err != nil {
		return err
	}

	col := client.Collection(collectionName)
	bulkwriter := client.BulkWriter(ctx)

	for {
		// Get a batch of documents
		iter := col.Limit(batchSize).Documents(ctx)
		numDeleted := 0

		// Iterate through the documents, adding
		// a delete operation for each one to the BulkWriter.
		for {
			doc, err := iter.Next()
			if err == iterator.Done {
				break
			}
			if err != nil {
				return err
			}

			bulkwriter.Delete(doc.Ref)
			numDeleted++
		}

		// If there are no documents to delete,
		// the process is over.
		if numDeleted == 0 {
			bulkwriter.End()
			break
		}

		bulkwriter.Flush()
	}
	fmt.Fprintf(w, "Deleted collection \"%s\"", collectionName)
	return nil
}

save_data_delete_collection.go
PHP 
function data_delete_collection(string $projectId, string $collectionName, int $batchSize)
{
    // Create the Cloud Firestore client
    $db = new FirestoreClient([
        'projectId' => $projectId,
    ]);
    $collectionReference = $db->collection($collectionName);
    $documents = $collectionReference->limit($batchSize)->documents();
    while (!$documents->isEmpty()) {
        foreach ($documents as $document) {
            printf('Deleting document %s' . PHP_EOL, $document->id());
            $document->reference()->delete();
        }
        $documents = $collectionReference->limit($batchSize)->documents();
    }
}
data_delete_collection.php
Единство 
// This is not supported. Delete data using CLI as discussed below.
С# 
private static async Task DeleteCollection(CollectionReference collectionReference, int batchSize)
{
    QuerySnapshot snapshot = await collectionReference.Limit(batchSize).GetSnapshotAsync();
    IReadOnlyList<DocumentSnapshot> documents = snapshot.Documents;
    while (documents.Count > 0)
    {
        foreach (DocumentSnapshot document in documents)
        {
            Console.WriteLine("Deleting document {0}", document.Id);
            await document.Reference.DeleteAsync();
        }
        snapshot = await collectionReference.Limit(batchSize).GetSnapshotAsync();
        documents = snapshot.Documents;
    }
    Console.WriteLine("Finished deleting all documents from the collection.");
}
Program.cs
Руби 
cities_ref = firestore.col collection_path
query      = cities_ref

query.get do |document_snapshot|
  puts "Deleting document #{document_snapshot.document_id}."
  document_ref = document_snapshot.ref
  document_ref.delete
end
delete_data.rb

Удаление данных с помощью Firebase CLI

Вы также можете использовать Firebase CLI для удаления документов и коллекций. Для удаления данных используйте следующую команду:

firebase firestore:delete [options] <<path>>

Удалить данные с помощью консоли

Вы можете удалить документы и коллекции со страницы Cloud Firestore в консоли . Удаление документа из консоли удаляет все вложенные данные в этом документе, включая все подколлекции.

Удаление данных с политиками TTL

Политика TTL определяет определённое поле как срок действия документов в определённой группе коллекций. Операции удаления в течение TTL учитываются в стоимости удаления документов.

Информацию о настройке TTL см. в разделе Управление хранением данных с помощью политик TTL .

Дополнительную информацию о кодах ошибок и способах устранения задержек при удалении данных можно найти на странице устранения неполадок .

Удаление данных с помощью Dataflow

Dataflow — отличный инструмент для массовых операций с базой данных Firestore. В статье блога, посвящённой коннектору Firestore для Dataflow, есть пример удаления всех документов в группе коллекций.

Использовать управляемое массовое удаление

Cloud Firestore поддерживает пакетное удаление одной или нескольких групп коллекций. Подробнее см. в разделе «Массовое удаление данных» .