@strapi/database 4.6.0-beta.0 → 4.6.0-beta.2

package/lib/entity-manager/__tests__/relations-orderer.test.js

@@ -1,85 +1,164 @@
 'use strict';
 
-const relationsOrderer = require('../relations-orderer');
+const { relationsOrderer } = require('../relations-orderer');
 
-describe('relations orderer', () => {
-  test('connect at the end', () => {
-    const orderer = relationsOrderer(
-      [
+describe('Given I have some relations in the database', () => {
+  describe('When I connect a relation at the end', () => {
+    test('Then it is placed at the end with the correct order', () => {
+      const orderer = relationsOrderer(
+        [
+          { id: 2, order: 4 },
+          { id: 3, order: 10 },
+        ],
+        'id',
+        'order'
+      );
+
+      orderer.connect([{ id: 4, position: { end: true } }, { id: 5 }]);
+
+      expect(orderer.get()).toMatchObject([
         { id: 2, order: 4 },
         { id: 3, order: 10 },
-      ],
-      'id',
-      'order'
-    );
-
-    orderer.connect([{ id: 4, position: { end: true } }, { id: 5 }]);
-
-    expect(orderer.get()).toMatchObject([
-      { id: 2, order: 4 },
-      { id: 3, order: 10 },
-      { id: 4, order: 10.5 },
-      { id: 5, order: 10.5 },
-    ]);
+        { id: 4, order: 10.5 },
+        { id: 5, order: 10.5 },
+      ]);
+    });
   });
 
-  test('connect at the start', () => {
-    const orderer = relationsOrderer(
-      [
+  describe('When I connect a relation at the start', () => {
+    test('Then it is placed at the start with the correct order', () => {
+      const orderer = relationsOrderer(
+        [
+          { id: 2, order: 4 },
+          { id: 3, order: 10 },
+        ],
+        'id',
+        'order'
+      );
+
+      orderer.connect([{ id: 4, position: { start: true } }]);
+
+      expect(orderer.get()).toMatchObject([
+        { id: 4, order: 0.5 },
         { id: 2, order: 4 },
         { id: 3, order: 10 },
-      ],
-      'id',
-      'order'
-    );
-
-    orderer.connect([{ id: 4, position: { start: true } }]);
-
-    expect(orderer.get()).toMatchObject([
-      { id: 4, order: 0.5 },
-      { id: 2, order: 4 },
-      { id: 3, order: 10 },
-    ]);
+      ]);
+    });
   });
 
-  test('connect multiple relations', () => {
-    const orderer = relationsOrderer(
-      [
+  describe('When I connect multiple relations using before', () => {
+    test('Then they are correctly ordered', () => {
+      const orderer = relationsOrderer(
+        [
+          { id: 2, order: 4 },
+          { id: 3, order: 10 },
+        ],
+        'id',
+        'order'
+      );
+
+      orderer.connect([
+        { id: 4, position: { before: 3 } },
+        { id: 5, position: { before: 4 } },
+      ]);
+
+      expect(orderer.get()).toMatchObject([
         { id: 2, order: 4 },
+        { id: 5, order: 9.5 },
+        { id: 4, order: 9.5 },
         { id: 3, order: 10 },
-      ],
-      'id',
-      'order'
-    );
-
-    orderer.connect([
-      { id: 4, position: { before: 2 } },
-      { id: 4, position: { before: 3 } },
-      { id: 5, position: { before: 4 } },
-    ]);
-
-    expect(orderer.get()).toMatchObject([
-      { id: 2, order: 4 },
-      { id: 5, order: 9.5 },
-      { id: 4, order: 9.5 },
-      { id: 3, order: 10 },
-    ]);
+      ]);
+    });
   });
 
-  test('connect with no initial relations', () => {
-    const orderer = relationsOrderer([], 'id', 'order');
-
-    orderer.connect([
-      { id: 1, position: { start: true } },
-      { id: 2, position: { start: true } },
-      { id: 3, position: { after: 1 } },
-      { id: 1, position: { after: 2 } },
-    ]);
-
-    expect(orderer.get()).toMatchObject([
-      { id: 2, order: 0.5 },
-      { id: 1, order: 0.5 },
-      { id: 3, order: 0.5 },
-    ]);
+  describe('When you connect multiple disordered relations', () => {
+    test('Then they are correctly ordered', () => {
+      const orderer = relationsOrderer(
+        [
+          { id: 1, order: 1 },
+          { id: 2, order: 2 },
+          { id: 3, order: 3 },
+        ],
+        'id',
+        'order'
+      );
+
+      orderer.connect([
+        { id: 5, position: { before: 1 } },
+        { id: 1, position: { before: 2 } },
+        { id: 2, position: { end: true } },
+      ]);
+
+      expect(orderer.get()).toMatchObject([
+        { id: 5, order: 0.5 },
+        { id: 1, order: 1.5 },
+        { id: 3, order: 3 },
+        { id: 2, order: 3.5 },
+      ]);
+    });
+  });
+
+  describe('When you connect a relation before a non-existing relation in non-strict mode', () => {
+    test('Then it is placed at the end', () => {
+      const orderer = relationsOrderer(
+        [
+          { id: 1, order: 1 },
+          { id: 2, order: 2 },
+          { id: 3, order: 3 },
+        ],
+        'id',
+        'order',
+        false
+      );
+
+      orderer.connect([{ id: 4, position: { before: 5 } }]);
+
+      expect(orderer.get()).toMatchObject([
+        { id: 1, order: 1 },
+        { id: 2, order: 2 },
+        { id: 3, order: 3 },
+        { id: 4, order: 3.5 },
+      ]);
+    });
+  });
+});
+
+describe('Given there are no relations in the database', () => {
+  describe('When you connect multiple new relations', () => {
+    test('Then they are correctly ordered', () => {
+      const orderer = relationsOrderer([], 'id', 'order');
+
+      orderer.connect([
+        { id: 1, position: { start: true } },
+        { id: 2, position: { start: true } },
+        { id: 3, position: { after: 1 } },
+      ]);
+
+      expect(orderer.get()).toMatchObject([
+        { id: 2, order: 0.5 },
+        { id: 1, order: 0.5 },
+        { id: 3, order: 0.5 },
+      ]);
+    });
+  });
+
+  describe('When you connect multiple disordered relations', () => {
+    test('Then they are correctly ordered', () => {
+      const orderer = relationsOrderer([], 'id', 'order');
+
+      orderer.connect([
+        { id: 5, position: { before: 1 } },
+        { id: 1, position: { before: 2 } },
+        { id: 2, position: { end: true } },
+        { id: 3, position: { after: 1 } },
+      ]);
+
+      expect(orderer.get()).toMatchObject([
+        { id: 5, order: 0.5 },
+        { id: 1, order: 0.5 },
+        { id: 3, order: 0.5 },
+        { id: 2, order: 0.5 },
+      ]);
+    });
   });
 });

package/lib/entity-manager/__tests__/sort-connect-array.test.js

@@ -0,0 +1,79 @@
+'use strict';
+
+const { sortConnectArray } = require('../relations-orderer');
+
+describe('sortConnectArray', () => {
+  test('sorts connect array', () => {
+    const sortConnect = sortConnectArray([
+      { id: 5, position: { before: 1 } },
+      { id: 1, position: { before: 2 } },
+      { id: 2, position: { end: true } },
+      { id: 3, position: { after: 1 } },
+    ]);
+
+    expect(sortConnect).toMatchObject([
+      { id: 2, position: { end: true } },
+      { id: 1, position: { before: 2 } },
+      { id: 5, position: { before: 1 } },
+      { id: 3, position: { after: 1 } },
+    ]);
+  });
+
+  test('sorts connect array with initial relations', () => {
+    const sortConnect = sortConnectArray(
+      [
+        { id: 5, position: { before: 1 } },
+        { id: 1, position: { before: 2 } },
+        { id: 2, position: { end: true } },
+        { id: 3, position: { after: 1 } },
+      ],
+      [{ id: 1 }]
+    );
+
+    expect(sortConnect).toMatchObject([
+      { id: 5, position: { before: 1 } },
+      { id: 2, position: { end: true } },
+      { id: 1, position: { before: 2 } },
+      { id: 3, position: { after: 1 } },
+    ]);
+  });
+
+  test("error if position doesn't exist", () => {
+    const sortConnect = () => sortConnectArray([{ id: 1, position: { after: 2 } }]);
+
+    expect(sortConnect).toThrowError(
+      'There was a problem connecting relation with id 1 at position {"after":2}. The relation with id 2 needs to be connected first.'
+    );
+  });
+
+  test('error with circular references', () => {
+    const sortConnect = () =>
+      sortConnectArray(
+        [
+          { id: 2, position: { after: 1 } },
+          { id: 3, position: { after: 1 } },
+          { id: 1, position: { after: 3 } },
+        ],
+        []
+      );
+
+    expect(sortConnect).toThrowError(
+      'A circular reference was found in the connect array. One relation is trying to connect before/after another one that is trying to connect before/after it'
+    );
+  });
+
+  test('error when connecting same relation twice', () => {
+    const sortConnect = () =>
+      sortConnectArray(
+        [
+          { id: 1, position: { after: 2 } },
+          { id: 1, position: { after: 3 } },
+        ],
+        []
+      );
+
+    expect(sortConnect).toThrowError(
+      'The relation with id 1 is already connected. You cannot connect the same relation twice.'
+    );
+  });
+});

package/lib/entity-manager/index.js

@@ -39,7 +39,7 @@ const {
   deleteRelations,
   cleanOrderColumns,
 } = require('./regular-relations');
-const relationsOrderer = require('./relations-orderer');
+const { relationsOrderer } = require('./relations-orderer');
 
 const toId = (value) => value.id || value;
 const toIds = (value) => castArray(value || []).map(toId);
@@ -78,6 +78,9 @@ const toAssocs = (data) => {
   }
 
   return {
+    options: {
+      strict: data?.options?.strict,
+    },
     connect: toIdArray(data?.connect).map((elm) => ({
       id: elm.id,
       position: elm.position ? elm.position : { end: true },
@@ -583,7 +586,12 @@ const createEntityManager = (db) => {
             });
           } else if (cleanRelationData.connect && hasOrderColumn(attribute)) {
             // use position attributes to calculate order
-            const orderMap = relationsOrderer([], inverseJoinColumn.name, joinTable.orderColumnName)
+            const orderMap = relationsOrderer(
+              [],
+              inverseJoinColumn.name,
+              joinTable.orderColumnName,
+              true // Always make an strict connect when inserting
+            )
               .connect(relsToAdd)
               .get()
               // set the order based on the order of the ids
@@ -873,7 +881,8 @@ const createEntityManager = (db) => {
                 const orderMap = relationsOrderer(
                   adjacentRelations,
                   inverseJoinColumn.name,
-                  joinTable.orderColumnName
+                  joinTable.orderColumnName,
+                  cleanRelationData.options.strict
                 )
                   .connect(cleanRelationData.connect)
                   .getOrderMap();

package/lib/entity-manager/regular-relations.js

@@ -198,60 +198,42 @@ const cleanOrderColumns = async ({ id, attribute, db, inverseRelIds, transaction
     return;
   }
 
-  // Handle databases that don't support window function ROW_NUMBER
-  if (!strapi.db.dialect.supportsWindowFunctions()) {
-    await cleanOrderColumnsForOldDatabases({ id, attribute, db, inverseRelIds, transaction: trx });
-    return;
-  }
-
-  const { joinTable } = attribute;
-  const { joinColumn, inverseJoinColumn, orderColumnName, inverseOrderColumnName } = joinTable;
-  const update = [];
-  const updateBinding = [];
-  const select = ['??'];
-  const selectBinding = ['id'];
-  const where = [];
-  const whereBinding = [];
-
-  if (hasOrderColumn(attribute) && id) {
-    update.push('?? = b.src_order');
-    updateBinding.push(orderColumnName);
-    select.push('ROW_NUMBER() OVER (PARTITION BY ?? ORDER BY ??) AS src_order');
-    selectBinding.push(joinColumn.name, orderColumnName);
-    where.push('?? = ?');
-    whereBinding.push(joinColumn.name, id);
-  }
-
-  if (hasInverseOrderColumn(attribute) && !isEmpty(inverseRelIds)) {
-    update.push('?? = b.inv_order');
-    updateBinding.push(inverseOrderColumnName);
-    select.push('ROW_NUMBER() OVER (PARTITION BY ?? ORDER BY ??) AS inv_order');
-    selectBinding.push(inverseJoinColumn.name, inverseOrderColumnName);
-    where.push(`?? IN (${inverseRelIds.map(() => '?').join(', ')})`);
-    whereBinding.push(inverseJoinColumn.name, ...inverseRelIds);
-  }
-
-  // raw query as knex doesn't allow updating from a subquery
-  // https://github.com/knex/knex/issues/2504
   switch (strapi.db.dialect.client) {
     case 'mysql':
-      await db.connection
-        .raw(
-          `UPDATE
-            ?? as a,
-            (
-              SELECT ${select.join(', ')}
-              FROM ??
-              WHERE ${where.join(' OR ')}
-            ) AS b
-          SET ${update.join(', ')}
-          WHERE b.id = a.id`,
-          [joinTable.name, ...selectBinding, joinTable.name, ...whereBinding, ...updateBinding]
-        )
-        .transacting(trx);
+      await cleanOrderColumnsForInnoDB({ id, attribute, db, inverseRelIds, transaction: trx });
       break;
     default: {
+      const { joinTable } = attribute;
+      const { joinColumn, inverseJoinColumn, orderColumnName, inverseOrderColumnName } = joinTable;
+      const update = [];
+      const updateBinding = [];
+      const select = ['??'];
+      const selectBinding = ['id'];
+      const where = [];
+      const whereBinding = [];
+
+      if (hasOrderColumn(attribute) && id) {
+        update.push('?? = b.src_order');
+        updateBinding.push(orderColumnName);
+        select.push('ROW_NUMBER() OVER (PARTITION BY ?? ORDER BY ??) AS src_order');
+        selectBinding.push(joinColumn.name, orderColumnName);
+        where.push('?? = ?');
+        whereBinding.push(joinColumn.name, id);
+      }
+
+      if (hasInverseOrderColumn(attribute) && !isEmpty(inverseRelIds)) {
+        update.push('?? = b.inv_order');
+        updateBinding.push(inverseOrderColumnName);
+        select.push('ROW_NUMBER() OVER (PARTITION BY ?? ORDER BY ??) AS inv_order');
+        selectBinding.push(inverseJoinColumn.name, inverseOrderColumnName);
+        where.push(`?? IN (${inverseRelIds.map(() => '?').join(', ')})`);
+        whereBinding.push(inverseJoinColumn.name, ...inverseRelIds);
+      }
+
       const joinTableName = addSchema(joinTable.name);
+
+      // raw query as knex doesn't allow updating from a subquery
+      // https://github.com/knex/knex/issues/2504
       await db.connection
         .raw(
           `UPDATE ?? as a
@@ -265,24 +247,29 @@ const cleanOrderColumns = async ({ id, attribute, db, inverseRelIds, transaction
           [joinTableName, ...updateBinding, ...selectBinding, joinTableName, ...whereBinding]
         )
         .transacting(trx);
+
+      /*
+        `UPDATE :joinTable: as a
+          SET :orderColumn: = b.src_order, :inverseOrderColumn: = b.inv_order
+          FROM (
+            SELECT
+              id,
+              ROW_NUMBER() OVER ( PARTITION BY :joinColumn: ORDER BY :orderColumn:) AS src_order,
+              ROW_NUMBER() OVER ( PARTITION BY :inverseJoinColumn: ORDER BY :inverseOrderColumn:) AS inv_order
+            FROM :joinTable:
+            WHERE :joinColumn: = :id OR :inverseJoinColumn: IN (:inverseRelIds)
+          ) AS b
+          WHERE b.id = a.id`,
+      */
     }
-    /*
-      `UPDATE :joinTable: as a
-        SET :orderColumn: = b.src_order, :inverseOrderColumn: = b.inv_order
-        FROM (
-          SELECT
-            id,
-            ROW_NUMBER() OVER ( PARTITION BY :joinColumn: ORDER BY :orderColumn:) AS src_order,
-            ROW_NUMBER() OVER ( PARTITION BY :inverseJoinColumn: ORDER BY :inverseOrderColumn:) AS inv_order
-          FROM :joinTable:
-          WHERE :joinColumn: = :id OR :inverseJoinColumn: IN (:inverseRelIds)
-        ) AS b
-        WHERE b.id = a.id`,
-    */
   }
 };
 
-const cleanOrderColumnsForOldDatabases = async ({
+/*
+ * Ensure that orders are following a 1, 2, 3 sequence, without gap.
+ * The use of a temporary table instead of a window function makes the query compatible with MySQL 5 and prevents some deadlocks to happen in innoDB databases
+ */
+const cleanOrderColumnsForInnoDB = async ({
   id,
   attribute,
   db,
@@ -309,7 +296,9 @@ const cleanOrderColumnsForOldDatabases = async ({
                 FROM :joinTableName: b
                 WHERE a.:orderColumnName: >= b.:orderColumnName: AND a.:joinColumnName: = b.:joinColumnName: AND a.:joinColumnName: = :id
               ) AS src_order
-            FROM :joinTableName: a`,
+            FROM :joinTableName: a
+            WHERE a.:joinColumnName: = :id
+            `,
           {
             tempOrderTableName,
             joinTableName: joinTable.name,
@@ -319,6 +308,9 @@ const cleanOrderColumnsForOldDatabases = async ({
           }
         )
         .transacting(trx);
+
+      // raw query as knex doesn't allow updating from a subquery
+      // https://github.com/knex/knex/issues/2504
       await db.connection
         .raw(
           `UPDATE ?? as a, (SELECT * FROM ??) AS b
@@ -338,7 +330,7 @@ const cleanOrderColumnsForOldDatabases = async ({
       await db.connection
         .raw(
           `
-          CREATE TEMPORARY TABLE ??
+          CREATE TABLE ??
             SELECT
               id,
               (
@@ -348,7 +340,9 @@ const cleanOrderColumnsForOldDatabases = async ({
                   .map(() => '?')
                   .join(', ')})
               ) AS inv_order
-            FROM ?? a`,
+            FROM ?? a
+            WHERE a.?? IN (${inverseRelIds.map(() => '?').join(', ')})
+            `,
           [
             tempInvOrderTableName,
             joinTable.name,
@@ -359,6 +353,8 @@ const cleanOrderColumnsForOldDatabases = async ({
             inverseJoinColumn.name,
             ...inverseRelIds,
             joinTable.name,
+            inverseJoinColumn.name,
+            ...inverseRelIds,
           ]
         )
         .transacting(trx);
@@ -371,9 +367,7 @@ const cleanOrderColumnsForOldDatabases = async ({
         )
         .transacting(trx);
     } finally {
-      await db.connection
-        .raw(`DROP TEMPORARY TABLE IF EXISTS ??`, [tempInvOrderTableName])
-        .transacting(trx);
+      await db.connection.raw(`DROP TABLE IF EXISTS ??`, [tempInvOrderTableName]).transacting(trx);
     }
   }
 };

package/lib/entity-manager/relations-orderer.js

@@ -1,6 +1,107 @@
 'use strict';
 
+const { castArray } = require('lodash/fp');
 const _ = require('lodash/fp');
+const { InvalidRelationError } = require('../errors');
+/**
+ * When connecting relations, the order you connect them matters.
+ *
+ * Example, if you connect the following relations:
+ *   { id: 5, position: { before: 1 } }
+ *   { id: 1, position: { before: 2 } }
+ *   { id: 2, position: { end: true } }
+ *
+ * Going through the connect array, id 5 has to be connected before id 1,
+ * so the order of id5 = id1 - 1. But the order value of id 1 is unknown.
+ * The only way to know the order of id 1 is to connect it first.
+ *
+ * This function makes sure the relations are connected in the right order:
+ *   { id: 2, position: { end: true } }
+ *   { id: 1, position: { before: 2 } }
+ *   { id: 5, position: { before: 1 } }
+ *
+ */
+const sortConnectArray = (connectArr, initialArr = [], strictSort = true) => {
+  const sortedConnect = [];
+  // Boolean to know if we have to recalculate the order of the relations
+  let needsSorting = false;
+  // Map to validate if relation is already in sortedConnect or DB.
+  const relationInInitialArray = initialArr.reduce((acc, rel) => ({ ...acc, [rel.id]: true }), {});
+  // Map to store the first index where a relation id is connected
+  const mappedRelations = connectArr.reduce((mapper, relation) => {
+    const adjacentRelId = relation.position?.before || relation.position?.after;
+
+    if (!relationInInitialArray[adjacentRelId] && !mapper[adjacentRelId]) {
+      needsSorting = true;
+    }
+
+    // If the relation is already in the array, throw an error
+    if (mapper[relation.id]) {
+      throw new InvalidRelationError(
+        `The relation with id ${relation.id} is already connected. ` +
+          'You cannot connect the same relation twice.'
+      );
+    }
+
+    return {
+      [relation.id]: { ...relation, computed: false },
+      ...mapper,
+    };
+  }, {});
+
+  // If we don't need to sort the connect array, we can return it as is
+  if (!needsSorting) return connectArr;
+
+  // Recursively compute in which order the relation should be connected
+  const computeRelation = (relation, relationsSeenInBranch) => {
+    const adjacentRelId = relation.position?.before || relation.position?.after;
+    const adjacentRelation = mappedRelations[adjacentRelId];
+
+    // If the relation has already been seen in the current branch,
+    // it means there is a circular reference
+    if (relationsSeenInBranch[adjacentRelId]) {
+      throw new InvalidRelationError(
+        'A circular reference was found in the connect array. ' +
+          'One relation is trying to connect before/after another one that is trying to connect before/after it'
+      );
+    }
+
+    // This relation has already been computed
+    if (mappedRelations[relation.id]?.computed) return;
+
+    mappedRelations[relation.id].computed = true;
+
+    // Relation does not have a before or after attribute or is in the initial array
+    if (!adjacentRelId || relationInInitialArray[adjacentRelId]) {
+      sortedConnect.push(relation);
+      return;
+    }
+
+    // Look if id is referenced elsewhere in the array
+    if (mappedRelations[adjacentRelId]) {
+      computeRelation(adjacentRelation, { ...relationsSeenInBranch, [relation.id]: true });
+      sortedConnect.push(relation);
+    } else if (strictSort) {
+      // If we reach this point, it means that the adjacent relation is not in the connect array
+      // and it is not in the database.
+      throw new InvalidRelationError(
+        `There was a problem connecting relation with id ${
+          relation.id
+        } at position ${JSON.stringify(
+          relation.position
+        )}. The relation with id ${adjacentRelId} needs to be connected first.`
+      );
+    } else {
+      // We are in non-strict mode so we can push the relation.
+      sortedConnect.push({ id: relation.id, position: { end: true } });
+    }
+  };
+
+  // Iterate over connectArr and populate sortedConnect
+  connectArr.forEach((relation) => computeRelation(relation, {}));
+
+  return sortedConnect;
+};
 
 /**
  * Responsible for calculating the relations order when connecting them.
@@ -23,34 +124,31 @@ const _ = require('lodash/fp');
  * - The final step would be to recalculate fractional order values.
  *      [ { id: 2, order: 4 }, { id: 5, order: 3.33 },  { id: 4, order: 3.66 }, { id: 3, order: 10 } ]
  *
- * Constraints:
- * - Expects you will never connect a relation before / after one that does not exist
- * - Expect initArr to have all relations referenced in the positional attributes
- *
  * @param {Array<*>} initArr - array of relations to initialize the class with
  * @param {string} idColumn - the column name of the id
  * @param {string} orderColumn - the column name of the order
+ * @param {boolean} strict - if true, will throw an error if a relation is connected adjacent to
+ *                               another one that does not exist
  * @return {*}
  */
-const relationsOrderer = (initArr, idColumn, orderColumn) => {
-  const arr = _.castArray(initArr || []).map((r) => ({
+const relationsOrderer = (initArr, idColumn, orderColumn, strict) => {
+  const computedRelations = _.castArray(initArr || []).map((r) => ({
     init: true,
     id: r[idColumn],
     order: r[orderColumn],
   }));
 
-  const maxOrder = _.maxBy('order', arr)?.order || 0;
+  const maxOrder = _.maxBy('order', computedRelations)?.order || 0;
 
-  // TODO: Improve performance by using a map
   const findRelation = (id) => {
-    const idx = arr.findIndex((r) => r.id === id);
-    return { idx, relation: arr[idx] };
+    const idx = computedRelations.findIndex((r) => r.id === id);
+    return { idx, relation: computedRelations[idx] };
   };
 
   const removeRelation = (r) => {
     const { idx } = findRelation(r.id);
     if (idx >= 0) {
-      arr.splice(idx, 1);
+      computedRelations.splice(idx, 1);
     }
   };
 
@@ -72,45 +170,46 @@ const relationsOrderer = (initArr, idColumn, orderColumn) => {
       idx = 0;
     } else {
       r.order = maxOrder + 0.5;
-      idx = arr.length;
+      idx = computedRelations.length;
     }
 
     // Insert the relation in the array
-    arr.splice(idx, 0, r);
+    computedRelations.splice(idx, 0, r);
   };
 
   return {
     disconnect(relations) {
-      _.castArray(relations).forEach((relation) => {
+      castArray(relations).forEach((relation) => {
         removeRelation(relation);
       });
       return this;
     },
     connect(relations) {
-      _.castArray(relations).forEach((relation) => {
+      sortConnectArray(castArray(relations), computedRelations, strict).forEach((relation) => {
         this.disconnect(relation);
 
         try {
           insertRelation(relation);
         } catch (err) {
-          strapi.log.error(err);
           throw new Error(
-            `Could not connect ${relation.id}, position ${JSON.stringify(
+            `There was a problem connecting relation with id ${
+              relation.id
+            } at position ${JSON.stringify(
               relation.position
-            )} is invalid`
+            )}. The list of connect relations is not valid`
           );
         }
       });
       return this;
     },
     get() {
-      return arr;
+      return computedRelations;
     },
     /**
      * Get a map between the relation id and its order
      */
     getOrderMap() {
-      return _(arr)
+      return _(computedRelations)
         .groupBy('order')
         .reduce((acc, relations) => {
           if (relations[0]?.init) return acc;
@@ -123,4 +222,4 @@ const relationsOrderer = (initArr, idColumn, orderColumn) => {
   };
 };
 
-module.exports = relationsOrderer;
+module.exports = { relationsOrderer, sortConnectArray };

package/lib/errors/index.js

@@ -5,6 +5,7 @@ const NotNullError = require('./not-null');
 const InvalidTimeError = require('./invalid-time');
 const InvalidDateError = require('./invalid-date');
 const InvalidDateTimeError = require('./invalid-datetime');
+const InvalidRelationError = require('./invalid-relation');
 
 module.exports = {
   DatabaseError,
@@ -12,4 +13,5 @@ module.exports = {
   InvalidTimeError,
   InvalidDateError,
   InvalidDateTimeError,
+  InvalidRelationError,
 };

package/lib/errors/invalid-relation.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const DatabaseError = require('./database');
+
+class InvalidRelationError extends DatabaseError {
+  constructor(message) {
+    super();
+    this.name = 'InvalidRelationFormat';
+    this.message = message || 'Invalid relation format';
+    this.details = {};
+  }
+}
+
+module.exports = InvalidRelationError;

package/lib/index.d.ts

@@ -1,3 +1,4 @@
+import { Knex } from 'knex';
 import { LifecycleProvider } from './lifecycles';
 import { MigrationProvider } from './migrations';
 import { SchemaProvider } from './schema';
@@ -31,8 +32,7 @@ type AttributeOperators<T, K extends keyof T> = {
 
 export type WhereParams<T> = {
   [K in keyof T]?: T[K] | T[K][] | AttributeOperators<T, K>;
-} &
-  LogicalOperators<T>;
+} & LogicalOperators<T>;
 
 type Sortables<T> = {
   // check sortable
@@ -158,6 +158,9 @@ export interface Database {
   lifecycles: LifecycleProvider;
   migrations: MigrationProvider;
   entityManager: EntityManager;
+  queryBuilder: any;
+  metadata: any;
+  connection: Knex;
 
   query<T extends keyof AllTypes>(uid: T): QueryFromContentType<T>;
 }

package/lib/index.js

@@ -20,6 +20,8 @@ class Database {
       connection: {},
       settings: {
         forceMigration: true,
+        runMigrations: true,
+        ...config.settings,
       },
       ...config,
     };

package/lib/migrations/index.js

@@ -61,7 +61,7 @@ const createMigrationsProvider = (db) => {
     async shouldRun() {
       const pending = await migrations.pending();
 
-      return pending.length > 0;
+      return pending.length > 0 && db.config.settings.runMigrations;
     },
     async up() {
       await migrations.up();

package/lib/query/helpers/index.js

@@ -7,4 +7,5 @@ module.exports = {
   ...require('./populate'),
   ...require('./where'),
   ...require('./transform'),
+  ...require('./streams'),
 };

package/lib/query/helpers/streams/index.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+  ReadableQuery: require('./readable'),
+};

package/lib/query/helpers/streams/readable.js

@@ -0,0 +1,174 @@
+'use strict';
+
+const { Readable } = require('stream');
+const { isFinite } = require('lodash/fp');
+
+const { applyPopulate } = require('../populate');
+const { fromRow } = require('../transform');
+
+const knexQueryDone = Symbol('knexQueryDone');
+const knexPerformingQuery = Symbol('knexPerformingQuery');
+
+class ReadableStrapiQuery extends Readable {
+  /**
+   * @param {object} options
+   * @param {ReturnType<typeof import('../../query-builder')>} options.qb The strapi query builder instance
+   * @param {string} options.uid The model uid
+   * @param {import('../../../index').Database} options.db The Database instance
+   * @param {boolean} [options.mapResults] The maximum number of entities to fetch per query
+   * @param {number} [options.batchSize] The maximum number of entities to fetch per query
+   */
+  constructor({ qb, db, uid, mapResults = true, batchSize = 500 }) {
+    super({ objectMode: true, highWaterMark: batchSize });
+
+    // Extract offset & limit from the query-builder's state
+    const { offset, limit } = qb.state;
+
+    // Original offset value
+    this._offset = isFinite(offset) ? offset : 0;
+
+    // Max amount of entities to fetch, force null as undefined value
+    this._limit = isFinite(limit) ? limit : null;
+
+    // Total amount of entities fetched
+    this._fetched = 0;
+
+    /**
+     * Original query
+     * @type {import('knex').Knex}
+     */
+    this._query = qb.getKnexQuery();
+
+    // Query Builder instance
+    this._qb = qb;
+
+    // Database related properties
+    this._db = db;
+    this._uid = uid;
+    this._meta = db.metadata.get(uid);
+
+    // Stream params
+    this._batchSize = batchSize;
+    this._mapResults = mapResults;
+
+    // States
+    this[knexPerformingQuery] = false;
+  }
+
+  _destroy(err, cb) {
+    // If the stream is destroyed while a query is being made, then wait for a
+    // kQueryDone event to be emitted before actually destroying the stream
+    if (this[knexPerformingQuery]) {
+      this.once(knexQueryDone, (er) => cb(err || er));
+    } else {
+      cb(err);
+    }
+  }
+
+  /**
+   * Custom ._read() implementation
+   *
+   *  NOTE: Here "size" means the number of entities to be read from the database.
+   *  Not the actual byte size, as it would means that we need to return partial entities.
+   *
+   * @param {number} size
+   */
+  async _read(size) {
+    const query = this._query;
+
+    // Remove the original offset & limit properties from the query
+    // Theoretically, they would be replaced by calling them again, but this is just to be sure
+    query.clear('limit').clear('offset');
+
+    // Define the maximum read size based on the limit and the requested size
+    // NOTE: size is equal to _batchSize by default. Since we want to allow customizing it on
+    // the fly, we need to use its value instead of batchSize when computing the maxReadSize value
+    const maxReadSize =
+      // if no limit is defined in the query, use the given size,
+      // otherwise, use the smallest value between the two
+      this._limit === null ? size : Math.min(size, this._limit);
+
+    // Compute the limit for the next query
+    const limit =
+      // If a limit is defined
+      this._limit !== null &&
+      // And reading `maxReadSize` would fetch too many entities (> _limit)
+      this._fetched + maxReadSize > this._limit
+        ? // Then adjust the limit so that it only get the remaining entities
+          this._limit - this._fetched
+        : // Else, use the max read size
+          maxReadSize;
+
+    // If we don't have anything left to read (_limit === _fetched),
+    // don't bother making the query and end the stream by pushing null
+    if (limit <= 0) {
+      this.push(null);
+      return;
+    }
+
+    // Compute the offset (base offset + number of entities already fetched)
+    const offset = this._offset + this._fetched;
+
+    // Update the query with the new values (offset + limit)
+    query.offset(offset).limit(limit);
+
+    // Lock the ._destroy()
+    this[knexPerformingQuery] = true;
+
+    let results;
+    let count;
+    let err;
+
+    try {
+      // Execute the query and store the results & count
+      results = await query;
+
+      const { populate } = this._qb.state;
+
+      // Apply populate if needed
+      if (populate) {
+        await applyPopulate(results, populate, { qb: this._qb, uid: this._uid, db: this._db });
+      }
+
+      // Map results if asked to
+      if (this._mapResults) {
+        results = fromRow(this._meta, results);
+      }
+
+      count = results.length;
+    } catch (e) {
+      err = e;
+    }
+
+    // Unlock the ._destroy()
+    this[knexPerformingQuery] = false;
+
+    // Tell ._destroy() that it's now safe to close the db connection
+    if (this.destroyed) {
+      this.emit(knexQueryDone);
+      return;
+    }
+
+    // If there is an error, destroy with the given error
+    if (err) {
+      this.destroy(err);
+      return;
+    }
+
+    // Update the amount of fetched entities
+    this._fetched += count;
+
+    // While there is at least one value to unpack
+    for (const result of results) {
+      this.push(result);
+    }
+
+    // If the amount of fetched entities is smaller than the
+    // maximum read size, Then push null to close the stream
+    if (this._fetched === this._limit || count < this._batchSize) {
+      this.push(null);
+    }
+  }
+}
+
+module.exports = ReadableStrapiQuery;

package/lib/query/query-builder.js

@@ -2,6 +2,7 @@
 
 const _ = require('lodash/fp');
 
+const { DatabaseError } = require('../errors');
 const helpers = require('./helpers');
 
 const createQueryBuilder = (uid, db, initialState = {}) => {
@@ -488,6 +489,16 @@ const createQueryBuilder = (uid, db, initialState = {}) => {
         db.dialect.transformErrors(error);
       }
     },
+
+    stream({ mapResults = true } = {}) {
+      if (state.type === 'select') {
+        return new helpers.ReadableQuery({ qb: this, db, uid, mapResults });
+      }
+
+      throw new DatabaseError(
+        `query-builder.stream() has been called with an unsupported query type: "${state.type}"`
+      );
+    },
   };
 };
 

package/lib/schema/index.d.ts

@@ -46,4 +46,4 @@ export interface SchemaProvider {
   drop(): Promise<void>;
 }
 
-export default function(db: Database): SchemaProvider;
+export default function (db: Database): SchemaProvider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/database",
-  "version": "4.6.0-beta.0",
+  "version": "4.6.0-beta.2",
   "description": "Strapi's database layer",
   "homepage": "https://strapi.io",
   "bugs": {
@@ -31,7 +31,7 @@
     "test:unit": "jest --verbose"
   },
   "dependencies": {
-    "date-fns": "2.29.2",
+    "date-fns": "2.29.3",
     "debug": "4.3.4",
     "fs-extra": "10.0.0",
     "knex": "1.0.7",
@@ -43,5 +43,5 @@
     "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "c0c3365ad801d088a6ab6c4eb95a014078429747"
+  "gitHead": "b852090f931cd21868c4016f24db2f9fdfc7a7ab"
 }