RootTableManager<$Database extends GeneratedDatabase, $Table extends Table, $Dataclass, $FilterComposer extends FilterComposer<$Database, $Table> , $OrderingComposer extends OrderingComposer<$Database, $Table> , $CreateCompanionCallback extends Function, $UpdateCompanionCallback extends Function, $DataclassWithReferences, $ActiveDataclass, $CreatePrefetchHooksCallback extends Function> class
abstract
A table manager with top level function for creating, reading, updating, and deleting items.
- Inheritance
-
- Object
- Selectable<
$ActiveDataclass> - BaseTableManager<
$Database, $Table, $Dataclass, $FilterComposer, $OrderingComposer, $CreateCompanionCallback, $UpdateCompanionCallback, $DataclassWithReferences, $ActiveDataclass, $CreatePrefetchHooksCallback> - RootTableManager
- Annotations
Constructors
-
RootTableManager(TableManagerState<
$Database, $Table, $Dataclass, $FilterComposer, $OrderingComposer, $CreateCompanionCallback, $UpdateCompanionCallback, $DataclassWithReferences, $ActiveDataclass, $CreatePrefetchHooksCallback> $state) - Create a new RootTableManager instance
Properties
-
$state
→ TableManagerState<
$Database, $Table, $Dataclass, $FilterComposer, $OrderingComposer, $CreateCompanionCallback, $UpdateCompanionCallback, $DataclassWithReferences, $ActiveDataclass, $CreatePrefetchHooksCallback> -
The state for this manager
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
asyncMap<
N> (FutureOr< N> mapper($ActiveDataclass)) → Selectable<N> -
Maps this selectable by the
mapper
function.inherited -
bulkCreate(
Iterable< Insertable< f($CreateCompanionCallback o), {InsertMode? mode, UpsertClause<$Dataclass> >$Table, $Dataclass> ? onConflict}) → Future<void> - Create multiple rows in the table using the given function
-
bulkReplace(
Iterable< Insertable< entities) → Future<$Dataclass> >void> - Replace multiple rows in the table
-
count(
{bool distinct = true}) → Future< int> -
Return the count of rows matched by the built statement
When counting rows, the query will only count distinct rows by default
inherited
-
create(
Insertable< $Dataclass> f($CreateCompanionCallback o), {InsertMode? mode, UpsertClause<$Table, $Dataclass> ? onConflict}) → Future<int> - Creates a new row in the table using the given function
-
createReturning(
Insertable< $Dataclass> f($CreateCompanionCallback o), {InsertMode? mode, UpsertClause<$Table, $Dataclass> ? onConflict}) → Future<$Dataclass> - Inserts a row into the table and returns it.
-
createReturningOrNull(
Insertable< $Dataclass> f($CreateCompanionCallback o), {InsertMode? mode, UpsertClause<$Table, $Dataclass> ? onConflict}) → Future<$Dataclass?> - Inserts a row into the table and returns it.
-
delete(
) → Future< int> -
Deletes all rows matched by built statement
inherited
-
exists(
) → Future< bool> -
Checks whether any rows exist
inherited
-
filter(
ComposableFilter f($FilterComposer f)) → ProcessedTableManager< $Database, $Table, $Dataclass, $FilterComposer, $OrderingComposer, $CreateCompanionCallback, $UpdateCompanionCallback, $DataclassWithReferences, $ActiveDataclass, $CreatePrefetchHooksCallback> -
Add a filter to the statement
inherited
-
get(
{bool distinct = false, int? limit, int? offset}) → Future< List< $ActiveDataclass> > -
Executes the statement and returns all rows as a list.
inherited
-
getSingle(
{bool distinct = true}) → Future< $ActiveDataclass> -
Executes this statement, like get, but only returns one
value. If the query returns no or too many rows, the returned future will
complete with an error.
inherited
-
getSingleOrNull(
{bool distinct = true}) → Future< $ActiveDataclass?> -
Executes this statement, like get, but only returns one
value. If the result too many values, this method will throw. If no
row is returned,
null
will be returned instead.inherited -
limit(
int limit, {int? offset}) → ProcessedTableManager< $Database, $Table, $Dataclass, $FilterComposer, $OrderingComposer, $CreateCompanionCallback, $UpdateCompanionCallback, $DataclassWithReferences, $ActiveDataclass, $CreatePrefetchHooksCallback> -
Add a limit to the statement
inherited
-
map<
N> (N mapper($ActiveDataclass)) → Selectable< N> -
Maps this selectable by the
mapper
function.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
orderBy(
ComposableOrdering o($OrderingComposer o)) → ProcessedTableManager< $Database, $Table, $Dataclass, $FilterComposer, $OrderingComposer, $CreateCompanionCallback, $UpdateCompanionCallback, $DataclassWithReferences, $ActiveDataclass, $CreatePrefetchHooksCallback> -
Add ordering to the statement
inherited
-
replace(
Insertable< $Dataclass> entity) → Future<bool> -
Replaces the old version of
entity
that is stored in the database with the fields of theentity
provided here. This implicitly applies a filter clause to rows with the same primary key asentity
, so that only the row representing outdated data will be replaced. -
toString(
) → String -
A string representation of this object.
inherited
-
update(
Insertable< $Dataclass> f($UpdateCompanionCallback o)) → Future<int> -
Writes all non-null fields from the entity into the columns of all rows
that match the filter clause. Warning: That also means that, when you're
not setting a where clause explicitly, this method will update all rows in
the
$state.table
.inherited -
watch(
{bool distinct = false, int? limit, int? offset}) → Stream< List< $ActiveDataclass> > -
Creates an auto-updating stream of the result that emits new items
whenever any table used in this statement changes.
inherited
-
watchSingle(
{bool distinct = true}) → Stream< $ActiveDataclass> -
Creates an auto-updating stream of this statement, similar to
watch. However, it is assumed that the query will only emit
one result, so instead of returning a
Stream<List<D>>
, this returns aStream<D>
. If, at any point, the query emits no or more than one rows, an error will be added to the stream instead.inherited -
watchSingleOrNull(
{bool distinct = true}) → Stream< $ActiveDataclass?> -
Creates an auto-updating stream of this statement, similar to
watch. However, it is assumed that the query will only
emit one result, so instead of returning a
Stream<List<D>>
, this returns aStream<D?>
. If the query emits more than one row at some point, an error will be emitted to the stream instead. If the query emits zero rows at some point,null
will be added to the stream instead.inherited -
withReferences(
[PrefetchHooks prefetch($CreatePrefetchHooksCallback prefetch)?]) → ProcessedTableManager< $Database, $Table, $Dataclass, $FilterComposer, $OrderingComposer, $CreateCompanionCallback, $UpdateCompanionCallback, $DataclassWithReferences, $DataclassWithReferences, $CreatePrefetchHooksCallback> -
This function with return a new manager which will return each item in the database with its references
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited