Cloud Firestore for PHP
Idiomatic PHP client forCloud Firestore.
NOTE: This repository is part ofGoogle Cloud PHP. Anysupport requests, bug reports, or development contributions should be directed tothat project.
A NoSQL document database built for automatic scaling, high performance, andease of application development. While the Cloud Firestore interface has many ofthe same features as traditional databases, as a NoSQL database it differs fromthem in the way it describes relationships between data objects.
Installation
To begin, install the preferred dependency manager for PHP,Composer.
Now install this component:
$ composer require google/cloud-firestoreThis component requires the gRPC extension. Please see ourgRPC installation guidefor more information on how to configure the extension.
Authentication
Please see ourAuthentication guide for more informationon authenticating your client. Once authenticated, you'll be ready to start making requests.
Sample
use Google\ApiCore\ApiException;use Google\Cloud\Firestore\V1\Client\FirestoreClient;use Google\Cloud\Firestore\V1\Document;use Google\Cloud\Firestore\V1\GetDocumentRequest;// Create a client.$firestoreClient = new FirestoreClient();// Prepare the request message.$request = (new GetDocumentRequest()) ->setName($name);// Call the API and handle any network failures.try { /** @var Document $response */ $response = $firestoreClient->getDocument($request); printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());} catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());}Debugging
Please see ourDebugging guidefor more information about the debugging tools.
Version
This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes inany minor or patch releases. We will address issues and requests with the highest priority.
Next Steps
- Understand theofficial documentation.
- Take a look atin-depth usage samples.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-24 UTC.