https://github.com/stepanic/parse-server-SCHEMA-to-DBML
Convert ParseServer _SCHEMA Mongo collection data to DBML (SQL@dbdiagram.io) to visualize relations between Parse classes
https://github.com/stepanic/parse-server-SCHEMA-to-DBML
Last synced: 5 months ago
JSON representation
Convert ParseServer _SCHEMA Mongo collection data to DBML (SQL@dbdiagram.io) to visualize relations between Parse classes
- Host: GitHub
- URL: https://github.com/stepanic/parse-server-SCHEMA-to-DBML
- Owner: stepanic
- Created: 2020-06-01T08:18:03.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-22T06:40:06.000Z (over 3 years ago)
- Last Synced: 2024-11-14T18:23:26.922Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 30.3 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - stepanic/parse-server-SCHEMA-to-DBML - Convert ParseServer _SCHEMA Mongo collection data to DBML (SQL@dbdiagram.io) to visualize relations between Parse classes (JavaScript)
README
# parse-server-SCHEMA-to-DBML
Convert [ParseServer](https://github.com/parse-community/parse-server) classes as documents from MongoDB collection `_SCHEMA` to [DBML](https://www.dbml.org) (SQL by dbdiagram.io) tables to visualize relations between Parse classes.## ParseServer
- https://github.com/parse-community/parse-server
- https://parseplatform.org## DBML
- https://www.dbml.org
### dbdiagram
- https://dbdiagram.io
### dbdocs
- http://dbdocs.io
# Requirements
Install `Node.js`, recommended `>= v12.x` with `NVM`
- https://github.com/nvm-sh/nvm
# Installation
```bash
npm install -g parse-server-schema-to-dbml
```# Usage
## 1. Export data from Mongo collection to the JSON file as array of documents
```bash
mongoexport --uri="${MONGO_URI}" --collection _SCHEMA --jsonArray --out _SCHEMA.json
```**NOTE:** do not worry about DB data leak, `_SCHEMA.json` is part of `.gitignore` 😎
## 2. Convert data from `_SCHEMA.json` to the DBML `_SCHEMA.dbml`
```bash
parseServerSchema2dbml -i _SCHEMA.json -o _SCHEMA.dbml
```**NOTE:** do not worry about DB data leak, `_SCHEMA.dbml` is also part of `.gitignore` 😎
### Short call
```bash
parseServerSchema2dbml
```#### NOTE
Default values are `./_SCHEMA.json` for the `-i` (`--input`) and `./_SCHEMA.dbml` for the `-o` (`--output`) options.
## 3. Import data to dbdiagram.io
Paste everything from `_SCHEMA.dbml` or other file defined at `--output` option to the empty or some existing diagram at the dbdiagram.io