Класс yii\elasticsearch\Connection

Все классы | Свойства | Методы | События

Наследование	yii\elasticsearch\Connection » yii\base\Component » yii\base\Object
Реализует	yii\base\Configurable
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2-elasticsearch/blob/master/Connection.php

Подключение к Elasticsearch используется для подключения к кластеру elasticsearch версии 0.20 или выше

Публичные свойства

Свойство	Тип	Описание	Определено
$activeNode	строка	Активный узел.	yii\elasticsearch\Connection
$auth	массив	Данные аутентификации, используемые для подключения к узлу ElasticSearch.	yii\elasticsearch\Connection
$autodetectCluster	логическое значение	Автоматически определять доступные узлы кластера при вызове open()	yii\elasticsearch\Connection
$behaviors	yii\base\Behavior[]	Список прикрепленных к этому компоненту поведений.	yii\base\Component
$clusterState			yii\elasticsearch\Connection
$connectionTimeout	число с плавающей точкой	Таймаут для подключения к узлу elasticsearch.	yii\elasticsearch\Connection
$dataTimeout	число с плавающей точкой	Таймаут для чтения ответа от узла elasticsearch.	yii\elasticsearch\Connection
$defaultProtocol	строка	Протокол по умолчанию для подключения к узлам.	yii\elasticsearch\Connection
$driverName	строка	Имя драйвера БД.	yii\elasticsearch\Connection
$isActive	логическое значение	Установлено ли соединение с БД.	yii\elasticsearch\Connection
$nodeInfo			yii\elasticsearch\Connection
$nodes	массив	Узлы кластера elasticsearch для подключения.	yii\elasticsearch\Connection
$queryBuilder	yii\elasticsearch\QueryBuilder		yii\elasticsearch\Connection

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает метод, который не является методом класса.	yii\base\Component
__clone()	Этот метод вызывается после создания объекта путем клонирования существующего.	yii\base\Component
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства компонента.	yii\base\Component
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Component
__set()	Устанавливает значение свойства компонента.	yii\base\Component
__sleep()	Закрывает подключение при сериализации компонента.	yii\elasticsearch\Connection
__unset()	Устанавливает свойство компонента в значение null.	yii\base\Component
attachBehavior()	Присоединяет поведение к компоненту.	yii\base\Component
attachBehaviors()	Присоединяет список поведений к компоненту.	yii\base\Component
behaviors()	Возвращает список поведений, по которым должен действовать этот компонент.	yii\base\Component
canGetProperty()	Возвращает значение, указывающее, можно ли прочитать свойство.	yii\base\Component
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Component
className()	Возвращает полное имя класса.	yii\base\Object
close()	Закрывает текущее активное подключение к БД.	yii\elasticsearch\Connection
createBulkCommand()	Создает команду для выполнения пакетных операций.	yii\elasticsearch\Connection
createCommand()	Создает команду для выполнения.	yii\elasticsearch\Connection
delete()	Выполняет HTTP-запрос DELETE.	yii\elasticsearch\Connection
detachBehavior()	Отсоединяет поведение от компонента.	yii\base\Component
detachBehaviors()	Отсоединяет все поведения от компонента.	yii\base\Component
ensureBehaviors()	Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту.	yii\base\Component
get()	Выполняет HTTP-запрос GET.	yii\elasticsearch\Connection
getBehavior()	Возвращает объект поведения с указанным именем.	yii\base\Component
getBehaviors()	Возвращает все присоединенные к этому компоненту поведения.	yii\base\Component
getClusterState()		yii\elasticsearch\Connection
getDriverName()	Возвращает имя драйвера БД для текущего \yii\elasticsearch\dsn.	yii\elasticsearch\Connection
getIsActive()	Возвращает значение, указывающее, установлено ли подключение к БД.	yii\elasticsearch\Connection
getNodeInfo()		yii\elasticsearch\Connection
getQueryBuilder()	Создает новый экземпляр билдера запросов.	yii\elasticsearch\Connection
hasEventHandlers()	Возвращает значение, указывающее, есть ли обработчик, присоединенный к событию с указанным именем.	yii\base\Component
hasMethod()	Возвращает значение, указывающее, определен ли метод.	yii\base\Component
hasProperty()	Возвращает значение, указывающее, определено ли свойство для этого компонента.	yii\base\Component
head()	Выполняет HTTP-запрос HEAD.	yii\elasticsearch\Connection
init()		yii\elasticsearch\Connection
off()	Отсоединяет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Присоединяет обработчик событий к событию.	yii\base\Component
open()	Устанавливает подключение к БД.	yii\elasticsearch\Connection
post()	Выполняет HTTP-запрос POST.	yii\elasticsearch\Connection
put()	Выполняет HTTP-запрос PUT.	yii\elasticsearch\Connection
trigger()	Вызывает событие.	yii\base\Component

Защищенные методы

Метод	Описание	Определено в
decodeErrorBody()	Попытаться декодировать информацию об ошибке, если это допустимый json, вернуть ее, если нет.	yii\elasticsearch\Connection
httpRequest()	Выполняет HTTP-запрос.	yii\elasticsearch\Connection
initConnection()	Инициализирует подключение к БД.	yii\elasticsearch\Connection
populateNodes()	Заполняет $nodes результатом запроса узлов кластера.	yii\elasticsearch\Connection
selectActiveNode()	Случайный выбор активного узла.	yii\elasticsearch\Connection

События

Событие	Тип	Описание	Определено в
EVENT_AFTER_OPEN	\yii\elasticsearch\Event	Событие, которое срабатывает после установления подключения к БД.	yii\elasticsearch\Connection

Подробное описание свойств

$activeNode открытое свойство

Активный узел. Ключ одного из $nodes. Будет случайным образом выбран при open().

public string $activeNode = null

$auth открытое свойство

Данные аутентификации, используемые для подключения к узлу ElasticSearch.

Элементы массива:

username: имя пользователя для аутентификации.
password: пароль для аутентификации.

Массив должен содержать как имя пользователя, так и пароль или не содержать никаких данных аутентификации.

См. также http://www.elasticsearch.org/guide/en/elasticsearch/client/php-api/current/_configuration.html#_example_configuring_http_basic_auth.

public array $auth = []

$autodetectCluster общедоступное свойство

Автообнаружение доступных узлов кластера при вызове open()

public boolean $autodetectCluster = true

$clusterState общедоступное только для чтения свойство

public void getClusterState ( )

$connectionTimeout общедоступное свойство

Таймаут для подключения к узлу elasticsearch. Это значение будет использоваться для настройки параметра curl CURLOPT_CONNECTTIMEOUT. Если не задано, явный таймаут для curl не будет установлен.

public float $connectionTimeout = null

$dataTimeout общедоступное свойство

Таймаут для чтения ответа от узла elasticsearch. Это значение будет использоваться для настройки параметра curl CURLOPT_TIMEOUT. Если не задано, явный таймаут для curl не будет установлен.

public float $dataTimeout = null

$defaultProtocol общедоступное свойство (доступно начиная с версии 2.0.5)

Протокол по умолчанию для подключения к узлам

public string $defaultProtocol = 'http'

$driverName общедоступное только для чтения свойство

Имя драйвера БД

public string getDriverName ( )

$isActive общедоступное только для чтения свойство

Установлено ли подключение к БД

public boolean getIsActive ( )

$nodeInfo общедоступное только для чтения свойство

public void getNodeInfo ( )

$nodes общедоступное свойство

Узлы кластера elasticsearch для подключения.

Заполняется результатом запроса к узлам кластера, когда $autodetectCluster имеет значение true.

Дополнительные параметры:

auth: перезаписывает свойство $auth. Например:

[
 'http_address' => 'inet[/127.0.0.1:9200]',
 'auth' => ['username' => 'yiiuser', 'password' => 'yiipw'], // Overrides the `auth` property of the class with specific login and password
 //'auth' => ['username' => 'yiiuser', 'password' => 'yiipw'], // Disabled auth regardless of `auth` property of the class
]

protocol: явно задаёт протокол для текущего узла (полезно при ручном определении кластера HTTPS)

См. также http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html#cluster-nodes-info.

public array $nodes = [['http_address' => 'inet[/127.0.0.1:9200]']]

$queryBuilder общедоступное только для чтения свойство

public yii\elasticsearch\QueryBuilder getQueryBuilder ( )

Подробное описание методов

__sleep() public method

Закрывает соединение, когда этот компонент сериализуется.

public array __sleep ( )

close() public method

Закрывает текущее активное соединение с БД.

Ничего не делает, если соединение уже закрыто.

public void close ( )

createBulkCommand() public method (available since version 2.0.5)

Создает команду массовой обработки для выполнения.

public yii\elasticsearch\BulkCommand createBulkCommand ( $config = [] )
$config	array	Конфигурация для класса yii\elasticsearch\BulkCommand
return	yii\elasticsearch\BulkCommand	Команда БД

createCommand() public method

Создает команду для выполнения.

public yii\elasticsearch\Command createCommand ( $config = [] )
$config	array	Конфигурация для класса Command
return	yii\elasticsearch\Command	Команда БД

decodeErrorBody() protected method

Пытается декодировать информацию об ошибке, если это валидный JSON, возвращает её, если нет.

protected mixed decodeErrorBody ( $body )
$body

delete() public method

Выполняет запрос DELETE HTTP

public mixed delete ( $url, $options = [], $body = null, $raw = false )
$url	string\|array	URL
$options	array	Параметры URL
$body	string	Тело запроса
$raw	boolean	Если тело ответа содержит JSON и должно быть декодировано
return	mixed	Ответ
throws	yii\elasticsearch\Exception
throws	yii\base\InvalidConfigException

get() public method

Выполняет запрос GET HTTP

public mixed get ( $url, $options = [], $body = null, $raw = false )
$url	string\|array	URL
$options	array	Параметры URL
$body	string	Тело запроса
$raw	boolean	Если тело ответа содержит JSON и должно быть декодировано
return	mixed	Ответ
throws	yii\elasticsearch\Exception
throws	yii\base\InvalidConfigException

getClusterState() public method

public void getClusterState ( )

getDriverName() public method

Возвращает имя драйвера БД для текущего \yii\elasticsearch\dsn.

public string getDriverName ( )
return	string	Имя драйвера БД

getIsActive() public method

Возвращает значение, указывающее, установлено ли соединение с БД.

public boolean getIsActive ( )
return	boolean	Установлено ли соединение с БД

getNodeInfo() public method

public void getNodeInfo ( )

getQueryBuilder() public method

Создает новый экземпляр построителя запросов

public yii\elasticsearch\QueryBuilder getQueryBuilder ( )

head() public method

Выполняет запрос HEAD HTTP

public mixed head ( $url, $options = [], $body = null )
$url	string\|array	URL
$options	array	Параметры URL
$body	string	Тело запроса
return	mixed	Ответ
throws	yii\elasticsearch\Exception
throws	yii\base\InvalidConfigException

httpRequest() protected method

Выполняет HTTP-запрос

protected mixed httpRequest ( $method, $url, $requestBody = null, $raw = false )
$method	string	Имя метода
$url	string	URL
$requestBody	string	Тело запроса
$raw	boolean	Если тело ответа содержит JSON и должно быть декодировано
return	mixed	Если запрос завершился неудачей
throws	yii\elasticsearch\Exception	если запрос завершился неудачей
throws	yii\base\InvalidConfigException

init() public method

public void init ( )

initConnection() protected method

Инициализирует соединение с БД.

Этот метод вызывается сразу после установления соединения с БД. Реализация по умолчанию вызывает событие EVENT_AFTER_OPEN.

protected void initConnection ( )

open() public method

Устанавливает соединение с БД.

Ничего не делает, если соединение с БД уже установлено.

public void open ( )
throws	yii\elasticsearch\Exception	если соединение не удалось

populateNodes() protected method (available since version 2.0.4)

Заполняет $nodes результатом запроса узлов кластера.

protected void populateNodes ( )
throws	yii\elasticsearch\Exception	если не найден ни один активный узел

post() public method

Выполняет запрос POST HTTP

public mixed post ( $url, $options = [], $body = null, $raw = false )
$url	строка\|массив	URL
$options	массив	Параметры URL
$body	строка	Тело запроса
$raw	булево	Если тело ответа содержит JSON и должно быть декодировано
return	mixed	Ответ
throws	yii\elasticsearch\Исключение
throws	yii\base\ИсключениеНевернойКонфигурации

put() public method

Выполняет HTTP-запрос PUT

public mixed put ( $url, $options = [], $body = null, $raw = false )
$url	строка\|массив	URL
$options	массив	Параметры URL
$body	строка	Тело запроса
$raw	булево	Если тело ответа содержит JSON и должно быть декодировано
return	mixed	Ответ
throws	yii\elasticsearch\Исключение
throws	yii\base\ИсключениеНевернойКонфигурации

selectActiveNode() protected method

Случайный выбор активного узла

protected void selectActiveNode ( )

Подробное описание событий

EVENT_AFTER_OPEN событие типа \yii\elasticsearch\Event

Событие, которое срабатывает после установления подключения к базе данных

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-elasticsearch-connection.html