データの取得

このドキュメントでは、データベースのデータの取得に関する基本に加え、データが並べ替えられる仕組みとデータに対して簡単なクエリを実行する方法について説明します。Admin SDK でのデータ取得は、プログラミング言語によって若干異なる方法で実装されています。

非同期リスナー: データベース参照に非同期リスナーを追加することにより、Firebase Realtime Database に保存されているデータを取得します。リスナーはデータの初期状態で 1 回トリガーされます。さらに、データが変更されると、そのたびに再びトリガーされます。イベントリスナーが受け取るイベントの種類は複数あります。このようなデータ取得モードは、Java、Node.js、Python の各 Admin SDK でサポートされます。
ブロック読み取り: データベース参照でブロックメソッドを呼び出すことにより、Firebase Realtime Database に保存されているデータを取得します。このメソッドは、参照に保存されているデータを返します。各メソッド呼び出しはワンタイムオペレーションです。つまり、SDK は後続のデータ更新をリッスンするコールバックを登録しません。このデータ取得モデルは、Python および Go Admin SDK でサポートされています。

はじめに

前の記事のブログサンプルを復習して、Firebase データベースからデータを読み取る方法を理解しましょう。サンプルアプリのブログ投稿は次のデータベースの URL に保存されています。https://docs-examples.firebaseio.com/server/saving-data/fireblog/posts.json。投稿したデータを読み取るには、以下を実行します。

Java

public static class Post {

  public String author;
  public String title;

  public Post(String author, String title) {
    // ...
  }

}

// Get a reference to our posts
final FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference ref = database.getReference("server/saving-data/fireblog/posts");

// Attach a listener to read the data at our posts reference
ref.addValueEventListener(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot dataSnapshot) {
    Post post = dataSnapshot.getValue(Post.class);
    System.out.println(post);
  }

  @Override
  public void onCancelled(DatabaseError databaseError) {
    System.out.println("The read failed: " + databaseError.getCode());
  }
});

Node.js

// Get a database reference to our posts
const db = getDatabase();
const ref = db.ref('server/saving-data/fireblog/posts');

// Attach an asynchronous callback to read the data at our posts reference
ref.on('value', (snapshot) => {
  console.log(snapshot.val());
}, (errorObject) => {
  console.log('The read failed: ' + errorObject.name);
});

Python

# Import database module.
from firebase_admin import db

# Get a database reference to our posts
ref = db.reference('server/saving-data/fireblog/posts')

# Read the data at the posts reference (this is a blocking operation)
print(ref.get())

Go


// Post is a json-serializable type.
type Post struct {
	Author string `json:"author,omitempty"`
	Title  string `json:"title,omitempty"`
}

// Create a database client from App.
client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// Get a database reference to our posts
ref := client.NewRef("server/saving-data/fireblog/posts")

// Read the data at the posts reference (this is a blocking operation)
var post Post
if err := ref.Get(ctx, &post); err != nil {
	log.Fatalln("Error reading value:", err)
}

Java および Node.js では、読み取りがキャンセルされた場合に呼び出されるキャンセルコールバック（任意指定）をイベントサブスクリプションに渡すことができます。アプリのクライアントにそのデータベース参照からの読み取り権限がない場合、読み取りはキャンセルされます。このコールバックには、エラーが発生した理由を示す error オブジェクトが渡されます。Python および Go では、get() / Get() オペレーション時にエラーが発生した場合、例外が発生してオペレーションが失敗します。

上記のコードを実行すると、コンソールのログに記録されたすべての投稿を含むオブジェクトが表示されます。Node.js および Java の場合、リスナー関数は新しいデータがデータベース参照に追加されるたびに呼び出されます。呼び出しを発生させるためにコードを追加で記述する必要はありません。

Java および Node.js では、コールバック関数は DataSnapshot を受け取ります。これはデータのスナップショットです。スナップショットとは、ある時点における特定のデータベース参照にあるデータの全体像を写し取ったものです。スナップショットの val() / getValue() を呼び出すと、データの言語固有のオブジェクト表現が返されます。参照先の場所にデータが存在しない場合、スナップショットの値が null になります。Python の get() メソッドは、データの Python 表現を直接返します。Go の Get() 関数は、データを特定のデータ構造にアンマーシャリングします。

上記の例では、イベントの種類 value を使用しました。この種類のイベントは、データがほんの 1 か所変更されただけでも、Firebase データベース参照のコンテンツ全体を読み取ります。value は、データベースからデータを読み取るために使用できる下記の 5 種類のイベントの 1 つです。

Java と Node.js でのイベントタイプの読み込み

値

value イベントは、特定のデータベースパスにあるコンテンツの静的なスナップショットを、読み取りイベントのときに存在していたとおりに読み取るために使用します。これは、初期データで 1 回トリガーされます。さらに、データが変更されると、そのたびに再びトリガーされます。イベントのコールバックには、その場所にあるすべてのデータ（子のデータも含む）を含んでいるスナップショットが渡されます。上記のコード例で、value はアプリ内のすべてのブログ投稿を返しています。新しいブログ投稿が追加されるたびに、コールバック関数がすべての投稿を返します。

child added

child_added イベントは通常、データベースからアイテムのリストを取得するために使用します。その場所にあるコンテンツ全体を返す value とは異なり、child_added は既存の子ごとに 1 回トリガーされます。さらに、指定されたパスに新しい子が追加されると、そのたびに再びトリガーされます。イベントコールバックには、新しい子のデータを含んでいるスナップショットが渡されます。並べ替え目的のため、前の子のキーを含んでいる 2 番目の引数も渡されます。

ブログアプリに新しい投稿が追加されたときにのみデータを取得したい場合は、child_added を使用できます。

Java

ref.addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    Post newPost = dataSnapshot.getValue(Post.class);
    System.out.println("Author: " + newPost.author);
    System.out.println("Title: " + newPost.title);
    System.out.println("Previous Post ID: " + prevChildKey);
  }

  @Override
  public void onChildChanged(DataSnapshot dataSnapshot, String prevChildKey) {}

  @Override
  public void onChildRemoved(DataSnapshot dataSnapshot) {}

  @Override
  public void onChildMoved(DataSnapshot dataSnapshot, String prevChildKey) {}

  @Override
  public void onCancelled(DatabaseError databaseError) {}
});

Node.js

// Retrieve new posts as they are added to our database
ref.on('child_added', (snapshot, prevChildKey) => {
  const newPost = snapshot.val();
  console.log('Author: ' + newPost.author);
  console.log('Title: ' + newPost.title);
  console.log('Previous Post ID: ' + prevChildKey);
});

この例では、スナップショットに各ブログ投稿を含んだオブジェクトが 1 つ含まれています。SDK は値を取得して投稿をオブジェクトに変換するため、author と title を呼び出すことで投稿の作成者とタイトルのプロパティそれぞれにアクセスすることができます。また、2 番目の prevChildKey 引数を使って以前の投稿 ID にアクセスすることもできます。

child changed

子ノードが修正されるたびに child_changed イベントがトリガーされます。この修正には、子ノードの子孫に対する修正も含まれます。これは通常、アイテムのリストに対する変更に応答するために、child_added および child_removed と組み合わせて使用します。イベントコールバックに渡されるスナップショットには、子の更新済みデータが含まれています。

編集時には、child_changed を使用して、ブログ投稿の更新済みデータを読み取ることができます。

Java

ref.addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {}

  @Override
  public void onChildChanged(DataSnapshot dataSnapshot, String prevChildKey) {
    Post changedPost = dataSnapshot.getValue(Post.class);
    System.out.println("The updated post title is: " + changedPost.title);
  }

  @Override
  public void onChildRemoved(DataSnapshot dataSnapshot) {}

  @Override
  public void onChildMoved(DataSnapshot dataSnapshot, String prevChildKey) {}

  @Override
  public void onCancelled(DatabaseError databaseError) {}
});

Node.js

// Get the data on a post that has changed
ref.on('child_changed', (snapshot) => {
  const changedPost = snapshot.val();
  console.log('The updated post title is ' + changedPost.title);
});

child removed

child_removed イベントは直接の子が削除されるとトリガーされます。通常は、child_added および child_changed と組み合わせて使用します。イベントのコールバックに渡されるスナップショットには、削除された子のデータが含まれています。

ブログの例では、次のように child_removed を使用して、削除された投稿に関する通知をコンソールに記録できます。

Java

ref.addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {}

  @Override
  public void onChildChanged(DataSnapshot dataSnapshot, String prevChildKey) {}

  @Override
  public void onChildRemoved(DataSnapshot dataSnapshot) {
    Post removedPost = dataSnapshot.getValue(Post.class);
    System.out.println("The blog post titled " + removedPost.title + " has been deleted");
  }

  @Override
  public void onChildMoved(DataSnapshot dataSnapshot, String prevChildKey) {}

  @Override
  public void onCancelled(DatabaseError databaseError) {}
});

Node.js

// Get a reference to our posts
const ref = db.ref('server/saving-data/fireblog/posts');

// Get the data on a post that has been removed
ref.on('child_removed', (snapshot) => {
  const deletedPost = snapshot.val();
  console.log('The blog post titled \'' + deletedPost.title + '\' has been deleted');
});

child moved

child_moved イベントは、並べ替えられたデータを操作する場合に使用します。並べ替えられたデータについては、次のセクションで説明します。

イベントの保証

Firebase データベースでは、イベントに関していくつかの重要な保証を行います。

データベースイベントの保証
イベントは、ローカルの状態が変化すると常にトリガーされます。
ネットワーク接続が一時的に切断されている状況など、ローカルのオペレーションやタイミングから一時的な差異が引き起こされた場合でも、イベントは常に、正しいデータ状態を最終的に反映することになります。
単一のクライアントからの書き込みは常にサーバーに書き込まれ、順に他のユーザーにブロードキャストされます。
value イベントは常に最後にトリガーされ、スナップショットの取得前に発生した他のイベントによる更新を含んでいることが保証されます。

value イベントは常に最後にトリガーされるため、次の例は常に動作します。

Java

final AtomicInteger count = new AtomicInteger();

ref.addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    // New child added, increment count
    int newCount = count.incrementAndGet();
    System.out.println("Added " + dataSnapshot.getKey() + ", count is " + newCount);
  }

  // ...
});

// The number of children will always be equal to 'count' since the value of
// the dataSnapshot here will include every child_added event triggered before this point.
ref.addListenerForSingleValueEvent(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot dataSnapshot) {
    long numChildren = dataSnapshot.getChildrenCount();
    System.out.println(count.get() + " == " + numChildren);
  }

  @Override
  public void onCancelled(DatabaseError databaseError) {}
});

Node.js

let count = 0;

ref.on('child_added', (snap) => {
  count++;
  console.log('added:', snap.key);
});

// length will always equal count, since snap.val() will include every child_added event
// triggered before this point
ref.once('value', (snap) => {
  console.log('initial data loaded!', snap.numChildren() === count);
});

コールバックのデタッチ

コールバックを削除するには、イベントの種類と、削除するコールバック関数を指定します。

Java

// Create and attach listener
ValueEventListener listener = new ValueEventListener() {
    // ...
};
ref.addValueEventListener(listener);

// Remove listener
ref.removeEventListener(listener);

Node.js

ref.off('value', originalCallback);

スコープコンテキストを on() に渡した場合は、コールバックをデタッチするときにも渡す必要があります。

Java

// Not applicable for Java

Node.js

ref.off('value', originalCallback, ctx);

ある場所のすべてのコールバックを削除するには、以下を実行します。

Java

// No Java equivalent, listeners must be removed individually.

Node.js

// Remove all value callbacks
ref.off('value');

// Remove all callbacks of any type
ref.off();

データの 1 回読み取り

場合によっては、コールバックを 1 回呼び出してから直ちに削除する方法が役立つことがあります。これを簡単に行うことができるようにヘルパー関数を作成しました。

Java

ref.addListenerForSingleValueEvent(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot dataSnapshot) {
    // ...
  }

  @Override
  public void onCancelled(DatabaseError databaseError) {
    // ...
  }
});

Node.js

ref.once('value', (data) => {
  // do some stuff once
});

Python

# Import database module.
from firebase_admin import db

# Get a database reference to our posts
ref = db.reference('server/saving-data/fireblog/posts')

# Read the data at the posts reference (this is a blocking operation)
print(ref.get())

Go

// Create a database client from App.
client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// Get a database reference to our posts
ref := client.NewRef("server/saving-data/fireblog/posts")

// Read the data at the posts reference (this is a blocking operation)
var post Post
if err := ref.Get(ctx, &post); err != nil {
	log.Fatalln("Error reading value:", err)
}

データのクエリ

Firebase データベースのクエリを使用すると、さまざまな要素に基づいてデータを選択的に取得できます。データベースでクエリを構築するには、まず、orderByChild()、orderByKey()、orderByValue() のいずれかの並べ替え関数を使用して、データの並び順を指定します。次に、これらを他の 5 つのメソッド limitToFirst()、limitToLast()、startAt()、endAt()、equalTo() と組み合わせて複雑なクエリを実行できます。

Firebase の担当者は皆、恐竜が大好きなので、恐竜に関するファクトのサンプルデータベースのスニペットを使用して、Firebase データベース内のデータのクエリを実行する方法について説明します。

{
  "lambeosaurus": {
    "height" : 2.1,
    "length" : 12.5,
    "weight": 5000
  },
  "stegosaurus": {
    "height" : 4,
    "length" : 9,
    "weight" : 2500
  }
}

データは、子キー、キー、または値の 3 つの方法で並べ替えることができます。基本的なデータベースクエリはこれらの並べ替え関数のいずれかから作り始めます。これらの各関数については、以下で説明します。

指定した子キーでの並べ替え

共通の子キーを orderByChild() に渡すことにより、ノードをそのキーで並べ替えることができます。たとえば、体高で並べ替えた恐竜をすべて読み取るには、以下のように行います。

Java

public static class Dinosaur {

  public int height;
  public int weight;

  public Dinosaur(int height, int weight) {
    // ...
  }

}

final DatabaseReference dinosaursRef = database.getReference("dinosaurs");
dinosaursRef.orderByChild("height").addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    Dinosaur dinosaur = dataSnapshot.getValue(Dinosaur.class);
    System.out.println(dataSnapshot.getKey() + " was " + dinosaur.height + " meters tall.");
  }

  // ...
});

Node.js

const ref = db.ref('dinosaurs');

ref.orderByChild('height').on('child_added', (snapshot) => {
  console.log(snapshot.key + ' was ' + snapshot.val().height + ' meters tall');
});

Python

ref = db.reference('dinosaurs')
snapshot = ref.order_by_child('height').get()
for key, val in snapshot.items():
    print('{0} was {1} meters tall'.format(key, val))

Go


// Dinosaur is a json-serializable type.
type Dinosaur struct {
	Height int `json:"height"`
	Width  int `json:"width"`
}

ref := client.NewRef("dinosaurs")

results, err := ref.OrderByChild("height").GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
for _, r := range results {
	var d Dinosaur
	if err := r.Unmarshal(&d); err != nil {
		log.Fatalln("Error unmarshaling result:", err)
	}
	fmt.Printf("%s was %d meteres tall", r.Key(), d.Height)
}

クエリに使用する子キーを持たないあらゆるノードは、値 null を使用して並べ替えられます。つまり、これらのノードが並べ替えで先頭になります。データが並べ替えられる仕組みの詳細については、データが並べ替えられる仕組みのセクションをご覧ください。

クエリは 1 レベル下の子だけでなく、深くネストされた子で並べ替えることもできます。これは、次のような深くネストされたデータがある場合に役立ちます。

{
  "lambeosaurus": {
    "dimensions": {
      "height" : 2.1,
      "length" : 12.5,
      "weight": 5000
    }
  },
  "stegosaurus": {
    "dimensions": {
      "height" : 4,
      "length" : 9,
      "weight" : 2500
    }
  }
}

ここで体高のクエリを実行するには、単一のキーではなく、オブジェクトへの完全なパスを使用します。

Java

dinosaursRef.orderByChild("dimensions/height").addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    // ...
  }

  // ...
});

Node.js

const ref = db.ref('dinosaurs');
ref.orderByChild('dimensions/height').on('child_added', (snapshot) => {
  console.log(snapshot.key + ' was ' + snapshot.val().height + ' meters tall');
});

Python

ref = db.reference('dinosaurs')
snapshot = ref.order_by_child('dimensions/height').get()
for key, val in snapshot.items():
    print('{0} was {1} meters tall'.format(key, val))

Go

ref := client.NewRef("dinosaurs")

results, err := ref.OrderByChild("dimensions/height").GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
for _, r := range results {
	var d Dinosaur
	if err := r.Unmarshal(&d); err != nil {
		log.Fatalln("Error unmarshaling result:", err)
	}
	fmt.Printf("%s was %d meteres tall", r.Key(), d.Height)
}

クエリでは、一度に 1 つのキーのみで並べ替えることができます。同じクエリで orderByChild() を複数回呼び出すと、エラーがスローされます。

キーによる並び替え

orderByKey() メソッドを使用してキーでノードを並べ替えることもできます。次の例では、アルファベット順にすべての恐竜を読み取っています。

Java

dinosaursRef.orderByKey().addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    System.out.println(dataSnapshot.getKey());
  }

  // ...
});

Node.js

var ref = db.ref('dinosaurs');
ref.orderByKey().on('child_added', (snapshot) => {
  console.log(snapshot.key);
});

Python

ref = db.reference('dinosaurs')
snapshot = ref.order_by_key().get()
print(snapshot)

Go

ref := client.NewRef("dinosaurs")

results, err := ref.OrderByKey().GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
snapshot := make([]Dinosaur, len(results))
for i, r := range results {
	var d Dinosaur
	if err := r.Unmarshal(&d); err != nil {
		log.Fatalln("Error unmarshaling result:", err)
	}
	snapshot[i] = d
}
fmt.Println(snapshot)

値での並べ替え

ノードは、orderByValue() メソッドを使用して子キーの値で並べ替えることができます。恐竜スポーツ競技会があり、次の形式でそのスコアを記録しているとします。

{
  "scores": {
    "bruhathkayosaurus" : 55,
    "lambeosaurus" : 21,
    "linhenykus" : 80,
    "pterodactyl" : 93,
    "stegosaurus" : 5,
    "triceratops" : 22
  }
}

恐竜をスコア順に並べ替えるには、以下のクエリを構築します。

Java

DatabaseReference scoresRef = database.getReference("scores");
scoresRef.orderByValue().addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    System.out.println("The " + dataSnapshot.getKey() + " score is " + dataSnapshot.getValue());
  }

  // ...
});

Node.js

const scoresRef = db.ref('scores');
scoresRef.orderByValue().on('value', (snapshot) => {
  snapshot.forEach((data) => {
    console.log('The ' + data.key + ' dinosaur\'s score is ' + data.val());
  });
});

Python

ref = db.reference('scores')
snapshot = ref.order_by_value().get()
for key, val in snapshot.items():
    print('The {0} dinosaur\'s score is {1}'.format(key, val))

Go

ref := client.NewRef("scores")

results, err := ref.OrderByValue().GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
for _, r := range results {
	var score int
	if err := r.Unmarshal(&score); err != nil {
		log.Fatalln("Error unmarshaling result:", err)
	}
	fmt.Printf("The %s dinosaur's score is %d\n", r.Key(), score)
}

orderByValue() の使用時に null、ブール値、文字列、オブジェクト値が並べ替えられる仕組みについては、データが並べ替えられる仕組みをご覧ください。

複雑なクエリ

データの並べ替え方法を理解できたら、以下で説明する limit または range メソッドを使用してより複雑なクエリを作成できます。

制限クエリ

limitToFirst() クエリと limitToLast() クエリは、所定のコールバックについて同期する子の最大数を設定するために使用します。上限 100 を設定した場合、初期状態では最大 100 個の child_added イベントのみを受け取ります。データベースに保存されているメッセージが 100 個未満の場合、メッセージごとに child_added イベントが発生します。一方、100 個を超えるメッセージが保存されている場合は、これらのメッセージのうち 100 個についてのみ child_added イベントを受け取ります。100 個とは、limitToFirst() を使用している場合は、並べ替えられたメッセージの最初の 100 個です。limitToLast() を使用している場合は、並べ替えられたメッセージの最後の 100 個です。アイテムの変更に応じて、クエリに加わったアイテムに対する child_added イベントと、クエリから外れたアイテムに対する child_removed イベントを受け取り、合計数が 100 に保たれます。

恐竜ファクトデータベースと orderByChild() を併用して、体重の重い順から上位 2 頭の恐竜を検索できます。

Java

dinosaursRef.orderByChild("weight").limitToLast(2).addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    System.out.println(dataSnapshot.getKey());
  }

  // ...
});

Node.js

const ref = db.ref('dinosaurs');
ref.orderByChild('weight').limitToLast(2).on('child_added', (snapshot) => {
  console.log(snapshot.key);
});

Python

ref = db.reference('dinosaurs')
snapshot = ref.order_by_child('weight').limit_to_last(2).get()
for key in snapshot:
    print(key)

Go

ref := client.NewRef("dinosaurs")

results, err := ref.OrderByChild("weight").LimitToLast(2).GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
for _, r := range results {
	fmt.Println(r.Key())
}

child_added コールバックは、データベースに保存されている恐竜が 2 頭未満の場合を除いて、正確に 2 回トリガーされます。また、データベースに新しい、より体重の重い恐竜が追加された場合も、これが発生します。Python では、クエリで体重が重い順から上位 2 頭の恐竜を含む OrderedDict が返されます。

同様に、limitToFirst() を使用して体高が低い順から上位 2 頭の恐竜を検索できます。

Java

dinosaursRef.orderByChild("weight").limitToFirst(2).addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    System.out.println(dataSnapshot.getKey());
  }

  // ...
});

Node.js

const ref = db.ref('dinosaurs');
ref.orderByChild('height').limitToFirst(2).on('child_added', (snapshot) => {
  console.log(snapshot.key);
});

Python

ref = db.reference('dinosaurs')
snapshot = ref.order_by_child('height').limit_to_first(2).get()
for key in snapshot:
    print(key)

Go

ref := client.NewRef("dinosaurs")

results, err := ref.OrderByChild("height").LimitToFirst(2).GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
for _, r := range results {
	fmt.Println(r.Key())
}

child_added コールバックは、データベースに保存されている恐竜が 2 頭未満の場合を除いて、正確に 2 回トリガーされます。先頭の 2 頭の恐竜のいずれかがデータベースから削除された場合も再度トリガーされます。これで、新しい恐竜が 2 番目に体高が低い恐竜になるからです。Python では、最も体高が低い恐竜を含む OrderedDict がクエリで直接返されます。

また、制限クエリを orderByValue() と併用することもできます。恐竜スポーツ競技会の選手でスコアの高い上位 3 頭を記載したリーダーボードを作成したい場合は、次を実行します。

Java

scoresRef.orderByValue().limitToFirst(3).addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    System.out.println("The " + dataSnapshot.getKey() + " score is " + dataSnapshot.getValue());
  }

  // ...
});

Node.js

const scoresRef = db.ref('scores');
scoresRef.orderByValue().limitToLast(3).on('value', (snapshot)  =>{
  snapshot.forEach((data) => {
    console.log('The ' + data.key + ' dinosaur\'s score is ' + data.val());
  });
});

Python

scores_ref = db.reference('scores')
snapshot = scores_ref.order_by_value().limit_to_last(3).get()
for key, val in snapshot.items():
    print('The {0} dinosaur\'s score is {1}'.format(key, val))

Go

ref := client.NewRef("scores")

results, err := ref.OrderByValue().LimitToLast(3).GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
for _, r := range results {
	var score int
	if err := r.Unmarshal(&score); err != nil {
		log.Fatalln("Error unmarshaling result:", err)
	}
	fmt.Printf("The %s dinosaur's score is %d\n", r.Key(), score)
}

範囲クエリ

startAt()、endAt()、equalTo() を使用すると、クエリに対し任意の始点と終点を選択できます。たとえば、体高が 3 m 以上のすべての恐竜を検索する場合は、orderByChild() と startAt() を組み合わせることができます。

Java

dinosaursRef.orderByChild("height").startAt(3).addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    System.out.println(dataSnapshot.getKey());
  }

  // ...
});

Node.js

const ref = db.ref('dinosaurs');
ref.orderByChild('height').startAt(3).on('child_added', (snapshot) => {
  console.log(snapshot.key);
});

Python

ref = db.reference('dinosaurs')
snapshot = ref.order_by_child('height').start_at(3).get()
for key in snapshot:
    print(key)

Go

ref := client.NewRef("dinosaurs")

results, err := ref.OrderByChild("height").StartAt(3).GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
for _, r := range results {
	fmt.Println(r.Key())
}

endAt() を使用して、辞書順で Pterodactyl よりも前に来る名前を持つすべての恐竜を検索できます。

Java

dinosaursRef.orderByKey().endAt("pterodactyl").addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    System.out.println(dataSnapshot.getKey());
  }

  // ...
});

Node.js

const ref = db.ref('dinosaurs');
ref.orderByKey().endAt('pterodactyl').on('child_added', (snapshot) => {
  console.log(snapshot.key);
});

Python

ref = db.reference('dinosaurs')
snapshot = ref.order_by_key().end_at('pterodactyl').get()
for key in snapshot:
    print(key)

Go

ref := client.NewRef("dinosaurs")

results, err := ref.OrderByKey().EndAt("pterodactyl").GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
for _, r := range results {
	fmt.Println(r.Key())
}

startAt() と endAt() は端点を含みます。つまり、「pterodactyl」は上記のクエリに一致します。

startAt() と endAt() を組み合わせてクエリの両端を制限できます。次の例では、「b」で始まる名前を持つすべての恐竜を検索しています。

Java

dinosaursRef.orderByKey().startAt("b").endAt("b\uf8ff").addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    System.out.println(dataSnapshot.getKey());
  }

  // ...
});

Node.js

var ref = db.ref('dinosaurs');
ref.orderByKey().startAt('b').endAt('b\uf8ff').on('child_added', (snapshot) => {
  console.log(snapshot.key);
});

Python

ref = db.reference('dinosaurs')
snapshot = ref.order_by_key().start_at('b').end_at(u'b\uf8ff').get()
for key in snapshot:
    print(key)

Go

ref := client.NewRef("dinosaurs")

results, err := ref.OrderByKey().StartAt("b").EndAt("b\uf8ff").GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
for _, r := range results {
	fmt.Println(r.Key())
}

上記のクエリで使用されている \uf8ff 文字は Unicode 範囲内の非常に高いコードポイントです。この文字は Unicode のほとんどの通常文字より後に来るため、クエリは b で始まるすべての値に一致します。

equalTo() メソッドを使用すると、完全一致に基づいてフィルタリングできます。他の範囲クエリの場合と同様、一致する子ノードごとにこのメソッドが呼び出されます。たとえば、次のクエリを使用して体高が 25 m のすべての恐竜を検索できます。

Java

dinosaursRef.orderByChild("height").equalTo(25).addChildEventListener(new ChildEventListener() {
  @Override
  public void onChildAdded(DataSnapshot dataSnapshot, String prevChildKey) {
    System.out.println(dataSnapshot.getKey());
  }

  // ...
});

Node.js

const ref = db.ref('dinosaurs');
ref.orderByChild('height').equalTo(25).on('child_added', (snapshot) => {
  console.log(snapshot.key);
});

Python

ref = db.reference('dinosaurs')
snapshot = ref.order_by_child('height').equal_to(25).get()
for key in snapshot:
    print(key)

Go

ref := client.NewRef("dinosaurs")

results, err := ref.OrderByChild("height").EqualTo(25).GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
for _, r := range results {
	fmt.Println(r.Key())
}

範囲クエリは、データをページ分割する場合にも便利です。

orderByValue() を startAt() や endAt() と組み合わせて範囲クエリを構築することもできます。

すべてを組み合わせる

これらのすべての方法を組み合わせて複雑なクエリを作成できます。たとえば、Stegosaurus よりも体高が低い恐竜の名前のみを検索できます。

Java

dinosaursRef.child("stegosaurus").child("height").addValueEventListener(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot stegoHeightSnapshot) {
    Integer favoriteDinoHeight = stegoHeightSnapshot.getValue(Integer.class);
    Query query = dinosaursRef.orderByChild("height").endAt(favoriteDinoHeight).limitToLast(2);
    query.addValueEventListener(new ValueEventListener() {
      @Override
      public void onDataChange(DataSnapshot dataSnapshot) {
        // Data is ordered by increasing height, so we want the first entry
        DataSnapshot firstChild = dataSnapshot.getChildren().iterator().next();
        System.out.println("The dinosaur just shorter than the stegosaurus is: " + firstChild.getKey());
      }

      @Override
      public void onCancelled(DatabaseError databaseError) {
        // ...
      }
    });
  }

  @Override
  public void onCancelled(DatabaseError databaseError) {
    // ...
  }
});

Node.js

  const ref = db.ref('dinosaurs');
  ref.child('stegosaurus').child('height').on('value', (stegosaurusHeightSnapshot) => {
    const favoriteDinoHeight = stegosaurusHeightSnapshot.val();

    const queryRef = ref.orderByChild('height').endAt(favoriteDinoHeight).limitToLast(2);
    queryRef.on('value', (querySnapshot) => {
      if (querySnapshot.numChildren() === 2) {
        // Data is ordered by increasing height, so we want the first entry
        querySnapshot.forEach((dinoSnapshot) => {
          console.log('The dinosaur just shorter than the stegasaurus is ' + dinoSnapshot.key);

          // Returning true means that we will only loop through the forEach() one time
          return true;
        });
      } else {
        console.log('The stegosaurus is the shortest dino');
      }
    });
});

Python

ref = db.reference('dinosaurs')
favotire_dino_height = ref.child('stegosaurus').child('height').get()
query = ref.order_by_child('height').end_at(favotire_dino_height).limit_to_last(2)
snapshot = query.get()
if len(snapshot) == 2:
    # Data is ordered by increasing height, so we want the first entry.
    # Second entry is stegosarus.
    for key in snapshot:
        print('The dinosaur just shorter than the stegosaurus is {0}'.format(key))
        return
else:
    print('The stegosaurus is the shortest dino')

Go

ref := client.NewRef("dinosaurs")

var favDinoHeight int
if err := ref.Child("stegosaurus").Child("height").Get(ctx, &favDinoHeight); err != nil {
	log.Fatalln("Error querying database:", err)
}

query := ref.OrderByChild("height").EndAt(favDinoHeight).LimitToLast(2)
results, err := query.GetOrdered(ctx)
if err != nil {
	log.Fatalln("Error querying database:", err)
}
if len(results) == 2 {
	// Data is ordered by increasing height, so we want the first entry.
	// Second entry is stegosarus.
	fmt.Printf("The dinosaur just shorter than the stegosaurus is %s\n", results[0].Key())
} else {
	fmt.Println("The stegosaurus is the shortest dino")
}

データが並べ替えられる仕組み

このセクションでは、4 つの並び替え関数をそれぞれ使用したときにデータがどのように並べ替えられるかについて説明します。

orderByChild

orderByChild() を使用すると、指定した子キーを含むデータは次のように並べ替えられます。

指定した子キーに null 値を持つ子が最初に来ます。
指定した子キーの値が false である子が次に来ます。複数の子が値 false を持つ場合、キーで辞書順に並べ替えられます。
指定した子キーの値が true である子が次に来ます。複数の子が値 true を持つ場合、キーで辞書順に並べ替えられます。
数値を持つ子が次に来ます。ただし、昇順に並べ替えられます。複数の子が指定した子ノードに同じ数値を持つ場合、キーで並べ替えられます。
文字列は数値の後に来て、辞書順で昇順に並べ替えられます。複数の子が指定した子ノードに同じ値を持つ場合、キーで辞書順に並べ替えられます。
オブジェクトが最後に来て、キーで、辞書順かつ昇順に並べ替えられます。

orderByKey

orderByKey() を使用してデータを並べ替えると、次のようにキーで昇順にデータが返されます。キーには文字列しか使用できないことに注意してください。

32 ビット整数として解析できるキーを持つ子が最初に来ます。ただし、昇順に並べ替えられます。
文字列値をキーとして持つ子が次に来ます。ただし、辞書順で昇順に並べ替えられます。

orderByValue

orderByValue() を使用すると、子がその値で並べ替えられます。並べ替えの条件は、指定した子キーの値の代わりにノードの値が使用されるという点を除いて、orderByChild() の場合と同じです。