Querying topic

Sequelize Dart provides a comprehensive, type-safe API for reading, creating, updating, and deleting data.

Select (Reading Data)

// Find all users
final users = await Users.model.findAll();

// Find one user by email
final user = await Users.model.findOne(
  where: (u) => u.email.eq('[e-mail]'),
);

// Select specific attributes
final names = await Users.model.findAll(
  attributes: QueryAttributes.include(['id', 'email']),
);

Operators

Type-safe comparison, string, and logical operators are available on every column reference.

// Comparison
(u) => u.age.gt(18)
(u) => u.age.between(18, 65)
(u) => u.status.in_(['active', 'pending'])

// String
(u) => u.username.like('admin%')
(u) => u.username.iLike('admin%')   // PostgreSQL

// Null checks
(u) => u.deletedAt.isNull()

// Logical combinations
(u) => and([u.age.gte(18), u.isActive.eq(true)])
(u) => or([u.role.eq('admin'), u.role.eq('moderator')])

Insert

final user = await Users.model.create(
  CreateUsers(email: '[e-mail]', firstName: 'Bob', lastName: 'Jones'),
);

Update

// Bulk update
await Users.model.update(
  lastName: 'Johnson',
  where: (u) => u.id.eq(1),
);

// Instance update
await user.update({'lastName': 'Johnson'});

Delete

// Soft delete (paranoid model)
await Users.model.destroy(where: (u) => u.id.eq(1));

// Hard delete
await Users.model.destroy(where: (u) => u.id.eq(1), force: true);

// Restore soft-deleted record
await Users.model.restore(where: (u) => u.id.eq(1));

Sorting & Pagination

final page = await Users.model.findAll(
  order: [OrderItem(column: 'created_at', direction: OrderDirection.DESC)],
  limit: 10,
  offset: 20,
);

Aggregations

final count = await Users.model.count();
final maxAge = await Users.model.max((u) => u.age);
final total = await Users.model.sum((u) => u.balance);

Classes

Column<T>

Type-safe column reference for building queries.

ComparisonOperator

LogicalOperator

Logical operator (e.g., and, or, not)

Query

QueryOperator

Transaction

Represents a transaction.