--- title: "API Reference" description: "Quick reference for all ORM methods and functions" canonical_url: "https://docs.ctrl-neo.dev/en/tauri-sqlite-orm/api-reference" --- # API Reference > Quick reference for all ORM methods and functions ## ORM Instance Methods ### Query Builders

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

### Utilities

Method	Returns	Description
`db.transaction(callback)`	`Promise`	Execute operations in a transaction
`db.migrate(options?)`	`Promise`	Run database migrations
`db.migrateIfDirty()`	`Promise`	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)

## SelectQueryBuilder Methods

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`	Execute and return all rows
`.get()`	`Promise`	Execute and return first row
`.first()`	`Promise`	Alias for `.get()`
`.exists()`	`Promise`	Check if any rows exist
`.count()`	`Promise`	Count matching rows
`.pluck(column)`	`Promise`	Get array of single column values
`.paginate(page, pageSize)`	`Promise`	Get paginated results
`.toSQL()`	`{sql, params}`	Get SQL without executing

## InsertQueryBuilder Methods

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

## UpdateQueryBuilder Methods

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`	Return all columns after update (array)
`.returningFirst()`	`Promise`	Return first updated record (single object)
`.execute()`	`Promise`	Execute the update
`.toSQL()`	`{sql, params}`	Get SQL without executing

## DeleteQueryBuilder Methods

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`	Return all columns from deleted rows (array)
`.returningFirst()`	`Promise`	Return first deleted record (single object)
`.execute()`	`Promise`	Execute the delete
`.toSQL()`	`{sql, params}`	Get SQL without executing

## Operators ### Comparison - `eq(column, value, alias?)` - Equal - `ne(column, value, alias?)` - Not equal - `gt(column, value)` - Greater than - `gte(column, value)` - Greater than or equal - `lt(column, value)` - Less than - `lte(column, value)` - Less than or equal - `between(column, min, max)` - Between range ### Logical - `and(...conditions)` - AND conditions - `or(...conditions)` - OR conditions - `not(condition)` - NOT condition ### String - `like(column, pattern)` - LIKE pattern - `ilike(column, pattern)` - Case-insensitive LIKE - `startsWith(column, value)` - Starts with - `endsWith(column, value)` - Ends with - `contains(column, value)` - Contains substring ### Array/List - `inArray(column, values | subquery)` - IN array or subquery - `notIn(column, values | subquery)` - NOT IN array or subquery ### Null - `isNull(column)` - IS NULL - `isNotNull(column)` - IS NOT NULL ### Subquery - `exists(subquery)` - EXISTS - `notExists(subquery)` - NOT EXISTS - `eqSubquery(column, subquery)` - Equal to subquery - `gtSubquery(column, subquery)` - Greater than subquery - `gteSubquery(column, subquery)` - Greater than or equal to subquery - `ltSubquery(column, subquery)` - Less than subquery - `lteSubquery(column, subquery)` - Less than or equal to subquery ## Column Helpers - `text(name, config?)` - TEXT column - `integer(name, config?)` - INTEGER column - `real(name)` - REAL column - `blob(name, config?)` - BLOB column - `boolean(name)` - BOOLEAN column - `numeric(name, config?)` - NUMERIC column - `enumType(name, values)` - ENUM column ## Aggregate Functions - `count(column?)` - COUNT - `countDistinct(column)` - COUNT DISTINCT - `sum(column)` - SUM - `avg(column)` - AVG - `min(column)` - MIN - `max(column)` - MAX - `groupConcat(column, separator?)` - GROUP_CONCAT (SQLite-specific) ## Subquery Helpers - `subquery(query)` - Convert query to subquery - `scalarSubquery(query)` - Scalar subquery for comparisons ## Utility Functions - `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 ## Type Helpers - `InferSelectModel` - Infer SELECT result type - `InferInsertModel` - Infer INSERT data type - `InferRelationalSelectModel` - Infer SELECT result type with relations from `.include(with)` ## Error Classes - `TauriORMError` - Base error class - `QueryBuilderError` - Query building errors - `MissingWhereClauseError` - Missing WHERE clause - `ValidationError` - Validation errors - `InsertValidationError` - Insert validation errors - `UpdateValidationError` - Update validation errors - `ColumnNotFoundError` - Column not found - `TableNotFoundError` - Table not found - `MigrationError` - Migration errors - `RelationError` - Relation errors ## Sitemap See the full [sitemap](https://docs.ctrl-neo.dev/sitemap.md) for all pages.