CSharpDB CLI Reference

# Build framework-dependent (requires .NET 10 runtime on target)
dotnet publish src/CSharpDB.Cli -c Release -o ./publish

# Build self-contained (no runtime required on target)
dotnet publish src/CSharpDB.Cli -c Release -r win-x64 --self-contained -o ./publish

# Build self-contained for Linux
dotnet publish src/CSharpDB.Cli -c Release -r linux-x64 --self-contained -o ./publish

# Open or create a database
csharpdb mydata.db

# Without arguments, uses csharpdb.db in the current directory
csharpdb

# Connect via HTTP (REST API)
csharpdb -- --endpoint http://localhost:61818

# Connect via gRPC (Daemon)
csharpdb -- --endpoint https://localhost:49995 --transport grpc

# Connect via Named Pipes
csharpdb -- --endpoint mypipe --transport namedpipes

csharpdb -- inspect mydata.db
csharpdb -- inspect-page mydata.db 5 --hex
csharpdb -- check-wal mydata.db
csharpdb -- check-indexes mydata.db --json
csharpdb -- maintenance-report mydata.db
csharpdb -- reindex mydata.db --all
csharpdb -- vacuum mydata.db
csharpdb -- migrate-foreign-keys mydata.db --spec fk-spec.json --validate-only
csharpdb -- etl run mydata.db pipeline.json

csdb> CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT NOT NULL, age INTEGER);
OK (0 ms)

csdb> INSERT INTO users VALUES (1, 'Alice', 30);
1 row(s) affected (1 ms)

csdb> SELECT * FROM users;
┌────┬───────┬─────┐
│ id │ name  │ age │
├────┼───────┼─────┤
│  1 │ Alice │  30 │
└────┴───────┴─────┘
1 row(s) returned (0 ms)

csdb> .quit

{
  "validateOnly": true,
  "violationSampleLimit": 100,
  "constraints": [
    {
      "tableName": "orders",
      "columnName": "customer_id",
      "referencedTableName": "customers",
      "referencedColumnName": "id",
      "onDelete": "Restrict"
    }
  ]
}

csharpdb -- migrate-foreign-keys mydata.db --spec fk-spec.json --validate-only

csdb> .migrate-fks fk-spec.json --backup pre-fk.backup.db

SELECT * FROM sys.tables ORDER BY table_name;
SELECT * FROM sys.columns WHERE table_name = 'users' ORDER BY ordinal_position;
SELECT * FROM sys.indexes WHERE table_name = 'users';
SELECT * FROM sys.foreign_keys ORDER BY table_name, column_name;
SELECT * FROM sys.views;
SELECT * FROM sys.triggers;
SELECT * FROM sys.objects ORDER BY object_type, object_name;
SELECT * FROM sys.saved_queries ORDER BY name;

# Generate a maintenance report
csharpdb -- maintenance-report mydata.db

# Rebuild all indexes
csharpdb -- reindex mydata.db --all

# Rebuild indexes for a specific table
csharpdb -- reindex mydata.db --table users

# Recover a corrupt index
csharpdb -- reindex mydata.db --index idx_users_name --force-corrupt-rebuild

# Compact the database file
csharpdb -- vacuum mydata.db

# Validate a pipeline package without executing
csharpdb -- etl validate mydata.db pipeline.json

# Simulate execution without writing to the destination
csharpdb -- etl dry-run mydata.db pipeline.json

# Execute the full pipeline and commit results
csharpdb -- etl run mydata.db pipeline.json

csdb> .tables
  users
  orders
  products

csdb> .schema users
CREATE TABLE users (
  id INTEGER PRIMARY KEY IDENTITY,
  name TEXT NOT NULL,
  age INTEGER
)

csdb> .indexes users
  idx_users_name  ON users(name)  UNIQUE

csdb> .info
  Tables:      3
  Indexes:     2
  Views:       1
  Triggers:    1
  Collections: 0
  Mode: WAL enabled, timing off, snapshot off

csdb> .begin
Transaction started.

csdb> INSERT INTO users VALUES (10, 'Test', 99);
1 row(s) affected

csdb> .rollback
Transaction rolled back.

csdb> SELECT * FROM users WHERE id = 10;
0 row(s) returned

csdb> .read samples/ecommerce-store/schema.sql
Executing 84 statements...
84 succeeded, 0 failed.

csdb> .snapshot on
Snapshot mode enabled.

csdb> SELECT COUNT(*) FROM users;
┌──────────┐
│ COUNT(*) │
├──────────┤
│       42 │
└──────────┘

csdb> .snapshot off
Snapshot mode disabled.

# Connect to the REST API
csharpdb -- --endpoint http://localhost:61818

# Connect to the gRPC daemon
csharpdb -- --endpoint https://localhost:49995 --transport grpc

csdb> .vacuum
Vacuum complete. Before: 40960 bytes (10 pages) → After: 32768 bytes (8 pages)

csdb> .reindex --table users
Rebuilt 2 index(es).

csdb> .backup mydata.backup.db --with-manifest
Backup written to mydata.backup.db
Manifest written to mydata.backup.db.manifest.json

# Import and run a pipeline
csharpdb -- etl import mydata.db pipeline.json
csharpdb -- etl run mydata.db pipeline.json

# Check run history
csharpdb -- etl list mydata.db