sqlew 3.7.2 → 3.7.4

package/docs/AUTO_FILE_TRACKING.md

@@ -837,4 +837,3 @@ task action=create
 - [WORKFLOWS.md](./WORKFLOWS.md) - Multi-agent coordination patterns
 - [BEST_PRACTICES.md](./BEST_PRACTICES.md) - Common errors and solutions
 - [TASK_MIGRATION.md](./TASK_MIGRATION.md) - Migrate from decision-based tracking
-- [MIGRATION_v3.3.md](./MIGRATION_v3.3.md) - Migration guide from v3.2.x to v3.4.1

package/docs/DATABASE_AUTH.md

@@ -440,6 +440,5 @@ Planned authentication methods:
 ## Related Documentation
 
 - [Configuration Guide](./CONFIGURATION.md)
-- [Database Setup](./DATABASE_SETUP.md)
-- [Architecture Overview](../ARCHITECTURE.md)
+- [Architecture Overview](./ARCHITECTURE.md)
 - [Type Definitions](../src/config/types.ts)

package/docs/TOOL_REFERENCE.md

@@ -585,8 +585,6 @@ Manage file watches dynamically:
 }
 ```
 
-**See Also:** [MIGRATION_v3.3.md](./MIGRATION_v3.3.md) for complete migration guide.
-
 ---
 
 ## Decision Context System (v3.2.2)

package/docs/{DATABASE_MIGRATION.md → cli/DATABASE_MIGRATION.md}

@@ -1,20 +1,45 @@
 # Database Migration Guide
 
-This guide explains how to generate complete SQL dumps from your mcp-sqlew database for use with SQLite, MySQL/MariaDB, or PostgreSQL.
+This guide explains how to generate complete SQL dumps from your mcp-sqlew database for use with SQLite, MySQL/MariaDB,
+or PostgreSQL.
 
 ## Overview
 
-The `db:dump` CLI tool generates complete SQL dumps (CREATE TABLE + INSERT statements) compatible with SQLite, MySQL/MariaDB, and PostgreSQL formats. The generated SQL can be imported directly into an empty database without additional setup.
+The `db:dump` CLI tool generates complete SQL dumps (CREATE TABLE + INSERT statements) compatible with SQLite,
+MySQL/MariaDB, and PostgreSQL formats. The generated SQL can be imported directly into an empty database without
+additional setup.
+
+## Installation
+
+To use the `db:dump` CLI command, install sqlew in your project:
+
+```bash
+cd /path/to/your/project
+npm install sqlew
+```
+
+**Tip**: Add a shortcut to your `package.json` for convenience:
+
+```json
+{
+  "scripts": {
+    "sqlew": "node node_modules/sqlew/dist/cli.js"
+  }
+}
+```
+
+Then you can use: `npm run sqlew db:dump --format=mysql --output=dump.sql`
 
 ## Usage
 
 ### Basic Syntax
 
 ```bash
-npx sqlew db:dump [--from <source>] --format <target> [options]
+node node_modules/sqlew/dist/cli.js db:dump [--from <source>] --format <target> [options]
 ```
 
 **Parameters:**
+
 - `--from <source>`: Source database (sqlite, mysql, postgresql). Default: sqlite
 - `--format <target>`: Target SQL format (sqlite, mysql, postgresql). **Required**
 - `--output <file>`: Output file path (omit for stdout)
@@ -29,12 +54,14 @@ npx sqlew db:dump [--from <source>] --format <target> [options]
 ### Generate SQL Dumps
 
 **From SQLite (default):**
+
 ```bash
-npx sqlew db:dump --format mysql --output dump-mysql.sql
-npx sqlew db:dump --format postgresql --output dump-pg.sql
+node node_modules/sqlew/dist/cli.js db:dump --format mysql --output dump-mysql.sql
+node node_modules/sqlew/dist/cli.js db:dump --format postgresql --output dump-pg.sql
 ```
 
 **From MySQL:**
+
 ```bash
 # Configure connection via environment variables
 export MYSQL_HOST=127.0.0.1
@@ -43,11 +70,12 @@ export MYSQL_USER=youruser
 export MYSQL_PASSWORD=yourpass
 export MYSQL_DATABASE=mcp_context
 
-npx sqlew db:dump --from mysql --format sqlite --output dump-sqlite.sql
-npx sqlew db:dump --from mysql --format postgresql --output dump-pg.sql
+node node_modules/sqlew/dist/cli.js db:dump --from mysql --format sqlite --output dump-sqlite.sql
+node node_modules/sqlew/dist/cli.js db:dump --from mysql --format postgresql --output dump-pg.sql
 ```
 
 **From PostgreSQL:**
+
 ```bash
 # Configure connection via environment variables
 export PG_HOST=localhost
@@ -56,8 +84,8 @@ export PG_USER=postgres
 export PG_PASSWORD=yourpass
 export PG_DATABASE=mcp_context
 
-npx sqlew db:dump --from postgresql --format sqlite --output dump-sqlite.sql
-npx sqlew db:dump --from postgresql --format mysql --output dump-mysql.sql
+node node_modules/sqlew/dist/cli.js db:dump --from postgresql --format sqlite --output dump-sqlite.sql
+node node_modules/sqlew/dist/cli.js db:dump --from postgresql --format mysql --output dump-mysql.sql
 ```
 
 ### Selective Table Export
@@ -65,7 +93,7 @@ npx sqlew db:dump --from postgresql --format mysql --output dump-mysql.sql
 Export only specific tables:
 
 ```bash
-npx sqlew db:dump --format mysql --tables t_decisions,t_tasks,m_agents --output partial.sql
+node node_modules/sqlew/dist/cli.js db:dump --format mysql --tables t_decisions,t_tasks,m_agents --output partial.sql
 ```
 
 ### Custom Chunk Size
@@ -73,7 +101,7 @@ npx sqlew db:dump --format mysql --tables t_decisions,t_tasks,m_agents --output
 For large tables, adjust INSERT batch size:
 
 ```bash
-npx sqlew db:dump --format mysql --chunk-size 500 --output dump.sql
+node node_modules/sqlew/dist/cli.js db:dump --format mysql --chunk-size 500 --output dump.sql
 ```
 
 ### Data-Only Dumps
@@ -81,10 +109,11 @@ npx sqlew db:dump --format mysql --chunk-size 500 --output dump.sql
 For advanced use cases where you manage schema separately:
 
 ```bash
-npx sqlew db:dump --format mysql --exclude-schema --output data-only.sql
+node node_modules/sqlew/dist/cli.js db:dump --format mysql --exclude-schema --output data-only.sql
 ```
 
 This generates INSERT statements without CREATE TABLE, useful for:
+
 - Importing into databases with existing schema
 - Backup/restore of data only
 - Data transfer between identical schemas
@@ -95,21 +124,23 @@ Handle duplicate keys when importing into existing databases:
 
 ```bash
 # Ignore duplicates (safe for adding new data)
-npx sqlew db:dump --format mysql --on-conflict ignore --output dump.sql
+node node_modules/sqlew/dist/cli.js db:dump --format mysql --on-conflict ignore --output dump.sql
 
 # Update existing rows (sync/overwrite mode)
-npx sqlew db:dump --format mysql --on-conflict replace --output dump.sql
+node node_modules/sqlew/dist/cli.js db:dump --format mysql --on-conflict replace --output dump.sql
 
 # Fail on duplicates (default, strict mode)
-npx sqlew db:dump --format mysql --on-conflict error --output dump.sql
+node node_modules/sqlew/dist/cli.js db:dump --format mysql --on-conflict error --output dump.sql
 ```
 
 **Modes:**
+
 - `error` (default): Standard INSERT, fails if duplicate keys exist
 - `ignore`: Skip duplicate rows (INSERT IGNORE / ON CONFLICT DO NOTHING)
 - `replace`: Update existing rows with new values (ON DUPLICATE KEY UPDATE / ON CONFLICT DO UPDATE)
 
 **Use cases:**
+
 - `ignore`: Importing into a database that may already have some data
 - `replace`: Synchronizing data from one database to another
 - `error`: Fresh database migration where duplicates indicate a problem
@@ -120,14 +151,14 @@ npx sqlew db:dump --format mysql --on-conflict error --output dump.sql
 
 The `db:dump` tool supports **all 6 migration paths** between SQLite, MySQL/MariaDB, and PostgreSQL:
 
-| Source | Target | Command |
-|--------|--------|---------|
-| SQLite | MySQL | `--format mysql` |
-| SQLite | PostgreSQL | `--format postgresql` |
-| MySQL | SQLite | `--from mysql --format sqlite` |
-| PostgreSQL | SQLite | `--from postgresql --format sqlite` |
-| MySQL | PostgreSQL | `--from mysql --format postgresql` |
-| PostgreSQL | MySQL | `--from postgresql --format mysql` |
+| Source     | Target     | Command                             |
+|------------|------------|-------------------------------------|
+| SQLite     | MySQL      | `--format mysql`                    |
+| SQLite     | PostgreSQL | `--format postgresql`               |
+| MySQL      | SQLite     | `--from mysql --format sqlite`      |
+| PostgreSQL | SQLite     | `--from postgresql --format sqlite` |
+| MySQL      | PostgreSQL | `--from mysql --format postgresql`  |
+| PostgreSQL | MySQL      | `--from postgresql --format mysql`  |
 
 ---
 
@@ -137,25 +168,26 @@ The tool automatically handles database-specific data type conversions:
 
 ### Boolean Values
 
-| SQLite | MySQL | PostgreSQL |
-|--------|-------|------------|
-| 0/1 | 0/1 (TINYINT) | FALSE/TRUE |
+| SQLite | MySQL         | PostgreSQL |
+|--------|---------------|------------|
+| 0/1    | 0/1 (TINYINT) | FALSE/TRUE |
 
 ### Binary Data
 
-| SQLite | MySQL | PostgreSQL |
-|--------|-------|------------|
+| SQLite     | MySQL         | PostgreSQL     |
+|------------|---------------|----------------|
 | BLOB (hex) | X'hex' (BLOB) | '\xhex'::bytea |
 
 ### Identifiers
 
-| SQLite | MySQL | PostgreSQL |
-|--------|-------|------------|
-| "table" | \`table\` | "table" |
+| SQLite  | MySQL     | PostgreSQL |
+|---------|-----------|------------|
+| "table" | \`table\` | "table"    |
 
 ### Text and Numeric Types
 
 All databases handle TEXT, VARCHAR, INTEGER, and REAL types consistently. The tool preserves:
+
 - Unix epoch timestamps (stored as INTEGER)
 - UTF-8 text encoding
 - NULL values
@@ -167,11 +199,13 @@ All databases handle TEXT, VARCHAR, INTEGER, and REAL types consistently. The to
 The generated SQL is complete and self-contained. Import it directly into an **empty database**:
 
 **SQLite:**
+
 ```bash
 sqlite3 your-database.db < dump-sqlite.sql
 ```
 
 **MySQL/MariaDB:**
+
 ```bash
 # Create empty database first
 mysql -e "CREATE DATABASE mydb CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
@@ -180,6 +214,7 @@ mysql mydb < dump-mysql.sql
 ```
 
 **PostgreSQL:**
+
 ```bash
 # Create empty database first
 createdb mydb
@@ -193,13 +228,16 @@ Use `--on-conflict ignore` or `--on-conflict replace` when generating the dump (
 ## Transaction Safety
 
 All generated SQL dumps are wrapped in database transactions:
+
 - **MySQL/MariaDB**: `START TRANSACTION;` ... `COMMIT;`
 - **PostgreSQL**: `BEGIN;` ... `COMMIT;`
 - **SQLite**: `BEGIN TRANSACTION;` ... `COMMIT;`
 
-If the import fails at any point, all changes are automatically rolled back, leaving the database in its original state. This prevents partial imports that would leave the database in an inconsistent state.
+If the import fails at any point, all changes are automatically rolled back, leaving the database in its original state.
+This prevents partial imports that would leave the database in an inconsistent state.
 
 **Benefits:**
+
 - Atomic imports: Either all data is imported successfully or nothing is changed
 - Safe to retry: Failed imports don't leave partial data that needs cleanup
 - Consistent state: Database is never left in an intermediate state
@@ -243,5 +281,6 @@ PG_DATABASE=mcp_context     # Default: mcp_context
 ## Support
 
 For issues or questions:
+
 - GitHub Issues: https://github.com/sin5ddd/mcp-sqlew/issues
 - Documentation: `/docs` directory in repository