הקלדת פונקציות

פונקציות הקלדה

שם תיאור
TYPE הפונקציה מחזירה את סוג הערך כ-STRING.
IS_TYPE הפונקציה מחזירה את הערך true אם הערך תואם לסוג שצוין.

סוג

תחביר:

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

תיאור:

הפונקציה מחזירה את הערך true אם input תואם לערך type שצוין, אחרת היא מחזירה את הערך 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" שגיאה