firestoreのindexを取得してfirestore.index.jsonに書き出したい


firestoreのindexをコードに書き出したい

  • 環境が複数個有ったりして、それぞれidenxを書いていくのは面倒。
  • json形式で自分で書くのは大変

そんな時に下記の記事を読ませていただきました。
Firebaseのfirestore.indexes.jsonの書式とかインデックスの作り方とかで戸惑った。

正直上記の記事さえあればいいのですが、自分のメモとして書かせていただきます。

firestore.index.jsonの書き出し

デプロイしたいソースコードのディレクトリへ移動して下記をターミナルで入力します。
※Firebase Client SDKが入っている前提でお話しています。

$ firebase firestore:indexes > {fileName}

ex)

$ firebase firestore:indexes > firestore.indexes.json

コレを書き出しておけばGCPのコンソールで自動生成したindexも自分で書いたindexも全てjson形式で書き出してくれるので
後は別環境にデプロイしたり、書き換えてしまったindexを上書いたりできるのでとても助かります。

実行時の注意点

  • firebase useでfirebase-toolsがどの環境へ向いているのか確認する