Skip to main content
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

Metadata

Release files for aws-redshift-schema-explorer 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-redshift-schema-explorer 0.1.1
File Size Uploaded
aws_redshift_schema_explorer-0.1.1.tar.gz 11.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aws-redshift-schema-explorer 0.1.1
File Interpreter ABI Platform
aws_redshift_schema_explorer-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 24.8 kB

Release files / aws_redshift_schema_explorer-0.1.1.tar.gz

Download URL aws_redshift_schema_explorer-0.1.1.tar.gz
Size 11.0 kB
Tags Source
SHA-256 checksum
How to use checksums
38749f56dd62580a3cff33758cd3b202a2d869b906f142eb75988ff1bd1e619f
BLAKE2b-256 checksum
How to use checksums
3ad3f937fc600037e281d70060491a7958c1eeac032d8e1b74437db60a857463
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.8

Release files / aws_redshift_schema_explorer-0.1.1-py3-none-any.whl

Download URL aws_redshift_schema_explorer-0.1.1-py3-none-any.whl
Size 13.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4052f99c6d574e20021a690b513aff7cd58e66b23170dcd91d05f7f173b851cf
BLAKE2b-256 checksum
How to use checksums
0d892b2865d28fb6b93bcc4681512d16c64c25a95c549a9f117f3a94e6cc3e20
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.8

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page