More fluent api to define queries

moor/lib/src/dsl/database.dart

@@ -25,22 +25,33 @@ class UseMoor {
   /// For instructions on how to write a dao, see the documentation of [UseDao]
   final List<Type> daos;
 
-  /// Optionally, a list of queries. Moor will generate matching methods for the
-  /// variables and return types.
-  // todo better documentation
+  /// {@template moor_compile_queries_param}
+  /// Optionally, a list of named sql queries. During a build, moor will look at
+  /// the defined sql, figure out what they do, and write appropriate
+  /// methods in your generated database.
+  ///
+  /// For instance, when using
+  /// ```dart
+  /// @UseMoor(
+  ///   tables: [Users],
+  ///   queries: {
+  ///     'userById': 'SELECT * FROM users WHERE id = ?',
+  ///   },
+  /// )
+  /// ```
+  /// Moor will generate two methods for you: `userById(int id)` and
+  /// `watchUserById(int id)`.
+  /// {@endtemplate}
   @experimental
-  final List<Sql> queries;
+  final Map<String, String> queries;
 
   /// Use this class as an annotation to inform moor_generator that a database
   /// class should be generated using the specified [UseMoor.tables].
-  const UseMoor({@required this.tables, this.daos = const [], this.queries});
-}
-
-class Sql {
-  final String name;
-  final String query;
-
-  const Sql(this.name, this.query);
+  const UseMoor({
+    @required this.tables,
+    this.daos = const [],
+    @experimental this.queries = const {},
+  });
 }
 
 /// Annotation to use on classes that implement [DatabaseAccessor]. It specifies
@@ -61,12 +72,16 @@ class Sql {
 /// you're ready to make queries inside your dao. You can obtain an instance of
 /// that dao by using the getter that will be generated inside your database
 /// class.
+///
+/// See also:
+/// - https://moor.simonbinder.eu/daos/
 class UseDao {
   /// The tables accessed by this DAO.
   final List<Type> tables;
-  // todo better documentation
-  @experimental
-  final List<Sql> queries;
 
-  const UseDao({@required this.tables, this.queries});
+  /// {@macro moor_compile_queries_param}
+  @experimental
+  final Map<String, String> queries;
+
+  const UseDao({@required this.tables, @experimental this.queries = const {}});
 }

moor/test/data/tables/todos.dart

@@ -55,13 +55,10 @@ class TableWithoutPK extends Table {
 @UseMoor(
   tables: [TodosTable, Categories, Users, SharedTodos, TableWithoutPK],
   daos: [SomeDao],
-  queries: [
-    Sql(
-      'allTodosWithCategory',
-      'SELECT t.*, c.id as catId, c."desc" as catDesc '
-          'FROM todos t INNER JOIN categories c ON c.id = t.category',
-    ),
-  ],
+  queries: {
+    'allTodosWithCategory': 'SELECT t.*, c.id as catId, c."desc" as catDesc '
+        'FROM todos t INNER JOIN categories c ON c.id = t.category',
+  },
 )
 class TodoDb extends _$TodoDb {
   TodoDb(QueryExecutor e) : super(e);
@@ -75,14 +72,12 @@ class TodoDb extends _$TodoDb {
 
 @UseDao(
   tables: [Users, SharedTodos, TodosTable],
-  queries: [
-    Sql(
-        'todosForUser',
-        'SELECT t.* FROM todos t '
-            'INNER JOIN shared_todos st ON st.todo = t.id '
-            'INNER JOIN users u ON u.id = st.user '
-            'WHERE u.id = :user'),
-  ],
+  queries: {
+    'todosForUser': 'SELECT t.* FROM todos t '
+        'INNER JOIN shared_todos st ON st.todo = t.id '
+        'INNER JOIN users u ON u.id = st.user '
+        'WHERE u.id = :user'
+  },
 )
 class SomeDao extends DatabaseAccessor<TodoDb> with _$SomeDaoMixin {
   SomeDao(TodoDb db) : super(db);

moor_generator/lib/src/dao_generator.dart

@@ -21,7 +21,7 @@ class DaoGenerator extends GeneratorForAnnotation<UseDao> {
         annotation.peek('tables').listValue.map((obj) => obj.toTypeValue());
     final parsedTables =
         tableTypes.map((type) => state.parseType(type, element)).toList();
-    final queries = annotation.peek('queries')?.listValue ?? [];
+    final queries = annotation.peek('queries')?.mapValue ?? {};
 
     if (element is! ClassElement) {
       throw InvalidGenerationSourceError(

moor_generator/lib/src/moor_generator.dart

@@ -27,7 +27,7 @@ class MoorGenerator extends GeneratorForAnnotation<UseMoor> {
         .listValue
         .map((obj) => obj.toTypeValue())
         .toList();
-    final queries = annotation.peek('queries')?.listValue ?? [];
+    final queries = annotation.peek('queries')?.mapValue ?? {};
 
     final tablesForThisDb = <SpecifiedTable>[];
     var resolvedQueries = <SqlQuery>[];

moor_generator/lib/src/parser/sql/sql_parser.dart

@@ -10,7 +10,7 @@ import 'package:sqlparser/sqlparser.dart' hide ResultColumn;
 class SqlParser {
   final List<SpecifiedTable> tables;
   final SharedState state;
-  final List<DartObject> definedQueries;
+  final Map<DartObject, DartObject> definedQueries;
 
   final TypeMapper _mapper = TypeMapper();
   SqlEngine _engine;
@@ -27,9 +27,9 @@ class SqlParser {
   void parse() {
     _spawnEngine();
 
-    for (var query in definedQueries) {
-      final name = query.getField('name').toStringValue();
-      final sql = query.getField('query').toStringValue();
+    definedQueries.forEach((key, value) {
+      final name = key.toStringValue();
+      final sql = value.toStringValue();
 
       AnalysisContext context;
       try {
@@ -47,6 +47,6 @@ class SqlParser {
       }
 
       foundQueries.add(QueryHandler(name, context, _mapper).handle());
-    }
+    });
   }
 }