Aureline

Schema Overview

How Aureline schema files are organized.

Aureline schema files describe SurrealDB definitions that can be checked and emitted into migrations.

/// Optional documentation comments.
table User schemafull {
  email string @unique
}

analyzer text_search {
  tokenizers blank, class
  filters lowercase, snowball(english)
}

Supported top-level declarations today:

DeclarationPurpose
tableDefines a SurrealDB table, fields, and table-level indexes.
analyzerDefines an analyzer for full-text indexes.
/// commentsPreserved as documentation comments in the AST.

Raw top-level #surql { ... } passthrough is not migration-ready in this release. Use the WIP pages for future directions.

Modular reference

On this page