データモデル

Firestore は NoSQL ドキュメント指向データベースです。SQL データベースとは違い、テーブルや行はありません。代わりに、データは「ドキュメント」に格納し、それが「コレクション」にまとめられます。

各「ドキュメント」には、一連の Key-Value ペアが含まれています。Firestore は、小さなドキュメントからなる大きなコレクションを格納するために最適化されています。

すべてのドキュメントはコレクションに保存する必要があります。ドキュメントには、「サブコレクション」と、ネストされたオブジェクトを格納できます。このどちらにも、文字列などの基本フィールドや、リストなどの複雑なオブジェクトを含めることができます。

コレクションとドキュメントは Firestore で暗黙的に作成されます。ユーザーはデータをコレクション内のドキュメントに割り当てるだけです。コレクションまたはドキュメントのいずれかが存在しない場合は、Firestore によって作成されます。

ドキュメント

Firestore では、ストレージの単位はドキュメントになります。ドキュメントは、値にマッピングされるフィールドを含む軽量のレコードです。各ドキュメントは名前で識別されます。

ユーザー alovelace を表すドキュメントは次のようになります。

alovelace

first : "Ada"
last : "Lovelace"
born : 1815

ドキュメント内のネストされた複雑なオブジェクトはマップと呼ばれます。たとえば、上記の例のユーザー名をマップで構造化すると、次のようになります。

alovelace

name :
first : "Ada"
last : "Lovelace"
born : 1815

見てわかるように、ドキュメントは JSON によく似ており、実際基本的には JSON と同じです。いくつかの違いはありますが（たとえばドキュメントでは追加のデータ型がサポートされており、サイズは 1 MB までに制限されています）、一般的にドキュメントは軽量の JSON レコードとして扱うことができます。

コレクション

ドキュメントはコレクションの中にあります。コレクションは端的に言えばドキュメントのコンテナです。たとえば、users コレクションを作成して、さまざまなユーザーを表すドキュメントを格納できます。

users
- alovelace
  
  first : "Ada"
  last : "Lovelace"
  born : 1815
- aturing
  
  first : "Alan"
  last : "Turing"
  born : 1912

Firestore はスキーマレスなので、各ドキュメントにどのフィールドを含めるか、また、そのフィールドにどのデータ型を格納するかは、完全に自由に決めることができます。同じコレクション内のドキュメントすべてに異なるフィールドを含めたり、それらのフィールドに異なるデータ型を格納したりもできます。ただし、複数のドキュメントで同じフィールドとデータ型を使用するほうが、ドキュメントのクエリが容易になります。

コレクションにはドキュメントだけが含まれます。コレクションに値を持つ生のフィールドを直接含めることはできず、他のコレクションを含めることもできません。Firestore でより複雑なデータを構造化する方法については、階層データをご覧ください。

コレクション内のドキュメントの名前は一意です。ユーザー ID などの独自のキーを指定することも、Firestore で自動的にランダムな ID を作成することもできます。

コレクションを「作成」したり「削除」したりする必要はありません。コレクション内の最初のドキュメントを作成すると、コレクションが暗黙的に作成され、コレクション内のドキュメントをすべて削除すると、コレクションも削除されます。

参照

Firestore のすべてのドキュメントは、データベース内の場所によって一意に識別されます。前の例では、コレクション users 中のドキュメント alovelace を示しました。コード内でこの場所を参照するには、その場所への「リファレンス」を作成します。

Web バージョン 9

import { doc } from "firebase/firestore";

const alovelaceDocumentRef = doc(db, 'users', 'alovelace');doc_reference.js

Web バージョン 8

var alovelaceDocumentRef = db.collection('users').doc('alovelace');test.firestore.js

Swift

注: このプロダクトは、watchOS と App Clip の各ターゲットでは利用できません。

let alovelaceDocumentRef = db.collection("users").document("alovelace")ViewController.swift

Objective-C

注: このプロダクトは、watchOS と App Clip の各ターゲットでは利用できません。

FIRDocumentReference *alovelaceDocumentRef =
    [[self.db collectionWithPath:@"users"] documentWithPath:@"alovelace"];ViewController.m

Kotlin KTX
Android

val alovelaceDocumentRef = db.collection("users").document("alovelace")DocSnippets.kt

Java
Android

DocumentReference alovelaceDocumentRef = db.collection("users").document("alovelace");DocSnippets.java

Dart

final alovelaceDocumentRef = db.collection("users").doc("alovelace");firestore.dart

Java

// Reference to a document with id "alovelace" in the collection "users"
DocumentReference document = db.collection("users").document("alovelace");References.java

Python

a_lovelace_ref = db.collection("users").document("alovelace")snippets.py

Python
（非同期）

a_lovelace_ref = db.collection("users").document("alovelace")snippets.py

C

DocumentReference alovelace_document_reference =
    db->Collection("users").Document("alovelace");snippets.cpp

Node.js

const alovelaceDocumentRef = db.collection('users').doc('alovelace');index.js

Go


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

func createDocReference(client *firestore.Client) {

	alovelaceRef := client.Collection("users").Doc("alovelace")

	_ = alovelaceRef
}
retrieve_data_reference_document.go

PHP

Firestore に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

$document = $db->collection('samples/php/users')->document('alovelace');

Unity

DocumentReference documentRef = db.Collection("users").Document("alovelace");

C#

DocumentReference documentRef = db.Collection("users").Document("alovelace");

Ruby

document_ref = firestore.col("users").doc("alovelace")data_model.rb

リファレンスは、単にデータベース内の場所を示す軽量なオブジェクトです。リファレンスはそこにデータがあるかどうかにかかわらず作成でき、リファレンスを作成してもネットワーク操作は実行されません。

コレクションへのリファレンスも作成できます。

Web バージョン 9

import { collection } from "firebase/firestore";

const usersCollectionRef = collection(db, 'users');collection_reference.js

Web バージョン 8

var usersCollectionRef = db.collection('users');test.firestore.js

Swift

注: このプロダクトは、watchOS と App Clip の各ターゲットでは利用できません。

let usersCollectionRef = db.collection("users")ViewController.swift

Objective-C

注: このプロダクトは、watchOS と App Clip の各ターゲットでは利用できません。

FIRCollectionReference *usersCollectionRef = [self.db collectionWithPath:@"users"];ViewController.m

Kotlin KTX
Android

val usersCollectionRef = db.collection("users")DocSnippets.kt

Java
Android

CollectionReference usersCollectionRef = db.collection("users");DocSnippets.java

Dart

final usersCollectionRef = db.collection("users");firestore.dart

Java

// Reference to the collection "users"
CollectionReference collection = db.collection("users");References.java

Python

users_ref = db.collection("users")snippets.py

Python
（非同期）

users_ref = db.collection("users")snippets.py

C

CollectionReference users_collection_reference = db->Collection("users");snippets.cpp

Node.js

const usersCollectionRef = db.collection('users');index.js

Go


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

func createCollectionReference(client *firestore.Client) {
	usersRef := client.Collection("users")

	_ = usersRef
}
retrieve_data_reference_collection.go

PHP

$collection = $db->collection('samples/php/users');

Unity

CollectionReference collectionRef = db.Collection("users");

C#

CollectionReference collectionRef = db.Collection("users");

Ruby

collection_ref = firestore.col "users"data_model.rb

便宜上、ドキュメントまたはコレクションへのパスを文字列として指定し、パスコンポーネントをスラッシュ（/）で区切ってリファレンスを作成することもできます。たとえば、alovelace ドキュメントへのリファレンスは次のように作成します。

Web バージョン 9

import { doc } from "firebase/firestore";

const alovelaceDocumentRef = doc(db, 'users/alovelace');doc_reference_alternative.js

Web バージョン 8

var alovelaceDocumentRef = db.doc('users/alovelace');test.firestore.js

Swift

注: このプロダクトは、watchOS と App Clip の各ターゲットでは利用できません。

let aLovelaceDocumentReference = db.document("users/alovelace")ViewController.swift

Objective-C

注: このプロダクトは、watchOS と App Clip の各ターゲットでは利用できません。

FIRDocumentReference *aLovelaceDocumentReference =
    [self.db documentWithPath:@"users/alovelace"];ViewController.m

Kotlin KTX
Android

val alovelaceDocumentRef = db.document("users/alovelace")DocSnippets.kt

Java
Android

DocumentReference alovelaceDocumentRef = db.document("users/alovelace");DocSnippets.java

Dart

final aLovelaceDocRef = db.doc("users/alovelace");firestore.dart

Java

// Reference to a document with id "alovelace" in the collection "users"
DocumentReference document = db.document("users/alovelace");References.java

Python

a_lovelace_ref = db.document("users/alovelace")snippets.py

Python
（非同期）

a_lovelace_ref = db.document("users/alovelace")snippets.py

C

DocumentReference alovelace_document = db->Document("users/alovelace");snippets.cpp

Node.js

const alovelaceDocumentRef = db.doc('users/alovelace');index.js

Go


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

func createDocReferenceFromString(client *firestore.Client) {
	// Reference to a document with id "alovelace" in the collection "users"
	alovelaceRef := client.Doc("users/alovelace")

	_ = alovelaceRef
}
retrieve_data_reference_document_path.go

PHP

$document = $db->document('users/alovelace');

Unity

DocumentReference documentRef = db.Document("users/alovelace");

C#

DocumentReference documentRef = db.Document("users/alovelace");

Ruby

document_path_ref = firestore.doc "users/alovelace"data_model.rb

階層データ

Firestore で階層データ構造がどのように機能するかを理解するために、メッセージとチャットルームを使ったチャットアプリの例を見てみましょう。

さまざまなチャットルームを格納するための rooms と呼ばれるコレクションを作成できます。

rooms
- roomA
  
  name : "my chat room"
- roomB
  
  ...

これでチャットルームができたので、メッセージを保存する方法を指定します。チャットルームのドキュメントに保存することはおすすめしません。Firestore 内のドキュメントは軽量にする必要がありますが、チャットルームには膨大な数のメッセージが格納される可能性があるからです。ただし、チャットルームのドキュメント内にサブコレクションとして追加のコレクションを作成できます。

サブコレクション

このシナリオでメッセージを保存するための最善の方法は、サブコレクションを使用することです。サブコレクションは特定のドキュメントに関連付けられたコレクションです。

rooms コレクション内のすべてのルームドキュメントに、messages というサブコレクションを作成できます。

rooms
- roomA
  
  name : "my chat room"
  - messages
    - message1
      
      from : "alex"
      msg : "Hello World!"
    - message2
      
      ...
- roomB
  
  ...

この例では、次のコードを使用して、サブコレクション内のメッセージへのリファレンスを作成します。

Web バージョン 9

import { doc } from "firebase/firestore";

const messageRef = doc(db, "rooms", "roomA", "messages", "message1");subcollection_reference.js

Web バージョン 8

var messageRef = db.collection('rooms').doc('roomA')
                .collection('messages').doc('message1');test.firestore.js

Swift

注: このプロダクトは、watchOS と App Clip の各ターゲットでは利用できません。

let messageRef = db
  .collection("rooms").document("roomA")
  .collection("messages").document("message1")ViewController.swift

Objective-C

注: このプロダクトは、watchOS と App Clip の各ターゲットでは利用できません。

FIRDocumentReference *messageRef =
    [[[[self.db collectionWithPath:@"rooms"] documentWithPath:@"roomA"]
    collectionWithPath:@"messages"] documentWithPath:@"message1"];ViewController.m

Kotlin KTX
Android

val messageRef = db
    .collection("rooms").document("roomA")
    .collection("messages").document("message1")DocSnippets.kt

Java
Android

DocumentReference messageRef = db
        .collection("rooms").document("roomA")
        .collection("messages").document("message1");DocSnippets.java

Dart

final messageRef = db
    .collection("rooms")
    .doc("roomA")
    .collection("messages")
    .doc("message1");firestore.dart

Java

// Reference to a document in subcollection "messages"
DocumentReference document =
    db.collection("rooms").document("roomA").collection("messages").document("message1");References.java

Python

room_a_ref = db.collection("rooms").document("roomA")
message_ref = room_a_ref.collection("messages").document("message1")snippets.py

Python
（非同期）

room_a_ref = db.collection("rooms").document("roomA")
message_ref = room_a_ref.collection("messages").document("message1")snippets.py

C

DocumentReference message_reference = db->Collection("rooms")
    .Document("roomA")
    .Collection("messages")
    .Document("message1");snippets.cpp

Node.js

const messageRef = db.collection('rooms').doc('roomA')
  .collection('messages').doc('message1');index.js

Go


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

func createSubcollectionReference(client *firestore.Client) {
	messageRef := client.Collection("rooms").Doc("roomA").
		Collection("messages").Doc("message1")

	_ = messageRef
}
retrieve_data_reference_subcollection.go

PHP

$document = $db
    ->collection('rooms')
    ->document('roomA')
    ->collection('messages')
    ->document('message1');

Unity

DocumentReference documentRef = db
	.Collection("Rooms").Document("RoomA")
	.Collection("Messages").Document("Message1");

C#

DocumentReference documentRef = db
    .Collection("Rooms").Document("RoomA")
    .Collection("Messages").Document("Message1");

Ruby

message_ref = firestore.col("rooms").doc("roomA").col("messages").doc("message1")data_model.rb

コレクションとドキュメントが交互になるよう注意してください。コレクションとドキュメントは常にこのパターンで従う必要があります。コレクション内のコレクションや、ドキュメント内のドキュメントは参照できません。

サブコレクションを使用すると、データを階層的に構造化できるため、データへのアクセスが容易になります。roomA にあるすべてのメッセージを取得するために、サブコレクション messages へのコレクションリファレンスを作成して、それを他のコレクションリファレンスと同じように操作できます。

サブコレクション内のドキュメントにもサブコレクションを格納できるため、データをさらにネストできます。データは最大 100 レベルまでネストできます。

データモデル

ドキュメント

コレクション

参照

Web バージョン 9

Web バージョン 8

Swift

Objective-C

Kotlin KTXAndroid

JavaAndroid

Dart

Java

Python

Python（非同期）

C

Node.js

Go

PHP

PHP

Unity

C#

C#

Ruby

Web バージョン 9

Web バージョン 8

Swift

Objective-C

Kotlin KTXAndroid

JavaAndroid

Dart

Java

Python

Python（非同期）

C

Node.js

Go

PHP

PHP

Unity

C#

C#

Ruby

Web バージョン 9

Web バージョン 8

Swift

Objective-C

Kotlin KTXAndroid

JavaAndroid

Dart

Java

Python

Python（非同期）

C

Node.js

Go

PHP

PHP

Unity

C#

C#

Ruby

階層データ

サブコレクション

Web バージョン 9

Web バージョン 8

Swift

Objective-C

Kotlin KTXAndroid

JavaAndroid

Dart

Java

Python

Python（非同期）

C

Node.js

Go

PHP

PHP

Unity

C#

Kotlin KTX
Android

Java
Android

Python
（非同期）

Kotlin KTX
Android

Java
Android

Python
（非同期）

Kotlin KTX
Android

Java
Android

Python
（非同期）

Kotlin KTX
Android

Java
Android

Python
（非同期）