geofirestore

Full documentation is available at https://geofirestore.com.

GeoFirestore is an open-source library that extends the Firestore library in order to store and query documents based on their geographic location. At its heart, GeoFirestore is just a wrapper for the Firestore library, exposing many of the same functions and features of Firestore. Its main benefit, however, is the possibility of retrieving only those documents within a given geographic area - all in realtime.

GeoFirestore uses the Firebase Cloud Firestore for data storage, allowing query results to be updated in realtime as they change. GeoFirestore selectively loads only the data near certain locations, keeping your applications light and responsive, even with extremely large datasets.

GeoFirestore is designed as a lightweight add-on to Firebase. To keep things simple, GeoFirestore stores data in its own format and its own location within your Firestore database.

Table of Contents

• Downloading GeoFirestore
  • Firebase Dependencies
• Example Usage
• Documentation
• Limitations & Considerations
  • Compound Queries
  • Data Structure
    • Security Rules
  • limit()
• Upgrading
• Contributing

Downloading GeoFirestore

You can install GeoFirestore via npm:

npm install geofirestore

Or you can use GeoFirestore via CDN:

<script src="https://unpkg.com/geofirestore/dist/geofirestore.js"></script>

Firebase Dependencies

If using this library in a Node.js environment, please install @google-cloud/firestore with a version >= 5.0.0 and a version < 6.0.0.

If using this library in a browser environment, please install firebase with a version >= 9.0.0 and a version < 10.0.0. Currently this library only works with the Firebase Compat library. Support for the Firebase Modular library is coming down the road.

Example Usage

Assume you are building an app to rate bars and you store all information for a bar, e.g. name, business hours and price range, and you want to add the possibility for users to search for bars in their vicinity. This is where GeoFirestore comes in. You can store each bar using GeoFirestore, using the location to build an easily queryable document. GeoFirestore then allows you to easily query which bars are nearby in a simalar fashion as geofire but will also return the bar information (not just the key or location).

Examples

You can find a full list of our demos and view the code for each of them in the examples directory of this repository. The examples cover some of the common use cases for GeoFirestore.

Documentation

Full documentation is available at https://geofirestore.com. It mostly provides the same functionality as the Firestore library, in almost the same way as the Firestore library. Many questions can be addressed by looking at the Firestore docs. However there are a few differences, and below is a little example of how to make a location based query.

import firebase from 'firebase/compat/app';
import 'firebase/compat/firestore';
import * as geofirestore from 'geofirestore';


// Initialize the Firebase SDK
firebase.initializeApp({
  // ...
});

// Create a Firestore reference
const firestore = firebase.firestore();

// Create a GeoFirestore reference
const GeoFirestore = geofirestore.initializeApp(firestore);

// Create a GeoCollection reference
const geocollection = GeoFirestore.collection('restaurants');

// Add a GeoDocument to a GeoCollection
geocollection.add({
  name: 'Geofirestore',
  score: 100,
  // The coordinates field must be a GeoPoint!
  coordinates: new firebase.firestore.GeoPoint(40.7589, -73.9851)
})

// Create a GeoQuery based on a location
const query = geocollection.near({ center: new firebase.firestore.GeoPoint(40.7589, -73.9851), radius: 1000 });

// Get query (as Promise)
query.get().then((value) => {
  // All GeoDocument returned by GeoQuery, like the GeoDocument added above
  console.log(value.docs);
});

Simple. Easy. And very similar with how Firestore handles a get from a Firestore Query. The difference being the added ability to say query near a center point, with a set radius in kilometers.

Limitations & Considerations

Compound Queries

Internally GeoFirestore creates multiple geohashes around a requested area. It then makes multiple inequality (<, <=, >, >=) queries and joins them together into one response. Unfortunately compound queries with inequalities or additional filtering methods such as orderBy, startAt and endAt are impossible with Firestore. To better understand this limitation, see the Firestore docs here.

Data Structure

Documents generated and stored in your Firestore collection by GeoFirestore are typed/structured as:

interface GeoDocumentData {
  g: {
    geohash: string;
    geopoint: GeoPoint;
  };
  [field: string]: any;
  }

• g.geohash is the geohash generated by the library, and is required in order to make the geoqery.
• g.geopoint is the GeoPoint used to generate the g.geohash field.

Data must be structured this way in order to work, and is why you should use the GeoFirestore library to insert data in order to be able to query it.

Security Rules

Because GeoFirestore adds the g field and expects a coordinates field, be sure to update your Firebase Security Rules to reflect the new fields. While not necessary for all applications, the rules below are an example of how you'd check for GeoFirestore specific fields.

match /collection/{key} {
  allow write: // Your previous rules here...
               && request.resource.data.g.size() == 2
               && request.resource.data.g.geohash is string
               && request.resource.data.g.geopoint is latlng
               && request.resource.data.coordinates is latlng
}

limit()

The limit filtering method is exposed through GeoFirestore, however there are some unique considerations when using it. Limits on geoqueries are applied based on the distance from the center. Geoqueries require an aggregation of queries. When performing a geoquery the library applies the limit on the client. This may mean you are loading to the client more documents then you intended. Use with this performance limitation in mind.

Contributing

All code should pass tests, as well as be well documented. Please open PRs into the dev branch. Please also see the Commit Message Guidelines for how commit messages should be structured.