Aureline

Aureline is an experimental ORM/toolkit for SurrealDB. The 0.1.0-dev.3 documentation focuses on the parts that are usable today: writing schema.aureline, checking it, generating migrations, and applying those migrations.

What works now

• Schema files with table, field, analyzer, field-index, and table-index declarations.
• aureline check for parser and semantic validation.
• Snapshot-based migrations with generated migration.surql, down.surql, snapshots, journal, and lockfile.
• aureline migrate apply with checksum checks and _aureline_migrations tracking.

Still WIP

Code generation, typed clients, advanced runtime APIs, and richer permission/assertion migration output are still in development. WIP pages describe the intended direction, but they are not a stable contract yet.

Minimal schema

/// User accounts.
table User schemafull {
  email string @unique
}

Expected migration output includes:

DEFINE TABLE user SCHEMAFULL;
DEFINE FIELD email ON user TYPE string;
DEFINE INDEX user_email_unique ON user FIELDS email UNIQUE;