字串函式參考資料

字串函式

名稱	說明
`BYTE_LENGTH`	傳回 `STRING` 或 `BYTES` 值中的 `BYTES` 數量
`CHAR_LENGTH`	傳回 `STRING` 值中的 Unicode 字元數
`STARTS_WITH`	如果 `STRING` 以指定前置字元開頭，則傳回 `TRUE`
`ENDS_WITH`	如果 `STRING` 以指定後置字串結尾，則傳回 `TRUE`。
`LIKE`	如果 `STRING` 符合模式，則傳回 `TRUE`
`REGEX_CONTAINS`	如果值與規則運算式部分或完全相符，則傳回 `TRUE`
`REGEX_MATCH`	如果值有任何部分符合規則運算式，則傳回 `TRUE`
`STRING_CONCAT`	將多個 `STRING` 串連成一個 `STRING`
`STRING_CONTAINS`	如果值包含 `STRING`，則傳回 `TRUE`。
`STRING_INDEX_OF`	傳回第一次出現 `STRING` 或 `BYTES` 值的索引 (索引從 0 開始)。
`TO_UPPER`	將 `STRING` 或 `BYTES` 值轉換為大寫。
`TO_LOWER`	將 `STRING` 或 `BYTES` 值轉換為小寫。
`SUBSTRING`	取得 `STRING` 或 `BYTES` 值的子字串。
`STRING_REVERSE`	反轉 `STRING` 或 `BYTES` 值。
`STRING_REPEAT`	將 `STRING` 或 `BYTES` 值重複指定次數。
`STRING_REPLACE_ALL`	取代所有 `STRING` 或 `BYTES` 值。
`STRING_REPLACE_ONE`	取代第一個出現的 `STRING` 或 `BYTES` 值。
`TRIM`	從 `STRING` 或 `BYTES` 值中移除開頭和結尾字元。
`LTRIM`	從 `STRING` 或 `BYTES` 值中移除開頭字元。
`RTRIM`	從 `STRING` 或 `BYTES` 值中移除尾隨字元。
`SPLIT`	將 `STRING` 或 `BYTES` 值分割為陣列。

BYTE_LENGTH

語法：

byte_length[T <: STRING | BYTES](value: T) -> INT64

說明：

傳回 STRING 或 BYTES 值中的 BYTES 數量。

範例：

值	`byte_length(value)`
"abc"	3
"xyzabc"	6
b"abc"	3

Node.js

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

網頁

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

Swift

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

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(
        field("title").byteLength().alias("titleByteLength")
    )
    .execute()DocSnippets.kt

Java
Android

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

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("title").byte_length().as_("titleByteLength"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(byteLength(field("title")).as("titleByteLength"))
        .execute()
        .get();PipelineSnippets.java

CHAR_LENGTH

語法：

char_length(value: STRING) -> INT64

說明：

傳回 STRING 值中的 Unicode 碼位數。

範例：

值	`char_length(value)`
"abc"	3
「hello」	5
「world」	5

Node.js

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

網頁

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

Swift

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

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(
        field("title").charLength().alias("titleCharLength")
    )
    .execute()DocSnippets.kt

Java
Android

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

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("title").char_length().as_("titleCharLength"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(charLength(field("title")).as("titleCharLength"))
        .execute()
        .get();PipelineSnippets.java

STARTS_WITH

語法：

starts_with(value: STRING, prefix: STRING) -> BOOLEAN

說明：

如果 value 以 prefix 開頭，則傳回 TRUE。

範例：

值	前置字串	`starts_with(value, prefix)`
"abc"	「a」	true
"abc"	"b"	false
"abc"	""	true

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("title").startsWith("The")
      .as("needsSpecialAlphabeticalSort")
  )
  .execute();test.firestore.js

網頁

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("title").startsWith("The")
      .as("needsSpecialAlphabeticalSort")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("title").startsWith("The")
      .as("needsSpecialAlphabeticalSort")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(
        field("title").startsWith("The")
            .alias("needsSpecialAlphabeticalSort")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("title").startsWith("The")
            .alias("needsSpecialAlphabeticalSort")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("title").starts_with("The").as_("needsSpecialAlphabeticalSort")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(startsWith(field("title"), "The").as("needsSpecialAlphabeticalSort"))
        .execute()
        .get();PipelineSnippets.java

ENDS_WITH

語法：

ends_with(value: STRING, postfix: STRING) -> BOOLEAN

說明：

如果 value 以 postfix 結尾，則傳回 TRUE。

範例：

值	後置字串	`ends_with(value, postfix)`
"abc"	"c"	true
"abc"	"b"	false
"abc"	""	true

Node.js

const result = await db.pipeline()
  .collection("inventory/devices/laptops")
  .select(
    field("name").endsWith("16 inch")
      .as("16InLaptops")
  )
  .execute();test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("inventory/devices/laptops")
  .select([
    Field("name").endsWith("16 inch")
      .as("16InLaptops")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("inventory/devices/laptops")
    .select(
        field("name").endsWith("16 inch")
            .alias("16InLaptops")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("inventory/devices/laptops")
    .select(
        field("name").endsWith("16 inch")
            .alias("16InLaptops")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("inventory/devices/laptops")
    .select(Field.of("name").ends_with("16 inch").as_("16InLaptops"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("inventory/devices/laptops")
        .select(endsWith(field("name"), "16 inch").as("16InLaptops"))
        .execute()
        .get();PipelineSnippets.java

LIKE

語法：

like(value: STRING, pattern: STRING) -> BOOLEAN

說明：

如果 value 與 pattern 相符，則傳回 TRUE。

範例：

值	pattern	`like(value, pattern)`
「Firestore」	「Fire%」	true
「Firestore」	「%store」	true
「Datastore」	「Data_tore」	true
「100%」	「100\%」	true

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("genre").like("%Fiction")
      .as("anyFiction")
  )
  .execute();test.firestore.js

網頁

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("genre").like("%Fiction")
      .as("anyFiction")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("genre").like("%Fiction")
      .as("anyFiction")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(
        field("genre").like("%Fiction")
            .alias("anyFiction")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("genre").like("%Fiction")
            .alias("anyFiction")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("genre").like("%Fiction").as_("anyFiction"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(like(field("genre"), "%Fiction").as("anyFiction"))
        .execute()
        .get();PipelineSnippets.java

REGEX_CONTAINS

語法：

regex_contains(value: STRING, pattern: STRING) -> BOOLEAN

說明：

如果 value 的部分內容與 pattern 相符，就會傳回 TRUE。如果 pattern 不是有效的規則運算式，這個函式會傳回 error。

規則運算式遵循 re2 程式庫的語法。

範例：

值	pattern	`regex_contains(value, pattern)`
「Firestore」	「Fire」	true
「Firestore」	「store$"	true
「Firestore」	「data」	false

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("title").regexContains("Firestore (Enterprise|Standard)")
      .as("isFirestoreRelated")
  )
  .execute();test.firestore.js

網頁

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("title").regexContains("Firestore (Enterprise|Standard)")
      .as("isFirestoreRelated")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("title").regexContains("Firestore (Enterprise|Standard)")
      .as("isFirestoreRelated")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("documents")
    .select(
        field("title").regexContains("Firestore (Enterprise|Standard)")
            .alias("isFirestoreRelated")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("title").regexContains("Firestore (Enterprise|Standard)")
            .alias("isFirestoreRelated")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("title")
        .regex_contains("Firestore (Enterprise|Standard)")
        .as_("isFirestoreRelated")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(
            regexContains(field("title"), "Firestore (Enterprise|Standard)")
                .as("isFirestoreRelated"))
        .execute()
        .get();PipelineSnippets.java

REGEX_MATCH

語法：

regex_match(value: STRING, pattern: STRING) -> BOOLEAN

說明：

如果 value 與 pattern 完全相符，就會傳回 TRUE。如果 pattern 不是有效的規則運算式，這個函式會傳回 error。

規則運算式遵循 re2 程式庫的語法。

範例：

值	pattern	`regex_match(value, pattern)`
「Firestore」	"F.*store"	true
「Firestore」	「Fire」	false
「Firestore」	"^F.*e$"	true

Node.js

const result = await db.pipeline()
  .collection("documents")
  .select(
    field("title").regexMatch("Firestore (Enterprise|Standard)")
      .as("isFirestoreExactly")
  )
  .execute();test.firestore.js

網頁

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("title").regexMatch("Firestore (Enterprise|Standard)")
      .as("isFirestoreExactly")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("title").regexMatch("Firestore (Enterprise|Standard)")
      .as("isFirestoreExactly")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("documents")
    .select(
        field("title").regexMatch("Firestore (Enterprise|Standard)")
            .alias("isFirestoreExactly")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("title").regexMatch("Firestore (Enterprise|Standard)")
            .alias("isFirestoreExactly")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("title")
        .regex_match("Firestore (Enterprise|Standard)")
        .as_("isFirestoreExactly")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("documents")
        .select(
            regexMatch(field("title"), "Firestore (Enterprise|Standard)")
                .as("isFirestoreExactly"))
        .execute()
        .get();PipelineSnippets.java

STRING_CONCAT

語法：

string_concat(values: STRING...) -> STRING

說明：

將兩個以上STRING值串連成單一結果。

範例：

引數	`string_concat(values...)`
`()`	錯誤
`("a")`	「a」
`("abc", "def")`	"abcdef"
`("a", "", "c")`	「ac」

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("title").stringConcat(" by ", field("author"))
      .as("fullyQualifiedTitle")
  )
  .execute();test.firestore.js

網頁

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("title").stringConcat(" by ", field("author"))
      .as("fullyQualifiedTitle")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("title").concat([" by ", Field("author")])
      .as("fullyQualifiedTitle")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(
        field("title").concat(" by ", field("author"))
            .alias("fullyQualifiedTitle")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("title").concat(" by ", field("author"))
            .alias("fullyQualifiedTitle")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(
        Field.of("title")
        .concat(" by ", Field.of("author"))
        .as_("fullyQualifiedTitle")
    )
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(stringConcat(field("title"), " by ", field("author")).as("fullyQualifiedTitle"))
        .execute()
        .get();PipelineSnippets.java

STRING_CONTAINS

語法：

string_contains(value: STRING, substring: STRING) -> BOOLEAN

說明：

檢查 value 是否包含字串常值 substring。

範例：

值	子字串	`string_contains(value, substring)`
"abc"	"b"	true
"abc"	「d」	false
"abc"	""	true
"a.c"	"."	true
「☃☃☃」	「☃」	true

Node.js

const result = await db.pipeline()
  .collection("articles")
  .select(
    field("body").stringContains("Firestore")
      .as("isFirestoreRelated")
  )
  .execute();test.firestore.js

網頁

const result = await execute(db.pipeline()
  .collection("articles")
  .select(
    field("body").stringContains("Firestore")
      .as("isFirestoreRelated")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("articles")
  .select([
    Field("body").stringContains("Firestore")
      .as("isFirestoreRelated")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("articles")
    .select(
        field("body").stringContains("Firestore")
            .alias("isFirestoreRelated")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("articles")
    .select(
        field("body").stringContains("Firestore")
            .alias("isFirestoreRelated")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("articles")
    .select(Field.of("body").string_contains("Firestore").as_("isFirestoreRelated"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("articles")
        .select(stringContains(field("body"), "Firestore").as("isFirestoreRelated"))
        .execute()
        .get();PipelineSnippets.java

STRING_INDEX_OF

語法：

string_index_of[T <: STRING | BYTES](value: T, search: T) -> INT64

說明：

傳回 value 中第一次出現 search 的索引值，而此索引值是以 0 起算。

若沒找到 search，則傳回 -1。
如果 value 是 STRING 值，結果會以 Unicode 碼點計算。如果是 BYTES 值，則以位元組為單位。
如果 search 是空白的 STRING 或 BYTES 值，則結果為 0。

範例：

值	搜尋	`string_index_of(value, search)`
「hello world」	"o"	4
「hello world」	「l」	2
「hello world」	"z"	-1
「banana」	「na」	2
"abc"	""	0
b"abc"	b"b"	1
"é"	"é"	0
b"é"	b"é"	0

TO_UPPER

語法：

to_upper[T <: STRING | BYTES](value: T) -> T

說明：

將 STRING 或 BYTES 值轉換為大寫。

如果位元組或字元不對應至 UTF-8 小寫英文字母，則會以未變更的形式傳遞。

範例：

值	`to_upper(value)`
"abc"	「ABC」
"AbC"	「ABC」
b"abc"	b"ABC"
b"a1c"	b"A1C"

Node.js

const result = await db.pipeline()
  .collection("authors")
  .select(
    field("name").toUpper()
      .as("uppercaseName")
  )
  .execute();test.firestore.js

網頁

const result = await execute(db.pipeline()
  .collection("authors")
  .select(
    field("name").toUpper()
      .as("uppercaseName")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("authors")
  .select([
    Field("name").toUpper()
      .as("uppercaseName")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("authors")
    .select(
        field("name").toUpper()
            .alias("uppercaseName")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("authors")
    .select(
        field("name").toUpper()
            .alias("uppercaseName")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("authors")
    .select(Field.of("name").to_upper().as_("uppercaseName"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("authors")
        .select(toUpper(field("name")).as("uppercaseName"))
        .execute()
        .get();PipelineSnippets.java

TO_LOWER

語法：

to_lower[T <: STRING | BYTES](value: T) -> T

說明：

將 STRING 或 BYTES 值轉換為小寫。

如果位元組或字元不對應至 UTF-8 大寫英文字母，則會以未變更的狀態傳遞。

範例：

值	`to_lower(value)`
「ABC」	"abc"
"AbC"	"abc"
「A1C」	"a1c"
b"ABC"	b"abc"

Node.js

const result = await db.pipeline()
  .collection("authors")
  .select(
    field("genre").toLower().equal("fantasy")
      .as("isFantasy")
  )
  .execute();test.firestore.js

網頁

const result = await execute(db.pipeline()
  .collection("authors")
  .select(
    field("genre").toLower().equal("fantasy")
      .as("isFantasy")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("authors")
  .select([
    Field("genre").toLower().equal("fantasy")
      .as("isFantasy")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("authors")
    .select(
        field("genre").toLower().equal("fantasy")
            .alias("isFantasy")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("authors")
    .select(
        field("genre").toLower().equal("fantasy")
            .alias("isFantasy")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("authors")
    .select(Field.of("genre").to_lower().equal("fantasy").as_("isFantasy"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("authors")
        .select(equal(toLower(field("genre")), "fantasy").as("isFantasy"))
        .execute()
        .get();PipelineSnippets.java

SUBSTRING

語法：

substring[T <: STRING | BYTES](input: T, position: INT64) -> T
substring[T <: STRING | BYTES](input: T, position: INT64, length: INT64) -> T

說明：

傳回 input 的子字串，從 position (以零為基準的索引) 開始，最多包含 length 個項目。如果未提供 length，則會傳回從 position 到 input 結尾的子字串。

如果 input 是 STRING 值，則 position 和 length 會以 Unicode 碼點為單位。如果是 BYTES 值，則以位元組為單位。
如果 position 大於 input 的長度，系統會傳回空白子字串。如果 position 加上 length 大於 input 的長度，子字串會截斷至 input 的結尾。
如果 position 為負數，位置會從輸入內容的結尾開始計算。如果負數 position 大於輸入內容的大小，位置會設為零。length 不得為負數。

範例：

如果未提供 length：

輸入	position	`substring(input, position)`
"abc"	0	"abc"
"abc"	1	"bc"
"abc"	3	""
"abc"	-1	"c"
b"abc"	1	b"bc"

提供 length 時：

輸入	position	長度	`substring(input, position, length)`
"abc"	0	1	「a」
"abc"	1	2	"bc"
"abc"	-1	1	"c"
b"abc"	0	1	b"a"

Node.js

const result = await db.pipeline()
  .collection("books")
  .where(field("title").startsWith("The "))
  .select(
    field("title").substring(4)
      .as("titleWithoutLeadingThe")
  )
  .execute();test.firestore.js

網頁

const result = await execute(db.pipeline()
  .collection("books")
  .where(field("title").startsWith("The "))
  .select(
    field("title").substring(4)
      .as("titleWithoutLeadingThe")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .where(Field("title").startsWith("The "))
  .select([
    Field("title").substring(position: 4)
      .as("titleWithoutLeadingThe")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .where(field("title").startsWith("The "))
    .select(
        field("title")
          .substring(constant(4),
            field("title").charLength().subtract(4))
            .alias("titleWithoutLeadingThe")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .where(field("title").startsWith("The "))
    .select(
        field("title").substring(
          constant(4),
            field("title").charLength().subtract(4))
            .alias("titleWithoutLeadingThe")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .where(Field.of("title").starts_with("The "))
    .select(Field.of("title").substring(4).as_("titleWithoutLeadingThe"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .where(startsWith(field("title"), "The "))
        .select(
            substring(field("title"), constant(4), field("title").charLength())
                .as("titleWithoutLeadingThe"))
        .execute()
        .get();PipelineSnippets.java

STRING_REVERSE

語法：

string_reverse[T <: STRING | BYTES](input: T) -> T

說明：

以相反順序傳回提供的輸入內容。

如果輸入內容為 STRING，系統會以 Unicode 碼位劃分字元；如果輸入內容為 BYTES 值，系統則會以位元組劃分字元。

範例：

輸入	`string_reverse(input)`
"abc"	"cba"
"a🌹b"	"b🌹a"
「hello」	「olleh」
b"abc"	b"cba"

Node.js

const result = await db.pipeline()
  .collection("books")
  .select(
    field("name").reverse().as("reversedName")
  )
  .execute();test.firestore.js

網頁

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("name").reverse().as("reversedName")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("name").reverse().as("reversedName")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(
        field("name").reverse().alias("reversedName")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("name").reverse().alias("reversedName")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("name").string_reverse().as_("reversedName"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(reverse(field("name")).as("reversedName"))
        .execute()
        .get();PipelineSnippets.java

STRING_REPEAT

語法：

string_repeat[T <: STRING | BYTES](input: T, repetitions: INT64) -> T

說明：

傳回重複 repetitions 次的 input。

repetitions 必須為非負整數。
如果 repetitions 為 0，則傳回與 input 相同類型的空值。
如果結果超過允許的大小上限 (1 MB)，系統會傳回錯誤。

範例：

輸入	重複次數	`string_repeat(input, repetitions)`
"foo"	3	「foofoofoo」
"foo"	0	""
"a "	3	"a a a "
b"ab"	2	b"abab"
「é🦆」	2	「é🦆é🦆」

STRING_REPLACE_ALL

語法：

string_replace_all[T <: STRING | BYTES](input: T, find: T, replacement: T) -> T

說明：

用 replacement 替換 input 中所有不重疊的 find。

比對時會區分大小寫。
如果 find 為空值，就不會進行替換。

範例：

輸入	find	換貨	`string_replace_all(input, find, replacement)`
"foobarfoo"	"foo"	"baz"	"bazbarbaz"
"ababab"	"aba"	"c"	"cbab"
"foobar"	"o"	""	「fbar」
「é🦆🌎🦆」	「🦆」	「a」	"éa🌎a"
b"abc"	b"b"	b"d"	b"adc"

STRING_REPLACE_ONE

語法：

string_replace_one[T <: STRING | BYTES](input: T, find: T, replacement: T) -> T

說明：

用 replacement 替換 input 中第一次出現的 find。

比對時會區分大小寫。
如果 find 為空值，就不會進行替換。

範例：

輸入	find	換貨	`string_replace_one(input, find, replacement)`
"foobarfoo"	"foo"	"baz"	"bazbarfoo"
"é"	"é"	「a」	「a」
b"foobar"	b"o"	b"z"	b"fzoobar"

TRIM

語法：

trim[T <: STRING | BYTES](input: T, values_to_trim: T) -> T
trim[T <: STRING | BYTES](input: T) -> T

說明：

從提供的 input 開頭和結尾，修剪一組指定的 BYTES 或 CHARS。

如果未提供 values_to_trim，則會修剪空白字元。

範例：

如果未提供 values_to_trim：

輸入	`trim(input)`
" foo "	"foo"
b" foo "	b"foo"
"foo"	"foo"
""	""
" "	""
"\t foo \n"	"foo"
b"\t foo \n"	b"foo"
"\r\f\v foo \r\f\v"	"foo"
b"\r\f\v foo \r\f\v"	b"foo"

提供 values_to_trim 時：

輸入	values_to_trim	`trim(input, values_to_trim)`
"abcbfooaacb"	"abc"	"foo"
「abcdaabadbac」	"abc"	"daabad"
b"C1C2C3"	b"C1"	b"C2C3"
b"C1C2"	"foo"	錯誤
"foo"	b"C1"	錯誤

網頁

const result = await execute(db.pipeline()
  .collection("books")
  .select(
    field("name").trim().as("whitespaceTrimmedName")
  )
);test.firestore.js

Swift

let result = try await db.pipeline()
  .collection("books")
  .select([
    Field("name").trim(" \n\t").as("whitespaceTrimmedName")
  ])
  .execute()PipelineSnippets.swift

Kotlin
Android

val result = db.pipeline()
    .collection("books")
    .select(
        field("name").trim().alias("whitespaceTrimmedName")
    )
    .execute()DocSnippets.kt

Java
Android

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .select(
        field("name").trim().alias("whitespaceTrimmedName")
    )
    .execute();DocSnippets.java

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .select(Field.of("name").trim().as_("whitespaceTrimmedName"))
    .execute()
)firestore_pipelines.py

Java

Pipeline.Snapshot result =
    firestore
        .pipeline()
        .collection("books")
        .select(trim(field("name")).as("whitespaceTrimmedName"))
        .execute()
        .get();PipelineSnippets.java

LTRIM

語法：

ltrim[T <: STRING | BYTES](value: T, to_trim: T) -> T
ltrim[T <: STRING | BYTES](value: T) -> T

說明：

從提供的 value 開頭移除指定的一組 BYTES 或 CHARS。

如果未提供 to_trim，則會修剪開頭的空白字元。

範例：

如果未提供 to_trim：

值	`ltrim(value)`
" foo "	"foo "
"foo"	"foo"

提供 to_trim 時：

值	to_trim	`ltrim(value, to_trim)`
"aaabc"	「a」	"bc"
"abacaba"	"ba"	"caba"
"é"	"é"	""

RTRIM

語法：

rtrim[T <: STRING | BYTES](value: T, to_trim: T) -> T
rtrim[T <: STRING | BYTES](value: T) -> T

說明：

從提供的 value 結尾刪除指定的一組 BYTES 或 CHARS。

如果未提供 to_trim，則會修剪尾隨的空白字元。

範例：

如果未提供 to_trim：

值	`rtrim(value)`
" foo "	" foo"
"foo"	"foo"

提供 to_trim 時：

值	to_trim	`rtrim(value, to_trim)`
"abccc"	"c"	"ab"
"abacaba"	"ba"	"abac"
"é"	"é"	""

SPLIT

語法：

split(input: STRING) -> ARRAY<STRING>
split[T <: STRING | BYTES](input: T, delimiter: T) -> ARRAY<T>

說明：

使用分隔符號拆分 STRING 或 BYTES 值。

對於 STRING，預設分隔符號是逗號 ,。分隔符號會視為單一字串。
對於 BYTES，您必須指定分隔符號。
以空的分隔符號分割時，STRING 值會產生 Unicode 碼位陣列，BYTES 值則會產生 BYTES 陣列。
分割空白 STRING 會傳回帶有單一空白 STRING 的 ARRAY。

範例：

如果未提供 delimiter：

輸入	`split(input)`
「foo,bar,foo」	["foo", "bar", "foo"]
"foo"	["foo"]
",foo,"	["", "foo", ""]
""	[""]
b"C120C2C4"	錯誤

提供 delimiter 時：

輸入	delimiter	`split(input, delimiter)`
"foo bar foo"	" "	["foo", "bar", "foo"]
"foo bar foo"	"z"	["foo bar foo"]
"abc"	""	["a", "b", "c"]
b"C1,C2,C4"	b","	[b"C1", b"C2", b"C4"]
b"ABC"	b""	[b"A", b"B", b"C"]
"foo"	b"C1"	錯誤

後續步驟

請參閱管道查詢總覽

字串函式參考資料

字串函式

BYTE_LENGTH

Node.js

網頁

Swift

KotlinAndroid

JavaAndroid

Python

Java

CHAR_LENGTH

Node.js

網頁

Swift

KotlinAndroid

JavaAndroid

Python

Java

STARTS_WITH

Node.js

網頁

Swift

KotlinAndroid

JavaAndroid

Python

Java

ENDS_WITH

Node.js

Swift

KotlinAndroid

JavaAndroid

Python

Java

LIKE

Node.js

網頁

Swift

KotlinAndroid

JavaAndroid

Python

Java

REGEX_CONTAINS

Node.js

網頁

Swift

KotlinAndroid

JavaAndroid

Python

Java

REGEX_MATCH

Node.js

網頁

Swift

KotlinAndroid

JavaAndroid

Python

Java

STRING_CONCAT

Node.js

網頁

Swift

KotlinAndroid

JavaAndroid

Python

Java

STRING_CONTAINS

Node.js

網頁

Swift

KotlinAndroid

JavaAndroid

Python

Java

STRING_INDEX_OF

TO_UPPER

Node.js

網頁

Swift

KotlinAndroid

JavaAndroid

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android

Kotlin
Android

Java
Android