lang2sql 0.1.6

Lang2SQL - Query Generator for Data Warehouse

Lang2SQL

Lang2SQL은 자연어 입력을 기반으로 SQL을 생성하는 프로젝트입니다. LangGraph, DataHub를 활용하여 데이터를 분석하고 최적의 SQL 쿼리를 생성 및 최적화합니다.

📌 프로젝트 목표

1. 자연어 입력을 기반으로 SQL 쿼리를 자동으로 생성
2. DataHub를 활용하여 관련 테이블 및 컬럼 메타데이터 조회
3. Best Practice Query를 참고하여 최적의 SQL 생성
4. SQL 최적화 과정을 거쳐 성능 향상

---

🚀 기술 스택

• LangGraph: LLM 기반의 쿼리 생성
• DataHub: 테이블 및 컬럼 메타데이터 조회

---

📦 설치 방법

1️⃣ 필수 패키지 설치

pip install -r requirements.txt

2️⃣ 패키지 설치

setup.py를 통해 패키지를 설치할 수 있습니다:

python setup.py install

3️⃣ CLI 명령어 사용

설치 후, lang2sql 명령어를 사용할 수 있습니다. 예를 들어, Streamlit 앱을 실행하려면 다음과 같이 입력합니다:

lang2sql --run-streamlit

기본 포트는 8501이며, 다른 포트를 사용하려면 -p 옵션을 사용하세요:

lang2sql --run-streamlit -p 8502

DataHub GMS 서버 URL을 설정하려면 --datahub_server 옵션을 사용하세요. 기본값은 http://localhost:8080입니다:

lang2sql --datahub_server http://your-datahub-server:8080 --run-streamlit

4️⃣ 환경 변수 설정

다음 환경 변수들은 설정되어야 합니다. .env 파일을 생성하여 다음과 같이 관리할 수 있습니다:

OPENAI_API_KEY=your-api-key-here
LANGCHAIN_TRACING_V2=true
LANGCHAIN_PROJECT=autosql
LANGCHAIN_ENDPOINT=https://api.smith.langchain.com
LANGCHAIN_API_KEY=your-langchain-api-key

---

🎯 동작

1. 자연어 입력을 기반으로 테이블 조회
2. 테이블의 스키마 및 컬럼 정보 확인
3. 최적의 SQL 쿼리 생성
4. 쿼리 최적화 실행

---

빌드 및 배포 방법

수동 빌드

python setup.py sdist bdist_wheel
twine upload dist/*

GitHub Actions를 통한 자동 배포

GitHub 저장소에 태그를 v* 형식으로 푸시하면, GitHub Actions가 자동으로 PyPI에 패키지를 배포합니다. 이 과정은 .github/workflows/pypi-release.yml 파일에 정의되어 있습니다.

• 태그 형식: v1.0.0 등
• 필요한 설정: GitHub Secrets에 PYPI_API_TOKEN을 설정해야 합니다.

---

라이선스

MIT License