Tauri SQLite ORM

API Reference

Quick reference for all ORM methods and functions

ORM Instance Methods

Method	Returns	Description
`db.select(table, columns?)`	`SelectQueryBuilder`	Start a SELECT query
`db.insert(table)`	`InsertQueryBuilder`	Start an INSERT query
`db.update(table)`	`UpdateQueryBuilder`	Start an UPDATE query
`db.delete(table)`	`DeleteQueryBuilder`	Start a DELETE query
`db.upsert(table, data, conflictTarget)`	`Promise`	Insert or update on conflict

Method	Returns	Description
`db.transaction(callback)`	`Promise<T>`	Execute operations in a transaction
`db.migrate(options?)`	`Promise<void>`	Run database migrations
`db.migrateIfDirty()`	`Promise<boolean>`	Run migrations only if schema changed
`db.isSchemaDirty()`	`Promise<{dirty, current, stored}>`	Check if schema has changed
`db.$with(alias)`	`WithQueryBuilder`	Start a CTE (Common Table Expression)

Method	Returns	Description
`.where(condition)`	`this`	Filter results with a condition
`.orderBy(column, direction?)`	`this`	Sort results (ASC or DESC)
`.limit(count)`	`this`	Limit number of results
`.offset(count)`	`this`	Skip first N results
`.distinct()`	`this`	Return only distinct rows
`.groupBy(...columns)`	`this`	Group results by columns
`.having(condition)`	`this`	Filter grouped results
`.leftJoin(table, condition, alias)`	`this`	Add a LEFT JOIN
`.innerJoin(table, condition, alias)`	`this`	Add an INNER JOIN
`.include(relations)`	`this`	Load relations
`.all()`	`Promise<T[]>`	Execute and return all rows
`.get()`	`Promise<T \| undefined>`	Execute and return first row
`.first()`	`Promise<T \| undefined>`	Alias for `.get()`
`.exists()`	`Promise<boolean>`	Check if any rows exist
`.count()`	`Promise<number>`	Count matching rows
`.pluck(column)`	`Promise<T[]>`	Get array of single column values
`.paginate(page, pageSize)`	`Promise<PaginationResult>`	Get paginated results
`.toSQL()`	`{sql, params}`	Get SQL without executing

Method	Returns	Description
`.values(data)`	`this`	Set data to insert (single object or array)
`.returning(...columns)`	`this`	Return specific columns after insert
`.returningAll()`	`Promise<T[]>`	Return all columns after insert (array)
`.returningFirst()`	`Promise<T \| undefined>`	Return first inserted record (single object)
`.onConflictDoNothing(target?)`	`this`	Ignore conflicts
`.onConflictDoUpdate(config)`	`this`	Update on conflict (upsert)
`.execute()`	`Promise<Result>`	Execute the insert
`.toSQL()`	`{sql, params}`	Get SQL without executing

Method	Returns	Description
`.set(data)`	`this`	Set column values to update
`.where(condition)`	`this`	Filter which rows to update (required!)
`.increment(column, value?)`	`this`	Atomically increment a column
`.decrement(column, value?)`	`this`	Atomically decrement a column
`.allowGlobalOperation()`	`this`	Allow UPDATE without WHERE clause
`.returning(...columns)`	`this`	Return specific columns after update
`.returningAll()`	`Promise<T[]>`	Return all columns after update (array)
`.returningFirst()`	`Promise<T \| undefined>`	Return first updated record (single object)
`.execute()`	`Promise<Result>`	Execute the update
`.toSQL()`	`{sql, params}`	Get SQL without executing

Method	Returns	Description
`.where(condition)`	`this`	Filter which rows to delete (required!)
`.allowGlobalOperation()`	`this`	Allow DELETE without WHERE clause
`.returning(...columns)`	`this`	Return specific columns from deleted rows
`.returningAll()`	`Promise<T[]>`	Return all columns from deleted rows (array)
`.returningFirst()`	`Promise<T \| undefined>`	Return first deleted record (single object)
`.execute()`	`Promise<Result>`	Execute the delete
`.toSQL()`	`{sql, params}`	Get SQL without executing

asTauriDatabase(db) - Type assertion for @tauri-apps/plugin-sql Database when TypeScript reports structural incompatibility. Use: new TauriORM(asTauriDatabase(dbInstance), schema)
sql - Raw SQL template literal
asc(column) - Ascending sort helper
desc(column) - Descending sort helper
relations(table, callback) - Define table relations (v1)
defineRelations(schema, callback) - Define all relations in one place (v2, from/to, many-without-one, through)
defineRelationsPart(schema, callback) - Define a part of relations for large schemas
through(column, junctionColumn, junctionTable) - Many-to-many via junction table
optional: false - One relation required at type level
where: (alias) => Condition - Predefined filter on many relations

InferSelectModel<T> - Infer SELECT result type
InferInsertModel<T> - Infer INSERT data type
InferRelationalSelectModel<TTable, TRelations, TWith, TAllRelations?> - Infer SELECT result type with relations from .include(with)

Subqueries & Aggregates

Using subqueries and aggregate functions