Skip to main content

A pluggable app that allows users (admins) to execute SQL, view, and export the results.

Project description

Documentation Status Latest Version Downloads License

SQL Explorer

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.

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

  • AI-powered SQL assistant

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

  • In-browser pivot tables (which can also be shared via URLs)

  • 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)

  • Basic code-completion in the SQL editor

  • 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

Development

Included is a test_project that you can use to kick the tires. Just create a new virtualenv, cd into test_project and run start.sh (or walk through the steps yourself) to get a test instance of the app up and running.

You can now navigate to 127.0.0.1:8000/explorer/ and begin exploring!

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.0.1.tar.gz (857.2 kB view details)

Uploaded Source

Built Distribution

django_sql_explorer-5.0.1-py3-none-any.whl (894.6 kB view details)

Uploaded Python 3

File details

Details for the file django_sql_explorer-5.0.1.tar.gz.

File metadata

  • Download URL: django_sql_explorer-5.0.1.tar.gz
  • Upload date:
  • Size: 857.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for django_sql_explorer-5.0.1.tar.gz
Algorithm Hash digest
SHA256 b5fbe5bdf8e86768e252f8ef69a0fb336e8255b5bef504aaefff83440871080e
MD5 60c528c80377bdb3588e85085d579d3a
BLAKE2b-256 1602143f56c3b8c3bec9a0c4b56138b9840471cf2e87ff4d451fdfbc388a0c53

See more details on using hashes here.

Provenance

File details

Details for the file django_sql_explorer-5.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_sql_explorer-5.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 da3df322b0d2eed8fbf7fd558f1e128be32adc602cf91a3d5ff0b1539e00e9fa
MD5 a2743519332e90b2f24e7a0dab800d48
BLAKE2b-256 b9edb4c43d2f079863a8890b50e669450564f63a4c5e7b177d4ef681a36db872

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