Interface SQLBuilderPort

Specified select column.

builder.column('id')
// `id`
Copy

Specified select column with alias name.

builder.column('id', 'user_id')
// `id` AS `user_id`
Copy

Specified table name.

builder.from('users')
// FROM `users`
Copy

Specified table name with alias.

builder.from('users', 'u')
// FROM `users` AS `u`
Copy

Specified group-by condition.

builder.groupBy('age')
Copy

Specified having condition.

builder.having('value', 1)
builder.having('value', [1, 5, 10])
Copy

Specified having condition.

builder.having('value', '>=', 10)
builder.having('value', 'in', [1, 5, 10])
Copy

Specified join.

Specified join with direction.

Sepcified left join

builder.leftJoin('passport', 'passport.id = user.passport_id')
// LEFT JOIN `passport` ON passport.id = user.passport_id
Copy

Specified left join with table alias.

builder.leftJoin('passport', 'p', 'p.id = user.passport_id')
// LEFT JOIN `passport` AS `p` ON p.id = user.passport_id
Copy

Specified limit value.

builder.limit(1)
Copy

Specified offset value.

builder.offset(1)
Copy

Specified order-by condition.

builder.orderBy('id', 'asc')
builder.orderBy('id', 'desc')
Copy

Returnes SQL and Binding values.

const [sql, bindings] = builder.toSQL()
Copy

Specified search condition.

builder.where('id', 1)
builder.where('id', [1, 2, 3]) // use `IN`
Copy

Specified search condition with expression. Example for IS NULL

import { is_null } from 'coral-sql'

builder.where('id`, is_null()) // `id` IS NULL
Copy

Specified search condition with operator.

builder.where('id', '!=', 1)
builder.where('id', 'in', [1, 2, 3])
builder.where('created_at', 'between', [start_at, end_at])
Copy

Specified where condition.

builder.where(createConditions().and('value', 1).or('value', 2))
Copy