Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coleifer/sqlite-web
Web-based SQLite database browser written in Python
https://github.com/coleifer/sqlite-web
database flask python sqlite
Last synced: 3 days ago
JSON representation
Web-based SQLite database browser written in Python
- Host: GitHub
- URL: https://github.com/coleifer/sqlite-web
- Owner: coleifer
- License: mit
- Created: 2014-11-08T05:26:31.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T18:51:30.000Z (4 months ago)
- Last Synced: 2024-10-29T10:52:39.484Z (about 2 months ago)
- Topics: database, flask, python, sqlite
- Language: Python
- Size: 1.31 MB
- Stars: 3,391
- Watchers: 77
- Forks: 334
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-sqlite - coleifer/sqlite-web: Web-based SQLite database browser written in Python
README
`sqlite-web` is a web-based SQLite database browser written in Python.
Project dependencies:
* [flask](http://flask.pocoo.org)
* [peewee](http://docs.peewee-orm.com)
* [pygments](http://pygments.org)
### Installation
```sh
$ pip install sqlite-web
```
### Usage
```sh
$ sqlite_web /path/to/database.db
```
Or run with docker:
```sh
$ docker run -it --rm \
-p 8080:8080 \
-v /path/to/your-data:/data \
-e SQLITE_DATABASE=db_filename.db \
ghcr.io/coleifer/sqlite-web:latest
```
Then navigate to http://localhost:8080/ to view your database.
### Features
* Works with your existing SQLite databases, or can be used to create new databases.
* Add or drop:
* Tables
* Columns (with support for older versions of Sqlite)
* Indexes
* Export data as JSON or CSV.
* Import JSON or CSV files.
* Browse table data.
* Insert, Update or Delete rows.
### Screenshots
The index page shows some basic information about the database, including the number of tables and indexes, as well as its size on disk:
The `structure` tab displays information about the structure of the table, including columns, indexes, triggers, and foreign keys (if any exist). From this page you can also create, rename or drop columns and indexes.
Columns are easy to add, drop or rename:
The `content` tab displays all the table data. Links in the table header can be used to sort the data:
The `query` tab allows you to execute arbitrary SQL queries on a table. The query results are displayed in a table and can be exported to either JSON or CSV:
The `import` tab supports importing CSV and JSON files into a table. There is an option to automatically create columns for any unrecognized keys in the import file:
The `export` tab supports exporting all, or a subset, of columns:
Basic INSERT, UPDATE and DELETE queries are supported:
### Command-line options
The syntax for invoking sqlite-web is:
```console
$ sqlite_web [options] /path/to/database-file.db
```
The following options are available:
* `-p`, `--port`: default is 8080
* `-H`, `--host`: default is 127.0.0.1
* `-d`, `--debug`: default is false
* `-l`, `--log-file`: filename for application logs.
* `-x`, `--no-browser`: do not open a web-browser when sqlite-web starts.
* `-P`, `--password`: prompt for password to access sqlite-web.
Alternatively, the password can be stored in the "SQLITE_WEB_PASSWORD"
environment variable, in which case the application will not prompt for a
password, but will use the value from the environment.
* `-r`, `--read-only`: open database in read-only mode.
* `-R`, `--rows-per-page`: set pagination on content page, default 50 rows.
* `-Q`, `--query-rows-per-page`: set pagination on query page, default 1000 rows.
* `-T`, `--no-truncate`: disable ellipsis for long text values. If this option
is used, the full text value is always shown.
* `-e`, `--extension`: path or name of loadable extension(s). To load
multiple extensions, specify ``-e [path]`` for each extension.
* `-f`, `--foreign-keys`: enable foreign-key constraint pragma.
* `-u`, `--url-prefix`: URL prefix for application, e.g. "/sqlite-web".
* `-c`, `--cert` and ``-k``, ``--key`` - specify SSL cert and private key.
* `-a`, `--ad-hoc` - run using an ad-hoc SSL context.
### Using docker
A Dockerfile is provided with sqlite-web. To use:
```console
#
# Use GitHub container registry:
#
$ docker run -it --rm \
-p 8080:8080 \
-v /path/to/your-data:/data \
-e SQLITE_DATABASE=db_filename.db \
ghcr.io/coleifer/sqlite-web:latest
#
# OR build the image yourself:
#
$ cd docker/ # Change dirs to the dir containing Dockerfile
$ docker build -t coleifer/sqlite-web .
$ docker run -it --rm \
-p 8080:8080 \
-v /path/to/your-data:/data \
-e SQLITE_DATABASE=db_filename.db \
coleifer/sqlite-web
```