Skip to content

Commit

Permalink
docs(firestore-v1): Minor documentation updates (#24451)
Browse files Browse the repository at this point in the history
  • Loading branch information
gcf-owl-bot[bot] authored Jan 20, 2024
1 parent d0ff4c4 commit 42e8df7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,23 +34,23 @@ module V1
#
# The map keys represent field names.
#
# A simple field name contains only characters `a` to `z`, `A` to `Z`,
# `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
# `foo_bar_17`.
#
# Field names matching the regular expression `__.*__` are reserved. Reserved
# field names are forbidden except in certain documented contexts. The map
# keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be
# field names are forbidden except in certain documented contexts. The field
# names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
# empty.
#
# Field paths may be used in other contexts to refer to structured fields
# defined here. For `map_value`, the field path is represented by the simple
# or quoted field names of the containing fields, delimited by `.`. For
# example, the structured field
# `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be
# represented by the field path `foo.x&y`.
# defined here. For `map_value`, the field path is represented by a
# dot-delimited (`.`) string of segments. Each segment is either a simple
# field name (defined below) or a quoted field name. For example, the
# structured field `"foo" : { map_value: { "x&y" : { string_value: "hello"
# }}}` would be represented by the field path `` foo.`x&y` ``.
#
# A simple field name contains only characters `a` to `z`, `A` to `Z`,
# `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
# `foo_bar_17`.
#
# Within a field path, a quoted field name starts and ends with `` ` `` and
# A quoted field name starts and ends with `` ` `` and
# may contain any character. Some characters, including `` ` ``, must be
# escaped using a `\`. For example, `` `x&y` `` represents `x&y` and
# `` `bak\`tik` `` represents `` bak`tik ``.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ module Cloud
module Firestore
module V1
# A Firestore query.
#
# The query stages are executed in the following order:
# 1. from
# 2. where
# 3. select
# 4. order_by + start_at + end_at
# 5. offset
# 6. limit
# @!attribute [rw] select
# @return [::Google::Cloud::Firestore::V1::StructuredQuery::Projection]
# Optional sub-set of the fields to return.
Expand Down

0 comments on commit 42e8df7

Please sign in to comment.