@nine-lab/nine-connector 0.1.11 → 0.1.13

package/README.kr.md

@@ -0,0 +1,71 @@
+cat <<EOF > README.kr.md
+# @nine-lab/nine-connector 🚀
+
+[한국어 문서(Korean)](./README.kr.md) | [English Document](./README.md)
+
+자연어 기반 SQL 생성 엔진(NineQuery)과 데이터베이스 사이를 연결하는 **AI 전용 DB 커넥터 서비스**입니다.
+
+데이터베이스의 구조(Schema)를 분석하여 AI가 최적의 쿼리를 생성할 수 있도록 브릿지 역할을 수행하며, 보안이 검증된 환경에서 데이터를 안전하게 반환합니다.
+
+---
+
+## 🌟 주요 기능
+
+* **자동 초기화**: \`nine-connector init\` 명령으로 \`.env\` 설정과 AI 프롬프트 템플릿을 즉시 구축합니다.
+* **Multi-DB 지원**: MySQL, PostgreSQL, MariaDB, Oracle 등 다양한 엔터프라이즈 DB 환경에 대응합니다.
+* **비즈니스 로직 최적화**: 프롬프트 파일 수정을 통해 특정 테이블 조회 금지, 필터링 조건 강제 등 고객사별 맞춤 규칙을 적용할 수 있습니다.
+* **보안 가드**: 내부적으로 오직 \`SELECT\` 쿼리만 허용하여 데이터 변조 및 유출을 원천 차단합니다.
+* **운영 안정성**: BigInt 직렬화 및 DB별 결과 포맷 정규화를 통해 데이터 일관성을 보장합니다.
+
+---
+
+## 🛠 설치 및 사용 방법
+
+### 1. 패키지 설치
+\`\`\`bash
+npm install -g @nine-lab/nine-connector
+\`\`\`
+
+### 2. 프로젝트 초기화 (최초 1회)
+서버 실행 전 DB 접속 정보 및 프롬프트 환경 구성을 위해 실행합니다.
+\`\`\`bash
+nine-connector init
+\`\`\`
+
+### 3. 서버 실행 및 관리 (PM2 권장)
+서버의 안정적인 기동과 로그 관리를 위해 프로세스 이름을 패키지명과 동일한 **nine-connector**로 관리하는 것을 권장합니다.
+
+* **서버 시작**:
+  \`\`\`bash
+  pm2 start nine-connector --name "nine-connector"
+  \`\`\`
+* **상태 확인**:
+  \`\`\`bash
+  pm2 status
+  \`\`\`
+* **로그 확인**:
+  \`\`\`bash
+  pm2 logs nine-connector
+  \`\`\`
+* **서버 중지/재시작**:
+  \`\`\`bash
+  pm2 stop nine-connector
+  pm2 restart nine-connector
+  \`\`\`
+
+---
+
+## 📂 프로젝트 구조 및 커스터마이징
+
+기본적으로 \`nine-query\` 컴포넌트와 연동되어 동작하며, 아래 파일들을 통해 세부 동작을 제어할 수 있습니다.
+
+* **.env**: DB 접속 정보 및 AI 모델(Gemini) 설정값
+* **prompts/table-filter.md**: 질문에 적합한 테이블을 찾아내는 AI의 판단 로직
+* **prompts/query-generator.md**: 실제 SQL을 생성하는 AI의 페르소나 및 규칙
+    * **💡 Tip**: 이 파일의 \`[고객사 전용 비즈니스 로직 및 보안 규칙]\` 섹션에 "특정 민감 테이블 조회 금지"나 "기본 정렬/필터링 기준"을 명시하여 AI의 답변을 통제할 수 있습니다.
+
+---
+
+## 📄 라이선스
+MIT © **nine-lab**
+EOF

package/README.md

@@ -1,60 +1,72 @@
 cat <<EOF > README.md
 # @nine-lab/nine-connector 🚀
 
-자연어 기반 SQL 생성 엔진(NineQuery)과 데이터베이스 사이를 연결하는 **AI 전용 DB 커넥터 서비스**입니다.
+[한국어 문서(Korean)](./README.kr.md) | [English Document](./README.md)
 
-사용자의 질문을 분석하여 최적의 테이블을 필터링하고, 안전한 SQL을 생성하여 즉시 실행 결과를 반환하는 통합 환경을 제공합니다.
+**NineConnector** is an AI-specialized database connector service that bridges the gap between natural language SQL generation engines (**NineQuery**) and your database.
+
+It analyzes database schemas to provide AI models with the necessary metadata for optimal query generation and ensures secure data retrieval within a verified environment.
 
 ---
 
-## 🌟 주요 기능
+## 🌟 Key Features
 
-* **자동 초기화**: \`nine-connector init\` 명령으로 \`.env\` 설정과 AI 프롬프트를 자동 구축합니다.
-* **Multi-DB 지원**: MySQL, PostgreSQL, MariaDB, Oracle 등 다양한 DB 환경에 대응합니다.
-* **비즈니스 로직 최적화**: 프롬프트 파일 수정을 통해 특정 테이블 조회 금지, 필터링 조건 강제 등 고객사별 맞춤 규칙을 적용할 수 있습니다.
-* **보안 가드**: 내부적으로 오직 \`SELECT\` 쿼리만 허용하여 데이터 변조를 차단합니다.
-* **데이터 타입 최적화**: \`BigInt\` 등 JSON 변환이 까다로운 타입을 포함하여 모든 데이터를 안전하게 반환합니다.
+* **Auto-Initialization**: Instantly set up your environment with \`.env\` configurations and AI prompt templates using the \`nine-connector init\` command.
+* **Multi-DB Support**: Out-of-the-box compatibility with enterprise database environments including **MySQL, PostgreSQL, MariaDB, and Oracle**.
+* **Business Logic Optimization**: Fine-tune AI behavior by customizing prompt files to enforce rules such as table access restrictions or mandatory filtering logic.
+* **Security Guardrail**: Strictly restricts execution to \`SELECT\` queries to prevent unauthorized data modification or leakage.
+* **Operational Stability**: Ensures data consistency through **BigInt serialization** and standardized result formatting across different DB dialects.
 
 ---
 
-## 🛠 설치 및 사용 방법
+## 🛠 Installation & Quick Start
 
-### 1. 패키지 설치
+### 1. Install Package
+Install the package globally to access the CLI commands from anywhere.
 \`\`\`bash
 npm install -g @nine-lab/nine-connector
 \`\`\`
 
-### 2. 프로젝트 초기화
-접속 정보 설정 및 프롬프트 템플릿 생성을 위해 실행합니다.
+### 2. Initialize Project (First-time setup)
+Run the initialization command to configure DB connection settings and generate prompt templates.
 \`\`\`bash
 nine-connector init
 \`\`\`
 
-### 3. 서버 실행
-\`\`\`bash
-nine-connector
-\`\`\`
+### 3. Server Execution & Management (PM2 Recommended)
+For production environments, we highly recommend using **PM2** to ensure high availability and efficient log management.
+
+* **Start Server**:
+  \`\`\`bash
+  pm2 start nine-connector --name "nine-connector"
+  \`\`\`
+* **Check Status**:
+  \`\`\`bash
+  pm2 status
+  \`\`\`
+* **View Logs**:
+  \`\`\`bash
+  pm2 logs nine-connector
+  \`\`\`
+* **Stop / Restart**:
+  \`\`\`bash
+  pm2 stop nine-connector
+  pm2 restart nine-connector
+  \`\`\`
 
 ---
 
-## 🔌 API 명세 (Public API)
+## 📂 Project Structure & Customization
 
-### 1. 자연어 질의 처리 (Main)
-사용자의 질문을 받아 **테이블 선정 -> SQL 생성 -> 데이터 조회**를 한 번에 수행합니다.
-* **Endpoint:** \`POST /api/ask\`
-* **Body:** \`{ "question": "올해 매출이 가장 높은 카테고리 알려줘" }\`
-* **Response:** SQL문, AI의 설명, 그리고 조회된 결과 데이터를 포함합니다.
-
----
+Designed to work seamlessly with the \`nine-query\` component, you can control the AI's behavior via the following files:
 
-## 📂 프로젝트 구조 및 커스터마이징
-* **.env**: DB 접속 및 AI 모델 설정값
-* **prompts/table-filter.md**: 질문에 필요한 테이블을 고르는 AI 로직
-* **prompts/query-generator.md**: 실제 SQL을 생성하는 AI 페르소나
-    * **Tip**: 파일 내 \`[고객사 전용 비즈니스 로직 및 보안 규칙]\` 섹션에 "특정 테이블 조회 금지"나 "기본 정렬 기준" 등을 작성하여 AI의 동작을 제어할 수 있습니다.
+* **.env**: Database credentials and AI model (e.g., Gemini) configurations.
+* **prompts/table-filter.md**: AI logic for identifying relevant tables based on user intent.
+* **prompts/query-generator.md**: Persona and rules for the SQL generation AI.
+    * **💡 Tip**: Use the \`[Custom Business Logic & Security Rules]\` section in this file to enforce specific constraints, such as "Do not access sensitive user tables" or "Always apply a default sort order."
 
 ---
 
-## 📄 라이선스
+## 📄 License
 MIT © **nine-lab**
-EOF
+EOF

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nine-lab/nine-connector",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "NineQuery AI Connector for Database",
   "main": "src/index.js",
   "type": "module",

package/src/database/core/PoolManager.js

@@ -67,7 +67,8 @@ class PoolManager {
             password: config.password,
             database: config.database,
             connectionLimit: 10,
-            connectTimeout: 10000
+            connectTimeout: 10000,
+            ssl: config.ssl || undefined
         });
     }
 

package/src/index.js

@@ -34,7 +34,10 @@ async function bootstrap() {
         port: Number(process.env.DB_PORT),
         user: process.env.DB_USER,
         password: process.env.DB_PASS,
-        database: process.env.DB_NAME
+        database: process.env.DB_NAME,
+        ssl: {
+            rejectUnauthorized: false
+        }
     });
 
     // BigInt 직렬화 설정