Class yii\elasticsearch\Connection

All Classes | Properties | Methods | Events

Inheritance	yii\elasticsearch\Connection » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-elasticsearch/blob/master/Connection.php

Elasticsearch Connection is used to connect to an elasticsearch cluster version 0.20 or higher

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$activeNode	array	The active node.	yii\elasticsearch\Connection
$auth			yii\elasticsearch\Connection
$autodetectCluster	boolean	Whether to autodetect available cluster nodes on open()	yii\elasticsearch\Connection
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$clusterState			yii\elasticsearch\Connection
$connectionTimeout	float	Timeout to use for connecting to an elasticsearch node.	yii\elasticsearch\Connection
$dataTimeout	float	Timeout to use when reading the response from an elasticsearch node.	yii\elasticsearch\Connection
$driverName	string	Name of the DB driver	yii\elasticsearch\Connection
$isActive	boolean	Whether the DB connection is established	yii\elasticsearch\Connection
$nodeInfo			yii\elasticsearch\Connection
$nodes	array	Cluster nodes This is populated with the result of a cluster nodes request when $autodetectCluster is true.	yii\elasticsearch\Connection
$queryBuilder	yii\elasticsearch\QueryBuilder		yii\elasticsearch\Connection

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\Object
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__sleep()	Closes the connection when this component is being serialized.	yii\elasticsearch\Connection
__unset()	Sets a component property to be null.	yii\base\Component
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\Object
close()	Closes the currently active DB connection.	yii\elasticsearch\Connection
createCommand()	Creates a command for execution.	yii\elasticsearch\Connection
delete()	Performs DELETE HTTP request	yii\elasticsearch\Connection
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
get()	Performs GET HTTP request	yii\elasticsearch\Connection
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getClusterState()		yii\elasticsearch\Connection
getDriverName()	Returns the name of the DB driver for the current \yii\elasticsearch\dsn.	yii\elasticsearch\Connection
getIsActive()	Returns a value indicating whether the DB connection is established.	yii\elasticsearch\Connection
getNodeInfo()		yii\elasticsearch\Connection
getQueryBuilder()	Creates new query builder instance	yii\elasticsearch\Connection
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
head()	Performs HEAD HTTP request	yii\elasticsearch\Connection
init()		yii\elasticsearch\Connection
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
open()	Establishes a DB connection.	yii\elasticsearch\Connection
post()	Performs POST HTTP request	yii\elasticsearch\Connection
put()	Performs PUT HTTP request	yii\elasticsearch\Connection
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
decodeErrorBody()	Try to decode error information if it is valid json, return it if not.	yii\elasticsearch\Connection
httpRequest()	Performs HTTP request	yii\elasticsearch\Connection
initConnection()	Initializes the DB connection.	yii\elasticsearch\Connection
selectActiveNode()	Select active node randomly	yii\elasticsearch\Connection

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_OPEN	\yii\elasticsearch\Event	An event that is triggered after a DB connection is established	yii\elasticsearch\Connection

Property Details

$activeNode public property

array $activeNode = null

The active node. key of $nodes. Will be randomly selected on open().

$auth public property

$auth = []

$autodetectCluster public property

boolean $autodetectCluster = true

Whether to autodetect available cluster nodes on open()

$clusterState public read-only property

void getClusterState( )

$connectionTimeout public property

float $connectionTimeout = null

Timeout to use for connecting to an elasticsearch node. This value will be used to configure the curl CURLOPT_CONNECTTIMEOUT option. If not set, no explicit timeout will be set for curl.

$dataTimeout public property

float $dataTimeout = null

Timeout to use when reading the response from an elasticsearch node. This value will be used to configure the curl CURLOPT_TIMEOUT option. If not set, no explicit timeout will be set for curl.

$driverName public read-only property

string getDriverName( )

Name of the DB driver

$isActive public read-only property

boolean getIsActive( )

Whether the DB connection is established

$nodeInfo public read-only property

void getNodeInfo( )

$nodes public property

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

Cluster nodes This is populated with the result of a cluster nodes request when $autodetectCluster is true.

$queryBuilder public read-only property

yii\elasticsearch\QueryBuilder getQueryBuilder( )

Method Details

__sleep() public method

Closes the connection when this component is being serialized.

array __sleep( )

close() public method

Closes the currently active DB connection.

It does nothing if the connection is already closed.

void close( )

createCommand() public method

Creates a command for execution.

yii\elasticsearch\Command createCommand( $config = [] )
$config	array	The configuration for the Command class
return	yii\elasticsearch\Command	The DB command

decodeErrorBody() protected method

Try to decode error information if it is valid json, return it if not.

mixed decodeErrorBody( $body )
$body

delete() public method

Performs DELETE HTTP request

mixed delete( $url, $options = [], $body = null, $raw = false )
$url	string	URL
$options	array	URL options
$body	string	Request body
$raw	boolean	If response body contains JSON and should be decoded
return	mixed	Response
throws	yii\elasticsearch\Exception
throws	yii\base\InvalidConfigException

get() public method

Performs GET HTTP request

mixed get( $url, $options = [], $body = null, $raw = false )
$url	string	URL
$options	array	URL options
$body	string	Request body
$raw	boolean	If response body contains JSON and should be decoded
return	mixed	Response
throws	yii\elasticsearch\Exception
throws	yii\base\InvalidConfigException

getClusterState() public method

void getClusterState( )

getDriverName() public method

Returns the name of the DB driver for the current \yii\elasticsearch\dsn.

string getDriverName( )
return	string	Name of the DB driver

getIsActive() public method

Returns a value indicating whether the DB connection is established.

boolean getIsActive( )
return	boolean	Whether the DB connection is established

getNodeInfo() public method

void getNodeInfo( )

getQueryBuilder() public method

Creates new query builder instance

yii\elasticsearch\QueryBuilder getQueryBuilder( )

head() public method

Performs HEAD HTTP request

mixed head( $url, $options = [], $body = null )
$url	string	URL
$options	array	URL options
$body	string	Request body
return	mixed	Response
throws	yii\elasticsearch\Exception
throws	yii\base\InvalidConfigException

httpRequest() protected method

Performs HTTP request

mixed httpRequest( $method, $url, $requestBody = null, $raw = false )
$method	string	Method name
$url	string	URL
$requestBody	string	Request body
$raw	boolean	If response body contains JSON and should be decoded
return	mixed	Response
throws	yii\elasticsearch\Exception	if request failed
throws	yii\base\InvalidParamException

init() public method

void init( )

initConnection() protected method

Initializes the DB connection.

This method is invoked right after the DB connection is established. The default implementation triggers an EVENT_AFTER_OPEN event.

void initConnection( )

open() public method

Establishes a DB connection.

It does nothing if a DB connection has already been established.

void open( )
throws	yii\elasticsearch\Exception	if connection fails

post() public method

Performs POST HTTP request

mixed post( $url, $options = [], $body = null, $raw = false )
$url	string	URL
$options	array	URL options
$body	string	Request body
$raw	boolean	If response body contains JSON and should be decoded
return	mixed	Response
throws	yii\elasticsearch\Exception
throws	yii\base\InvalidConfigException

put() public method

Performs PUT HTTP request

mixed put( $url, $options = [], $body = null, $raw = false )
$url	string	URL
$options	array	URL options
$body	string	Request body
$raw	boolean	If response body contains JSON and should be decoded
return	mixed	Response
throws	yii\elasticsearch\Exception
throws	yii\base\InvalidConfigException

selectActiveNode() protected method

Select active node randomly

void selectActiveNode( )

Event Details

EVENT_AFTER_OPEN event

An event that is triggered after a DB connection is established