Version 2.10.0

• 2.16.0 (latest)
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.2
• 2.6.6

Google Cloud Firestore Emulator

To develop and test your application locally, you can use the Google Cloud Firestore Emulator, which provides local emulation of the production Google Cloud Firestore environment. You can start the Google Cloud Firestore emulator using the gcloud command-line tool.

gcloud beta emulators firestore start --host-port=0.0.0.0:8080

When you run the Cloud Firestore emulator you will see a message similar to the following printed:

If you are using a library that supports the FIRESTORE_EMULATOR_HOST
environment variable, run:

  export FIRESTORE_EMULATOR_HOST=localhost:8080

Now you can connect to the emulator using the FIRESTORE_EMULATOR_HOST environment variable:

require "google/cloud/firestore"

# Make Firestore use the emulator
ENV["FIRESTORE_EMULATOR_HOST"] = "127.0.0.1:8080"

firestore = Google::Cloud::Firestore.new project_id: "emulator-project-id"

# Get a document reference
nyc_ref = firestore.doc "cities/NYC"

nyc_ref.set({ name: "New York City" }) # Document created

Or by providing the emulator_host argument:

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new project_id: "emulator-project-id",
                                         emulator_host: "127.0.0.1:8080"

# Get a document reference
nyc_ref = firestore.doc "cities/NYC"

nyc_ref.set({ name: "New York City" }) # Document created