Skip to main content

A Python library for extracting AWS Redshift schema metadata as structured dataclasses, designed for AI text-to-SQL applications.

Project description

Documentation Status https://github.com/MacHu-GWU/aws_redshift_schema_explorer-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/aws_redshift_schema_explorer-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/aws-redshift-schema-explorer.svg https://img.shields.io/pypi/l/aws-redshift-schema-explorer.svg https://img.shields.io/pypi/pyversions/aws-redshift-schema-explorer.svg https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to aws_redshift_schema_explorer Documentation

https://aws-redshift-schema-explorer.readthedocs.io/en/latest/_static/aws_redshift_schema_explorer-logo.png

A Python library that provides a simple, structured interface for extracting AWS Redshift schema metadata. This project focuses purely on the extraction layer, offering clean command-pattern APIs to retrieve database, schema, table, view, and column information from Redshift clusters. The extracted metadata is returned as structured dataclasses, making it ideal for downstream applications like AI-powered text-to-SQL systems. The library handles the complexity of querying Redshift system tables and views, providing a clean abstraction for schema exploration without dictating how the metadata should be encoded or consumed.

Note: the sql command used in this project is based on my own research.

Install

aws_redshift_schema_explorer is released on PyPI, so all you need is to:

$ pip install aws-redshift-schema-explorer

To upgrade to latest version:

$ pip install --upgrade aws-redshift-schema-explorer

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

aws_redshift_schema_explorer-0.1.1.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aws_redshift_schema_explorer-0.1.1-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file aws_redshift_schema_explorer-0.1.1.tar.gz.

File metadata

File hashes

Hashes for aws_redshift_schema_explorer-0.1.1.tar.gz
Algorithm Hash digest
SHA256 38749f56dd62580a3cff33758cd3b202a2d869b906f142eb75988ff1bd1e619f
MD5 be7bf3fc57252a59dc3bec7f59975592
BLAKE2b-256 3ad3f937fc600037e281d70060491a7958c1eeac032d8e1b74437db60a857463

See more details on using hashes here.

File details

Details for the file aws_redshift_schema_explorer-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_redshift_schema_explorer-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4052f99c6d574e20021a690b513aff7cd58e66b23170dcd91d05f7f173b851cf
MD5 b6d6cfd01b907b9d8c47e2a2f1f0d72d
BLAKE2b-256 0d892b2865d28fb6b93bcc4681512d16c64c25a95c549a9f117f3a94e6cc3e20

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