Skip to content

platyplus/cerberus

Repository files navigation

Sphinx Metadata normaliser and loader

Installation

Requirements

Git, Docker Machine

Clone the repository

git clone https://github.com/platyplus/cerberus
cd cerberus

How it works

The metadata Excel file is in the ./importer folder. The first sheet have to contain the information about the several Sphinx databases. Sphinx metadata will be automatically analysed and normalised into TypeORM class files, that will be stored in the ./importer/entity folder.

TypeORM will then automatically create a PostgreSQL database schema based on this normalised schema.

Once the Typescript classes and the SQL schema are built, the program will scan the Sphinx Excel exports in the ./data directory and automatically import its data into the PosgreSQL database. Note that any change in an excel export file will trigger a re-import of the file.

Once all the data is loaded, you can use Metabase to start analysing the data.

Statistics

You may want to compare how many tables and columns are created in the transformation process, compared to the initial Sphinx metadata. You can run the NPM command npm run stats to get the numerator.

Start in development mode

docker-compose -f docker-compose.yml -f docker-compose-dev.yml up --build

Start in production mode

docker-compose -f docker-compose.yml -f docker-compose-prod.yml up --build

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages