QueryBuilderImpl class

Inheritance
Implemented types
Implementers

Constructors

QueryBuilderImpl()

Properties

bindings Map<String, dynamic>
finalinherited
conditions List<String>
finalinherited
conn DatabaseConnection
getter/setter pairinherited
connectionName String
getter/setter pairoverride-getter
cteConfiguration → CteConfiguration
no setterinherited
cteCount int
no setterinherited
cteNames List<String>
no setterinherited
currentParamCounter int
Returns the current parameter counter value. Useful for synchronizing nested queries.
no setterinherited
dbConnection DatabaseConnection?
no setterinherited
getTable String
no setteroverride
hasCtes bool
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
joins List<String>
getter/setter pairinherited
paramCounter int
no getterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectColumns List<String>
getter/setter pairinherited
unions List<String>
getter/setter pairinherited

Methods

addSelect(List<String> columns) QueryBuilder
inherited
alerts() Stream<DatabaseAlert>
override
avg(String column) Future<num>
inherited
batchProcess({required int batchSize, required Future<void> processor(List<Map<String, dynamic>> batch, int batchNumber), List<String> columns = const ['*']}) Future<void>
inherited
build({String? aggregateFunction, String? aggregateColumn}) String
override
buildJoins() String
inherited
buildWhereClause() String
inherited
buildWithClause() String
inherited
bulkDelete({String? column, List? values, int batchSize = 1000}) Future<bool>
inherited
bulkDeleteWhere(List<Map<String, dynamic>> conditions, {int batchSize = 500}) Future<bool>
inherited
bulkInsert(List<Map<String, dynamic>> data, {ConflictAction conflictAction = ConflictAction.ignore, List<String>? conflictColumns, List<String>? updateColumns, int batchSize = 1000, bool returnIds = false}) Future<bool>
inherited
bulkUpdate(List<Map<String, dynamic>> updates, {required String matchColumn, List<String>? updateColumns, int batchSize = 500, Map<String, dynamic>? additionalValues}) Future<bool>
inherited
chunk(int chunk, void callback(List<Map<String, dynamic>> data)) Future<void>
inherited
chunkById(int chunk, void callback(List<Map<String, dynamic>> data), [String column = 'id']) Future<void>
inherited
chunkedProcess({required int chunkSize, required Future<List<Map<String, dynamic>>> processor(List<Map<String, dynamic>> chunk), String? destination, List<String> columns = const ['*']}) Future<void>
inherited
clearBulkOperations() → void
inherited
clearCtes() → void
inherited
clearWindowFunctions() → void
inherited
collection(String name) QueryBuilder
Alias for table. Some drivers (document stores) prefer the "collection" spelling; both names route to the same underlying state on every driver.
inherited
configureCte(CteConfiguration config) → void
inherited
connection([String? connection]) QueryBuilder
override
count([String columns = '*']) Future<int>
inherited
crossJoin(String table, [List bindings = const []]) QueryBuilder
inherited
cumeDist({String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
cursor([int chunk = 1000]) Stream<Map<String, dynamic>>
inherited
decrement(String column, [int amount = 1, Map<String, dynamic> extra = const {}]) Future<bool>
inherited
delete() Future<bool>
inherited
denseRank({String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
doesntExist() Future<bool>
inherited
each(void callback(Map<String, dynamic> q)) Future<void>
inherited
exists() Future<bool>
inherited
find(dynamic id, {String byColumnName = 'id', List<String> columns = const []}) Future<Map<String, dynamic>?>
inherited
findOrFail(dynamic id, {String byColumnName = 'id', List<String> columns = const []}) Future<Map<String, dynamic>?>
inherited
first([List<String> columns = const []]) Future<Map<String, dynamic>?>
inherited
firstOrFail([List<String> columns = const []]) Future<Map<String, dynamic>?>
inherited
firstValue(String column, {String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
firstWhere(String column, [String? operator = '=', dynamic value, List<String> columns = const []]) Future<Map<String, dynamic>?>
inherited
formatValue(dynamic value) String
inherited
get([List<String> columns = const []]) Future<List<Map<String, dynamic>>>
inherited
getBindings() Map<String, dynamic>
override
getCacheStats() Map<String, dynamic>
inherited
getConnection() Future<DatabaseConnection>
inherited
getCteBindings() Map<String, dynamic>
inherited
getCteInfo() List<Map<String, dynamic>>
inherited
getPerformanceStats() Map<String, PerformanceStats>
override
groupBy(List<String> groups) QueryBuilder
override
groupByRaw(String expression) QueryBuilder
Emits expression into GROUP BY verbatim.
override
hasCte(String name) bool
inherited
having(String column, [String? operator, dynamic value, String boolean = 'and']) QueryBuilder
override
havingBetween(String column, List values, {String boolean = 'and', bool not = false}) QueryBuilder
override
increment(String column, [int amount = 1, Map<String, dynamic> extra = const {}]) Future<bool>
inherited
incrementEach(Map<String, int> increments, [Map<String, dynamic> extra = const {}]) Future<bool>
inherited
inRandomOrder([dynamic seed]) QueryBuilder
override
insert(Map<String, dynamic> values) Future<bool>
inherited
insertGetId(Map<String, dynamic> values, [String? sequence]) Future
inherited
insertMany(List<Map<String, dynamic>> valuesList) Future<bool>
inherited
insertOrIgnore(Map<String, dynamic> values) Future<bool>
inherited
insertUsing(List<String> columns, QueryBuilder subQuery) Future<bool>
inherited
join(String table, String firstColumn, [String? operator, String? secondColumn, String type = 'INNER', bool where = false]) QueryBuilder
inherited
joinSub(QueryBuilder subQuery, String as, String firstColumn, [String? operator, String? secondColumn, String type = 'inner']) QueryBuilder
inherited
lag(String column, {int offset = 1, dynamic defaultValue, String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
lastValue(String column, {String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
latest([String column = 'created_at']) QueryBuilder
override
lazy([int chunk = 100, String column = 'id']) Stream<Iterable<Map<String, dynamic>>>
inherited
lead(String column, {int offset = 1, dynamic defaultValue, String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
leftJoin(String table, String firstColumn, [String? operator, String? secondColumn, bool where = false]) QueryBuilder
inherited
leftJoinSub(QueryBuilder subQuery, String as, String firstColumn, [String? operator, String? secondColumn]) QueryBuilder
inherited
limit(int value) QueryBuilder
override
max(String column) Future
inherited
merge(List<Map<String, dynamic>> sourceData, {required List<String> matchOn, ConflictAction whenMatched = ConflictAction.update, ConflictAction whenNotMatched = ConflictAction.ignore, ConflictAction? whenNotMatchedBySource, List<String>? updateColumns, List<String>? insertColumns, Map<String, dynamic>? additionalValues}) Future<bool>
inherited
min(String column) Future
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
ntile(int buckets, {String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
offset(int value) QueryBuilder
override
orderBy(String column, [String direction = 'ASC']) QueryBuilder
override
orderByAsc(String column) QueryBuilder
override
orderByDesc(String column) QueryBuilder
override
orderByRaw(String expression) QueryBuilder
Emits expression into ORDER BY verbatim.
override
orWhere(dynamic condition, [String operator = '=', dynamic value, String boolean = 'and']) QueryBuilder
inherited
orWhereBetween(String column, List values, {bool not = false}) QueryBuilder
inherited
orWhereColumn(String first, String operator, String secondColumn) QueryBuilder
inherited
orWhereDate(String column, String operator, dynamic value) QueryBuilder
inherited
orWhereDay(String column, String operator, dynamic value) QueryBuilder
inherited
orWhereDoesntHave(String relation, QueryCallback callback) QueryBuilder
inherited
orWhereExists(QueryCallback callback, {bool not = false}) QueryBuilder
inherited
orWhereFullText(dynamic columns, dynamic query, [Map<String, dynamic> options = const {}]) QueryBuilder
inherited
orWhereHas(String relation, QueryCallback callback) QueryBuilder
inherited
orWhereHour(String column, String operator, dynamic value) QueryBuilder
inherited
orWhereIn(String column, List values, {bool not = false}) QueryBuilder
inherited
orWhereJsonContains(String column, dynamic value, {bool not = false}) QueryBuilder
inherited
orWhereJsonDoesntContain(String column, dynamic value) QueryBuilder
inherited
orWhereJsonLength(String column, String operator, dynamic value) QueryBuilder
inherited
orWhereLike(String column, dynamic value, {bool caseSensitive = false}) QueryBuilder
inherited
orWhereMonth(String column, String operator, dynamic value) QueryBuilder
inherited
orWhereNotBetween(String column, List values) QueryBuilder
inherited
orWhereNotExists(QueryCallback callback) QueryBuilder
inherited
orWhereNotIn(String column, dynamic values) QueryBuilder
inherited
orWhereNotLike(String column, dynamic value, {bool caseSensitive = false, String boolean = 'and'}) QueryBuilder
inherited
orWhereNotNull(String column) QueryBuilder
inherited
orWhereNull(String column) QueryBuilder
inherited
orWhereRaw(String sql, [List rawBindings = const []]) QueryBuilder
inherited
orWhereRowValues(List<String> columns, String operator, List values) QueryBuilder
inherited
orWhereTime(String column, String operator, dynamic value) QueryBuilder
inherited
orWhereYear(String column, String operator, dynamic value) QueryBuilder
inherited
paginate({int perPage = 15, List<String> columns = const [], String? pageName, int? page}) Future<Map<String, dynamic>>
inherited
parallelBulkInsert(List<Map<String, dynamic>> data, {int parallelism = 2, int batchSize = 1000, ConflictAction conflictAction = ConflictAction.ignore, List<String>? conflictColumns}) Future<bool>
inherited
percentRank({String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
pluck(String column, [String? key]) Future
inherited
rank({String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
raw(String value) RawExpression
override
removeCte(String name) bool
inherited
reorder([String? column, String? direction]) QueryBuilder
override
resetCteState() → void
Hook for QueryBuilder.resetQuery. Leaves the configuration and escaping strategy alone — those describe the dialect, not the query.
inherited
resetQuery() → void
Drops every clause accumulated so far, leaving the table, alias and connection in place so the builder can be reused for a fresh query.
override
resetWindowState() → void
Hook for QueryBuilder.resetQuery; the list is private to this library, so the reset has to be driven from here.
inherited
rightJoin(String table, String firstColumn, [String? operator, String? secondColumn]) QueryBuilder
inherited
rowNumber({String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
select([List<String> columns = const ['*']]) QueryBuilder
inherited
selectRaw(String query, [List bindings = const []]) QueryBuilder
inherited
selectSub(QueryBuilder subQuery, String as) QueryBuilder
inherited
simplePaginate([int perPage = 15, List<String> columns = const [], String? pageName, int? page]) Future<Map<String, dynamic>>
inherited
skip(int value) QueryBuilder
override
sum(String column) Future<num>
inherited
table(String table, [String? as]) QueryBuilder
override
take(int value) QueryBuilder
override
toRawSql() String
override
toSql() String
override
toString() String
A string representation of this object.
inherited
transaction(Future<bool> action(), [String? conditionName]) Future<bool>
override
transactionalBulkOperation(Future<bool> action()) Future<bool>
inherited
truncate({bool force = false}) Future<bool>
inherited
union(QueryBuilder query) QueryBuilder
inherited
unionAll(QueryBuilder query) QueryBuilder
inherited
update(Map<String, dynamic> values) Future<bool>
inherited
updateMany(List<Map<String, dynamic>> updates, String column) Future<bool>
inherited
updateOrInsert(Map<String, dynamic> search, Map<String, dynamic> update) Future<bool>
inherited
upsert(Map<String, dynamic> values, List<String> uniqueBy, [Map<String, dynamic>? update]) Future<bool>
inherited
validateAllCtes() → void
inherited
value(String column) Future
inherited
where(dynamic condition, [String operator = '=', dynamic value, String boolean = 'and']) QueryBuilder
inherited
whereAfterToday(String column, {String boolean = 'and'}) QueryBuilder
inherited
whereAll(String column, List values, {String boolean = 'and'}) QueryBuilder
inherited
whereAny(String column, List values, {String boolean = 'and'}) QueryBuilder
inherited
whereBeforeToday(String column, {String boolean = 'and'}) QueryBuilder
inherited
whereBetween(String column, List values, {String boolean = 'and', bool not = false}) QueryBuilder
inherited
whereBetweenColumns(String column, List<String> columns, {String boolean = 'and'}) QueryBuilder
inherited
whereColumn(String firstColumn, String operator, String secondColumn, [String boolean = 'and']) QueryBuilder
inherited
whereDate(String column, String operator, dynamic value, {String boolean = 'and'}) QueryBuilder
inherited
whereDay(String column, String operator, dynamic value, {String boolean = 'and'}) QueryBuilder
inherited
whereDoesntHave(String relation, QueryCallback callback, {String boolean = 'and'}) QueryBuilder
inherited
whereEqualTo(dynamic condition, [dynamic value, String boolean = 'and']) QueryBuilder
inherited
whereExists(QueryCallback callback, {String boolean = 'and', bool not = false}) QueryBuilder
inherited
whereFullText(dynamic columns, dynamic query, [Map<String, dynamic> options = const {}]) QueryBuilder
inherited
whereFuture(String column, {String boolean = 'and'}) QueryBuilder
inherited
whereGreaterThan(dynamic condition, [dynamic value, String boolean = 'and']) QueryBuilder
inherited
whereGreaterThanOrEqualTo(dynamic condition, [dynamic value, String boolean = 'and']) QueryBuilder
inherited
whereHas(String relation, QueryCallback callback, {String boolean = 'and'}) QueryBuilder
inherited
whereHour(String column, String operator, dynamic value, {String boolean = 'and'}) QueryBuilder
inherited
whereIn(String column, List values, {String boolean = 'and', bool not = false}) QueryBuilder
inherited
whereJsonContains(String column, dynamic value, {String boolean = 'and', bool not = false}) QueryBuilder
inherited
whereJsonDoesntContain(String column, dynamic value, {String boolean = 'and'}) QueryBuilder
inherited
whereJsonLength(String column, String operator, dynamic value, {String boolean = 'and'}) QueryBuilder
inherited
whereLessThan(dynamic condition, [dynamic value, String boolean = 'and']) QueryBuilder
inherited
whereLessThanOrEqualTo(dynamic condition, [dynamic value, String boolean = 'and']) QueryBuilder
inherited
whereLike(String column, dynamic value, {bool caseSensitive = false, String boolean = 'and'}) QueryBuilder
inherited
whereMonth(String column, String operator, dynamic value, {String boolean = 'and'}) QueryBuilder
inherited
whereNone(String column, List values, {String boolean = 'and'}) QueryBuilder
inherited
whereNotBetween(String column, List values, {String boolean = 'and'}) QueryBuilder
inherited
whereNotBetweenColumns(String column, List<String> columns, {String boolean = 'and'}) QueryBuilder
inherited
whereNotEqualTo(dynamic condition, [dynamic value, String boolean = 'and']) QueryBuilder
inherited
whereNotExists(QueryCallback callback, {String boolean = 'and'}) QueryBuilder
inherited
whereNotIn(String column, dynamic values, {String boolean = 'and'}) QueryBuilder
inherited
whereNotLike(String column, dynamic value, {bool caseSensitive = false, String boolean = 'and'}) QueryBuilder
inherited
whereNotNull(String column, {String boolean = 'and'}) QueryBuilder
inherited
whereNowOrFuture(String column, {String boolean = 'and'}) QueryBuilder
inherited
whereNowOrPast(String column, {String boolean = 'and'}) QueryBuilder
inherited
whereNull(String column, {String boolean = 'and', bool not = false}) QueryBuilder
inherited
wherePast(String column, {String boolean = 'and'}) QueryBuilder
inherited
whereRaw(String sql, [List rawBindings = const [], String boolean = 'and']) QueryBuilder
inherited
whereRowValues(List<String> columns, String operator, List values, {String boolean = 'and'}) QueryBuilder
inherited
whereTime(String column, String operator, dynamic value, {String boolean = 'and'}) QueryBuilder
inherited
whereToday(String column, {String boolean = 'and'}) QueryBuilder
inherited
whereTodayOrAfter(String column, {String boolean = 'and'}) QueryBuilder
inherited
whereTodayOrBefore(String column, {String boolean = 'and'}) QueryBuilder
inherited
whereYear(String column, String operator, dynamic value, {String boolean = 'and'}) QueryBuilder
inherited
windowAvg(String column, {String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
windowCount(String column, {String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
windowMax(String column, {String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
windowMin(String column, {String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
windowSum(String column, {String? partitionBy, String? orderBy, String? as}) QueryBuilder
inherited
withCte(String name, QueryBuilder subQuery, {List<String>? columns}) QueryBuilder
inherited
withMaterialized(String name, QueryBuilder subQuery, {List<String>? columns}) QueryBuilder
inherited
withMultiple(Map<String, QueryBuilder> ctes, {Map<String, List<String>>? columnsMap}) QueryBuilder
inherited
withNotMaterialized(String name, QueryBuilder subQuery, {List<String>? columns}) QueryBuilder
inherited
withRecursive(String name, QueryBuilder baseCase, QueryBuilder recursiveCase, {List<String>? columns}) QueryBuilder
inherited
withSoftDeletes([String column = 'deleted_at']) QueryBuilder
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited