@shabados/database

An open gurbani database containing an evolving set of corrections. Used in Shabad OS software.

An open Gurbani database containing an evolving set of corrections. Used in Shabad OS software.

Want to speak to us?

Quickstart

Want to use this in your own project? Get it from npm with npm install @shabados/database.

An objection.js object is returned, allowing for flexible and relational querying.

To fetch a Shabad with first letters:

// const { Lines } = require('@shabados/database') // If using npm module
const { Lines } = require('./index') // If using this repo
    
// Fetch the line, with information about the shabad
Lines
  .query() // Start a query on the lines table
  .firstLetters('ਹਹਹਗ')   // Search for the first letters, ordering the results sensibly
  .first()  // Use the first line that is returned
  .then(line => line.$relatedQuery('shabad').eager('[lines, writer]'))  // Return the shabad the line is from, with the lines and writer
  .then(shabad => console.log(shabad))

You can also search the ascii equivalent, and the API will automatically convert the search to unicode:

Lines.query().firstLetters('kkggAnj')

Note that although the column names are in snake_case, the API will return names in camelCase note.

Vague Benchmarks

ਹਹ yielded 2748 results in ~80ms
ਹਹਹ yielded 226 results in ~50ms
ਹਹਹਹ yielded 50 results in ~50ms
ਹਹਹਹਹ yielded 13 results in ~50ms

Obviously, YMMV depending on specs, but this does show that it's probably ok to return between 0-200 results in a reasonable amount of time.

To run your own benchmarks, docker-compose up benchmark or npm run benchmark

Schema

Building

You can use docker, or node.

Docker

Install docker. You won't need to install anything else.

Run docker-compose up build to generate the SQLite3 DB in the build folder.

Node

Install node.

Run npm install inside the project directory to install dependencies.

Run npm run build to build the database.

Contributing

The schema can be modified in the migrations/schema.js file.

Structure

JSON files for Raags, Sources, Writers, and Line_Types can be found in the seeds folder. Changing a value here will be reflected everwhere else. The (array index) + 1 represents the id used for each relation in other tables.

Lines are split by sources/source name/first ang in batch/ang number.json.

Banis can be added by adding a named JSON file to the banis folder. To define the lines a bani contains, each bani should contain a list of objects with start_line and end_line, referring to the files in sources. Note that for now, these lines have to be updated if new lines are added or removed from the source files.

Shabads are split by shabads/source name/writer name.json.

Single line changes

The content for each ang can be found in the corresponding js file. Simply change any values as desired.

Large/batch changes

To modify large parts of the database, based on some rule:

Build a local copy of the database, following the instructions in the Building section
Modify the database file in builds/database.sqlite as you see fit
Run docker-compose up generate or npm run generate to regenerate the seed files with your changes

Releases

The builds for any of branches can be found on CircleCI.

If MAJOR, MINOR are found in any of the commit messages, the version will be adjusted as per semantic versioning (PATCH is assumed if none of the above are found). NO-RELEASE will not create a release.

Compiled databases are available via the release page, or via npm install @shabados/database.

Viewing

You can use an application like DBeaver to view the SQLite file.

Todo

Redo English translations under an open license
Automatically update the Bani files if a line change in sources occurs

swissarmykirpan/database