우리는 함께 코드와 아이디어를 나누며 더 나은 데이터 환경을 만들기 위한 오픈소스 여정을 떠납니다. 🌍💡
"모두가 더 가치 있는 일에 집중할 수 있기를 바랍니다."
Lang2SQL은 자연어 쿼리를 최적화된 SQL 문으로 변환하는 오픈소스 도구입니다. LangGraph와 DataHub 통합으로 구축되어, 복잡한 데이터베이스 스키마에 대한 깊은 지식 없이도 데이터 사용자들이 효율적인 SQL 쿼리를 생성할 수 있도록 도와줍니다.
- 🗣️ 자연어를 SQL로 변환: 일상 언어를 정확한 SQL 쿼리로 변환
- 📊 스마트 테이블 발견: 의미론적 검색을 사용하여 관련 테이블을 자동으로 찾기
- 🔍 스키마 인식: DataHub 메타데이터를 활용한 정확한 컬럼 매핑
- 🛠️ 웹 인터페이스: 대화형 Streamlit 앱을 통한 사용
- 📈 시각화: 생성된 SQL 쿼리 결과를 다양한 차트와 그래프로 시각화하여 데이터 인사이트를 직관적으로 파악
- 🗄️ 유연한 VectorDB: FAISS(로컬)와 pgvector(PostgreSQL) 중 선택 가능한 벡터 데이터베이스 지원
새로운 데이터팀 구성원들이 자주 직면하는 문제들:
- 🤯 "테이블이 너무 많아! 어디서부터 시작하지?"
- 🧐 "이 JOIN이 맞나요?"
- 🐌 "이 쿼리 성능이 괜찮을까요?"
- 😰 "어떻게 의미있는 인사이트를 추출하지?"
Lang2SQL은 다음을 제공하여 이를 해결합니다:
- ✅ 자연어 입력 → 테이블 추천
- ✅ 적절한 컬럼 조합으로 자동 SQL 생성
- ✅ 모범 사례 기반 성능 최적화
# pip
pip install lang2sql
# uv
uv venv --python 3.11
source .venv/bin/activate
uv add lang2sql# 소스 클론
git clone https://github.com/CausalInferenceLab/lang2sql.git
cd lang2sql
# (권장) uv 사용
# uv 설치가 되어 있다면 아래 두 줄로 개발 모드 설치
uv venv --python 3.11
source .venv/bin/activate
uv pip install -e .
# (대안) pip 사용
python -m venv .venv
source .venv/bin/activate
pip install -e .Streamlit 웹 인터페이스 실행:
lang2sql run-streamlit사용자 정의 포트로 실행:
lang2sql run-streamlit -p 8888참고:
- Streamlit 서버는
0.0.0.0으로 바인딩되어 외부에서 접속 가능합니다. --datahub_server옵션은 더 이상 사용되지 않습니다(deprecated). DataHub 설정은 UI의 설정 > 데이터 소스 탭에서 관리하세요.
Streamlit 앱은 멀티 페이지 구조입니다. 좌측 네비게이션에서 "Graph Builder" 페이지를 열어 LangGraph 워크플로우를 구성할 수 있습니다.
- 프리셋 선택: "기본" 또는 "확장"
- 커스텀 옵션:
PROFILE_EXTRACTION,CONTEXT_ENRICHMENT,QUERY_MAKER포함 여부 토글 - 선택이 바뀌면 그래프가 즉시 컴파일되어 세션에 적용됩니다
- "세션 그래프 새로고침" 버튼으로 수동 재적용 가능
QUERY_MAKER를 비활성화하면 테이블 검색 정보만 표시됩니다
참고: CLI 레벨의 --vectordb-type 및 --vectordb-location 옵션은 더 이상 사용되지 않습니다(deprecated). Streamlit 실행 시 VectorDB 설정은 UI의 설정 > 데이터 소스 탭에서 관리하세요.
query 명령어에서는 VectorDB 옵션을 사용할 수 있습니다:
# FAISS 사용 (기본값)
lang2sql query "질문" --vectordb-type faiss
# pgvector 사용
lang2sql query "질문" --vectordb-type pgvector
# 위치 지정 예시
# FAISS: 인덱스 디렉토리 경로 지정
lang2sql query "질문" --vectordb-type faiss --vectordb-location ./dev/table_info_db
# pgvector: 연결 문자열 지정
lang2sql query "질문" --vectordb-type pgvector --vectordb-location "postgresql://user:pass@host:5432/db"참고: DataHub 없이도 미리 준비된 VectorDB(FAISS 디렉토리 혹은 pgvector 컬렉션)를 바로 사용할 수 있습니다. 자세한 준비 방법은 DataHub 없이 시작하기를 참고하세요.
튜토리얼 본문이 길어져 별도 문서로 분리되었습니다. 아래 문서를 참고하세요.
# 기본 사용 (FAISS, clickhouse, 기본 검색기)
lang2sql query "고객 데이터를 기반으로 유니크한 유저 수를 카운트하는 쿼리"
# 옵션 사용 예시
lang2sql query "고객 데이터를 기반으로 유니크한 유저 수를 카운트하는 쿼리" \
--database-env clickhouse \
--retriever-name 기본 \
--top-n 5 \
--device cpu \
--use-enriched-graph \
--vectordb-type faiss \
--vectordb-location ./dev/table_info_db
# pgvector 사용 예시
lang2sql query "고객 데이터를 기반으로 유니크한 유저 수를 카운트하는 쿼리" \
--vectordb-type pgvector \
--vectordb-location "postgresql://postgres:postgres@localhost:5432/postgres"주요 옵션 설명:
--database-env: 사용할 데이터베이스 환경 (기본값: clickhouse)--retriever-name: 테이블 검색기 이름 (기본값: 기본)--top-n: 검색된 상위 테이블 수 제한 (기본값: 5)--device: LLM 실행에 사용할 디바이스 (기본값: cpu)--use-enriched-graph: 확장된 그래프(프로파일 추출 + 컨텍스트 보강) 사용 여부--vectordb-type: 벡터 데이터베이스 타입 ("faiss" 또는 "pgvector", 기본값: faiss)--vectordb-location: VectorDB 위치 (FAISS: 디렉토리 경로, pgvector: 연결 문자열)
.env파일을 생성하여 설정을 관리합니다. (예시 파일이 있다면 참조)- 또는 CLI 옵션으로 환경을 지정할 수 있습니다:
--env-file-path: 환경 변수 파일 경로 지정--prompt-dir-path: 프롬프트 템플릿(.md) 디렉토리 지정--datahub_server: [Deprecated] DataHub GMS 서버 URL 지정. 이제는 UI의 설정 > 데이터 소스 탭에서 관리하세요.
Lang2SQL은 LangGraph를 사용한 다단계 접근 방식을 따릅니다:
- 📝 자연어 처리: 사용자 의도 파싱 및 핵심 엔티티 추출
- 🔍 테이블 검색: 의미론적 유사성을 사용한 관련 테이블 찾기 (Vector Search)
- ⚙️ SQL 생성: 최적화된 SQL 쿼리 생성
- 🚀 쿼리 시각화: 쿼리 결과를 시각화 합니다.
- Docker를 활용하여 프로젝트를 컨테이너화하고,
pip install lang2sql설치 후 단일 명령어로 실행 가능하도록 개선합니다. - CI/CD 파이프라인 구축 및 자동화된 테스트 환경 구성까지 확장할 수 있는 작업입니다.
- 쿼리 생성 과정을 에이전틱하게 개선하여 더욱 지능적이고 자율적인 SQL 생성이 가능하도록 개발합니다.
- 데이터 디스커버리 기능을 강화하여 사용자가 원하는 데이터를 더 효과적으로 찾을 수 있도록 지원합니다.
- 현재 Datahub의 Glossary와 쿼리 예시를 코드로 조회하는 기능이 구현되어 있습니다.
- 이러한 메타데이터를 쿼리 생성 과정에 더욱 긴밀하게 통합하여 컨텍스트 기반의 정확한 SQL 생성을 지원하는 작업입니다.
- 현재는 Datahub를 통해 로컬에 FAISS VectorDB를 생성해야만 사용 가능한 구조입니다.
- 이 결합도를 낮춰서 Datahub 없이도 기존에 준비된 VectorDB만 있으면 바로 활용할 수 있도록 아키텍처를 개선하는 작업입니다.
- 프로젝트 사용 패턴과 성능을 모니터링하고, 상세한 로깅 시스템을 구축합니다.
- 사용자 피드백 수집 및 분석 프로세스를 통해 지속적인 개선이 가능한 기반을 마련하는 작업입니다.
- 프로젝트 기여 장벽을 낮추기 위한 포괄적인 문서화 작업입니다.
- 개발자 가이드, 튜토리얼 등을 체계적으로 정리하여 새로운 기여자들이 쉽게 참여할 수 있는 환경을 조성합니다.
프런트에서는 LLM 호출·키를 제거하고 내부 백엔드 API로 위임해 보안·권한·모니터링을 중앙화합니다.
커뮤니티의 기여를 환영합니다! 여러분이 도울 수 있는 방법들:
- 저장소 포크하기
- 포크 클론:
git clone https://github.com/YOUR_USERNAME/lang2sql.git - 의존성 설치:
pip install -r requirements.txt - 기능 브랜치 생성:
git checkout -b feature/amazing-feature - 변경사항 커밋:
git commit -m 'Add amazing feature' - 브랜치에 푸시:
git push origin feature/amazing-feature - Pull Request 열기
버그를 발견했거나 기능 요청이 있으신가요? 다음 정보와 함께 이슈를 열어주세요:
- 문제/기능에 대한 명확한 설명
- 재현 단계 (버그의 경우)
- 예상 동작 vs 실제 동작
- 환경 세부사항
- pre-commit 활성화
- 새로운 기능에 대한 테스트 작성
- 필요시 문서 업데이트
- 원자적이고 잘 설명된 커밋 유지
- 모두를 위한 게임 데이터 검색 시스템 / if(kakaoAI)2024
- AI 데이터 분석가 '물어보새' 등장 – 1부. RAG와 Text-To-SQL 활용
- 테디노트 LangGraph
- DataHub 문서
- Vanna.ai
| Role | Name | Skills | Interests |
|---|---|---|---|
| Project Manager | 이동욱 |  |
LLM, Open Source, Causal Inference |
| AI Engineer | 문찬국 | |
LLM, Agentic RAG, Open Source |
| Data Engineer | 박경태 | |
LLM-driven Data Engineering |
| AI Engineer | 손봉균 | |
LLM, RAG, AI Planning |
| Data Scientist | 안재일 |  |
LLM, Data Analysis, RAG |
| ML Engineer | 이호민 | |
Multi-Agent Systems |
| AI Engineer | 최세영 | |
LLM, RAG, Multi-Agent |
| Full-Stack Developer | 황윤진 |   |
LLM Orchestration |
| AI Engineer | 김경서 | |
LLM, FinNLP, FDS, RAG |
| Data Engineer | 홍지영 | |
LLM, Data Engineering |
| Data Operator | 이화림 | |
LLM, Data Engineering |
uv build
UV_PUBLISH_TOKEN=$PYPI_API_TOKEN uv publish --token $UV_PUBLISH_TOKEN사전 준비: GitHub Secrets에 PYPI_API_TOKEN 등록
# 1) 버전 업데이트
# - 버전 파일: version.py 의 __version__ = "X.Y.Z"
git add version.py
git commit -m "chore: bump version to X.Y.Z"
# 2) 태그 생성/푸시 (v* 형식이 트리거)
git tag vX.Y.Z
git push origin HEAD
git push origin vX.Y.Z설명: v* 태그가 푸시되면 .github/workflows/pypi-release.yml이 실행되어 uv로 빌드/배포합니다.
uv build
UV_PUBLISH_TOKEN=$TEST_PYPI_API_TOKEN \
uv publish --repository-url https://test.pypi.org/legacy/ --token $UV_PUBLISH_TOKENLang2SQL은 가짜연구소의 인과추론팀에서 개발중인 프로젝트입니다.
- This project is licensed under the MIT License.
가짜연구소는 머신러닝과 AI 기술 발전에 중점을 둔 비영리 조직입니다. 공유, 동기부여, 그리고 협업의 기쁨이라는 핵심 가치를 바탕으로 영향력 있는 오픈소스 프로젝트를 만들어갑니다.
전 세계 5,000명 이상의 연구자들과 함께, 우리는 AI 지식의 민주화와 열린 협업을 통한 혁신 촉진에 전념하고 있습니다.
우리 커뮤니티에 참여하세요:
- 💬 Discord
⭐ 이 저장소가 도움이 되셨다면 스타를 눌러주세요!
"우리는 함께 코드와 아이디어를 나누며 더 나은 데이터 환경을 만들기 위한 오픈소스 여정을 떠납니다. 🌍💡"