Skip to main content

This project extracts catalog and query metadata from a SQL query.

Project description

Introduction

This project extracts catalog and query metadata from a SQL query. Each SELECT statement is parsed as a list of tokens as well as an AST. The former works even for incomplete or invalid SQL queries, while the latter requires a valid SQL syntax. Additionally, catalog metadata is extracted from the database schema.

Details

For each SELECT statement, the package extracts:

  • the list of SELECT queries (in case of set operations, nested queries, or ctes)
  • the main SELECT query
  • the list of schemas/tables/columns available in the catalog
  • the list of tables referenced in each query
  • the resulting table from each query execution, including its columns and their types
  • each clause of each query

The catalog extract schema/table/column metadata. For each column, the following information are extracted:

  • name
  • data type
  • nullability
  • foreign key

Additionally, for each table, PRIMARY KEY/UNIQUE constraints are extracted. This is also computed for the result of each SELECT query.

Credits

Special thanks to Flavio Venturini for his valuable contributions to the development of this project.

Limitations

  • Fully identified schema names are not supported when specifying column names (e.g. SELECT schema.table.column [...])

Project details


Download files

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

Source Distribution

sqlscope-1.0.11.tar.gz (44.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sqlscope-1.0.11-py3-none-any.whl (45.3 kB view details)

Uploaded Python 3

File details

Details for the file sqlscope-1.0.11.tar.gz.

File metadata

  • Download URL: sqlscope-1.0.11.tar.gz
  • Upload date:
  • Size: 44.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for sqlscope-1.0.11.tar.gz
Algorithm Hash digest
SHA256 14d85bbe67150e2a9d69ba9718df5d330c709e7321d6ac73f55e15c14ccd250e
MD5 5a6d54ec058ae30cf819a768bc296b9f
BLAKE2b-256 c14fa0d44e2161a2121962fd9d7511ada6f771ce684aa6c254905eee14bba0f3

See more details on using hashes here.

File details

Details for the file sqlscope-1.0.11-py3-none-any.whl.

File metadata

  • Download URL: sqlscope-1.0.11-py3-none-any.whl
  • Upload date:
  • Size: 45.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for sqlscope-1.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 ada5d05b679f55bcf107e4b9b090ccd87e8d49f1c87c97496c4dbe2f4a4dd659
MD5 f5c41aeb522c67c14e042853f30ec4c4
BLAKE2b-256 1d487c5ee5283af796d1fa3f1354557aeb1a9aaa810e0ad52241fdce9e955719

See more details on using hashes here.

Supported by

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