Java idiomatic client for Cloud Firestore.
If you are using Maven with BOM, add this to your pom.xml file:
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>26.24.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-firestore</artifactId>
</dependency>
If you are using Maven without the BOM, add this to your dependencies:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-firestore</artifactId>
<version>3.15.0</version>
</dependency>
If you are using Gradle 5.x or later, add this to your dependencies:
implementation platform('com.google.cloud:libraries-bom:26.24.0')
implementation 'com.google.cloud:google-cloud-firestore'If you are using Gradle without BOM, add this to your dependencies:
implementation 'com.google.cloud:google-cloud-firestore:3.15.0'If you are using SBT, add this to your dependencies:
libraryDependencies += "com.google.cloud" % "google-cloud-firestore" % "3.15.0"See the Authentication section in the base directory's README.
The client application making API calls must be granted authorization scopes required for the desired Cloud Firestore APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Cloud Firestore API calls.
You will need a Google Cloud Platform Console project with the Cloud Firestore API enabled.
Follow these instructions to get your project set up. You will also need to set up the local development environment by
installing the Google Cloud Command Line Interface and running the following commands in command line:
gcloud auth login and gcloud config set project [YOUR PROJECT ID].
You'll need to obtain the google-cloud-firestore library. See the Quickstart section
to add google-cloud-firestore as a dependency in your code.
Cloud Firestore is a fully-managed NoSQL document database for mobile, web, and server development from Firebase and Google Cloud Platform. It's backed by a multi-region replicated database that ensures once data is committed, it's durable even in the face of unexpected disasters. Not only that, but despite being a distributed database, it's also strongly consistent and offers seamless integration with other Firebase and Google Cloud Platform products, including Google Cloud Functions.
See the Cloud Firestore client library docs to learn how to use this Cloud Firestore Client Library.
Samples are in the samples/ directory.
| Sample | Source Code | Try it |
|---|---|---|
| Native Image Firestore Sample | source code |  |
| Person | source code | |
| Quickstart | source code | |
| Example Firestore Beam Read | source code | |
| Example Firestore Beam Write | source code | |
| Listen Data Snippets | source code | |
| Manage Data Snippets | source code | |
| Query Data Snippets | source code | |
| References | source code | |
| Retrieve Data Snippets | source code | |
| City | source code | |
To get help, follow the instructions in the shared Troubleshooting document.
Cloud Firestore uses gRPC for the transport layer.
Java 8 or above is required for using this client.
Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).
In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.
Java 11 and (in September 2021) Java 17 are the best choices for new development.
Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).
Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.
Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.
The latest versions and the supported Java versions are identified on
the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME
and on google-cloud-java.
This library follows Semantic Versioning.
Contributions to this library are always welcome and highly encouraged.
See CONTRIBUTING for more information how to get started.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.
Apache 2.0 - See LICENSE for more information.
| Java Version | Status |
|---|---|
| Java 8 |  |
| Java 8 OSX |  |
| Java 8 Windows |  |
| Java 11 |  |
Java is a registered trademark of Oracle and/or its affiliates.