Skip to content
unreal-orm
Search
Ctrl
K
Cancel
GitHub
Getting Started
Introduction
Capabilities
Guides
Cookbook
Mastering Graph Relations
Migrating 0.x → 1.0.0 alpha
Migrations & Schema Sync
Common Patterns
Security & Permissions
Testing Strategies
Unreal-ORM Tutorial
CLI Reference
CLI Reference
unreal docs
unreal github
unreal init
unreal view
Contributing
Contributing Guide
Design Principles
API Reference
functions
applySchema
clearConfig
compareSchemas
configure
extractIndexFromDefinition
extractSchemaFromDefinables
extractTableFromModel
extractTableName
filterChangesByType
generateFullSchemaQl
generateMigrationSurql
generateSurqlFromAST
getDatabase
groupChangesByTable
hasDatabase
isIndexDefinition
isModelClass
isSurrealLike
parseFieldDefinition
parseIndexDefinition
parseTableDefinition
schemasAreEqual
typed
interfaces
ConfigureOptions
CountQueryOptions
EventAST
FieldAST
FieldOptions
IndexAST
InsertQueryOptions
JsonPatchOperation
OrderByClause
PermissionsAST
SchemaAST
SchemaChange
SelectQueryOptions
TableAST
TypedExpr
unreal-orm
type-aliases
AnyModelClass
ChangeType
FieldSelect
InferOmitResult
InferSelectResult
ModelInstance
ModelStatic
OmitSelect
PatchUpdateOptions
ReturnType
SchemaApplicationMethod
SelectOption
StandardUpdateOptions
SurrealLike
TableType
UpdateMode
UpdateOptions
UpdateOptionsForMode
variables
Index
Field
Table
Unreal
Changelog
v0.4.4
v0.5.0
v0.5.1
v0.5.2
v0.6.0
v1.0.0-alpha.1
v1.0.0-alpha.2
v1.0.0-alpha.3 – alpha.5
v1.0.0-alpha.6
v1.0.0-alpha.7
v1.0.0-alpha.8
v1.0.0-alpha.9
GitHub
🚀 This documentation is for
unreal-orm 1.0.0 alpha
which requires
SurrealDB 2.0 SDK
. For use with version 1.x, see
here
.
unreal github
Open the UnrealORM GitHub repository
Usage
Section titled “Usage”
Terminal window
unreal
github
