Sha256: 82dbecb021d433151c51dc4a1bbdb85c2a7005e9ac990bae2ac8783c44395adb

Contents?: true

Size: 1.44 KB

Versions: 35

Compression:

Stored size: 1.44 KB

Contents

# Google Cloud Firestore Emulator

To develop and test your application locally, you can use the [Google Cloud
Firestore
Emulator](https://cloud.google.com/firestore/docs/security/test-rules-emulator#install_the_emulator),
which provides local emulation of the production Google Cloud Firestore
environment. You can start the Google Cloud Firestore emulator using the
[`firebase` command-line tool](https://firebase.google.com/docs/cli/).

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

```
$ firebase serve --only firestore
API endpoint: http://[::1]:8080
API endpoint: http://127.0.0.1:8080
Dev App Server is now running.
```

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

```ruby
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:

```ruby
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
```

Version data entries

35 entries across 35 versions & 1 rubygems

Version Path
google-cloud-firestore-2.7.1 EMULATOR.md
google-cloud-firestore-2.7.0 EMULATOR.md
google-cloud-firestore-2.6.6 EMULATOR.md
google-cloud-firestore-2.6.5 EMULATOR.md
google-cloud-firestore-2.6.4 EMULATOR.md
google-cloud-firestore-2.6.3 EMULATOR.md
google-cloud-firestore-2.6.2 EMULATOR.md
google-cloud-firestore-2.6.1 EMULATOR.md
google-cloud-firestore-2.6.0 EMULATOR.md
google-cloud-firestore-2.5.1 EMULATOR.md
google-cloud-firestore-2.5.0 EMULATOR.md
google-cloud-firestore-2.4.1 EMULATOR.md
google-cloud-firestore-2.4.0 EMULATOR.md
google-cloud-firestore-2.3.0 EMULATOR.md
google-cloud-firestore-2.2.0 EMULATOR.md
google-cloud-firestore-2.1.0 EMULATOR.md
google-cloud-firestore-2.0.0 EMULATOR.md
google-cloud-firestore-1.4.4 EMULATOR.md
google-cloud-firestore-1.4.3 EMULATOR.md
google-cloud-firestore-1.4.2 EMULATOR.md