NEW COMMAND

akron db init

Initialize a new Akron project with schema configuration file and migration directory structure.

Syntax

1akron db init [OPTIONS]

Options

Option	Description	Default
--provider	Database provider (sqlite, mysql, postgresql, mongodb)	sqlite
--url	Custom database connection URL	Provider default
--force	Overwrite existing akron.json file	false

Examples

Basic SQLite Project

Initialize a new project with SQLite database (default):

1akron db init

Expected Output

✅ Initialized Akron project
   Provider: sqlite
   Database: sqlite:///app.db
   Schema file: akron.json

📝 Next steps:
   1. Edit akron.json to define your schema
   2. Run 'akron db makemigrations' to generate migrations
   3. Run 'akron db migrate' to apply migrations

PostgreSQL Project

Initialize with PostgreSQL and custom connection URL:

1akron db init --provider postgresql --url "postgres://user:password@localhost:5432/myapp"

Expected Output

✅ Initialized Akron project
   Provider: postgresql
   Database: postgres://user:password@localhost:5432/myapp
   Schema file: akron.json

📝 Next steps:
   1. Edit akron.json to define your schema
   2. Run 'akron db makemigrations' to generate migrations
   3. Run 'akron db migrate' to apply migrations

Force Overwrite

Overwrite existing configuration:

1akron db init --provider mysql --force

Expected Output

✅ Initialized Akron project
   Provider: mysql
   Database: mysql://user:password@localhost:3306/database
   Schema file: akron.json

📝 Next steps:
   1. Edit akron.json to define your schema
   2. Run 'akron db makemigrations' to generate migrations
   3. Run 'akron db migrate' to apply migrations

Generated Files

akron.json

The main schema configuration file:

1{
"database": {
  "provider": "sqlite",
  "url": "sqlite:///app.db"
},
"tables": {
  "User": {
    "columns": {
      "id": {
        "type": "int",
        "primaryKey": true,
        "autoIncrement": true
      },
      "email": {
        "type": "string",
        "unique": true,
        "nullable": false
      },
      "name": {
        "type": "string",
        "nullable": true
      },
      "createdAt": {
        "type": "datetime",
        "default": "now"
      }
    }
  }
}
30}

.akron/ Directory

Migration tracking directory structure:

1.akron/
2├── schema_snapshots.json   # Schema change tracking
3└── (migration files)       # Generated migration files

Default Database URLs

Provider	Default URL	Notes
sqlite	sqlite:///app.db	Creates local file database
mysql	mysql://user:password@localhost:3306/database	Update credentials before use
postgresql	postgres://user:password@localhost:5432/database	Update credentials before use
mongodb	mongodb://localhost:27017/database	Default local MongoDB

Next Steps

After initialization:

Edit akron.json to define your database schema
Run akron db makemigrations to generate initial migrations
Run akron db migrate to create your database tables
Start building your application with Akron ORM

→ Schema Management Guide → Generate Migrations → Apply Migrations