firestoreindexensurer

README

Firestore index ensurer developers guide

This package automatically creates the needed composite indexes for Google Firestore. It's based on well-defined JSON file named indexes.json, which is obtained by running the following, with the __name__ field removed:

gcloud firestore indexes composite list --format=json --sort-by=name

For details for this command: https://cloud.google.com/sdk/gcloud/reference/firestore/indexes/composite/list

Documentation

Overview

Package firestoreindexensurer automatically creates/deletes the needed composite indexes for Google Firestore, based on well-defined JSON format indexes list.

Index

• type IndexEnsurer
  • func NewIndexEnsurer(gcloudPath, projectID, serviceAcccountFile, colPrefix string, ...) IndexEnsurer

Types

type IndexEnsurer

type IndexEnsurer interface {
	CreateIndexes(ctx context.Context) error
}

func NewIndexEnsurer

func NewIndexEnsurer(gcloudPath, projectID, serviceAcccountFile, colPrefix string, logger *zap.Logger) IndexEnsurer