graphql-engine/community/tools/firebase2graphql/README.md

Firebase to GraphQL

A CLI tool to help you try realtime GraphQL on your firebase data. It takes data exported from firebase and imports it into Postgres via Hasura GraphQL engine.

Quick start

1. Quickly get the GraphQL Engine running by clicking this button:

   

   Note the URL. It will be of the form: https://<app-name>.herokuapp.com

   Check this page for other deployment options

2. Go to Firebase console > Database > Realtime Database and click on Export JSON from the options on the upper right corner

   

   The exported JSON will be something like this:

   {
     "Articles": {
       "A1": {
         "Title": "Title1",
         "Body": "Body1",
         "IsUnpublished": false,
         "Author": {
           "Name": "AName1",
           "Age": 11
         },
         "Comments": {
           "C1": {
             "Body": "Comment1",
             "Author": {
               "Name": "AName2",
               "Sex": "M"
             },
             "Date": "22-09-2018"
           },
           "C2": {
             "Body": "Comment2",
             "Author": {
               "Name": "AName1",
               "Sex": "F"
             },
             "Date": "21-09-2018"
           }
         }
       },
       "A2": {
         "Title": "Title2",
         "Body": "Body2",
         "IsUnpublished": true,
         "Author": {
           "Name": "AName2",
           "Age": 22
         },
         "Comments": {
           "C3": {
             "Body": "Comment1",
             "Author": {
               "Name": "AName1",
               "Sex": "F"
             },
             "Date": "23-09-2018"
           },
           "C4": {
             "Body": "Comment2",
             "Author": {
               "Name": "AName2",
               "Sex": "M"
             },
             "Date": "24-09-2018"
           }
         }
       }
     },
     "Authors": {
       "AT1": {
         "Name": "AName1",
         "Age": 11,
         "Sex": "F",
         "Articles": {
           "A1": {
             "Title": "Title1"
           }
         }
       },
       "AT2": {
         "Name": "AName2",
         "Age": 22,
         "Sex": "M",
         "Articles": {
           "A2": {
             "Title": "Title2"
           }
         }
       }
     },
     "Comments": {
       "C1": {
         "Body": "Comment1",
         "Author": {
           "Name": "AName2"
         },
         "Date": "22-09-2018"
       },
       "C2": {
         "Body": "Comment2",
         "Author": {
           "Name": "AName1"
         },
         "Date": "21-09-2018"
       },
       "C3": {
         "Body": "Comment1",
         "Author": {
           "Name": "AName1"
         },
         "Date": "23-09-2018"
       },
       "C4": {
         "Body": "Comment2",
         "Author": {
           "Name": "AName2"
         },
         "Date": "24-09-2018"
       }
     }
   }
   

3. Use the CLI to import the data:

   npx firebase2graphql https://<app-name>.herokuapp.com --db=./path/to/db.json --normalize
   

4. That's it. You can now go to your GraphQL Engine URL https://<app-name>.herokuapp.com and make awesome GraphQL Queries like:

   query {
     Authors (order_by: Name_asc){
       Name
       Age
       Sex
       Articles (
         order_by: Title_asc
         where: {
           IsUnpublished: {
             _eq: false
           }
         }
       ){
         Title
         Body
         Comments (order_by: Date_desc){
           Body
           Authors {
             Name
           }
           Date
         }
       }
     }
   }
   

Check out next steps.

Installation

CLI

npm install -g firebase2graphql

Usage

Without access key

firebase2graphql https://hge.herokuapp.com -d ./path/to/db.json

With access key

firebase2graphql https://hge.herokuapp.com -k <access-key> -d ./path/to/db.json

Command

firebase2graphql URL [flags]

Args

• URL: The URL where Hasura GraphQL Engine is running

Options

• -d --db: path to the JS file that exports your sample JSON database
• -n --normalize: normalize the schema while importing
• -o --overwrite: (experimental) overwrite tables if they already exist in database
• -v --version: show CLI version
• -h, --help: show CLI help

Next steps

Once you have imported your data, it is recommended that you make it production ready.

1. Normalize the data by removing duplicates.

2. Explore the GraphQL Engine Console to play with things such as

   • Relationships
   • Permissions
   • Using SQL
   • Set up async business logic using event triggers
   • Create new tables

3. Set appropriate permissions. GraphQL Engine comes with fine grained control layer that can be integrated with any standard Auth provider.

Usage Comparison - Firebase SDK vs GraphQL

A typical query to do a single read from the database using Firebase SDK, (javascript) would look something like:

firebase.database().ref('/users/' + userId).once('value').then(function(snapshot) {
  var username = (snapshot.val() && snapshot.val().username) || 'Anonymous';
  // ...
});

Equivalent GraphQL Query would look like:

query {
  users(where: {uid: {_eq: userId}}) {
    uid,
    username
  }
}

Similarly a write into database using Firebase SDK, would look something like:

firebase.database().ref('users/' + userId).set({
    username: name,
    email: email,
    profile_picture : imageUrl
  });

And the equivalent GraphQL Mutation would look like:

mutation {
  insert_users(objects:[{
      uid: userId
      username: name,
      email: email,
      profile_picture: imageUrl
    }])
}

Things to know about implementation

Working

We flatten the JSON database into tables and create children tables when data nesting is detected.

In this way, you get almost the exact API over GraphQL that you had on Firebase.

If you use the flag --normalize, the CLI finds out if the children tables are duplicates of the original tables and tries to normalize the data by removing duplicates and creating respective relationships.

Normalization

The CLI provides a flag called --normalize if you want to normalize your denormalized database.

A lot of guess-work is done by the CLI while normalizing the database. Here are some thing you need to know:

1. Root level tables are never deleted. So if there are some relationships that you wish to create manually, you can do so.
2. Children tables are deleted if they are detected to be duplicates of some other root or child table.
3. In case of some children tables, when the data lacks a unique identifier, an extra unique field is added. In most cases, this field gets deleted while mergine a duplicate table with the original table.

Duplicates

By default, the CLI gives you almost the exact API that you originally had in Firebase (of course, over GraphQL). But in that case, some duplicate tables might be created and you might not be able to leverage the complete power of GraphQL and Postgres.

In such cases, you have three choices:

1. Use the API as such if you prefer the exact API.
2. Go to the UI Console and delete the duplicates and normalize the database as you feel fit.
3. Use the --normalize flag and rerun the migration. In this case, the CLI will detect duplicates and make appropriate relationships between root nodes. (This feature is experimental and needs more test cases to attain stability. Contributions are welcome)

Overwrite

If your database already contains tables with the same name as the root fields of your JSON database, the command will fail. If you want to overwrite the database anyway, you should provide an additional flag "--overwrite".

Feedback

This project is still in alpha and we are actively looking for feedback about how the tool can be improved. If you are facing an issue, feel free to open one here. Any positive or negative feedback would be appreciated.

---

Maintained with ♡ by Hasura