Skip to main content

SQL Reporting that Just Works. Fast, simple, and confusion-free.Write and share queries in a delightful SQL editor, with AI assistance

Project description

Documentation Status Latest Version Downloads License

SQL Explorer

Video Tour

inline-image

Quick Start

Included is a complete test project that you can use to kick the tires.

  1. Run docker compose up

  2. Navigate to 127.0.0.1:8000/explorer/

  3. log in with admin/admin

  4. Begin exploring!

This will also run a Vite dev server with hot reloading for front-end changes.

About

SQL Explorer aims to make the flow of data between people fast, simple, and confusion-free. It is a Django-based application that you can add to an existing Django site, or use as a standalone business intelligence tool. It will happily connect to any SQL database that Django supports as well as user-uploaded CSV, JSON, or SQLite databases.

Quickly write and share SQL queries in a simple, usable SQL editor, view the results in the browser, and keep the information flowing.

Add an OpenAI (or other provider) API key and get an LLM-powered SQL assistant that can help write and debug queries. The assistant will automatically add relevant context and schema into the underlying LLM prompt.

SQL Explorer values simplicity, intuitive use, unobtrusiveness, stability, and the principle of least surprise. The project is MIT licensed, and pull requests are welcome.

Some key features include:

  • Support for multiple connections, admin configured or user-provided.

  • Users can upload and immediately query JSON or CSV files.

  • AI-powered SQL assistant

  • Quick access to schema information to make querying easier (including autocomplete)

  • Ability to snapshot queries on a regular schedule, capturing changing data

  • Query history and logs

  • Quick in-browser statistics, pivot tables, and scatter-plots (saving a trip to Excel for simple analyses)

  • Parameterized queries that automatically generate a friendly UI for users who don’t know SQL

  • A playground area for quickly running ad-hoc queries

  • Send query results via email

  • Saved queries can be exposed as a quick-n-dirty JSON API if desired

  • …and more!

Screenshots

Writing a query and viewing the schema helper

https://sql-explorer.s3.amazonaws.com/5.0-query-with-schema.png

Using the SQL AI Assistant

https://sql-explorer.s3.amazonaws.com/5.0-assistant.png

Viewing all queries

https://sql-explorer.s3.amazonaws.com/5.0-query-list.png

Query results w/ stats summary

https://sql-explorer.s3.amazonaws.com/5.0-query-results.png

Pivot in browser

https://sql-explorer.s3.amazonaws.com/5.0-pivot.png

View logs

https://sql-explorer.s3.amazonaws.com/5.0-querylogs.png

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_sql_explorer-5.2b1.tar.gz (872.8 kB view details)

Uploaded Source

Built Distribution

django_sql_explorer-5.2b1-py3-none-any.whl (915.1 kB view details)

Uploaded Python 3

File details

Details for the file django_sql_explorer-5.2b1.tar.gz.

File metadata

  • Download URL: django_sql_explorer-5.2b1.tar.gz
  • Upload date:
  • Size: 872.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for django_sql_explorer-5.2b1.tar.gz
Algorithm Hash digest
SHA256 826e1cf10aebf15c99db615e5422d2b3da473049733b9c0816279fa8ec449051
MD5 c139b263cdb3748f86f9615bd33c8de6
BLAKE2b-256 0bbe638c4e9b32cb428e6b1039ae2eca56eaf9e5528ec1dc69a965121e78c72b

See more details on using hashes here.

Provenance

File details

Details for the file django_sql_explorer-5.2b1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_sql_explorer-5.2b1-py3-none-any.whl
Algorithm Hash digest
SHA256 dda8b5494b461badbfdf0c86b7b587e1772422739a219a56256ca7624b06c1d9
MD5 d4b5a1a56b59a53822d6a50490dd2656
BLAKE2b-256 a7516705049c6569ecd26407aa0c41b5f1533e37daada26ad81b9b6f17fa64c2

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page