Specified column's name.
Optional
as: stringCreate a new SQLBuilder instance.
const newBuilder = builder.createBuilder()
Optional
options: SQLBuilderToSQLInputOptionsOptional SQLBuilderToSQLInputOptions
Create a new Conditions instance for building complex condition groups.
const conditions = builder.createConditions()
.and('status', 'active')
.or('priority', 'high')
Specified table name.
builder.from('users')
// FROM `users`
Optional
as: stringSpecified group-by condition.
builder.groupBy('age')
Specified having condition using conditions instance.
const conditions = createConditions().and('value', '>', 10).or('value', '<', 2)
builder.having(conditions)
Specified having condition.
builder.having('value', 1)
builder.having('value', [1, 5, 10])
Specified having condition.
builder.having('value', '>=', 10)
builder.having('value', 'in', [1, 5, 10])
Specified join.
Sepcified left join
builder.leftJoin('passport', 'passport.id = user.passport_id')
// LEFT JOIN `passport` ON passport.id = user.passport_id
Specified limit value.
builder.limit(1)
Specified offset value.
builder.offset(1)
Specified order-by condition.
builder.orderBy('id', 'asc')
builder.orderBy('id', 'desc')
Set a custom SELECT statement.
builder.select('COUNT(*) AS total')
// SELECT COUNT(*) AS total
Custom SELECT statement
Override builder options.
builder.setOptions({quote: '`'})
Returns SQL and Binding values.
const [sql, bindings] = builder.toSQL()
Optional
input: SQLBuilderToSQLInputOptionsSpecified search condition.
builder.where('id', 1)
builder.where('id', [1, 2, 3]) // use `IN`
Specified select column.