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.6.tar.gz (39.4 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.6-py3-none-any.whl (44.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlscope-1.0.6.tar.gz
  • Upload date:
  • Size: 39.4 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.6.tar.gz
Algorithm Hash digest
SHA256 57199219c0ff10f9a75c2a26e364256fa1b5541332018d0ee2b41f0df2e154b3
MD5 5e55488514bf002603873137b002cf56
BLAKE2b-256 2f4a115838e12b9236fa8291c7bc7a3c1e0be29f756b4facfff8f066efe8f3ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sqlscope-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 44.9 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 dd4c876ad443a1c399122ea2f1d3a9cf8f8fe249f9b2062c504a84b2bf64fc3d
MD5 3ff438ca817b552916898cdbcf329fdf
BLAKE2b-256 dfd8890388575b1c5dcc9e8fb0d9513dedd2c25d4615cc3c142f04d60b1537cb

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