{"id":21231372,"url":"https://github.com/marcosvidolin/firestore-bulk-loader","last_synced_at":"2025-06-23T01:06:29.463Z","repository":{"id":35206737,"uuid":"214515935","full_name":"marcosvidolin/firestore-bulk-loader","owner":"marcosvidolin","description":"A simple tool to load data to Cloud Firestore.🔥","archived":false,"fork":false,"pushed_at":"2023-01-09T11:57:58.000Z","size":120,"stargazers_count":2,"open_issues_count":14,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-22T14:08:25.688Z","etag":null,"topics":["bulk-loader","cloud","data","database","firebase","firestore","import","load","loader","tools"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcosvidolin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-11T19:38:52.000Z","updated_at":"2022-07-13T03:19:13.000Z","dependencies_parsed_at":"2023-01-15T16:10:42.736Z","dependency_job_id":null,"html_url":"https://github.com/marcosvidolin/firestore-bulk-loader","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/marcosvidolin/firestore-bulk-loader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcosvidolin%2Ffirestore-bulk-loader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcosvidolin%2Ffirestore-bulk-loader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcosvidolin%2Ffirestore-bulk-loader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcosvidolin%2Ffirestore-bulk-loader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcosvidolin","download_url":"https://codeload.github.com/marcosvidolin/firestore-bulk-loader/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcosvidolin%2Ffirestore-bulk-loader/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261373999,"owners_count":23148945,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bulk-loader","cloud","data","database","firebase","firestore","import","load","loader","tools"],"created_at":"2024-11-20T23:46:38.224Z","updated_at":"2025-06-23T01:06:24.451Z","avatar_url":"https://github.com/marcosvidolin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# firestore-bulk-loader\n\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7df8ffe9407c444d9992e9aa16f50607)](https://www.codacy.com/manual/marcosvidolin/firestore-bulk-loader?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=marcosvidolin/firestore-bulk-loader\u0026amp;utm_campaign=Badge_Grade) [![Build Status](https://travis-ci.org/marcosvidolin/firestore-bulk-loader.svg?branch=master)](https://travis-ci.org/marcosvidolin/firestore-bulk-loader)\n\nA simple tool to load data to Cloud Firestore.\n\n## How to install\n\n```shell\nnpm i firestore-bulk-loader\n```\n\n## How to Use\n\n**Basic usage:**\n\n```javascript\nconst bulkLoader = require('firestore-bulk-loader');\nconst serviceAccount = require('./path/to/service-account.json');\nconst data = require('path/to/data.json');\n\nbulkLoader.load(data, \"my-collection\", serviceAccount);\n```\n\nor\n\n```javascript\nconst bulkLoader = require('firestore-bulk-loader');\nconst serviceAccount = require('./path/to/service-account.json');\n\nconst data = [\n    { name:\"John\", age:30 },\n    { name:\"Mario\", age:25 },\n    { name:\"Bruna\", age:33 }\n];\n\nbulkLoader.load(data, \"my-collection\", serviceAccount);\n```\n\n**To specify a custom id:**\n\n***WARN: The document will be updated if an existing ID is used.***\n\n```javascript\nconst bulkLoader = require('firestore-bulk-loader');\nconst serviceAccount = require('./path/to/service-account.json');\n\nconst data = [\n    { myId: \"j1\", name:\"John\", age:30 },\n    { myId: \"m2\", name:\"Mario\", age:25 },\n    { myId: \"b3\", name:\"Bruna\", age:33 }\n];\n\n// the name of the attribute to use as ID.\nvar options = {\n    documentKeyProperty: \"myId\"\n}\n\nbulkLoader.load(data, \"my-collection\", serviceAccount, options);\n```\n\n**CSV files:**\n\n```javascript\nconst bulkLoader = require('firestore-bulk-loader');\nconst serviceAccount = require('./path/to/service-account.json');\n\nconst data = require('./path/to/data.csv');\n\nvar options = {\n    csv: true\n}\n\nbulkLoader.load(data, \"my-collection\", serviceAccount, options);\n```\n\n## Options\n\n| Parameter           | Description                            | Default  | Required |\n|---------------------|----------------------------------------|----------|----------|\n| documentKeyProperty | The name of the attribute to use as ID |          | No       |\n| csv                 | specifies that the data type is CSV    | false    | No       |\n\n## Considerations\n\n- If you load a collection that dons't exists in the Firestore it will be created;\n- If the collections already exist in the Firestore all the data will be added to the existent collection;\n- A Document will only be replaced if the given 'id' alread exists in the collection. This case only happens when used **documentKeyProperty** option;\n\n## Contributors\n\n[![](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/images/0)](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/links/0)[![](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/images/1)](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/links/1)[![](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/images/2)](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/links/2)[![](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/images/3)](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/links/3)[![](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/images/4)](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/links/4)[![](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/images/5)](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/links/5)[![](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/images/6)](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/links/6)[![](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/images/7)](https://sourcerer.io/fame/marcosvidolin/marcosvidolin/firestore-bulk-loader/links/7)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcosvidolin%2Ffirestore-bulk-loader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcosvidolin%2Ffirestore-bulk-loader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcosvidolin%2Ffirestore-bulk-loader/lists"}