射影クエリ

ほとんどの Datastore クエリでは、エンティティ全体が結果として返されますが、多くの場合、アプリケーションが実際に必要としているのはエンティティの一部のプロパティだけです。射影クエリを使用すると、エンティティのプロパティの中で本当に必要なものだけをクエリできるため、エンティティ全体を取得する場合よりもレイテンシとコストを低く抑えられます。

射影クエリは、次のような形式の SQL クエリと似ています。

SELECT name, email, phone FROM CUSTOMER

標準的なエンティティ クエリで使用できるフィルタリングや並べ替えの機能はすべて使用できます。制限事項については、以降で説明するとおりです。このクエリでは要約された結果が返されます。指定したプロパティ（この例では name、email、phone）だけに値が格納され、その他すべてのプロパティにはデータは格納されません。

Go 1.11 での射影クエリの使用

Query を準備するときに、Project メソッドを使用して射影を指定します。

q := datastore.NewQuery("People").Project("FirstName", "LastName")

これらのクエリの結果は、標準的なエンティティのクエリの場合と同じように扱います（結果を反復処理する、など）。

次の例では、すべての EventLog エンティティの Title、ReadPath、DateWritten の各プロパティをクエリし、DateWritten の昇順で並べ替えて、各プロパティの値をアプリケーション ログに書き込みます。

q := datastore.NewQuery("EventLog").
	Project("Title", "ReadPath", "DateWritten").
	Order("DateWritten")
t := q.Run(ctx)
for {
	var l EventLog
	_, err := t.Next(&l)
	if err == datastore.Done {
		break
	}
	if err != nil {
		log.Errorf(ctx, "Running query: %v", err)
		break
	}
	log.Infof(ctx, "Log record: %v, %v, %v", l.Title, l.ReadPath, l.DateWritten)
}

グループ化（試験運用版）

射影クエリで Distinct メソッドを使用すると、完全に一意の結果のみが結果セットで返されます。つまり、射影されているプロパティについて同じ値を持つエンティティが複数存在する場合は、最初の結果だけが返されます。

q := datastore.NewQuery("Person").
	Project("LastName", "Height").Distinct().
	Filter("Height >", 20).
	Order("-Height").Order("LastName")

射影の制限事項

射影クエリには次のような制限事項があります。

  • 射影できるのはインデックス付けされたプロパティのみ。

    インデックスに登録されていないプロパティでは、明示的にも暗黙的にも射影はサポートされません。1,500 バイトを超える文字列と、格納されている要素数が 1,500 個を超えるバイト配列はインデックス登録されません。

  • 同じプロパティは複数回射影できない。

  • 等式フィルタ（=）で参照されているプロパティは射影できない。

    例:

    SELECT A FROM kind WHERE B = 1

    は有効です（射影されたプロパティが等式フィルタで使用されていないため）。同様に、

    SELECT A FROM kind WHERE A > 1

    も有効です（等式フィルタではないため）。ただし、

    SELECT A FROM kind WHERE A = 1

    は無効です（射影されたプロパティが等式フィルタで使用されているため）。

  • 射影クエリから返された結果を Datastore に再保存するべきではない。

    このようなクエリでは部分的に格納された結果しか返されないため、Datastore に書き戻すべきではありません。

射影と複数の値を持つプロパティ

複数の値を持つプロパティを射影した場合は、そのプロパティのすべての値が格納されるのではなく、クエリに一致する、射影された値の一意の組み合わせごとに個別のエンティティが返されます。たとえば、複数の値を持つ 2 つのプロパティ A と B が設定された Foo という種類のエンティティがあるとします。

entity := Foo{A: []int{1, 1, 2, 3}, B: []string{"x", "y", "x"}}

この状況で、次の射影クエリを実行します。

q := datastore.NewQuery("Foo").Project("A", "B").Filter("A <", 3)

この場合、次の値の組み合わせを持つ 4 つのエンティティが返されます。

A = 1、B = 'x'
A = 1、B = 'y'
A = 2、B = 'x'
A = 2、B = 'y'

値が指定されていない複数値プロパティがエンティティに含まれている場合、そのプロパティのエントリはどれもインデックスに取り込まれません。したがって、こうしたプロパティを含む射影クエリからは、エンティティに対する結果が返されません。

射影のインデックス

射影クエリでは、射影で指定されているすべてのプロパティが Datastore のインデックスに含まれるようにする必要があります。App Engine 開発用サーバーを使用すると、必要なインデックスがインデックス構成ファイル（index.yaml）内に自動生成されます。このファイルはアプリケーションと一緒にアップロードされます。

必要なインデックスの数を最小限に抑える方法の 1 つとして、必ずしもすべてが必要でない場合であっても、同じ複数のプロパティを一貫して射影する方法があります。たとえば、次のクエリはそれぞれ個別のインデックスを必要とします。

SELECT A, B FROM Kind
SELECT A, B, C FROM Kind

ただし、C が必要でないときでもプロパティ A、B、C を常に射影すれば、必要となるインデックスは 1 つのみとなります。

射影のプロパティがクエリの別の部分に含まれていない場合、既存のクエリを射影クエリに変換する際に新しいインデックスを構築しなければならない場合があります。たとえば、次のような既存のクエリがあるとします。

SELECT * FROM Kind WHERE A > 1 ORDER BY A, B

必要なインデックスは次のとおりです。

Index(Kind, A, B)

このクエリを次のいずれかの射影クエリに変換します。

SELECT C FROM Kind WHERE A > 1 ORDER BY A, B
SELECT A, B, C FROM Kind WHERE A > 1 ORDER BY A, B

新しいプロパティ（C）が取り入れられるため、新しいインデックス Index(Kind, A, B, C) を作成する必要があります。次の射影クエリ

SELECT A, B FROM Kind WHERE A > 1 ORDER BY A, B

では、必要なインデックスに変化はありません。これは射影される A プロパティと B プロパティが既存のクエリにすでに含まれているためです。