NoSQLクラウドDB「Firestore」の基本ガイド

NoSQLクラウドDB「Firestore」の基本ガイド：詳細徹底解説

はじめに：Firestoreとは何か？

現代のアプリケーション開発において、データの永続化は不可欠です。そして、その要件を満たすデータベースの種類は多岐にわたります。リレーショナルデータベース（RDB）が長らく主流でしたが、スケーラビリティ、柔軟性、リアルタイム性といった新たなニーズに応える形で、NoSQLデータベースが注目を集めています。

Google Cloudの提供する「Firestore」は、Firebaseの一部としても提供されている、スケーラブルで高性能なNoSQLドキュメントデータベースです。特にモバイル、ウェブ、サーバー開発者にとって非常に扱いやすく設計されており、リアルタイム同期やオフライン対応といった強力な機能を備えています。

このガイドでは、Firestoreを初めて利用する方から、より深く理解したい方までを対象に、その基本概念から応用的な機能、さらには最適な利用方法までを詳細に解説します。約5000語をかけて、Firestoreの魅力を余すところなくお伝えします。

第1章：Firestoreの基本概念

Firestoreは、従来のRDBとは異なる「ドキュメント指向」のNoSQLデータベースです。この章では、Firestoreの最も基本的な構成要素である「コレクション」と「ドキュメント」、そしてデータの表現方法について掘り下げます。

1.1. ドキュメント指向とは？

RDBがデータをテーブル（スキーマ定義された行と列の集合）に格納するのに対し、ドキュメント指向データベースはデータを「ドキュメント」と呼ばれる単位で格納します。ドキュメントは、キーと値のペア（フィールド）の集合であり、構造は柔軟です。RDBのように事前に厳密なスキーマ定義を行う必要はありません。

FirestoreのドキュメントはJSONライクな構造を持ちますが、実際にはより多くのデータ型をサポートしています。この柔軟性が、変化の激しいアプリケーション開発において大きなメリットとなります。

1.2. コレクション（Collections）

コレクションは、ドキュメントを格納するためのコンテナです。RDBのテーブルに似ていますが、以下の点が異なります。

ドキュメントの格納: コレクションはドキュメントのみを格納し、他のコレクションを直接格納することはできません（ただし、ドキュメント内にサブコレクションを持つことは可能です）。
スキーマの柔軟性: コレクション内のドキュメントは、必ずしも同じフィールドを持つ必要はありません。各ドキュメントは独立した構造を持つことができます。
階層構造: コレクションは、データベースのルート直下、または特定のドキュメントの「サブコレクション」として存在できます。これにより、自然な階層構造を構築できます。

例：ユーザー情報を格納する users コレクション、投稿を格納する posts コレクションなど。

コレクション名は、 / や . などの特殊文字を含まない、有効なUTF-8文字列である必要があります。

1.3. ドキュメント（Documents）

ドキュメントは、Firestoreにおけるデータの最小単位です。各ドキュメントは、一意のIDを持ち、キーと値のペアの集合である「フィールド」で構成されます。

例：ユーザー情報を表すドキュメント
json { "name": "山田太郎", "email": "[email protected]", "age": 30, "isActive": true, "address": { "street": "渋谷区道玄坂 1-1-1", "city": "東京都" }, "tags": ["engineer", "firestore", "nosql"], "createdAt": "2023-10-27T10:00:00Z" }

ID: ドキュメントIDは、自動生成することも、任意に指定することも可能です。自動生成されるIDは一意性が保証されており、順序性はありません。任意に指定する場合、そのコレクション内で一意である必要があります。
フィールド: 各フィールドは、キー（フィールド名）と値のペアです。値には様々なデータ型を使用できます。
サイズ制限: 1つのドキュメントには最大1MiB（1,048,576バイト）のデータしか格納できません。これは、過度に大きなドキュメント設計を防ぎ、パフォーマンスを維持するための重要な制約です。

1.4. データ型（Data Types）

Firestoreは、NoSQLながらリッチなデータ型をサポートしています。主要なデータ型は以下の通りです。

String: テキスト文字列。
Number: 整数または浮動小数点数。
Boolean: true または false。
Map: キーと値のペアの集合。ネストされたオブジェクトを表すのに使用します。ドキュメント内に構造化されたデータを格納できます。例：address フィールド。
Array: 値のリスト。異なるデータ型の値を混在させることができます。例：tags フィールド。
Null: Null値。
Timestamp: 日時を表すタイムスタンプ。Firestore SDKは通常、ネイティブの日時オブジェクト（例：JavaScriptのDateオブジェクト）にマッピングします。
GeoPoint: 緯度と経度。位置情報を格納するのに便利です。
Reference: データベース内の他のドキュメントへの参照。RDBにおける外部キーのような関連付けに使用できますが、参照自体がデータを格納するわけではありません。

これらのデータ型を組み合わせることで、複雑なデータ構造をドキュメント内に表現できます。

1.5. サブコレクション（Subcollections）

ドキュメントはコレクションを格納できます。これをサブコレクションと呼びます。サブコレクションを使用することで、データを階層的に整理できます。

例：
* posts (コレクション)
* postId1 (ドキュメント)
* title: “Firestoreについて”
* content: “Firestoreは素晴らしい…”
* comments (サブコレクション)
* commentId1 (ドキュメント)
* author: “ユーザーA”
* text: “参考になりました！”
* commentId2 (ドキュメント)
* author: “ユーザーB”
* text: “別の視点も知りたいです”
* postId2 (ドキュメント)
* …
* comments (サブコレクション)
* …

この構造により、特定の投稿 (postId1) に関連するコメント (comments サブコレクション) だけを効率的に取得できます。

サブコレクションは、親ドキュメントが削除されても自動的に削除されません。サブコレクション内のドキュメントを削除するには、明示的にコードで処理する必要があります。

1.6. 階層構造とパス

Firestore内のすべてのデータは、コレクションとドキュメントのパスによって一意に識別されます。パスは / で区切られたコレクション名とドキュメント名のシーケンスです。

例：
* /users (コレクション)
* /users/userId1 (ドキュメント)
* /posts/postId1/comments (サブコレクション)
* /posts/postId1/comments/commentId1 (ドキュメント)

このパスは、データを読み書きする際に使用します。

第2章：Firestoreのセットアップ

Firestoreを利用するには、Firebaseプロジェクトが必要です。この章では、Firestoreをプロジェクトに追加し、アプリケーションからアクセスするための基本的な手順を解説します。

2.1. Firebaseプロジェクトの作成/選択

まだFirebaseプロジェクトがない場合は、Firebaseコンソール（console.firebase.google.com）にアクセスし、新しいプロジェクトを作成します。既存のプロジェクトがある場合は、それを使用できます。

2.2. Firestoreの有効化

Firebaseプロジェクトを選択または作成したら、左側のナビゲーションメニューから「Build」 > 「Firestore Database」を選択します。

「データベースを作成」ボタンをクリックします。
セキュリティルールの設定を選択します。「本番環境用ロックモードで開始」または「テストモードで開始」を選びます。最初は「テストモード」でも構いませんが、公開するアプリケーションでは必ず「本番環境用」を選択し、後でセキュリティルールを適切に設定し直してください。
Firestoreのロケーションを選択します。ユーザーの地理的な位置や他のGoogle Cloudサービスとの連携を考慮して、最適なリージョンを選択します。一度設定すると変更できないため、慎重に選びましょう。
データベースがプロビジョニングされるまで待ちます。

これで、Firestoreデータベースがプロジェクト内で有効化されました。

2.3. アプリケーションへのSDKの追加

アプリケーションの種類（Web、Android、iOS、サーバーサイドなど）に応じて、対応するFirestore SDKをプロジェクトに追加します。

Webアプリケーションの場合（例：npm）

bash npm install firebase

または

bash yarn add firebase

初期化コード（Webの場合）

アプリケーションの初期化スクリプトにFirebaseアプリの初期化コードを追加します。Firebaseコンソールのプロジェクト設定から、ウェブアプリを追加する際に提供される設定オブジェクトを使用します。

“`javascript
// Import the functions you need from the SDKs you need
import { initializeApp } from “firebase/app”;
import { getFirestore } from “firebase/firestore”;
// TODO: Add SDKs for Firebase products that you want to use
// https://firebase.google.com/docs/web/setup#available-libraries

// Your web app’s Firebase configuration
// For Firebase JS SDK v7.20.0 and later, measurementId is optional
const firebaseConfig = {
apiKey: “YOUR_API_KEY”,
authDomain: “YOUR_AUTH_DOMAIN”,
projectId: “YOUR_PROJECT_ID”,
storageBucket: “YOUR_STORAGE_BUCKET”,
messagingSenderId: “YOUR_MESSAGING_SENDER_ID”,
appId: “YOUR_APP_ID”,
measurementId: “YOUR_MEASUREMENT_ID”
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);

// Get a reference to the Firestore service
const db = getFirestore(app);

// Now you can use ‘db’ to interact with Firestore
“`

他のプラットフォーム（Android, iOS, Node.jsなど）でも同様に、それぞれの方法でSDKを追加し、初期化を行います。初期化後、db オブジェクト（またはそれに相当するもの）を通じてFirestoreデータベースへの操作を行います。

第3章：基本的なデータ操作（CRUD）

データベースの基本はCRUD操作です。Create（作成）、Read（読み取り）、Update（更新）、Delete（削除）の方法を、具体的なコード例とともに見ていきましょう。

Firestore SDKの操作は非同期です。ここではJavaScriptのPromiseまたはasync/await構文を使用して説明します。

3.1. データの作成（Create）

新しいドキュメントをコレクションに追加する方法は主に2つあります。

自動生成IDでドキュメントを追加する (add())
Firestoreにドキュメントの内容だけを渡し、一意のIDを自動で生成させたい場合に便利です。
“`javascript
import { collection, addDoc } from “firebase/firestore”;

async function addPost(title, content) {
try {
const docRef = await addDoc(collection(db, “posts”), {
title: title,
content: content,
createdAt: new Date() // Timestampとして保存される
});
console.log(“Document written with ID: “, docRef.id);
return docRef.id;
} catch (e) {
console.error(“Error adding document: “, e);
throw e;
}
}

addPost(“Firestoreの基本”, “Firestoreは使いやすいデータベースです。”);
``addDocは、追加されたドキュメントへの参照（DocumentReference）を返します。そのid` プロパティで自動生成されたIDを取得できます。
任意のIDを指定してドキュメントを設定する (set())
ユーザーIDなど、特定のIDをドキュメントIDとして使用したい場合に使います。指定したIDのドキュメントが既に存在する場合は、そのドキュメント全体が上書きされます。
“`javascript
import { doc, setDoc } from “firebase/firestore”;

async function setUser(userId, name, email) {
try {
await setDoc(doc(db, “users”, userId), {
name: name,
email: email,
updatedAt: new Date()
});
console.log(“User document set with ID: “, userId);
} catch (e) {
console.error(“Error setting document: “, e);
throw e;
}
}

setUser(“user_abc123”, “佐藤花子”, “[email protected]”);
``setDoc` は、成功すると何も返しません。

既存ドキュメントへのフィールド追加/更新 (set() with { merge: true })

setDoc に { merge: true } オプションを付けると、ドキュメント全体を上書きするのではなく、指定したフィールドだけを追加または更新し、それ以外のフィールドはそのまま保持します。指定したドキュメントが存在しない場合は、新しく作成されます。

“`javascript
import { doc, setDoc } from “firebase/firestore”;

async function updateUserData(userId, newData) {
try {
await setDoc(doc(db, “users”, userId), newData, { merge: true });
console.log(“User document merged with ID: “, userId);
} catch (e) {
console.error(“Error merging document: “, e);
throw e;
}
}

updateUserData(“user_abc123”, { age: 25, city: “大阪市” }); // user_abc123ドキュメントにageとcityフィールドが追加/更新される
“`

3.2. データの読み取り（Read）

データは単一のドキュメントまたはコレクション全体（またはクエリ結果）として読み取ることができます。

単一ドキュメントの取得 (get())
特定のコレクションの、特定のIDを持つドキュメントを取得します。
“`javascript
import { doc, getDoc } from “firebase/firestore”;

async function getPost(postId) {
const docRef = doc(db, “posts”, postId);
const docSnap = await getDoc(docRef);

if (docSnap.exists()) {
console.log(“Document data:”, docSnap.data());
return docSnap.data();
} else {
// doc.data() will be undefined in this case
console.log(“No such document!”);
return null;
}
}

getPost(“auto_generated_post_id”);
``getDocはDocumentSnapshotを返します。exists()メソッドでドキュメントが存在するか確認し、data()` メソッドでドキュメントのフィールドを取得します。
コレクション内の全ドキュメントの取得 (get())
コレクション内のすべてのドキュメントを取得します。ドキュメント数が多い場合は後述のクエリとページネーションを組み合わせるのが推奨されます。
“`javascript
import { collection, getDocs } from “firebase/firestore”;

async function getAllPosts() {
const querySnapshot = await getDocs(collection(db, “posts”));
querySnapshot.forEach((doc) => {
// doc.data() is never undefined for query doc snapshots
console.log(${doc.id} => ${JSON.stringify(doc.data())});
});
return querySnapshot.docs.map(doc => ({ id: doc.id, …doc.data() }));
}

getAllPosts();
``getDocsはQuerySnapshotを返します。forEachメソッドでスナップショット内の各ドキュメントをループ処理できます。docs` プロパティでドキュメントスナップショットの配列として取得することも可能です。

3.3. データの更新（Update）

既存のドキュメントの特定のフィールドを更新します。ドキュメントが存在しない場合は失敗します。

“`javascript
import { doc, updateDoc } from “firebase/firestore”;

async function updatePostTitle(postId, newTitle) {
const postRef = doc(db, “posts”, postId);

try {
await updateDoc(postRef, {
title: newTitle
});
console.log(“Post title updated successfully.”);
} catch (e) {
console.error(“Error updating document: “, e);
throw e;
}
}

updatePostTitle(“auto_generated_post_id”, “Firestoreの最新情報”);
“`

updateDoc は複数のフィールドを同時に更新できます。

“`javascript
import { doc, updateDoc } from “firebase/firestore”;

async function updatePostFields(postId, updates) {
const postRef = doc(db, “posts”, postId);
try {
await updateDoc(postRef, updates); // updates は { field1: value1, field2: value2 } のようなオブジェクト
console.log(“Post fields updated successfully.”);
} catch (e) {
console.error(“Error updating document: “, e);
throw e;
}
}

updatePostFields(“auto_generated_post_id”, {
title: “更新されたタイトル”,
content: “更新されたコンテンツ”,
updatedAt: new Date()
});
“`

ネストされたフィールドを更新する場合は、ドット記法を使用します。

“`javascript
import { doc, updateDoc } from “firebase/firestore”;

async function updateAddressCity(userId, newCity) {
const userRef = doc(db, “users”, userId);
try {
await updateDoc(userRef, {
“address.city”: newCity // ネストされたフィールドはドットで指定
});
console.log(“User address city updated successfully.”);
} catch (e) {
console.error(“Error updating document: “, e);
throw e;
}
}

updateAddressCity(“user_abc123”, “京都市”);
“`

配列フィールドの操作

配列フィールドに要素を追加したり削除したりする場合、特別なフィールドバリューを使用します。

“`javascript
import { doc, updateDoc, arrayUnion, arrayRemove } from “firebase/firestore”;

async function updateUserTags(userId) {
const userRef = doc(db, “users”, userId);
try {
// ‘tags’ 配列に “database” と “cloud” を追加（既に存在すれば追加しない）
await updateDoc(userRef, {
tags: arrayUnion(“database”, “cloud”)
});
console.log(“Tags added.”);

// 'tags' 配列から "firestore" を削除
await updateDoc(userRef, {
  tags: arrayRemove("firestore")
});
console.log("Tag 'firestore' removed.");

} catch (e) {
console.error(“Error updating tags: “, e);
throw e;
}
}

updateUserTags(“user_abc123”);
``arrayUnionは重複を避けて要素を追加し、arrayRemove` は指定した要素をすべて削除します。

3.4. データの削除（Delete）

ドキュメント全体またはドキュメント内の特定のフィールドを削除できます。

ドキュメントの削除 (deleteDoc())
指定したドキュメントを完全に削除します。そのドキュメントのサブコレクションは自動的には削除されないことに注意が必要です。
“`javascript
import { doc, deleteDoc } from “firebase/firestore”;

async function deletePost(postId) {
try {
await deleteDoc(doc(db, “posts”, postId));
console.log(“Post document deleted successfully.”);
} catch (e) {
console.error(“Error deleting document: “, e);
throw e;
}
}

deletePost(“auto_generated_post_id”);
“`
ドキュメント内のフィールドの削除 (updateDoc() with FieldValue.delete())
ドキュメント全体ではなく、特定のフィールドだけを削除したい場合に使います。
“`javascript
import { doc, updateDoc, deleteField } from “firebase/firestore”;

async function deleteUserAge(userId) {
const userRef = doc(db, “users”, userId);
try {
await updateDoc(userRef, {
age: deleteField()
});
console.log(“User age field deleted successfully.”);
} catch (e) {
console.error(“Error deleting field: “, e);
throw e;
}
}

deleteUserAge(“user_abc123”);
``deleteField()` は、そのフィールドをドキュメントから削除するための特別な値です。

コレクションの削除

Firestoreには、コレクション全体を単一の操作で削除する機能はありません。これは、誤って大量のデータを削除することを防ぐための設計です。コレクションを削除するには、そのコレクション内のすべてのドキュメント（およびそのサブコレクション内のドキュメント）を再帰的に削除する必要があります。これは通常、サーバーサイドのコード（Cloud Functionsなど）を使用して実装されます。Firestore SDKには、ドキュメントのバッチ削除を支援する機能がありますが、コレクションの再帰的な削除自体は手動でコーディングが必要です。Firebase CLIには、コレクションを削除するためのコマンドが提供されています（ただし、本番環境での使用は慎重に）。

第4章：データのクエリ（Queries）

単にドキュメントを取得するだけでなく、特定の条件に一致するドキュメントを検索したり、結果を並べ替えたり、取得数を制限したりすることが、実用的なアプリケーションでは必須です。Firestoreのクエリ機能を見ていきましょう。

クエリは、collection() 関数でコレクション参照を取得した後、それに様々なメソッドをチェインしていく形で構築します。

4.1. フィルタリング（Filtering: `where()`）

where() メソッドを使用して、フィールドの値に基づきドキュメントをフィルタリングします。

等価比較 (==)

“`javascript
import { collection, query, where, getDocs } from “firebase/firestore”;

async function getActiveUsers() {
const q = query(collection(db, “users”), where(“isActive”, “==”, true));