db-connector-for-ai-coding

A CLI tool for database connection, DDL extraction, and query validation to assist AI coding assistants.

Overview

db-connector-for-ai-coding is a Node.js CLI tool that bridges the gap between database schemas and AI code generation. It provides programmatic access to database structure information, enabling AI assistants (like Claude, ChatGPT, etc.) to work with real database structures without manual intervention.

Features

• Database Connection Management: Connect to MySQL and PostgreSQL databases using configuration files
• DDL Extraction: Extract table creation statements (DDL) with indexes, foreign keys, and constraints
• Query Validation: Analyze SQL queries against table indexes to identify performance risks
• AI-Friendly Output: Generate schema information in formats optimized for AI consumption
• CLI Interface: Comprehensive command-line interface for all database operations

Installation

# Install globally
npm install -g db-connector-for-ai-coding

# Install locally in your project
npm install db-connector-for-ai-coding

Quick Start

# Generate sample configuration
db-connector config:init

# Test database connection
db-connector connect --config db-connect.config.yaml

# Extract DDL for all tables
db-connector extract-ddl --config db-connect.config.yaml

# Validate a SQL query
db-connector validate-query --config db-connect.config.yaml --query "SELECT * FROM users WHERE email = ?"

Configuration

Create a configuration file (db-connect.config.yaml or db-connect.config.json) with your database connection details:

type: mysql  # or postgres
host: localhost
port: 3306
username: your_username
password: your_password
database: your_database

CLI Commands

• db-connect connect - Test database connectivity
• db-connect extract-ddl - Extract table DDL statements
• db-connect validate-query - Validate SQL queries against indexes
• db-connect config:init - Generate sample configuration file
• db-connect config:validate - Validate configuration syntax

Documentation

• Configuration Guide - Detailed configuration options
• CLI Commands - Complete command reference
• AI Integration - Using with AI coding assistants
• API Reference - Programmatic API documentation

Requirements

• Node.js: >= 14.0.0
• MySQL: 5.7+ (recommended 8.0+)
• PostgreSQL: 12+ (recommended 13+)

Supported Versions

| Database | Minimum | Recommended | |----------|---------|-------------| | MySQL | 5.7 | 8.0+ | | PostgreSQL | 12 | 13+ | | Node.js | 14.0.0 | 16+ |

License

MIT

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details.

Support

For bugs and feature requests, please create an issue on GitHub.

Changelog

See CHANGELOG.md for version history.

Status

Current Version: 0.1.0-beta Development Status: Active development Stability: Beta - Core features functional, testing in progress