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.13.tar.gz (44.6 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.13-py3-none-any.whl (45.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlscope-1.0.13.tar.gz
  • Upload date:
  • Size: 44.6 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.13.tar.gz
Algorithm Hash digest
SHA256 166919a0a1759fe41a7d6ac54f88a65a3b4e945f812527331ba54d526e1c4fff
MD5 eac08a1832c21dd93948ef2d313518dc
BLAKE2b-256 98eb4ba7f621bfd7c187d1a99c65b08d57ec97968894a30e5e9e6d0da314cec2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sqlscope-1.0.13-py3-none-any.whl
  • Upload date:
  • Size: 45.5 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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 9b76ee955cdc2ad55aaf0f0136d4f69fec796d1bdf281c99e61810009ef2c1e8
MD5 62f0cd0b7b094dcc1fbcf1bc52ae18ee
BLAKE2b-256 dc11b5a05eea08f886f9c988647df0d9bf9361e01879df0072b4ec7776859957

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