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.1.tar.gz (39.2 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.1-py3-none-any.whl (44.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlscope-1.0.1.tar.gz
  • Upload date:
  • Size: 39.2 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.1.tar.gz
Algorithm Hash digest
SHA256 f9b705855e5278319109ea16d03d221d4368b4f6533b1c6ba2cc6586071ef3c6
MD5 25dea301db8776e1f1627475065402dd
BLAKE2b-256 c1ae2b44e046aea7e72c08d526fdc31fa32e4c34f07541678e08bdd967e4201d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sqlscope-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 44.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fd6808743cf10f6a477f12b1cc81d0a562b2893f94461222bd178dad204e56ff
MD5 68283c6d65d719d8a6f6a54227ada95e
BLAKE2b-256 ceec40a980814fa3877fbde3feae37310dbed9d6b1ea813566881f481344db32

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