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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlscope-1.0.15.tar.gz
  • Upload date:
  • Size: 44.8 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.15.tar.gz
Algorithm Hash digest
SHA256 c870e9aed3aee7494394bfcaa751cb5f5d40247070d4a6c04f21271f702b8823
MD5 54b52959fff2f73e674e66c3b58875ae
BLAKE2b-256 def46bc198cdbf0d44d539bddb08b9be83c75603b41dd14901ed297ab4ce3b14

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sqlscope-1.0.15-py3-none-any.whl
  • Upload date:
  • Size: 45.6 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.15-py3-none-any.whl
Algorithm Hash digest
SHA256 d4e1b2847a04a5f5af1311572498ddb589f332384912a7131618f7958649e840
MD5 89e7a158b2eb3a51dd7458bfcb209100
BLAKE2b-256 5d1d4cf1d807a8cad43e8399812560c2b5be15c6451c59c12805faec00e59b55

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