ドキュメントとフィールドを削除する

次の例は、ドキュメント、フィールド、コレクションを削除する方法を示しています。

ドキュメントを削除する

ドキュメントを削除するには、次の言語固有の delete() メソッドを使用します。

Web バージョン 9

deleteDoc() メソッドを使用します。

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

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

Web バージョン 8

delete() メソッドを使用します。

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

Swift

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+KTX
Android

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
Android

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

Java

delete() メソッドを使用します。

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

Python

delete() メソッドを使用します。

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

Python
（非同期）

delete() メソッドを使用します。

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

C++

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

Go

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

Unity

DeleteAsync() メソッドを使用します。

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

C#

DeleteAsync() メソッドを使用します。

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

Ruby

delete() メソッドを使用します。

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

ドキュメントを削除しても、Firestore がそのドキュメントのサブコレクションに含まれるドキュメントを自動的に削除することはありません。サブコレクションのドキュメントには参照により引き続きアクセスできます。たとえば、パス /mycoll/mydoc/mysubcoll/mysubdoc にあるドキュメントには、/mycoll/mydoc の祖先ドキュメントを削除してもアクセスできます。

存在しない祖先ドキュメントはコンソールには表示されますが、クエリの結果やスナップショットには表示されません。

ドキュメントと、そのドキュメントのサブコレクション内のすべてのドキュメントを削除するには、手動での操作が必要です。詳しくは、コレクションを削除するをご覧ください。

フィールドを削除する

特定のフィールドをドキュメントから削除するには、ドキュメントを更新するときに次の言語固有の FieldValue.delete() メソッドを使用します。

Web バージョン 9

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 バージョン 8

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

Swift

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+KTX
Android

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
Android

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

Java

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

Python

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

C++

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

Go

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

Unity

FieldValue.Delete メソッドを使用します。

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

C#

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

Ruby

firestore.field_delete メソッドを使用します。

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

コレクションを削除する

Firestore でコレクション全体またはサブコレクションを削除するには、コレクションまたはサブコレクション内のすべてのドキュメントを取得して（読み取って）、削除します。このプロセスでは、読み取りコストと削除コストの両方が発生します。大きなコレクションがある場合は、メモリ不足エラーを避けるため、小さなバッチに分けてドキュメントを削除することをおすすめします。コレクション全体またはサブコレクションが削除されるまで、このプロセスを繰り返します。

コレクションを削除するには、数に制約のない個別の削除リクエストを用意する必要があります。コレクション全体を削除する必要がある場合は、信頼できるサーバー環境からのみ実行してください。モバイル / ウェブクライアントからコレクションを削除することも可能ですが、その場合セキュリティとパフォーマンスに悪影響を与えます。

以下のスニペットは少し単純化されていて、エラー処理、セキュリティ、サブコレクションの削除、またはパフォーマンスの最大化については扱っていません。本番環境でコレクションを削除するために推奨される方法については、コレクションとサブコレクションを削除するをご覧ください。

ウェブ

// Deleting collections from a Web client is not recommended.

Swift

注: このプロダクトは、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+KTX
Android

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

Java
Android

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

Dart

クライアントからコレクションを削除することはおすすめしません。

Java

/**
 * 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

Python

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

C++

// 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

Go


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

Unity

// This is not supported. Delete data using CLI as discussed below.

C#

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

Ruby

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
enddelete_data.rb

Firebase CLI でデータを削除する

Firebase CLI を使用してドキュメントやコレクションを削除することもできます。データを削除するには、次のコマンドを使用します。

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

コンソールでデータを削除する

コンソールの Firestore ページからドキュメントやコレクションを削除できます。コンソールからドキュメントを削除すると、そのドキュメント内のネストされたデータ（サブコレクションを含む）がすべて削除されます。

TTL ポリシーでデータを削除する

TTL ポリシーは、特定のフィールドを、特定のコレクショングループ内のドキュメントの有効期限として指定します。TTL の削除オペレーションは、ドキュメントの削除費用にカウントされます。

TTL の設定については、TTL ポリシーでデータ保持を管理するをご覧ください。

エラーコードと、データを削除する際のレイテンシの問題を解決する方法については、トラブルシューティングページをご覧ください。

Dataflow でデータを削除する

Dataflow は、Firestore データベースでの一括オペレーションに最適なツールです。Dataflow 用の Firestore コネクタの概要のブログ記事には、コレクショングループ内のすべてのドキュメントを削除する例が記載されています。

ドキュメントとフィールドを削除する

ドキュメントを削除する

Web バージョン 9

Web バージョン 8

Swift

Objective-C

Kotlin+KTXAndroid

JavaAndroid

Dart

Java

Python

Python（非同期）

C++

Node.js

Go

PHP

Unity

C#

Ruby

フィールドを削除する

Web バージョン 9

Web バージョン 8

Swift

Objective-C

Kotlin+KTXAndroid

JavaAndroid

Dart

Java

Python

Python（非同期）

C++

Node.js

Go

PHP

Unity

C#

Ruby

コレクションを削除する

ウェブ

Swift

Objective-C

Kotlin+KTXAndroid

JavaAndroid

Dart

Java

Python

Python（非同期）

C++

Node.js

Go

PHP

Unity

C#

Ruby

Firebase CLI でデータを削除する

コンソールでデータを削除する

TTL ポリシーでデータを削除する

Dataflow でデータを削除する

Kotlin+KTX
Android

Java
Android

Python
（非同期）

Kotlin+KTX
Android

Java
Android

Python
（非同期）

Kotlin+KTX
Android

Java
Android

Python
（非同期）