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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlscope-1.0.3.tar.gz
  • Upload date:
  • Size: 39.3 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.3.tar.gz
Algorithm Hash digest
SHA256 567a3956608aa08abece1bad93cebe6eaa6a0cb4af86a80a9bc2e485ee644ffc
MD5 d9afc0c098da0e54bd713035db6a2864
BLAKE2b-256 31e17123f7c9874fcdf1aaa6237ebc467112d9a7262fd22d7a838114d27179c6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sqlscope-1.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bf5df07fd551e092a0547a274582c0eea66998ea812bca5c09225a5ea7f07c8c
MD5 96fd45b929823bad4de5f4b10081152e
BLAKE2b-256 f1baae4ba8e4e05af93f19623a89578773db98ffc269e6d78f01921eba5685b2

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