JarCastingGoogle Cloud Firestore Client for Java
Java idiomatic client for Cloud Firestore.
Quickstart
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>16.1.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 BOM, add this to your dependencies:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-firestore</artifactId>
<version>2.1.0</version>
</dependency>
If you are using Gradle, add this to your dependencies
compile 'com.google.cloud:google-cloud-firestore:2.1.0'
If you are using SBT, add this to your dependencies
libraryDependencies += "com.google.cloud" % "google-cloud-firestore" % "2.1.0"
Authentication
See the Authentication section in the base directory's README.
Getting Started
Prerequisites
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 SDK and running the following commands in command line: gcloud auth login and gcloud config set project [YOUR PROJECT ID].
Installation and setup
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.
About Cloud Firestore
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
Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.
| Sample | Source Code | Try it |
|---|---|---|
| Quickstart | 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 | |
Troubleshooting
To get help, follow the instructions in the shared Troubleshooting document.
Transport
Cloud Firestore uses gRPC for the transport layer.
Java Versions
Java 7 or above is required for using this client.
Versioning
This library follows Semantic Versioning.
Contributing
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.
License
Apache 2.0 - See LICENSE for more information.
CI Status
| Java Version | Status |
|---|---|
| Java 7 |  |
| Java 8 |  |
| Java 8 OSX |  |
| Java 8 Windows |  |
| Java 11 |  |
