Reference documentation and code samples for the Cloud Firestore V1 Client class Field.
Represents a single field in the database.
Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.
Generated from protobuf message google.firestore.admin.v1.Field
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. A field name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
A field path may be a simple field name, e.g. address
or a path to fields within map_value , e.g. address.city
, or a special field path. The only valid special field is *
, which represents any field. Field paths may be quoted using (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:
,
. , ``` (backtick),
[ ,
] , as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block)
`address.city` represents a field named
address.city , not the map key
city in the field
address .
`
` represents a field named
, not any field. A special
Field contains the default indexing settings for all fields. This field's resource name is:
projects/{project_id}/databases/{database_id}/collectionGroups/ default/fields/
Indexes defined on this
Field will be applied to all fields which do not have their own
Field` index configuration.
↳ index_config
Google\Cloud\Firestore\Admin\V1\Field\IndexConfig
The index configuration for this field. If unset, field indexing will revert to the configuration defined by the ancestor_field
. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.
↳ ttl_config
Google\Cloud\Firestore\Admin\V1\Field\TtlConfig
The TTL configuration for this Field
. Setting or unsetting this will enable or disable the TTL for documents that have this Field
.
getName
Required. A field name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
A field path may be a simple field name, e.g. address
or a path to fields
within map_value , e.g. address.city
,
or a special field path. The only valid special field is *
, which
represents any field.
Field paths may be quoted using (backtick). The only character that needs
to be escaped within a quoted field path is the backtick character itself,
escaped using a backslash. Special characters in field paths that
must be quoted include:
,
. ,
``` (backtick),
[ ,
] , as well as any ascii symbolic characters.
Examples:
(Note: Comments here are written in markdown syntax, so there is an
additional layer of backticks to represent a code block)
`address.city` represents a field named
address.city , not the map key
city in the field
address .
`
` represents a field named
, not any field.
A special
Field contains the default indexing settings for all fields.
This field's resource name is:
projects/{project_id}/databases/{database_id}/collectionGroups/ default/fields/
Indexes defined on this
Field will be applied to all fields which do not
have their own
Field` index configuration.
string
setName
Required. A field name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
A field path may be a simple field name, e.g. address
or a path to fields
within map_value , e.g. address.city
,
or a special field path. The only valid special field is *
, which
represents any field.
Field paths may be quoted using (backtick). The only character that needs
to be escaped within a quoted field path is the backtick character itself,
escaped using a backslash. Special characters in field paths that
must be quoted include:
,
. ,
``` (backtick),
[ ,
] , as well as any ascii symbolic characters.
Examples:
(Note: Comments here are written in markdown syntax, so there is an
additional layer of backticks to represent a code block)
`address.city` represents a field named
address.city , not the map key
city in the field
address .
`
` represents a field named
, not any field.
A special
Field contains the default indexing settings for all fields.
This field's resource name is:
projects/{project_id}/databases/{database_id}/collectionGroups/ default/fields/
Indexes defined on this
Field will be applied to all fields which do not
have their own
Field` index configuration.
var
string
$this
getIndexConfig
The index configuration for this field. If unset, field indexing will
revert to the configuration defined by the ancestor_field
. To
explicitly remove all indexes for this field, specify an index config
with an empty list of indexes.
hasIndexConfig
clearIndexConfig
setIndexConfig
The index configuration for this field. If unset, field indexing will
revert to the configuration defined by the ancestor_field
. To
explicitly remove all indexes for this field, specify an index config
with an empty list of indexes.
$this
getTtlConfig
The TTL configuration for this Field
.
Setting or unsetting this will enable or disable the TTL for
documents that have this Field
.
hasTtlConfig
clearTtlConfig
setTtlConfig
The TTL configuration for this Field
.
Setting or unsetting this will enable or disable the TTL for
documents that have this Field
.
$this
