CRUD Operations

AN5 ORM provides a clean, type-safe API for all CRUD operations tailored for Swift.


Client Setup

import An5Client

let db = try An5Db(connectionString: try An5Config.connectionString())

An5Config reads AN5_DATABASE_URL; An5Db(path:) opens a file directly. Both are reference types that live as long as the process.


1. Create

Create a Single Record

let user = try db.user.create(User(email: "john@example.com", name: "John Doe"))
print(user.id ?? "unknown")

Create Many Records

let created = try db.user.createMany([
    User(email: "alice@example.com", name: "Alice"),
    User(email: "bob@example.com", name: "Bob"),
])
print("Created \(created) users")

skipDuplicates defaults to false.


2. Read

Find by Primary Key or Unique Field

var byEmail = An5Orm.UserWhere()
byEmail.email = An5Orm.StringFilter.`is`("john@example.com")

let user = try db.user.findUnique(filter: byEmail.build())

findUnique returns nil when nothing matches.

Find Many Records with Filter & Sort

var active = An5Orm.UserWhere()
active.isActive = An5Orm.BoolFilter.`is`(true)
active.email = An5Orm.StringFilter.has("@example.com")

let users = try db.user.findMany(Query(
    filter: active.build(),
    orderBy: [["createdAt": "desc"]],
    skip: 0,
    take: 10
))

Query is a value: filter, sort, paging and projection are all arguments to it.


3. Update

Update Single Record

var byId = An5Orm.UserWhere()
byId.id = An5Orm.StringFilter.`is`(user.id)

let updated = try db.user.update(
    filter: byId.build(),
    data: User(name: "Johnny Doe")
)

Columns left out of data are left out of the statement.


4. Delete

Delete Single Record

var byId = An5Orm.UserWhere()
byId.id = An5Orm.StringFilter.`is`(user.id)

_ = try db.user.delete(filter: byId.build())

deleteMany(filter:) returns how many rows went away.


Next Steps