型関数

プレビュー: Enterprise エディションのネイティブ モードの Firestore（Pipeline オペレーションを含む）は、サービス固有の規約の一般サービス規約セクションにある「pre-GA 提供サービス規約」の対象となります。お客様はこの機能の個人データを Cloud のデータ処理に関する追加条項に記載されているとおりに処理できます。ただし、Google Cloud へのアクセスに関する契約に記載されている義務と制限事項が適用されます。pre-GA の機能は「現状のまま」で提供されるものであり、サポートが制限されることがあります。詳細については、リリース ステージの説明をご覧ください。

型関数

名前	説明
TYPE	値の型を STRING として返します。
IS_TYPE	値が指定された型と一致する場合に true を返します。

TYPE

構文:

type(input: ANY) -> STRING

説明:

input 型の文字列表現を返します。

欠損値を指定した場合は、NULL を返します。

例:

input	type(input)
NULL	"null"
true	"boolean"
1	"int32"
-3L	"int64"
3.14	"float64"
2024-01-01T00:00:00Z UTC	"timestamp"
"foo"	"string"
b"foo"	"bytes"
[1, 2]	"array"
{"a": 1}	"map"
path("c/d")	"reference"
vector([1.0, 2.0])	"vector"
ABSENT	NULL

クライアントの例

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(field("title").notEqual("1984").as("not1984"))
  .execute();
test.firestore.js

Web

const result = await execute(db.pipeline()
  .collection("books")
  .select(field("title").notEqual("1984").as("not1984"))
);
test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([Field("title").notEqual("1984").as("not1984")])
  .execute()
PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .select(field("title").notEqual("1984").alias("not1984"))
    .execute()
DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(field("title").notEqual("1984").alias("not1984"))
    .execute();
DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("title").not_equal("1984").as_("not1984"))
    .execute()
)
firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(notEqual(field("title"), "1984").as("not1984"))
        .execute()
        .get();
PipelineSnippets.java

IS_TYPE

構文:

is_type(input: ANY, type: STRING) -> BOOLEAN

説明:

input が指定された type と一致する場合は true、それ以外の場合は false を返します。存在しない input が指定された場合は、NULL を返します。

サポートされている type 文字列は次のとおりです。

• "null"
• "boolean"
• "int32"
• "int64"
• "float64"
• "decimal128"
• "number"
• "timestamp"
• "string"
• "bytes"
• "array"
• "map"
• "reference"
• "vector"
• "geo_point"
• "max_key"
• "min_key"
• "object_id"
• "regex"
• "bson_timestamp"

例:

input	type	is_type(input, type)
NULL	"null"	true
true	"boolean"	true
3.14	"float64"	true
"foo"	"string"	true
b"foo"	"string"	false
[1, 2]	"array"	true
{"a": 1}	"map"	true
vector([1.0, 2.0])	"vector"	true
ABSENT	"string"	NULL
"bar"	"other"	エラー