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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlscope-1.0.7.tar.gz
  • Upload date:
  • Size: 39.5 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.7.tar.gz
Algorithm Hash digest
SHA256 dffe4820809cbd69b25220253173a4994d2b359312558f52b5b23ca24c15798f
MD5 164c748af94c743921a8bbdc3f6cc219
BLAKE2b-256 f14d942bf2d941c2c6eed29c1626b78c8cbf722eee5389c82d1a2c7927995378

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sqlscope-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 45.1 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 15efe083abc5dc56590c34f81f974626e66594db9ba72f53639d910f93999e2d
MD5 a76ba90f7d550f065cbcf4252c7bdec9
BLAKE2b-256 4e29bce8ece0911969927171ac074093a348f7a907180f2320891502dbd26d8f

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