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.5.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.5-py3-none-any.whl (44.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlscope-1.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 93f5bb869a896ce1f95dfd879bd2aa88017ce6e73c0f494a41f5d9450f5a01d7
MD5 28a0e8fa8d87025685c978c90895b3dc
BLAKE2b-256 1f0192f115b17dd78e8fc4d133218d268dbab78191e38b97c2962e83748c877e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sqlscope-1.0.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 218320550545de14b64b49750f345623d78490b79a20617754b95633d62f107e
MD5 a64ac43e0d504375537097024d07ccfb
BLAKE2b-256 b797ea3fba788e4443278b5c0f0009a039824df8ce8ee24c0a9b378cedecb650

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