npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@nanogiants/firegration

v0.0.8

Published

A CLI tool to migrate Firestore data using typed migrations

Downloads

440

Readme

Firegrations

Firegrations is a simple migration tool for Firestore. It allows you to define your migrations in code fully typed in Typescript and run them in a specific order.

Installation

There are two operation modes of the migration tool. You can either use the CLI or the package as a library directly in your code.

If you solely want to use the CLI, you don't need to install this package. However, it is useful to install it for type information. You can use it directly from npx.

npx @nanogiants/firegration --migrations=./your-migrations-folder

For library usage, you can install the package from npm:

npm install @nanogiants/firegration

You also need Firebase Credentials in both modes to run the migrations. Simply set the GOOGLE_APPLICATION_CREDENTIALS environment variable when running the migrations.

Usage

Write your migrations

You can write your migrations in a folder of your choice in Typescript. Each migration should be a separate file that exports a function that takes a Firestore instance as an argument. The naming scheme must satisfy the following regex: v{semver}__{description}.

You can either export a default anonymous function or export a named function migrate:

// migrations/v1.0.0__migration1.ts
import { MigrationParameters } from "@nanogiants/firegration";
export default async function ({ firestore }: MigrationParameters) {
  // Your migration code here
}
// migrations/v1.0.1__migration2.ts
import { MigrationParameters } from "@nanogiants/firegration";
export async function migrate({ firestore }: MigrationParameters) {
  // Your migration code here
}

Run your migrations

You can run your migrations using the CLI or the library.

CLI

GOOGLE_APPLICATION_CREDENTIALS="service_account.json" npx @nanogiants/firegration --migrations=./migrations

Library

// index.js
import { runMigrations } from "@nanogiants/firegration";

runMigrations({
  migrations: "./migrations",
});
GOOGLE_APPLICATION_CREDENTIALS="service_account.json" node index.js

CLI Parameters

Usage: @nanogiants/firegration [options]

Options:
  --migrations <path>              Path to migrations folder
  --migrationsCollection <string>  Name of migrations collection (default: "firegration")
  --databaseId <string>            Id of firestore database to use
  --tsconfig <path>                Path to tsconfig file
  -V, --version                    output the version number
  -h, --help                       display help for command

Examples

You can find examples of how to use Firegration in the examples folder.