https://github.com/inukshuk/sqleton

Visualize your SQLite database schema
https://github.com/inukshuk/sqleton

database sqlite visualizer

Last synced: 6 days ago
JSON representation

Visualize your SQLite database schema

• Host: GitHub
• URL: https://github.com/inukshuk/sqleton
• Owner: inukshuk
• License: gpl-3.0
• Created: 2016-03-28T12:37:41.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-27T10:28:02.000Z (6 months ago)
• Last Synced: 2025-01-04T19:04:31.190Z (17 days ago)
• Topics: database, sqlite, visualizer
• Language: JavaScript
• Homepage:
• Size: 5.29 MB
• Stars: 114
• Watchers: 4
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sqleton ['skelɪtən]

Visualizes your SQLite database schema.

![](https://raw.githubusercontent.com/inukshuk/sqleton/master/examples/screenshot.png)

## Installation

```bash

$ npm install -g sqleton

```

You need to install [graphviz](http://www.graphviz.org/) separately:

```bash

$ [pacman -Sy | apt-get install | brew install] graphviz

```

## Example

```bash

$ sqleton -o db.svg db.sqlite

```

The format will be inferred from the name of the output file; you

can use any format supported by `graphviz` (png, pdf, svg, and many more).

## Usage

```

Usage: sqleton [options] 

Options:

  -L, --layout      The layout command

       [choices: "neato", "dot", "circo", "fdp", "osage", "sfdp", "twopi"]

                                                          [default: "fdp"]

  -e, --edge-labels  Label foreign key edges                     [boolean]

  -t, --title        Optional title string

  -f, --font         The font to use                [default: "Helvetica"]

  -d, --direction    Graph direction [choices: "TB", "LR"] [default: "LR"]

  -o, --out          Output file (determines output format)     [required]

      --skip-index   Skip writing table indexes                  [boolean]

```

## Fine-Tuning

To fine-tune your graph, the best option is to use `.dot` as your output

format and adjust the parameters in the file.

## Node.js

```js

const sqleton = require('sqleton')

// Open your database and writable stream

// ....

sqleton(db, stream, options)

  .then(() => { db.close() })

  .then(() => { stream.end() })

```

## What about PostgreSQL or other databases?

`sqleton` was written to visualize SQLite schemata. Having said that,

you can try to dump your schema and create a new SQLite database for

visualisation from it.

## License

GPL-3.0