include/SugarSearchEngine/Elastic/Elastica/Cluster.php

Show:

inherited

Classes
- \Elastica_Cluster

Table of Contents

Cluster informations for elasticsearch

Author: Nicolas Ruflin
Category: Xodoa
Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/admin/cluster
Package: Elastica

\Elastica_Cluster
jump to top

Package: Elastica

Cluster informations for elasticsearch

Author: Nicolas Ruflin
Category: Xodoa
Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/admin/cluster

Properties


                 $_client= 'null'

Default valuenullDetails

Type: n/a

Methods

__construct(
          \Elastica_Client $client
          )
        
        :
          void

Creates a cluster object

Parameters

Name	Type	Description
$client	\Elastica_Client	Connection client object

getClient(
          
          )
        
        :
          \Elastica_Client

Returns the client object

Returns

Type	Description
\Elastica_Client	Client object

getHealth(
          array $args
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$args	array	OPTIONAL

Details

Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/admin/cluster/health/

getInfo(
          array $args
          )
        
        :
          void

Returns the cluster information (not implemented yet)

Parameters

Name	Type	Description
$args	array	Additional arguemtns

Details

Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/admin/cluster/nodes_info/

getNodeNames(
          
          )
        
        :
          array

Returns a list of existing node names

Returns

Type	Description
array	List of node names

getNodes(
          
          )
        
        :
          array

Returns all nodes of the cluster

Returns

Type	Description
array	List of Elastica_Node objects

getResponse(
          
          )
        
        :
          \Elastica_Response

Returns the response object

Returns

Type	Description
\Elastica_Response	Response object

getState(
          
          )
        
        :
          array

Returns the full state of the cluster

Returns

Type	Description
array	State array

Details

Link: http://www.elasticsearch.org/guide/reference/api/admin-cluster-state.html

refresh(
          
          )
        
        :
          void

Refreshs all cluster information (state)

shutdown(
          string $delay
              =
              '1s'
          )
        
        :
          \Elastica_Response

Shuts down the complete cluster

Parameters

Name	Type	Description
$delay	string	OPTIONAL Seconds to shutdown cluster after (default = 1s)

Returns

Type	Description
\Elastica_Response

Details

Link: http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown.html

include/SugarSearchEngine/Elastic/Elastica/Cluster.php

\Elastica_Clusterjump to top

Properties

Methods

\Elastica_Cluster
jump to top