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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlscope-1.0.12.tar.gz
  • Upload date:
  • Size: 44.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.12.tar.gz
Algorithm Hash digest
SHA256 bdce2dc4ee9f6850d58d48f684d5842fc91cd94e3825869560fd89ab1c73cabc
MD5 5944f33978738b5b87c68f52abee7eb2
BLAKE2b-256 245534c8fb3e355967026bff6d0d8c433585134c553972eaf802c91af4068458

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sqlscope-1.0.12-py3-none-any.whl
  • Upload date:
  • Size: 45.4 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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 bc58e20f4b24cd0aff0c9cdfa09f0980584aee2dcb89df239eb09a1cc67787e9
MD5 dce7f01b40af3b69247185908f66eed7
BLAKE2b-256 d59dd721b1ff6b0a2209c8b82f913b5992b461f6f9e43fde6fe02b2d6d40c68b

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