Skip to main content
Technology areas
AI and ML
Application development
Application hosting
Compute
Data analytics and pipelines
Databases
Distributed, hybrid, and multicloud
Generative AI
Industry solutions
Networking
Observability and monitoring
Security
Storage
Cross-product tools
Access and resources management
Costs and usage management
Infrastructure as code
Migration
SDK, languages, frameworks, and tools
/
Console
English
Deutsch
Español – América Latina
Français
Português – Brasil
中文 – 简体
日本語
한국어
Sign in
PHP
Client libraries
Start free
Overview
Guides
Reference
Samples
Technology areas
More
Overview
Guides
Reference
Samples
Cross-product tools
More
Console
Overview
Library reference docs
Client library help
google/auth
google/cloud-firestore
Overview
Services
Admin
FirestoreAdminClient
FirestoreAdminClient (beta)
FirestoreClient
FirestoreClient
FirestoreClient (beta)
FirestoreClient (beta)
Messages
Admin
Backup
Stats
Backup
BackupSchedule
CreateBackupScheduleRequest
CreateDatabaseMetadata
CreateDatabaseRequest
CreateIndexRequest
DailyRecurrence
Database
DeleteBackupRequest
DeleteBackupScheduleRequest
DeleteDatabaseMetadata
DeleteDatabaseRequest
DeleteIndexRequest
ExportDocumentsMetadata
ExportDocumentsRequest
ExportDocumentsResponse
Field
IndexConfig
TtlConfig
Field
FieldOperationMetadata
IndexConfigDelta
TtlConfigDelta
FieldOperationMetadata
GetBackupRequest
GetBackupScheduleRequest
GetDatabaseRequest
GetFieldRequest
GetIndexRequest
ImportDocumentsMetadata
ImportDocumentsRequest
Index
IndexField
VectorConfig
FlatIndex
VectorConfig
IndexField
Index
IndexOperationMetadata
ListBackupSchedulesRequest
ListBackupSchedulesResponse
ListBackupsRequest
ListBackupsResponse
ListDatabasesRequest
ListDatabasesResponse
ListFieldsRequest
ListFieldsResponse
ListIndexesRequest
ListIndexesResponse
LocationMetadata
Progress
RestoreDatabaseMetadata
RestoreDatabaseRequest
UpdateBackupScheduleRequest
UpdateDatabaseMetadata
UpdateDatabaseRequest
UpdateFieldRequest
WeeklyRecurrence
AggregationResult
ArrayValue
BatchGetDocumentsRequest
BatchGetDocumentsResponse
BatchWriteRequest
BatchWriteResponse
BeginTransactionRequest
BeginTransactionResponse
BitSequence
BloomFilter
CommitRequest
CommitResponse
CreateDocumentRequest
Cursor
DeleteDocumentRequest
Document
DocumentChange
DocumentDelete
DocumentMask
DocumentRemove
DocumentTransform
FieldTransform
DocumentTransform
ExecutionStats
ExistenceFilter
ExplainMetrics
ExplainOptions
GetDocumentRequest
ListCollectionIdsRequest
ListCollectionIdsResponse
ListDocumentsRequest
ListDocumentsResponse
ListenRequest
ListenResponse
MapValue
PartitionQueryRequest
PartitionQueryResponse
PlanSummary
Precondition
QueryPlan
ResultSetStats
RollbackRequest
RunAggregationQueryRequest
RunAggregationQueryResponse
RunQueryRequest
RunQueryResponse
StructuredAggregationQuery
Aggregation
Avg
Count
Sum
Aggregation
StructuredAggregationQuery
StructuredQuery
CollectionSelector
CompositeFilter
FieldFilter
FieldReference
Filter
FindNearest
Order
Projection
UnaryFilter
StructuredQuery
Target
DocumentsTarget
QueryTarget
Target
TargetChange
TransactionOptions
PBReadOnly
ReadWrite
TransactionOptions
UpdateDocumentRequest
Value
Write
WriteRequest
WriteResponse
WriteResult
ArrayValue
BatchGetDocumentsRequest
BatchGetDocumentsResponse
BeginTransactionRequest
BeginTransactionResponse
CommitRequest
CommitResponse
CreateDocumentRequest
Cursor
DeleteDocumentRequest
Document
DocumentChange
DocumentDelete
DocumentMask
DocumentRemove
DocumentTransform
FieldTransform
DocumentTransform
ExistenceFilter
GetDocumentRequest
ListCollectionIdsRequest
ListCollectionIdsResponse
ListDocumentsRequest
ListDocumentsResponse
ListenRequest
ListenResponse
MapValue
Precondition
RollbackRequest
RunQueryRequest
RunQueryResponse
StructuredQuery
CollectionSelector
CompositeFilter
FieldFilter
FieldReference
Filter
Order
Projection
UnaryFilter
StructuredQuery
Target
DocumentsTarget
QueryTarget
Target
TargetChange
TransactionOptions
PBReadOnly
ReadWrite
TransactionOptions
UpdateDocumentRequest
Value
Write
WriteRequest
WriteResponse
WriteResult
Enums
Admin
Backup
State
Database
AppEngineIntegrationMode
ConcurrencyMode
DatabaseType
DeleteProtectionState
PointInTimeRecoveryEnablement
Field
TtlConfig
State
FieldOperationMetadata
IndexConfigDelta
ChangeType
TtlConfigDelta
ChangeType
Index
ApiScope
IndexField
ArrayConfig
Order
QueryScope
State
OperationState
DocumentTransform
FieldTransform
ServerValue
QueryMode
StructuredQuery
CompositeFilter
Operator
Direction
FieldFilter
Operator
FindNearest
DistanceMeasure
UnaryFilter
Operator
TargetChange
TargetChangeType
DocumentTransform
FieldTransform
ServerValue
StructuredQuery
CompositeFilter
Operator
Direction
FieldFilter
Operator
UnaryFilter
Operator
TargetChange
TargetChangeType
Aggregate
AggregateQuery
AggregateQuerySnapshot
BulkWriter
CollectionReference