类 DeleteQuery

处理清除迭代器并克隆所有表达式和值绑定器。

返回值

构造函数。

参数

返回一个数组，该数组可用于描述此对象的内部状态。

返回值

返回此查询的字符串表示形式（完整的 SQL 语句）。

返回值

用于通过组合 QueryExpression 对象来构建条件的辅助函数。

参数

返回值

将查询标记为脏，从内存缓存中删除任何预处理信息。

返回值

traverseExpressions() 使用的查询部分遍历方法

参数

返回值

返回一个数组，该数组可以传递给描述单个连接子句的 join 方法。

参数

返回值

使用 AND 运算符将任何先前定义的条件集连接到提供的列表。此函数接受与方法 where 相同格式的条件列表，因此您可以使用数组、表达式对象回调函数或字符串。

重要的是要注意，在调用此函数时，为该查询定义的任何先前条件集将被视为 AND 运算符的单个参数。此函数不仅会操作最新定义的条件，还会操作所有条件。

当使用数组定义条件时，从每个数组条目创建约束将使用与 where() 函数相同的逻辑。这意味着每个数组条目将使用 AND 运算符与其他条目连接，除非您使用其他运算符将条件嵌套在数组中。

示例

$query->where(['title' => 'Hello World')->andWhere(['author_id' => 1]);

将生成

WHERE title = 'Hello World' AND author_id = 1

$query
  ->where(['OR' => ['published' => false, 'published is NULL']])
  ->andWhere(['author_id' => 1, 'comments_count >' => 10])

生成

WHERE (published = 0 OR published IS NULL) AND author_id = 1 AND comments_count > 10

$query
  ->where(['title' => 'Foo'])
  ->andWhere(function ($exp, $query) {
    return $exp
      ->or(['author_id' => 1])
      ->add(['author_id' => 2]);
  });

生成以下条件

WHERE (title = 'Foo') AND (author_id = 1 OR author_id = 2)

参数

返回值

另请参阅

将查询占位符与值和类型关联。

$query->bind(':id', 1, 'integer');

参数

返回值

返回存储在指定子句中的任何数据。这对于修改查询的任何内部部分很有用，并且 SQL 方言在执行查询之前使用它来相应地转换查询。可以检索的有效子句是：delete、update、set、insert、values、select、distinct、from、join、set、where、group、having、order、limit、offset、union 和 intersect。

每个部分的返回值可能不同。一些子句使用 QueryExpression 在内部存储其状态，一些子句使用数组，而其他子句可能使用布尔值或整数。以下是每个子句的返回值类型的摘要。

• update：string 要更新的表的名称
• set：QueryExpression
• insert：array，将返回一个包含表 + 列的数组。
• values：ValuesExpression
• select：array，当没有设置字段时将返回空数组
• distinct：boolean
• from：表数组
• join：array
• set：array
• where：QueryExpression，当未设置时返回 null
• group：array
• having：QueryExpression，当未设置时返回 null
• order：OrderByExpression，当未设置时返回 null
• limit：integer 或 QueryExpression，当未设置时返回 null
• offset：integer 或 QueryExpression，当未设置时返回 null
• union：array
• intersect：array

参数

返回值

抛出

一个字符串或表达式，它将作为注释附加到生成的查询。

示例

$query->select('id')->where(['author_id' => 1])->comment('Filter for admin user');

注释内容是原始 SQL，不适合与用户提供的数据一起使用。

参数

返回值

创建一个删除查询。

可以与 from()、where() 和其他方法结合使用，以创建具有特定条件的删除查询。

参数

返回值

一个字符串或表达式，它将附加到生成的查询。

示例

$query->select('id')->where(['author_id' => 1])->epilog('FOR UPDATE');
$query
 ->insert('articles', ['title'])
 ->values(['author_id' => 1])
 ->epilog('RETURNING id');

Epliog 内容是原始 SQL，不适合与用户提供的数据一起使用。

参数

返回值

编译此查询的 SQL 表示形式，并使用配置的连接对象执行它。返回结果语句对象。

在内部执行查询会执行几个步骤，第一个步骤是让连接转换此对象以适应其特定的方言，这可能会导致生成一个不同的 Query 对象，该对象将是实际执行的对象。紧随其后，文字值将传递给连接，以便以安全的方式绑定到查询。最后，生成的语句用自定义对象装饰，以在必要时为检索到的每一行执行回调。

生成的语句是可遍历的，因此它可以在任何循环中使用，就像使用数组一样。

此方法可以在查询子类中被重写以在查询执行周围装饰行为。

返回值

返回一个新的 QueryExpression 对象。这是使用流畅界面构建复杂查询时的便捷函数。您还可以覆盖子类中的此函数，以在需要时使用更专业的 QueryExpression 类。

可以选择传递一个原始 SQL 字符串，或者传递一个数组或表达式，任何格式都可以被 \Cake\Database\Expression\QueryExpression 接受

$expression = $query->expr(); // Returns an empty expression object
$expression = $query->expr('Table.column = Table2.column'); // Return a raw SQL expression

参数

返回值

将一个或多个表添加到此查询的 FROM 子句中。表可以作为字符串数组、表达式对象数组、单个表达式或单个字符串传递。

如果传递了一个数组，则键将用于使用值作为要别名的真实字段来别名表。可以别名字符串、ExpressionInterface 对象甚至其他 Query 对象。

默认情况下，此函数会将任何传递的参数追加到要从中选择的表的列表中，除非第二个参数设置为 true。

此方法可用于 select、update 和 delete 语句。

示例

$query->from(['p' => 'posts']); // Produces FROM posts p
$query->from('authors'); // Appends authors: FROM posts p, authors
$query->from(['products'], true); // Resets the list: FROM products
$query->from(['sub' => $countQuery]); // FROM (SELECT ...) sub

参数

返回值

返回一个函数构建器对象实例，该实例可用于生成任意 SQL 函数。

示例

$query->func()->count('*');
$query->func()->dateDiff(['2012-01-05', '2012-01-02'])

返回值

获取用于执行和转换此查询的连接实例。

返回值

返回连接角色 ('read' 或 'write')

返回值

获取当前类型映射的默认类型。

返回值

返回现有的类型映射。

返回值

返回当前使用的 ValueBinder 实例。

ValueBinder 负责生成查询占位符，并将值临时关联到这些占位符，以便它们可以正确传递给语句对象。

返回值

创建一个引用标识符的表达式。标识符用于引用字段名称，并允许 SQL 编译器应用引号或转义标识符。

值按原样使用，并且您可能需要在标识符中使用别名或包含表引用。不要使用此方法注入 SQL 方法或逻辑语句。

示例

$query->newExpr()->lte('count', $query->identifier('total'));

参数

返回值

向查询添加一个 INNER JOIN 子句。

这是通过 join() 构建联接的简写方法。

此方法的参数与 leftJoin() 简写相同，请参阅该方法的描述以了解更多详细信息。

参数

返回值

将一个或多个表添加到此查询中用作 JOIN 子句。表可以作为字符串数组、描述连接部分的数组、包含多个连接描述的数组或单个字符串传递。

默认情况下，此函数会将任何传递的参数追加到要联接的表的列表中，除非第三个参数设置为 true。

当未指定联接类型时，默认情况下使用 INNER JOIN：$query->join(['authors']) 将生成 INNER JOIN authors ON 1 = 1

也可以使用数组键来别名联接：$query->join(['a' => 'authors']) 将生成 INNER JOIN authors a ON 1 = 1

可以使用数组符号来完整描述和别名联接

$query->join([
    'a' => [
        'table' => 'authors',
        'type' => 'LEFT',
        'conditions' => 'a.id = b.author_id'
    ]
]);
// Produces LEFT JOIN authors a ON a.id = b.author_id

您甚至可以在数组中指定多个联接，包括完整描述

$query->join([
    'a' => [
        'table' => 'authors',
        'type' => 'LEFT',
        'conditions' => 'a.id = b.author_id'
    ],
    'p' => [
        'table' => 'publishers',
        'type' => 'INNER',
        'conditions' => 'p.id = b.publisher_id AND p.name = "Cake Software Foundation"'
    ]
]);
// LEFT JOIN authors a ON a.id = b.author_id
// INNER JOIN publishers p ON p.id = b.publisher_id AND p.name = "Cake Software Foundation"

使用条件和类型

可以使用字符串来表达条件，如上面的示例所示，使用字符串来比较列，或者使用包含已引用文字值的字符串。此外，还可以使用数组或表达式对象中表达的条件。

当使用数组来表达条件时，通常希望将文字值转换为正确的数据库表示。这可以通过此函数的第二个参数来实现。

$query->join(['a' => [
    'table' => 'articles',
    'conditions' => [
        'a.posted >=' => new DateTime('-3 days'),
        'a.published' => true,
        'a.author_id = authors.id'
    ]
]], ['a.posted' => 'datetime', 'a.published' => 'boolean'])

覆盖联接

当使用数组符号创建别名联接时，可以通过在后续对该函数的调用中使用相同的别名来覆盖以前的联接定义，或者如果该函数的第三个参数设置为 true，则可以使用另一个列表替换所有先前定义的联接。

$query->join(['alias' => 'table']); // joins table with as alias
$query->join(['alias' => 'another_table']); // joins another_table with as alias
$query->join(['something' => 'different_table'], [], true); // resets joins list

参数

返回值

另请参阅

向查询添加一个 LEFT JOIN 子句。

这是通过 join() 构建联接的简写方法。

表名可以作为字符串传递，或者如果需要别名，可以作为数组传递

// LEFT JOIN authors ON authors.id = posts.author_id
$query->leftJoin('authors', 'authors.id = posts.author_id');

// LEFT JOIN authors a ON a.id = posts.author_id
$query->leftJoin(['a' => 'authors'], 'a.id = posts.author_id');

条件可以作为字符串、数组或表达式对象传递。当使用数组时，可以将它们与 $types 参数结合起来，以定义如何转换值

$query->leftJoin(['a' => 'articles'], [
     'a.posted >=' => new DateTime('-3 days'),
     'a.published' => true,
     'a.author_id = authors.id'
], ['a.posted' => 'datetime', 'a.published' => 'boolean']);

有关条件和类型的更多详细信息，请参见 join()。

参数

返回值

设置应从数据库中检索的记录数，接受一个整数或一个计算结果为整数的表达式对象。在某些数据库中，此操作可能不受支持，或者需要转换查询才能限制结果集大小。

示例

$query->limit(10) // generates LIMIT 10
$query->limit($query->newExpr()->add(['1 + 1'])); // LIMIT (1 + 1)

参数

返回值

向 SELECT 中添加一个或多个 SELECT 修饰符。

默认情况下，此函数会将任何传递的参数追加到要应用的修饰符列表中，除非第二个参数设置为 true。

示例

// Ignore cache query in MySQL
$query->select(['name', 'city'])->from('products')->modifier('SQL_NO_CACHE');
// It will produce the SQL: SELECT SQL_NO_CACHE name, city FROM products

// Or with multiple modifiers
$query->select(['name', 'city'])->from('products')->modifier(['HIGH_PRIORITY', 'SQL_NO_CACHE']);
// It will produce the SQL: SELECT HIGH_PRIORITY SQL_NO_CACHE name, city FROM products

参数

返回值

返回一个新的 QueryExpression 对象。这是使用流畅界面构建复杂查询时的便捷函数。您还可以覆盖子类中的此函数，以在需要时使用更专业的 QueryExpression 类。

可以选择传递一个原始 SQL 字符串，或者传递一个数组或表达式，任何格式都可以被 \Cake\Database\Expression\QueryExpression 接受

$expression = $query->expr(); // Returns an empty expression object
$expression = $query->expr('Table.column = Table2.column'); // Return a raw SQL expression

参数

返回值

设置应从原始结果集中跳过的记录数。这通常用于对大型结果进行分页。接受一个整数或一个计算结果为整数的表达式对象。

在某些数据库中，此操作可能不受支持，或者需要转换查询才能限制结果集的大小。

示例

$query->offset(10) // generates OFFSET 10
$query->offset($query->newExpr()->add(['1 + 1'])); // OFFSET (1 + 1)

参数

返回值

将一个或多个字段添加到此查询的 ORDER 子句中。字段可以作为字符串数组、表达式对象数组、单个表达式或单个字符串传递。

如果传递了一个数组，则键将用作字段本身，而值将表示该字段应排序的顺序。如果多次使用相同的字段作为键调用，则最后一个排序定义将优先于其他定义。

默认情况下，此函数会将任何传递的参数追加到要选择的字段列表中，除非第二个参数设置为 true。

示例

$query->orderBy(['title' => 'DESC', 'author_id' => 'ASC']);

生成

ORDER BY title DESC, author_id ASC

$query
    ->orderBy(['title' => $query->newExpr('DESC NULLS FIRST')])
    ->orderBy('author_id');

将生成

ORDER BY title DESC NULLS FIRST, author_id

$expression = $query->newExpr()->add(['id % 2 = 0']);
$query->orderBy($expression)->orderBy(['title' => 'ASC']);

和

$query->orderBy(function ($exp, $query) {
    return [$exp->add(['id % 2 = 0']), 'title' => 'ASC'];
});

两者都将变为

ORDER BY (id %2 = 0), title ASC

排序字段/方向不会被查询生成器清理。传递用户提供的数据到 order() 时，应使用允许的字段/方向列表。

如果您需要将复杂表达式设置为排序条件，则应使用 orderByAsc() 或 orderByDesc()。

参数

返回值

添加一个带有 ASC 方向的 ORDER BY 子句。

此方法允许您将复杂表达式设置为排序条件，与 order() 不同

订单字段不适合用于用户提供的數據，因为它们没有被查询构建器进行清理。

参数

返回值

将一个或多个字段添加到此查询的 ORDER 子句中。字段可以作为字符串数组、表达式对象数组、单个表达式或单个字符串传递。

如果传递了一个数组，则键将用作字段本身，而值将表示该字段应排序的顺序。如果多次使用相同的字段作为键调用，则最后一个排序定义将优先于其他定义。

默认情况下，此函数会将任何传递的参数追加到要选择的字段列表中，除非第二个参数设置为 true。

示例

$query->orderBy(['title' => 'DESC', 'author_id' => 'ASC']);

生成

ORDER BY title DESC, author_id ASC

$query
    ->orderBy(['title' => $query->newExpr('DESC NULLS FIRST')])
    ->orderBy('author_id');

将生成

ORDER BY title DESC NULLS FIRST, author_id

$expression = $query->newExpr()->add(['id % 2 = 0']);
$query->orderBy($expression)->orderBy(['title' => 'ASC']);

和

$query->orderBy(function ($exp, $query) {
    return [$exp->add(['id % 2 = 0']), 'title' => 'ASC'];
});

两者都将变为

ORDER BY (id %2 = 0), title ASC

排序字段/方向不会被查询生成器清理。传递用户提供的数据到 order() 时，应使用允许的字段/方向列表。

如果您需要将复杂表达式设置为排序条件，则应使用 orderByAsc() 或 orderByDesc()。

参数

返回值

添加一个带有 ASC 方向的 ORDER BY 子句。

此方法允许您将复杂表达式设置为排序条件，与 order() 不同

订单字段不适合用于用户提供的數據，因为它们没有被查询构建器进行清理。

参数

返回值

添加一个带有 DESC 方向的 ORDER BY 子句。

此方法允许您将复杂表达式设置为排序条件，与 order() 不同

订单字段不适合用于用户提供的數據，因为它们没有被查询构建器进行清理。

参数

返回值

添加一个带有 DESC 方向的 ORDER BY 子句。

此方法允许您将复杂表达式设置为排序条件，与 order() 不同

订单字段不适合用于用户提供的數據，因为它们没有被查询构建器进行清理。

参数

返回值

设置您想要的页面结果。

此方法提供了一个更易于使用的接口来设置记录集中您想要作为结果的限制和偏移量。如果为空，则限制将默认为现有的限制子句，如果限制子句也为空，则使用 25。

页码必须从 1 开始。

参数

返回值

抛出

如果已定义，则删除连接。

当您重新定义联接或想要重新排序联接子句时非常有用。

参数

返回值

向查询添加单个 RIGHT JOIN 子句。

这是通过 join() 构建联接的简写方法。

此方法的参数与 leftJoin() 简写相同，请参考该方法的描述以获取更多详细信息。

参数

返回值

执行此查询的 SQL，并在返回更改的记录行数之前立即关闭语句。

此方法可以用于 UPDATE 和 DELETE 查询，但不建议用于 SELECT 查询，也不用于统计记录数。

示例

$rowCount = $query->update('articles')
                ->set(['published'=>true])
                ->where(['published'=>false])
                ->rowCountAndClose();

以上示例将所有为假的 published 列更改为 true，并返回更新的记录数。

返回值

设置要用于执行和转换此查询的连接实例。

参数

返回值

覆盖实现对象中字段的默认类型映射。

如果您需要设置跨多个函数/表达式共享的类型映射，此方法很有用。

要添加默认值而不覆盖现有值，请使用 getTypeMap()->addDefaults()

参数

返回值

另请参阅

如果 $typeMap 是一个数组，则创建一个新的 TypeMap，否则用给定的 TypeMap 交换它。

参数

返回值

覆盖当前值绑定器

ValueBinder 负责生成查询占位符，并将值临时关联到这些占位符，以便它们可以正确传递给语句对象。

参数

返回值

返回此对象的 SQL 表示形式。

此函数将编译此查询，使其与连接使用的 SQL 方言兼容。此过程可能会添加、删除或更改任何查询部分或内部表达式，使其在目标平台上可执行。

生成的查询可能包含占位符，这些占位符将在查询执行时被实际值替换，因此最适合与预备语句一起使用。

参数

返回值

将遍历每个指定的部件。遍历函数可以使用闭包中的变量或实例变量聚合结果。此函数通常用作遍历将用于构造查询的所有查询部件的方法。

回调将接收 2 个参数，第一个是正在迭代的查询部分的值，第二个是该部分的名称。

示例

$query->select(['title'])->from('articles')->traverse(function ($value, $clause) {
    if ($clause === 'select') {
        var_dump($value);
    }
});

参数

返回值

此函数的工作原理类似于 traverse() 函数，区别在于它对整个表达式树进行全深度遍历。这将为存储在此查询中的每个 ExpressionInterface 对象执行提供的回调函数，无论其在查询中的任何部分的嵌套深度如何。

回调将以第一个参数的形式接收当前访问的表达式。

参数

返回值

将遍历提供的部件。

遍历函数可以使用闭包中的变量或实例变量聚合结果。此方法可用于遍历查询部分的子集，以渲染 SQL 查询。

回调将接收 2 个参数，第一个是正在迭代的查询部分的值，第二个是该部分的名称。

示例

$query->select(['title'])->from('articles')->traverse(function ($value, $clause) {
    if ($clause === 'select') {
        var_dump($value);
    }
}, ['select', 'from']);

参数

返回值

返回此查询的类型（select、insert、update、delete）

返回值

添加要用于此查询 WHERE 子句的条件或一组条件。条件可以表示为一个字段作为键的数组，其中包含比较运算符，数组的值将用于将字段与这样的文字进行比较。最后，条件可以表示为单个字符串或字符串数组。

使用数组时，每个条目将使用 AND 运算符连接到条件的其余部分。对该函数的连续调用也将使用 AND 运算符连接指定的新的条件。此外，可以使用包含其他查询对象的表达式对象来表达值。

使用此方法创建的任何条件都可以用于任何 SELECT、UPDATE 和 DELETE 类型的查询。

使用运算符的条件

$query->where([
    'posted >=' => new DateTime('3 days ago'),
    'title LIKE' => 'Hello W%',
    'author_id' => 1,
], ['posted' => 'datetime']);

前面的示例生成

WHERE posted >= 2012-01-27 AND title LIKE 'Hello W%' AND author_id = 1

第二个参数用于指定为每个传入键期望的类型。有效类型可以从与 Database\Type 类映射的类型中使用。

使用连词嵌套条件

$query->where([
    'author_id !=' => 1,
    'OR' => ['published' => true, 'posted <' => new DateTime('now')],
    'NOT' => ['title' => 'Hello']
], ['published' => boolean, 'posted' => 'datetime']

前面的示例生成

WHERE author_id = 1 AND (published = 1 OR posted < '2012-02-01') AND NOT (title = 'Hello')

您可以根据需要使用连词嵌套条件。有时，您可能希望为同一个键定义 2 个不同的选项，在这种情况下，您可以将每个条件包装在一个新的数组中

$query->where(['OR' => [['published' => false], ['published' => true]])

将导致

WHERE (published = false) OR (published = true)

请记住，每次您使用第三个参数设置为 false（默认值）调用 where() 时，它将使用 AND 运算符将传入的条件与以前存储的列表连接起来。此外，在对该方法的连续调用中使用相同的数组键两次不会覆盖以前的值。

使用表达式对象

$exp = $query->newExpr()->add(['id !=' => 100, 'author_id' != 1])->tieWith('OR');
$query->where(['published' => true], ['published' => 'boolean'])->where($exp);

前面的示例生成

WHERE (id != 100 OR author_id != 1) AND published = 1

其他查询对象可以用作任何字段的条件。

分步骤添加条件

您可以使用回调来构建复杂的表达式，函数接收一个新的 QueryExpression 对象作为第一个参数，接收该查询实例作为第二个参数。函数必须返回一个表达式对象，该对象将使用 AND 运算符添加到查询的条件列表中。

$query
  ->where(['title !=' => 'Hello World'])
  ->where(function ($exp, $query) {
    $or = $exp->or(['id' => 1]);
    $and = $exp->and(['id >' => 2, 'id <' => 10]);
   return $or->add($and);
  });

• 前面的示例生成

WHERE title != 'Hello World' AND (id = 1 OR (id > 2 AND id < 10))

字符串形式的条件

$query->where(['articles.author_id = authors.id', 'modified IS NULL']);

前面的示例生成

WHERE articles.author_id = authors.id AND modified IS NULL

请注意，使用数组表示法或表达式对象时，所有 *值* 将被正确地引用并自动转换为相应的数据库数据类型，从而保护您的应用程序免受 SQL 注入。但是，键不会被视为不安全的输入，应进行验证/清理。

如果您使用字符串条件，请确保您的值被正确引用。您可以做的最安全的事情是永远不要使用字符串条件。

使用可为空的值

使用可能为空的值时，您可以使用 'IS' 关键字让 ORM 根据值的类型生成正确的 SQL

$query->where([
    'posted >=' => new DateTime('3 days ago'),
    'category_id IS' => $category,
]);

如果 $category 为 null - 它实际上会将其转换为 category_id IS NULL - 如果它为 4，它将将其转换为 category_id = 4

参数

返回值

另请参阅

添加要用于此查询 WHERE 子句的 IN 条件或一组条件。

与 where() 相比，此方法允许空输入，前提是您将 'allowEmpty' 设置为 true。在没有适当的完整性检查的情况下使用它要小心。

选项

• types - 用于将值绑定到查询的类型名称的关联数组
• allowEmpty - 允许空数组。

参数

返回值

添加要用于此查询 WHERE 子句的 NOT IN 条件或一组条件。

与 where() 相比，此方法允许空输入，前提是您将 'allowEmpty' 设置为 true。在没有适当的完整性检查的情况下使用它要小心。

参数

返回值

添加要用于此查询 WHERE 子句的 NOT IN 条件或一组条件。这也允许字段使用 IS NULL 条件为 null，因为 null 值会导致 NOT IN 条件始终失败。

与 where() 相比，此方法允许空输入，前提是您将 'allowEmpty' 设置为 true。在没有适当的完整性检查的情况下使用它要小心。

参数

返回值

便利方法，向查询添加 NOT NULL 条件

参数

返回值

便利方法，向查询添加 IS NULL 条件

参数

返回值

向查询添加一个新的公用表表达式 (CTE)。

示例

通用表表达式可以作为预先构造的表达式对象传递

$cte = new \Cake\Database\Expression\CommonTableExpression(
    'cte',
    $connection
        ->selectQuery('*')
        ->from('articles')
);

$query->with($cte);

或从闭包中返回，该闭包将接收一个新的通用表表达式对象作为第一个参数，以及一个新的空白选择查询对象作为第二个参数

$query->with(function (
    \Cake\Database\Expression\CommonTableExpression $cte,
    \Cake\Database\Query $query
 ) {
    $cteQuery = $query
        ->select('*')
        ->from('articles');

return $cte
        ->name('cte')
        ->query($cteQuery);
});

参数

返回值