类连接

命名空间： Cake\ElasticSearch\Datasource

常量

字符串

ROLE_READ ¶
```
'read'
```
字符串

ROLE_WRITE ¶
```
'write'
```
ConnectionInterface 的兼容性垫片

属性摘要

$_client 受保护

ElasticaClient

Elastica 客户端实例
$_esLogger 受保护

ElasticLogger

ElasticLogger 实例
$_logger 受保护

QueryLogger|LoggerInterface

记录器对象实例。
$cacher 受保护

CacheInterface
$configName 受保护

字符串

连接管理器中的连接名称。
$logQueries 受保护

布尔值

是否启用了查询记录。

方法摘要

__call() 公共

将剩余方法传递给 elastica 客户端（如果存在）并根据当前 logQueries 值设置当前记录器
__construct() 公共

构造函数。
config() 公共

获取此连接的配置数据。
configName() 公共

获取此连接的配置名称。
disableConstraints() 公共

{@inheritDoc}
disableQueryLogging() 公共

禁用查询记录
enableQueryLogging() 公共

启用/禁用查询记录
getCacher() 公共

获取缓存器。
getDriver() 公共

获取驱动程序实例。
getEsLogger() 公共

返回 ElasticLogger 实例
getIndex() 公共

返回给定连接的索引
getLogger() 公共

获取记录器对象如果找到，将默认记录器设置为 elasticsearch，否则设置为调试如果以上两者都没有找到，将使用默认的 Es 记录器。
getSchemaCollection() 公共

返回 SchemaCollection 存根，直到我们能够在 Connection 中添加更多抽象 API。
isQueryLoggingEnabled() 公共

检查是否启用了查询记录。
setCacher() 公共

设置缓存器。
setLogger() 公共

设置记录器

方法详细信息

__call() ¶ 公共

__call(string $name, array $attributes): mixed

将剩余方法传递给 elastica 客户端（如果存在）并根据当前 logQueries 值设置当前记录器

参数

字符串 $name: 方法名称
数组 $attributes: 方法属性

返回值

混合

__construct() ¶ 公共

__construct(array $config = [], callable|null $callback = null)

构造函数。

参数

数组 $config 可选: 配置选项
可调用|空 $callback 可选: 可调用函数，可用于接收有关错误的通知（例如连接断开）

config() ¶ 公共

config(): array

获取此连接的配置数据。

返回值

数组

configName() ¶ 公共

configName(): string

获取此连接的配置名称。

返回值

字符串

disableConstraints() ¶ 公共

disableConstraints(callable $operation): mixed

{@inheritDoc}

Elasticsearch 不处理外键约束的概念此方法仅触发 $callback 参数。

参数

可调用 $operation: 在事务中执行的回调。

返回值

混合

抛出

异常
将在回滚事务后重新抛出 $callback 中引发的任何异常。

disableQueryLogging() ¶ 公共

disableQueryLogging(): $this

禁用查询记录

返回值

$this

enableQueryLogging() ¶ 公共

enableQueryLogging(bool $value = true): $this

启用/禁用查询记录

参数

布尔值 $value 可选: 启用/禁用查询记录

返回值

$this

getCacher() ¶ 公共

getCacher(): Psr\SimpleCache\CacheInterface

获取缓存器。

返回值

Psr\SimpleCache\CacheInterface

getDriver() ¶ 公共

getDriver(string $role = self::ROLE_WRITE): Elastica\Client

获取驱动程序实例。

参数

字符串 $role 可选

返回值

Elastica\Client

另请参阅

\Cake\Datasource\ConnectionInterface::getDriver()

getEsLogger() ¶ 公共

getEsLogger(): Cake\ElasticSearch\Datasource\Log\ElasticLogger

返回 ElasticLogger 实例

返回值

Cake\ElasticSearch\Datasource\Log\ElasticLogger

getIndex() ¶ 公共

getIndex(string|null $name = null): Elastica\Index

返回给定连接的索引

参数

字符串|空 $name 可选: 要创建连接的索引名称，如果未传递任何值，它将使用连接的默认索引名称。

返回值

Elastica\Index

getLogger() ¶ 公共

getLogger(): Psr\Log\LoggerInterface

获取记录器对象如果找到，将默认记录器设置为 elasticsearch，否则设置为调试如果以上两者都没有找到，将使用默认的 Es 记录器。

返回值

Psr\Log\LoggerInterface

getSchemaCollection() ¶ 公共

getSchemaCollection(): Cake\ElasticSearch\Datasource\SchemaCollection

返回 SchemaCollection 存根，直到我们能够在 Connection 中添加更多抽象 API。

返回值

Cake\ElasticSearch\Datasource\SchemaCollection

isQueryLoggingEnabled() ¶ 公共

isQueryLoggingEnabled(): bool

检查是否启用了查询记录。

返回值

布尔值

setCacher() ¶ 公共

setCacher(Psr\SimpleCache\CacheInterface $cacher): $this

设置缓存器。

参数

Psr\SimpleCache\CacheInterface $cacher

返回值

$this

setLogger() ¶ 公共

setLogger(Cake\Database\Log\QueryLoggerPsr\Log\LoggerInterface $logger): $this

设置记录器

参数

Cake\Database\Log\QueryLoggerPsr\Log\LoggerInterface $logger: 记录器实例

返回值

$this

属性详细信息

`$_client` ¶ 受保护

Elastica 客户端实例

类型

ElasticaClient

`$_esLogger` ¶ protected

ElasticLogger 实例

类型

ElasticLogger

`$_logger` ¶ protected

记录器对象实例。

类型

QueryLogger|LoggerInterface

`$cacher` ¶ protected

类型

CacheInterface

`$configName` ¶ protected

连接管理器中的连接名称。

类型

字符串

`$logQueries` ¶ protected

是否启用了查询记录。

类型

布尔值

命名空间

类连接

常量

属性摘要

方法摘要

__call() 公共

__construct() 公共

config() 公共

configName() 公共

disableConstraints() 公共

disableQueryLogging() 公共

enableQueryLogging() 公共

getCacher() 公共

getDriver() 公共

getEsLogger() 公共

getIndex() 公共

getLogger() 公共

getSchemaCollection() 公共

isQueryLoggingEnabled() 公共

setCacher() 公共

setLogger() 公共

方法详细信息

__call() ¶ 公共

参数

返回值

__construct() ¶ 公共

参数

config() ¶ 公共

返回值

configName() ¶ 公共

返回值

disableConstraints() ¶ 公共

参数

返回值

抛出

disableQueryLogging() ¶ 公共

返回值

enableQueryLogging() ¶ 公共

参数

返回值

getCacher() ¶ 公共

返回值

getDriver() ¶ 公共

参数

返回值

另请参阅

getEsLogger() ¶ 公共

返回值

getIndex() ¶ 公共

参数

返回值

getLogger() ¶ 公共

返回值

getSchemaCollection() ¶ 公共

返回值

isQueryLoggingEnabled() ¶ 公共

返回值

setCacher() ¶ 公共

参数

返回值

setLogger() ¶ 公共

参数

返回值

属性详细信息

$_client ¶ 受保护

类型

$_esLogger ¶ protected

类型

$_logger ¶ protected

类型

$cacher ¶ protected

类型

$configName ¶ protected

类型

$logQueries ¶ protected

类型

`$_client` ¶ 受保护

`$_esLogger` ¶ protected

`$_logger` ¶ protected

`$cacher` ¶ protected

`$configName` ¶ protected

`$logQueries` ¶ protected