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.9.tar.gz (44.1 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.9-py3-none-any.whl (45.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlscope-1.0.9.tar.gz
  • Upload date:
  • Size: 44.1 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.9.tar.gz
Algorithm Hash digest
SHA256 e1c731f4a945a77f321f310a4dc90ad397249d0bb3bbd6c69359a003b456dde4
MD5 f8229e8415024dd1eedf52b426cde306
BLAKE2b-256 79fb3cc5e276b8b31e0236305a3d6b728c07135e1b273825a1f8450dd5c9ebe6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sqlscope-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 45.2 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 15421931f343b71a31643fc8f73de0b7f1a4a6fa39813dc9ee79664619460efb
MD5 3327cb70217a012c001607c123513184
BLAKE2b-256 69eb2149d686565bc00b6b008b0df2bc968f6c945ed43fcfb51e434d4b5c8bcf

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