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

This version

5.3

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.3.tar.gz (910.0 kB view hashes)

Uploaded Source

Built Distribution

django_sql_explorer-5.3-py3-none-any.whl (958.0 kB view hashes)

Uploaded Python 3

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