Hàm tổng hợp

Tổng hợp

Bạn có thể dùng tất cả các hàm tổng hợp làm biểu thức cấp cao nhất trong giai đoạn aggregate(...).

Tên Mô tả
COUNT Trả về số lượng chứng từ.
COUNT_IF Trả về số lượng tài liệu mà một biểu thức cho kết quả là TRUE
COUNT_DISTINCT Trả về số lượng giá trị riêng biệt, không phải NULL
SUM Trả về tổng của tất cả các giá trị NUMERIC
AVERAGE Trả về giá trị trung bình của tất cả các giá trị NUMERIC
MINIMUM Trả về giá trị nhỏ nhất không phải là NULL
MAXIMUM Trả về giá trị không phải NULL lớn nhất
FIRST Trả về giá trị expression cho tài liệu đầu tiên.
LAST Trả về giá trị expression cho tài liệu cuối cùng.
ARRAY_AGG Trả về một mảng gồm tất cả các giá trị đầu vào.
ARRAY_AGG_DISTINCT Trả về một mảng gồm tất cả các giá trị đầu vào riêng biệt.

COUNT

Cú pháp:

count() -> INT64
count(expression: ANY) -> INT64

Nội dung mô tả:

Trả về số lượng tài liệu từ giai đoạn trước mà expression đánh giá thành bất kỳ giá trị nào không phải NULL. Nếu không có expression nào được cung cấp, hàm này sẽ trả về tổng số tài liệu từ giai đoạn trước.

Web

// Total number of books in the collection
const countOfAll = await execute(db.pipeline()
  .collection("books")
  .aggregate(countAll().as("count"))
);

// Number of books with nonnull `ratings` field
const countField = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("ratings").count().as("count"))
);
test.firestore.js
Swift
// Total number of books in the collection
let countAll = try await db.pipeline()
  .collection("books")
  .aggregate([CountAll().as("count")])
  .execute()

// Number of books with nonnull `ratings` field
let countField = try await db.pipeline()
  .collection("books")
  .aggregate([Field("ratings").count().as("count")])
  .execute()
PipelineSnippets.swift

Kotlin

// Total number of books in the collection
val countAll = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.countAll().alias("count"))
    .execute()

// Number of books with nonnull `ratings` field
val countField = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.count("ratings").alias("count"))
    .execute()
DocSnippets.kt

Java

// Total number of books in the collection
Task<Pipeline.Snapshot> countAll = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.countAll().alias("count"))
    .execute();

// Number of books with nonnull `ratings` field
Task<Pipeline.Snapshot> countField = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.count("ratings").alias("count"))
    .execute();
DocSnippets.java
Python
from google.cloud.firestore_v1.pipeline_expressions import Count

# Total number of books in the collection
count_all = (
    client.pipeline().collection("books").aggregate(Count().as_("count")).execute()
)

# Number of books with nonnull `ratings` field
count_field = (
    client.pipeline()
    .collection("books")
    .aggregate(Count("ratings").as_("count"))
    .execute()
)
firestore_pipelines.py

COUNT_IF

Cú pháp:

count_if(expression: BOOLEAN) -> INT64

Nội dung mô tả:

Trả về số lượng tài liệu từ giai đoạn trước mà expression đánh giá thành TRUE.

Web

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(
    field("rating").greaterThan(4).countIf().as("filteredCount")
  )
);
test.firestore.js
Swift
let result = try await db.pipeline()
  .collection("books")
  .aggregate([
    AggregateFunction("count_if", [Field("rating").greaterThan(4)]).as("filteredCount")
  ])
  .execute()
PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .aggregate(
        AggregateFunction.countIf(field("rating").greaterThan(4)).alias("filteredCount")
    )
    .execute()
DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .aggregate(
        AggregateFunction.countIf(field("rating").greaterThan(4)).alias("filteredCount")
    )
    .execute();
DocSnippets.java
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .aggregate(Field.of("rating").greater_than(4).count_if().as_("filteredCount"))
    .execute()
)
firestore_pipelines.py

COUNT_DISTINCT

Cú pháp:

count_distinct(expression: ANY) -> INT64

Nội dung mô tả:

Trả về số lượng giá trị riêng biệt không phải NULL, không phải ABSENT của expression.

Web

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("author").countDistinct().as("unique_authors"))
);
test.firestore.js
Swift
let result = try await db.pipeline()
  .collection("books")
  .aggregate([AggregateFunction("count_distinct", [Field("author")]).as("unique_authors")])
  .execute()
PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.countDistinct("author").alias("unique_authors"))
    .execute()
DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.countDistinct("author").alias("unique_authors"))
    .execute();
DocSnippets.java
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .aggregate(Field.of("author").count_distinct().as_("unique_authors"))
    .execute()
)
firestore_pipelines.py

SUM

Cú pháp:

sum(expression: ANY) -> NUMBER

Nội dung mô tả:

Trả về tổng của tất cả các giá trị bằng số, bỏ qua các giá trị không phải là số. Trả về NaN nếu có giá trị là NaN.

Kết quả sẽ có cùng loại với loại đầu vào rộng nhất, ngoại trừ những trường hợp sau:

  • INTEGER sẽ được chuyển đổi thành DOUBLE nếu không thể biểu thị dưới dạng INTEGER.

Web

const result = await execute(db.pipeline()
  .collection("cities")
  .aggregate(field("population").sum().as("totalPopulation"))
);
test.firestore.js
Swift
let result = try await db.pipeline()
  .collection("cities")
  .aggregate([Field("population").sum().as("totalPopulation")])
  .execute()
PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("cities")
    .aggregate(AggregateFunction.sum("population").alias("totalPopulation"))
    .execute()
DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("cities")
    .aggregate(AggregateFunction.sum("population").alias("totalPopulation"))
    .execute();
DocSnippets.java
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("cities")
    .aggregate(Field.of("population").sum().as_("totalPopulation"))
    .execute()
)
firestore_pipelines.py

AVERAGE

Cú pháp:

average(expression: ANY) -> FLOAT64

Nội dung mô tả:

Trả về giá trị trung bình của tất cả các giá trị số, bỏ qua các giá trị không phải là số. Đánh giá là NaN nếu có giá trị là NaN hoặc NULL nếu không có giá trị số nào được tổng hợp.

Kết quả sẽ có cùng loại với loại đầu vào, ngoại trừ những trường hợp sau:

  • INTEGER sẽ được chuyển đổi thành DOUBLE nếu không thể biểu thị dưới dạng INTEGER.

Web

const result = await execute(db.pipeline()
  .collection("cities")
  .aggregate(field("population").average().as("averagePopulation"))
);
test.firestore.js
Swift
let result = try await db.pipeline()
  .collection("cities")
  .aggregate([Field("population").average().as("averagePopulation")])
  .execute()
PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("cities")
    .aggregate(AggregateFunction.average("population").alias("averagePopulation"))
    .execute()
DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("cities")
    .aggregate(AggregateFunction.average("population").alias("averagePopulation"))
    .execute();
DocSnippets.java
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("cities")
    .aggregate(Field.of("population").average().as_("averagePopulation"))
    .execute()
)
firestore_pipelines.py

TỐI THIỂU

Cú pháp:

minimum(expression: ANY) -> ANY

Nội dung mô tả:

Trả về giá trị tối thiểu không phải NULL, không phải giá trị không có của expression khi được đánh giá trên mỗi tài liệu.

Nếu không có giá trị nào không phải là NULL và không bị thiếu, thì NULL sẽ được trả về. Điều này áp dụng cả khi không có tài liệu nào được xem xét.

Nếu có nhiều giá trị tương đương tối thiểu, bạn có thể trả về bất kỳ giá trị nào trong số đó. Thứ tự loại giá trị tuân theo thứ tự được ghi lại.

Web

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("price").minimum().as("minimumPrice"))
);
test.firestore.js
Swift
let result = try await db.pipeline()
  .collection("books")
  .aggregate([Field("price").minimum().as("minimumPrice")])
  .execute()
PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.minimum("price").alias("minimumPrice"))
    .execute()
DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.minimum("price").alias("minimumPrice"))
    .execute();
DocSnippets.java
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .aggregate(Field.of("price").minimum().as_("minimumPrice"))
    .execute()
)
firestore_pipelines.py

TỐI ĐA

Cú pháp:

maximum(expression: ANY) -> ANY

Nội dung mô tả:

Trả về giá trị lớn nhất không phải NULL, không phải giá trị trống của expression khi được đánh giá trên mỗi tài liệu.

Nếu không có giá trị nào không phải là NULL và không bị thiếu, thì NULL sẽ được trả về. Điều này áp dụng cả khi không có tài liệu nào được xem xét.

Nếu có nhiều giá trị tương đương tối đa, thì hàm có thể trả về bất kỳ giá trị nào trong số đó. Thứ tự loại giá trị tuân theo thứ tự được ghi lại.

Web

const result = await execute(db.pipeline()
  .collection("books")
  .aggregate(field("price").maximum().as("maximumPrice"))
);
test.firestore.js
Swift
let result = try await db.pipeline()
  .collection("books")
  .aggregate([Field("price").maximum().as("maximumPrice")])
  .execute()
PipelineSnippets.swift

Kotlin

val result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.maximum("price").alias("maximumPrice"))
    .execute()
DocSnippets.kt

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("books")
    .aggregate(AggregateFunction.maximum("price").alias("maximumPrice"))
    .execute();
DocSnippets.java
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("books")
    .aggregate(Field.of("price").maximum().as_("maximumPrice"))
    .execute()
)
firestore_pipelines.py

FIRST

Cú pháp:

first(expression: ANY) -> ANY

Nội dung mô tả:

Trả về giá trị của expression cho tài liệu được trả về đầu tiên.

LAST

Cú pháp:

last(expression: ANY) -> ANY

Nội dung mô tả:

Trả về giá trị của expression cho tài liệu được trả về gần đây nhất.

ARRAY_AGG

Cú pháp:

array_agg(expression: ANY) -> ARRAY<ANY>

Nội dung mô tả:

Trả về một mảng chứa tất cả các giá trị của expression khi được đánh giá trên mỗi tài liệu.

Nếu biểu thức phân giải thành một giá trị không có, thì giá trị đó sẽ được chuyển đổi thành NULL.

Thứ tự của các phần tử trong mảng đầu ra không ổn định và bạn không nên dựa vào đó.

Hàm ARRAY_AGG_DISTINCT

Cú pháp:

array_agg_distinct(expression: ANY) -> ARRAY<ANY>

Nội dung mô tả:

Trả về một mảng chứa tất cả các giá trị riêng biệt của expression khi được đánh giá trên từng tài liệu.

Nếu biểu thức phân giải thành một giá trị không có, thì giá trị đó sẽ được chuyển đổi thành NULL.

Thứ tự của các phần tử trong mảng đầu ra không ổn định và bạn không nên dựa vào đó.