v1.7.6 - selectIDsBy

CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.7.6
+
+- `EntityHandler`:
+  - Added `getIDs`.
+
+- `EntitySource`, `EntityRepository`:
+  - Added `existIDs`, `selectIDsBy` and `selectIDsByQuery`.
+
+- `DBRelationalAdapter`:
+  - Added `parseIDs`.
+
 ## 1.7.5
 
 - New `IterableEntityReferenceExtension` and `IterableEntityReferenceListExtension`.

lib/src/bones_api_base.dart

@@ -42,7 +42,7 @@ typedef APILogger = void Function(APIRoot apiRoot, String type, String? message,
 /// Bones API Library class.
 class BonesAPI {
   // ignore: constant_identifier_names
-  static const String VERSION = '1.7.5';
+  static const String VERSION = '1.7.6';
 
   static bool _boot = false;
 

lib/src/bones_api_condition_encoder.dart

@@ -748,12 +748,15 @@ class EncodingContext {
 
   String? tableName;
 
+  String? tableFieldID;
+
   EncodingContext(this.entityName,
       {this.parameters,
       this.positionalParameters,
       this.namedParameters,
       this.transaction,
-      this.tableName});
+      this.tableName,
+      this.tableFieldID});
 
   /// The encoded parameters placeholders and values.
   final Map<String, dynamic> parametersPlaceholders = <String, dynamic>{};
@@ -974,13 +977,15 @@ abstract class ConditionEncoder {
       List? positionalParameters,
       Map<String, Object?>? namedParameters,
       Transaction? transaction,
-      String? tableName}) {
+      String? tableName,
+      String? tableFieldID}) {
     var context = EncodingContext(entityName,
         parameters: parameters,
         positionalParameters: positionalParameters,
         namedParameters: namedParameters,
         transaction: transaction,
-        tableName: tableName);
+        tableName: tableName,
+        tableFieldID: tableFieldID);
 
     if (condition is ConditionANY) {
       return context;

lib/src/bones_api_entity.dart

@@ -480,6 +480,15 @@
     return null;
   }
 
+  List<V?> getIDs<V>(List<O> os) {
+    if (os.isEmpty) return [];
+
+    var o = os.first;
+    var fieldID = idFieldName(o);
+
+    return os.map((o) => getField<V?>(o, fieldID)).toList();
+  }
+
   V? getID<V>(O o) => getField<V?>(o, idFieldName(o));
 
   void setID<V>(O o, V id) => setField<V>(o, idFieldName(o), id);
@@ -2279,6 +2288,16 @@
     return super.encodeObjectListJson(list);
   }
 
+  @override
+  List<V?> getIDs<V>(List<O> os) {
+    if (os.isEmpty) return [];
+
+    var o = os.first;
+    inspectObject(o);
+
+    return os.map((o) => o.getID<V>()).toList();
+  }
+
   @override
   V? getID<V>(O o) {
     inspectObject(o);
@@ -2714,6 +2733,9 @@
 
   FutureOr<bool> existsID(dynamic id, {Transaction? transaction});
 
+  FutureOr<Iterable<I>> existIDs<I extends Object>(List<I?> ids,
+      {Transaction? transaction});
+
   FutureOr<O?> selectByID(dynamic id, {Transaction? transaction}) {
     return select(ConditionID(id)).resolveMapped((sel) {
       return sel.isNotEmpty ? sel.first : null;
@@ -2789,6 +2811,29 @@
       int? limit,
       EntityResolutionRules? resolutionRules});
 
+  FutureOr<Iterable<I>> selectIDsByQuery<I extends Object>(String query,
+      {Object? parameters,
+      List? positionalParameters,
+      Map<String, Object?>? namedParameters,
+      Transaction? transaction,
+      int? limit}) {
+    var condition = _parseCache.parseQuery(query);
+
+    return selectIDsBy(condition,
+        parameters: parameters,
+        positionalParameters: positionalParameters,
+        namedParameters: namedParameters,
+        transaction: transaction,
+        limit: limit);
+  }
+
+  FutureOr<Iterable<I>> selectIDsBy<I extends Object>(EntityMatcher<O> matcher,
+      {Object? parameters,
+      List? positionalParameters,
+      Map<String, Object?>? namedParameters,
+      Transaction? transaction,
+      int? limit});
+
   FutureOr<Iterable<O>> selectAll(
       {Transaction? transaction,
       int? limit,
@@ -4352,6 +4397,25 @@
         resolutionRules: resolutionRules);
   }
 
+  @override
+  FutureOr<Iterable<I>> selectIDsByQuery<I extends Object>(String query,
+      {Object? parameters,
+      List? positionalParameters,
+      Map<String, Object?>? namedParameters,
+      Transaction? transaction,
+      int? limit}) {
+    checkNotClosed();
+
+    var condition = _parseCache.parseQuery(query);
+
+    return selectIDsBy(condition,
+        parameters: parameters,
+        positionalParameters: positionalParameters,
+        namedParameters: namedParameters,
+        transaction: transaction,
+        limit: limit);
+  }
+
   @override
   FutureOr<O?> deleteEntity(O o, {Transaction? transaction}) =>
       deleteByID(getEntityID(o), transaction: transaction);
@@ -5989,6 +6053,20 @@
     return o != null;
   }
 
+  @override
+  FutureOr<Iterable<I>> existIDs<I extends Object>(List<I?> ids,
+      {Transaction? transaction}) {
+    checkNotClosed();
+
+    var osIDs = iterable().map((o) {
+      var oId = getID(o, entityHandler: entityHandler);
+      var matches = ids.contains(oId);
+      return matches ? oId as I : null;
+    }).whereNotNull();
+
+    return osIDs;
+  }
+
   @override
   Iterable<O> select(EntityMatcher<O> matcher,
       {Object? parameters,
@@ -6008,6 +6086,26 @@
     return trackEntities(os);
   }
 
+  @override
+  Iterable<I> selectIDsBy<I extends Object>(EntityMatcher<O> matcher,
+      {Object? parameters,
+      List? positionalParameters,
+      Map<String, Object?>? namedParameters,
+      Transaction? transaction,
+      int? limit}) {
+    checkNotClosed();
+
+    var os = matches(matcher,
+        parameters: parameters,
+        positionalParameters: positionalParameters,
+        namedParameters: namedParameters,
+        limit: limit);
+
+    var ids = entityHandler.getIDs<I>(os);
+
+    return ids.whereNotNull().toList();
+  }
+
   @override
   FutureOr<Iterable<O>> selectAll(
       {Transaction? transaction,

lib/src/bones_api_entity_db.dart

@@ -481,6 +481,9 @@
       Map<String, Object?>? namedParameters,
       PreFinishDBOperation<int, int>? preFinish});
 
+  FutureOr<List<I>> doExistIDs<I extends Object>(
+      TransactionOperation op, String entityName, String table, List<I> ids);
+
   FutureOr<R?> doSelectByID<R>(
       TransactionOperation op, String entityName, String table, Object id,
       {PreFinishDBOperation<Map<String, dynamic>?, R?>? preFinish});
@@ -1129,6 +1132,10 @@
           namedParameters: namedParameters,
           preFinish: preFinish);
 
+  FutureOr<List<I>> doExistIDs<I extends Object>(
+          TransactionOperation op, List<I> ids) =>
+      databaseAdapter.doExistIDs<I>(op, name, tableName, ids);
+
   FutureOr<R?> doSelectByID<R>(TransactionOperation op, Object id,
           {PreFinishDBOperation<Map<String, dynamic>?, R?>? preFinish}) =>
       databaseAdapter.doSelectByID<R>(op, name, tableName, id,
@@ -1216,13 +1223,55 @@
 
   @override
   FutureOr<bool> existsID(dynamic id, {Transaction? transaction}) {
-    var cachedEntityByID = transaction?.getCachedEntityByID(id, type: type);
-    if (cachedEntityByID != null) return false;
-
     return count(matcher: ConditionID(id), transaction: transaction)
         .resolveMapped((count) => count > 0);
   }
 
+  @override
+  FutureOr<Iterable<I>> existIDs<I extends Object>(List<I?> ids,
+      {Transaction? transaction}) {
+    var idsNotNull = ids is List<I> ? ids : ids.whereNotNull().toList();
+    if (idsNotNull.isEmpty) return <I>[];
+
+    var cachedEntityByIDs =
+        transaction?.getCachedEntitiesByIDs(idsNotNull, type: type);
+
+    var cachedIDs = cachedEntityByIDs?.keys.whereType<I>().toList();
+
+    List<I> notCachedIDs;
+    if (cachedIDs != null) {
+      notCachedIDs = idsNotNull.whereNotIn(cachedIDs).toList();
+      if (notCachedIDs.isEmpty) {
+        return idsNotNull;
+      }
+    } else {
+      notCachedIDs = idsNotNull;
+    }
+
+    checkNotClosed();
+
+    var op = TransactionOperationCount(name, operationExecutor,
+        matcher: ConditionIdIN(notCachedIDs), transaction: transaction);
+
+    try {
+      return repositoryAdapter
+          .doExistIDs(op, notCachedIDs)
+          .resolveMapped((ids) {
+        return [
+          ...?cachedIDs,
+          ...ids,
+        ];
+      });
+    } catch (e, s) {
+      var message = 'existIDs> '
+          'cachedIDs: $cachedIDs ; '
+          'notCachedIDs: $notCachedIDs ; '
+          'op: $op';
+      _log.severe(message, e, s);
+      rethrow;
+    }
+  }
+
   @override
   FutureOr<dynamic> ensureStored(o,
       {Transaction? transaction, TransactionOperation? operation}) {
@@ -1337,6 +1386,28 @@
         "Relationship select not supported for: (${matcher.runtimeTypeNameUnsafe}) $matcher @ $tableName ($this)");
   }
 
+  @override
+  FutureOr<Iterable<I>> selectIDsBy<I extends Object>(EntityMatcher matcher,
+      {Object? parameters,
+      List? positionalParameters,
+      Map<String, Object?>? namedParameters,
+      Transaction? transaction,
+      int? limit}) {
+    if (matcher is ConditionID) {
+      var id = matcher.idValue;
+      return existsID(id, transaction: transaction)
+          .resolveMapped((exists) => exists ? [id] : []);
+    }
+
+    if (matcher is ConditionIdIN) {
+      var ids = matcher.idsValues.whereType<I>().toList();
+      return existIDs(ids, transaction: transaction);
+    }
+
+    throw UnsupportedError(
+        "Relationship select not supported for: (${matcher.runtimeTypeNameUnsafe}) $matcher @ $tableName ($this)");
+  }
+
   FutureOr<O?> _selectByID(Transaction? transaction, ConditionID matcher,
       Object? parameters, EntityResolutionRules? resolutionRules) {
     var id = matcher.idValue ?? matcher.getID(parameters);

lib/src/bones_api_entity_db_memory.dart

@@ -7,6 +7,7 @@
 import 'package:statistics/statistics.dart';
 
 import 'bones_api_condition_encoder.dart';
+import 'bones_api_condition.dart';
 import 'bones_api_entity.dart';
 import 'bones_api_entity_annotation.dart';
 import 'bones_api_entity_db_sql.dart';
@@ -412,6 +413,28 @@
     }
   }
 
+  @override
+  FutureOr<List<I>> doExistIDsSQL<I extends Object>(
+      String entityName,
+      String table,
+      SQL sql,
+      Transaction transaction,
+      DBSQLMemoryAdapterContext connection) {
+    var map = _getTableMap(table, false);
+    if (map == null) return [];
+
+    var condition = sql.condition;
+    if (condition is! ConditionIdIN) {
+      return [];
+    }
+
+    var ids = condition.idsValues;
+
+    var existIDs = map.keys.whereIn(ids).whereType<I>().toList();
+
+    return existIDs;
+  }
+
   @override
   FutureOr doInsertRelationshipSQL(String entityName, String table, SQL sql,
       Transaction transaction, DBSQLMemoryAdapterContext connection) {

lib/src/bones_api_entity_db_mysql.dart

@@ -643,6 +643,27 @@ class DBMySQLAdapter extends DBSQLAdapter<DBMySqlConnectionWrapper>
     });
   }
 
+  @override
+  FutureOr<List<I>> doExistIDsSQL<I extends Object>(
+      String entityName,
+      String table,
+      SQL sql,
+      Transaction transaction,
+      DBMySqlConnectionWrapper connection) {
+    if (sql.isDummy) return <I>[];
+
+    return connection
+        .query(sql.sqlPositional, sql.parametersValuesByPosition)
+        .resolveMapped((results) {
+      var ids = results
+          .map((e) => e.fields)
+          .whereType<Map<String, dynamic>>()
+          .map((e) => e['id']);
+
+      return parseIDs<I>(ids);
+    });
+  }
+
   @override
   FutureOr<Iterable<Map<String, dynamic>>> doSelectSQL(
       String entityName,