资源:字段
表示数据库中的单个字段。
字段按其“集合组”进行分组,集合组表示数据库中具有相同 ID 的所有集合。
JSON 表示法 |
---|
{ "name": string, "indexConfig": { object ( |
字段 | |
---|---|
name |
必需。格式为 字段路径可以是简单的字段名称(如 可以使用 示例:(注意:此处的注释采用 Markdown 语法编写,因此还有一层额外的反引号来表示代码块) 特殊的 |
indexConfig |
此字段的索引配置。如果未设置,字段索引编制将还原为 |
ttlConfig |
此 |
IndexConfig
此字段的索引配置。
JSON 表示法 |
---|
{
"indexes": [
{
object ( |
字段 | |
---|---|
indexes[] |
此字段支持的索引。 |
usesAncestorConfig |
仅供输出。如果为 true,则 |
ancestorField |
仅供输出。指定 |
reverting |
仅在输出结果为 true 时,正在还原 |
TtlConfig
设置了此 Field
的文档的 TTL(存留时间)配置。
将时间戳值存储到启用 TTL 的字段将被视为文档的绝对到期时间。过去的时间戳值表示文档符合立即到期的条件。使用任何其他数据类型或省略该字段将停用单个文档的到期时间。
JSON 表示法 |
---|
{
"state": enum ( |
字段 | |
---|---|
state |
仅供输出。TTL 配置的状态。 |
状态
将 TTL 配置应用于所有文档的状态。
枚举 | |
---|---|
STATE_UNSPECIFIED |
状态未指定或未知。 |
CREATING |
正在应用 TTL。有一项正在进行的长时间运行的操作来跟踪更改。新写入的文档将根据需要应用 TTL。仍在处理现有文档请求的 TTL。当所有现有文档的 TTL 均已处理完毕后,状态将变为“ACTIVE”。 |
ACTIVE |
TTL 对所有文档都有效。 |
NEEDS_REPAIR |
无法为所有现有文档启用 TTL 配置。新写入的文档将继续应用其 TTL。上次尝试为此 Field 启用 TTL 失败时返回的 LRO,可能有更多详细信息。 |
方法 |
|
---|---|
|
获取字段的元数据和配置。 |
|
列出此数据库的字段配置和元数据。 |
|
更新字段配置。 |