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.10.tar.gz (44.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.10-py3-none-any.whl (45.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlscope-1.0.10.tar.gz
  • Upload date:
  • Size: 44.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.10.tar.gz
Algorithm Hash digest
SHA256 48a9fed445b5ec3e9b773c0bc007a2255c6434a3a74e25839ad415042ccd51e5
MD5 af698cea16b9b96797df9a94155ea063
BLAKE2b-256 ada19c9a7cbb42327b35fe6b8ce4e009635fe288252875c50cb2ae99eb44c43c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sqlscope-1.0.10-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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 49aa67b40def556605d35716d421337a6c1a033344b65d502a06f935d5f64fad
MD5 5cea309c62292882da25eabe1cb83410
BLAKE2b-256 6463c24beee727fe35c270f64d2153b3ea20807d4b13b0737b3bf45bef94410a

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