Firestore 查询。
JSON 表示 |
---|
{ "select": { object ( |
领域 | |
---|---|
select | 要返回的字段的可选子集。 这充当查询返回的文档的 |
from[] | 要查询的集合。 |
where | 要应用的过滤器。 |
orderBy[] | 应用于查询结果的顺序。 Firestore 允许调用者提供完整排序、部分排序或根本不排序。在所有情况下,Firestore 通过以下规则保证稳定的排序:
字段附加的排序方向与最后指定的顺序相同,如果未指定顺序,则附加“升序”。例如:
|
startAt | 结果集中开始查询的位置的潜在前缀。 结果集的排序基于原始查询的
此查询的结果按 游标可以引用完整的排序或位置的前缀,但它不能引用比提供的 继续上面的示例,附加以下启动光标将产生不同的影响:
与需要扫描前 N 个结果以跳过的 要求:
|
endAt | 结果集中结束查询的位置的潜在前缀。 这与 要求:
|
offset | 返回第一个结果之前要跳过的文档数。 这适用于 要求:
|
limit | 要返回的最大结果数。 在所有其他约束之后适用。 要求:
|
投影
要返回的文档字段的投影。
JSON 表示 |
---|
{
"fields": [
{
object ( |
领域 | |
---|---|
fields[] | 要返回的字段。 如果为空,则返回所有字段。要仅返回文档的名称,请使用 |
集合选择器
集合的选择,例如messages as m1
。
JSON 表示 |
---|
{ "collectionId": string, "allDescendants": boolean } |
领域 | |
---|---|
collectionId | 集合 ID。设置后,仅选择具有此 ID 的集合。 |
allDescendants | 如果为 false,则仅选择作为包含的 |
筛选
一个过滤器。
JSON 表示 |
---|
{ // Union field |
领域 | |
---|---|
联合字段filter_type 。过滤器的类型。 filter_type 只能是以下之一: | |
compositeFilter | 复合过滤器。 |
fieldFilter | 文档字段上的过滤器。 |
unaryFilter | 一种只接受一个参数的过滤器。 |
复合过滤器
使用给定运算符合并多个其他过滤器的过滤器。
JSON 表示 |
---|
{ "op": enum ( |
领域 | |
---|---|
op | 用于组合多个过滤器的运算符。 |
filters[] | 要组合的过滤器列表。 要求:
|
操作员
复合过滤器运算符。
枚举 | |
---|---|
OPERATOR_UNSPECIFIED | 未指定。不得使用该值。 |
AND | 需要文档来满足所有组合过滤器。 |
OR | 文档需要满足至少一个组合过滤器。 |
字段过滤器
针对特定字段的过滤器。
JSON 表示 |
---|
{ "field": { object ( |
领域 | |
---|---|
field | 要过滤的字段。 |
op | 要过滤的运算符。 |
value | 要比较的值。 |
操作员
字段过滤器运算符。
枚举 | |
---|---|
OPERATOR_UNSPECIFIED | 未指定。不得使用该值。 |
LESS_THAN | 给定 要求:
|
LESS_THAN_OR_EQUAL | 给定 要求:
|
GREATER_THAN | 给定 要求:
|
GREATER_THAN_OR_EQUAL | 给定 要求:
|
EQUAL | 给定field 等于给定value 。 |
NOT_EQUAL | 给定 要求:
|
ARRAY_CONTAINS | 给定field 是包含给定value 的数组。 |
IN | 给定 要求:
|
ARRAY_CONTAINS_ANY | 给定 要求:
|
NOT_IN | 该 要求:
|
一元过滤器
具有单个操作数的过滤器。
JSON 表示 |
---|
{ "op": enum ( |
领域 | |
---|---|
op | 要应用的一元运算符。 |
联合字段operand_type 。过滤器的参数。 operand_type 只能是以下之一: | |
field | 要应用运算符的字段。 |
操作员
一元运算符。
枚举 | |
---|---|
OPERATOR_UNSPECIFIED | 未指定。不得使用该值。 |
IS_NAN | 给定field 等于NaN 。 |
IS_NULL | 给定field 等于NULL 。 |
IS_NOT_NAN | 给定 要求:
|
IS_NOT_NULL | 给定 要求:
|
命令
田野上的命令。
JSON 表示 |
---|
{ "field": { object ( |
领域 | |
---|---|
field | 排序依据的字段。 |
direction | 排序的方向。默认为 |
方向
一个排序方向。
枚举 | |
---|---|
DIRECTION_UNSPECIFIED | 未指定。 |
ASCENDING | 上升。 |
DESCENDING | 下降。 |