Skip to content
Automatically create a GraphQL server from a SQLite database or a SQL file
JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
.vscode it works Nov 20, 2017
src Fix deprecation of findById in sequelize 5 Aug 25, 2019
.babelrc it works Nov 20, 2017
.editorconfig it works Nov 20, 2017
.gitignore ignore demo infile Aug 25, 2019
.npmignore ignore demo infile Aug 25, 2019
.prettierrc it works Nov 20, 2017
LICENSE Create LICENSE Nov 20, 2017
Readme.md Switch to GH action badge Sep 14, 2019
package-lock.json 1.7.0 Aug 25, 2019
package.json Switching from travis to GH actions Sep 14, 2019

Readme.md

tuql build status Coverage Status

Pronounced: Too cool

tuql is a simple tool that turns a sanely formatted sqlite database into a graphql endpoint. It tries to infer relationships between objects, currently supporting belongsTo, hasMany and belongsToMany. It also forms the basic mutations necessary to create, update, and delete objects, as well as assoicate many-to-many relationships.

Installing

npm install -g tuql

Using

tuql --db path/to/database.sqlite

You can also optionally set the port and enable graphiql:

tuql --db path/to/database.sqlite --port 8888 --graphiql

Or, you can use a sql file with statements to build up an in-memory database:

tuql --infile path/to/db_dump.sql --graphiql

If you'd like to print out the schema itself, use:

tuql --db path/to/database.sqlite --schema

Or send it to a file:

tuql --db path/to/database.sqlite --schema > schema.graphql

How it works

Imagine your sqlite schema looked something like this:

posts users categories category_post
id   id id category_id
user_id username title post_id
title
body

tuql will automatically define models and associations, so that graphql queries like this will work right out of the box:

{
  posts {
    title
    body
    user {
      username
    }
    categories {
      title
    }
  }
}

tuql works one of two ways. It prefers to map your schema based on the foreign key information in your tables. If foreign keys are not present, tuql assumes the following about your schema in order to map relationships:

  1. The primary key column is named id or thing_id or thingId, where thing is the singular form of the table name. Example: For a table named posts, the primary key column should be named id, post_id or postId.
  2. Similarly, foreign key columns should be thing_id or thingId, where thing is the singular form of the associated table.
  3. For many-to-many associations, the table name should be in the form of foo_bar or bar_foo (ordering is not important). The columns should follow the same pattern as #2 above.
You can’t perform that action at this time.