类 Query

查询构造函数

参数

用于将条件解析为布尔查询并将它们存储在 _queryParts 变量中的辅助函数。

参数

返回

执行查询。

返回

将聚合添加到弹性查询对象

参数

返回

返回表示单个别名字段的键 => 值数组，该数组可以直接传递给 select() 方法。键将包含别名，值将包含实际字段名称。

如果字段已经被别名化，则不会被改变。如果没有传入 $alias，则将使用此查询的默认表。

参数

返回

对提供的列表中的每个字段运行 aliasField() 并将结果放在单个数组下返回。

参数

返回

获取此查询的结果。

将返回通过 setResult() 设置的结果集，或执行此查询并返回 ResultSetDecorator 对象，该对象已准备好用于结果流。

ResultSetDecorator 是一个可遍历对象，它实现了 Cake\Collection\Collection 中找到的方法。

返回

使用 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)

参数

返回

另请参阅

使用数组填充或添加当前查询子句的部分。这对于一次传递所有查询子句非常方便。选项数组接受

• fields: 映射到 select 方法
• conditions: 映射到 where 方法
• order: 映射到 order 方法
• limit: 映射到 limit 方法
• offset: 映射到 offset 方法
• page: 映射到 page 方法

示例

$query->applyOptions([
  'fields' => ['id', 'name'],
  'conditions' => [
    'created >=' => '2013-01-01'
  ],
  'limit' => 10
]);

等效于

 $query
 ->select(['id', 'name'])
 ->where(['created >=' => '2013-01-01'])
 ->limit(10)

参数

返回

为此查询启用结果缓存。

如果查询已启用缓存，则在执行时将执行以下操作

• 检查 $key 的缓存。如果存在结果，则不会执行 SQL。而是返回缓存的结果。
• 当缓存的数据陈旧/丢失时，将随着查询的执行将结果集缓存起来。

用法

// Simple string key + config
$query->cache('my_key', 'db_results');

// Function to generate key.
$query->cache(function ($q) {
  $key = serialize($q->clause('select'));
  $key .= serialize($q->clause('where'));
  return md5($key);
});

// Using a pre-built cache engine.
$query->cache('my_key', $engine);

// Disable caching
$query->cache(false);

参数

返回

返回存储在指定子句中的任何数据。这对于修改查询的任何内部部分很有用，它在编译期间用于在执行查询之前相应地转换查询。可以检索的有效子句是：fields、filter、postFilter、query、order、limit 和 offset。

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

• fields: 数组，当未设置任何字段时将返回空数组
• query: 要在查询（带有评分）部分中使用的最终 BoolQuery。
• filter: 要在最终 BoolQuery 过滤器对象中使用的查询，在未设置时返回 null
• postFilter: 要在 post_filter 对象中使用的查询，在未设置时返回 null
• order: OrderByExpression，在未设置时返回 null
• limit: 整数，在未设置时返回 null
• offset: 整数，在未设置时返回 null

参数

返回

将折叠添加到弹性查询对象

参数

返回

编译 Elasticsearch 查询。

返回

返回查询的命中总数

返回

使用 MapReduce 例程和格式化程序修饰结果迭代器

参数

返回

返回用于修饰结果的类的名称

返回

对现有查询对象应用自定义查找。

允许自定义查找方法组合并应用于彼此。

$repository->find('all')->find('recent');

以上是将多个查找方法堆叠到单个查询中的示例。

参数

返回

返回执行此查询的第一个结果，如果查询之前未执行，则出于性能原因，它将限制子句设置为 1。

示例

$singleUser = $query->select(['id', 'username'])->first();

返回

从执行的查询中获取第一个结果或引发异常。

返回

抛出

注册一个新的格式化器回调函数，该函数将在尝试从数据库中获取结果时执行。

如果第二个参数设置为 true，则将擦除先前的格式化程序并将其替换为传入的第一个参数。

回调需要返回一个迭代器对象，该对象将用作此查询结果的返回值。格式化函数在执行此查询的所有 MapReduce 例程后应用。

格式化回调将接收两个参数，第一个参数是一个实现 \Cake\Collection\CollectionInterface 的对象，可以遍历和修改该对象。第二个参数是正在应用格式化回调的查询实例。

示例

返回由 id 索引的表中的所有结果

$query->select(['id', 'name'])->formatResults(function ($results) {
    return $results->indexBy('id');
});

向 ResultSet 添加新列

$query->select(['name', 'birth_date'])->formatResults(function ($results) {
    return $results->map(function ($row) {
        $row['age'] = $row['birth_date']->diff(new DateTime)->y;

return $row;
    });
});

参数

返回

抛出

执行此查询并返回结果迭代器。此函数需要实现 IteratorAggregate 接口，并允许在不手动调用 execute() 的情况下迭代查询，从而使其看起来像结果集而不是查询本身。

返回

返回先前注册的映射减少例程列表。

返回

返回一个包含应用于此查询的自定义选项的数组，这些选项尚未由此类中的其他方法处理。

示例

 $query->applyOptions(['doABarrelRoll' => true, 'fields' => ['id', 'name']);
 $query->getOptions(); // Returns ['doABarrelRoll' => true]

返回

另请参阅

返回此查询将使用的默认存储库对象，即将出现在 from 子句中的表。

返回

返回先前注册的格式例程列表。

返回

设置查询的突出显示选项。

参数

返回

设置此查询要返回的最大结果数。这会为 Elasticsearch 查询设置 size 选项。

示例

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

参数

返回

注册一个新的 MapReduce 例程，该例程将在数据库结果之上执行

MapReduce 路由只会在查询执行并尝试获取第一个结果时运行。

如果第三个参数设置为 true，它将擦除之前的 map reducers 并用传递的参数替换它。

参数

返回

另请参阅

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

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

示例

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

参数

返回

设置结果集的排序选项。

接受的 $order 参数格式为

• [['name' => ['order'=> 'asc', ...]], ['price' => ['order'=> 'asc', ...]]]
• ['name' => 'asc', 'price' => 'desc']
• 'field1' (默认为 order => 'desc')

参数

返回

设置结果集的排序选项。

接受的 $order 参数格式为

• [['name' => ['order'=> 'asc', ...]], ['price' => ['order'=> 'asc', ...]]]
• ['name' => 'asc', 'price' => 'desc']
• 'field1' (默认为 order => 'desc')

参数

返回

设置您想要的页面结果。

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

页面应该从 1 开始。

参数

返回

设置在 post_filter 对象中使用的查询。使用此方法添加的过滤器将堆叠在 BoolQuery 上。

此方法可以像使用 where() 方法一样使用。请参阅其文档以了解更多详细信息。

参数

返回

另请参阅

修改查询部分，考虑分数。使用此方法添加的查询将堆叠在 bool 查询上，并应用于最终 BoolQuery 的 must 部分。

此方法可以像使用 where() 方法一样使用。请参阅其文档以了解更多详细信息。

参数

返回

修改查询部分，考虑分数。使用此方法添加的查询将堆叠在 bool 查询上，并应用于最终 BoolQuery 的 should 部分。

此方法可以像使用 where() 方法一样使用。请参阅其文档以了解更多详细信息。

参数

返回

设置此查询将使用的默认存储库对象。

参数

返回

设置或获取搜索选项

参数

返回

添加要从 _source 中选择的字段。

多次调用此函数将向要从 _source 中选择的字段列表追加更多字段。

如果在第二个参数中传递 true，则任何之前的选择都将被第一个参数中传递的列表覆盖。

参数

返回

用于设置或覆盖查询的方法。

参数

返回

设置此查询将使用的默认存储库对象。

参数

返回

在执行查询后，返回结果的数组表示形式。

返回

设置要在查询对象中使用的过滤器。使用此方法添加的查询将堆叠在 bool 查询上，并应用于最终 BoolQuery 的过滤器部分。

使用此方法添加的过滤器对文档的最终得分没有影响，不匹配指定过滤器的文档将被排除在外。

您可以通过多种方式使用此方法。最简单的方法是传递一个简单的条件数组

{{{ // 生成一个 {"term": {"name": "jose"}} json 查询 $query->where(['name' => 'jose']); }}}

您可以在数组中包含任意多的条件，运算符也可以在数组的字段侧使用

{{{ $query->where(['name' => 'jose', 'age >' => 30, 'interests in' => ['php', 'cake']); }}}

您可以在 Cake\ElasticSearch\QueryBuilder::parse() 方法文档中阅读有关可用运算符及其如何转换为 Elasticsearch 查询的信息。

此外，可以使用闭包作为第一个参数。闭包将接收一个 QueryBuilder 实例，您可以使用它来创建任意查询组合

{{{ $query->where(function ($builder) { return $builder->and($builder->between('age', 10, 20), $builder->missing('name')); }); }}}

最后，您可以将任何已经构建的查询作为第一个参数传递

{{{ $query->where(new \Elastica\Filter\Term('name.first', 'jose')); }}{

参数

返回

另请参阅

设置结果集中的结果应具有的最小分数，以便在结果集中返回。

参数

返回