Weave Code
Cloud Firestore Laravel Package
google/cloud-firestore
Idiomatic PHP client for Google Cloud Firestore. Install via Composer and use the generated gRPC-based API to read/write documents, run queries, and manage data at scale. Part of the googleapis/google-cloud-php project.
At a glance
Frequently asked questions about Cloud Firestore
- Can I use Google Cloud Firestore as a direct replacement for Laravel Eloquent in my project?
- Yes, but strategically. Firestore excels for dynamic or schema-less data (e.g., user-generated content, CMS backends) while keeping Eloquent for relational data (e.g., users, roles). Use Laravel Scout for search indexing alongside Firestore. Abstract operations into repositories to maintain consistency with Laravel’s patterns.
- What Laravel versions and PHP requirements does google/cloud-firestore support?
- The package supports PHP 8.1–8.4, aligning with Laravel 9.x–11.x (LTS versions). Ensure your server has the gRPC PHP extension installed (via PECL or Docker). Test thoroughly with Laravel’s latest stable branch, as NoSQL interactions differ from Eloquent’s query builder.
- How do I authenticate Firestore in Laravel without hardcoding credentials?
- Use Google’s Application Default Credentials or store service account keys in Laravel’s `config/services.php` under a `firestore` key. Bind the Firestore client to Laravel’s container in a service provider (e.g., `app()->bind(FirestoreClient::class, fn() => new FirestoreClient([...]))`). Avoid committing keys to version control.
- What are the performance implications of Firestore for high-frequency CRUD apps in Laravel?
- Firestore auto-scales but costs can rise with high read/write volumes. Optimize by denormalizing data (e.g., embedding related fields) and using composite indexes. For analytics-heavy apps, pre-aggregate data in Firestore or use BigQuery. Monitor usage via Google Cloud Console to avoid surprises.
- Can I use Firestore’s real-time updates with Laravel Livewire or Inertia.js for live dashboards?
- Absolutely. Firestore’s `onSnapshot` listeners trigger instantly when data changes, making it ideal for Livewire/Inertia apps. Subscribe to collections in your frontend (e.g., via Firebase SDK) or use Laravel queues to process updates server-side (e.g., `firestore-document-updated` events). Pair with Laravel Echo for WebSocket-like behavior.
- How do I handle data migrations from MySQL to Firestore in a Laravel app?
- Use Laravel’s Artisan commands to export data (e.g., `php artisan db:export --format=json`) and transform it into Firestore’s document structure. Write a custom script to batch-import documents using Firestore’s `set()` or `create()` methods. Test with the Firestore Emulator locally before deploying to production.
- Are there alternatives to google/cloud-firestore for Laravel that offer similar NoSQL flexibility?
- For Laravel, consider `spatie/laravel-firestore` (a wrapper for this package), `mongodb/laravel-mongodb` (MongoDB), or `couchbase/laravel-couchbase` (Couchbase). Firestore stands out for real-time sync and serverless integration, but MongoDB offers richer query capabilities. Evaluate based on your need for scalability vs. complex aggregations.
- How do I secure Firestore in Laravel to comply with GDPR or CCPA data deletion requests?
- Use Firestore’s security rules to enforce field-level permissions (e.g., `allow delete: if request.auth != null && request.auth.uid == resource.data.author`). Implement Laravel’s `SoftDeletes` trait for Eloquent models and write a script to archive/delete Firestore documents via bulk operations. Monitor data retention policies in Google Cloud Console.
- What’s the best way to structure Firestore documents for a Laravel e-commerce app (e.g., products, orders, inventory)?
- Denormalize frequently accessed data (e.g., embed product variants in the product document) but reference related collections (e.g., orders → line_items) to avoid over-nesting. Use subcollections for hierarchical data (e.g., `products/{id}/reviews`). For inventory, use Firestore transactions to prevent overselling during high-traffic events.
- How do I test Firestore interactions in Laravel’s PHPUnit tests without hitting production costs?
- Use Google Cloud’s Firestore Emulator Suite, which runs locally and mimics production behavior. Configure it in your `phpunit.xml` with the emulator’s endpoint. Reset the emulator’s state between tests using `FirestoreClient::createRestStub()` with emulator credentials. Mock the client in unit tests for faster execution.
Weaver
How can I help you explore Laravel packages today?