https://github.com/unitvectory-labs/firestore-batch-incrementer

Iterates through a Firestore collection in batches and atomically increments a specified root‑level numeric field with configurable rate limiting.
https://github.com/unitvectory-labs/firestore-batch-incrementer

Last synced: about 1 year ago
JSON representation

Iterates through a Firestore collection in batches and atomically increments a specified root‑level numeric field with configurable rate limiting.

• Host: GitHub
• URL: https://github.com/unitvectory-labs/firestore-batch-incrementer
• Owner: UnitVectorY-Labs
• License: mit
• Created: 2025-04-17T23:38:46.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-05-07T23:17:31.000Z (about 1 year ago)
• Last Synced: 2025-05-08T00:14:09.418Z (about 1 year ago)
• Language: Go
• Size: 49.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![GitHub release](https://img.shields.io/github/release/UnitVectorY-Labs/firestore-batch-incrementer.svg)](https://github.com/UnitVectorY-Labs/firestore-batch-incrementer/releases/latest) [![License](https://img.shields.io/badge/license-MIT-blue)](https://opensource.org/licenses/MIT) [![Active](https://img.shields.io/badge/Status-Active-green)](https://guide.unitvectorylabs.com/bestpractices/status/#active)

# firestore-batch-incrementer

Iterates through a Firestore collection in batches and atomically increments a specified root‑level numeric field with configurable rate limiting.

## Purpose

Loops through every document in a specified Firestore collection and atomically increments a given root‑level numeric field—adding the field with a count of 1 if it doesn’t exist—to bulk-update all records so that downstream Eventarc triggers fire on each change.

This application runs scanning through the collection, updating each document at the specified rate limit, and then exits. It is intended to run as a Cloud Run Job.

## Environment Variables

- `PROJECT_ID` – GCP project ID  

- `COLLECTION` – Firestore collection to scan  

- `FIELD_KEY` – Root‑level field to increment  

- `DATABASE_ID` – Firestore database ID (default: "(default)")

- `BATCH_SIZE` – Number of documents per batch (default: 100)  

- `RATE_LIMIT` – Maximum updates per second (default: 50)

- `ATOMIC_UPDATES` – Use atomic transactions for updates (ensures document existence, default: false)

- `UPDATE_TYPE` – Defines how the field is updated. Possible values:

  - `INCREMENT` (default): Atomically increments the numeric field by 1.

  - `START_TIMESTAMP`: Sets the field to the same UTC timestamp captured at the start of execution.

  - `CURRENT_TIMESTAMP`: Sets the field to the current UTC timestamp for each document as it is updated.

- `GOOGLE_APPLICATION_CREDENTIALS` – (Optional) Path to the service account JSON file. If not set, Application Default Credentials (ADC) will be used (e.g., when running in Cloud Run Jobs with an attached service account).