include/SugarSearchEngine/Elastic/Elastica/Status.php
Show:
inherited
inherited
Classes
Elastica general status
- Author
- Nicolas Ruflin
- Category
- Xodoa
- Link
- http://www.elasticsearch.org/guide/reference/api/admin-indices-status.html
- Package
- Elastica
\Elastica_Status
Package: Elastica
Elastica general status
- Author
- Nicolas Ruflin
- Category
- Xodoa
- Link
- http://www.elasticsearch.org/guide/reference/api/admin-indices-status.html
Properties
$_client= 'null'
Default value
nullDetails- Type
- n/a
$_data= 'array()'
Default value
array()Details- Type
- n/a
\Elastica_Response
$_response= 'null'
Contains all status infos
Response object
Default value
nullDetails- Type
- \Elastica_Response
Methods
__construct(
\Elastica_Client $client
)
:
voidConstructs Status object
Parameters
| Name | Type | Description |
|---|---|---|
| $client | \Elastica_Client | Client object |
aliasExists(
string $name
)
:
boolChecks if the given alias exists
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | Alias name |
| Type | Description |
|---|---|
| bool | True if alias exists |
getData(
)
:
arrayReturns status data
Returns
| Type | Description |
|---|---|
| array | Status data |
getIndexNames(
)
:
arrayReturns a list of the existing index names
Returns
| Type | Description |
|---|---|
| array | Index names list |
getIndexStatuses(
)
:
arrayReturns status objects of all indices
Returns
| Type | Description |
|---|---|
| array | List of Elastica_Client_Index objects |
getIndicesWithAlias(
string $name
)
:
arrayReturns an array with all indices that the given alias name points to
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | Alias name |
| Type | Description |
|---|---|
| array | List of Elastica_Index |
getResponse(
)
:
\Elastica_ResponseReturns response object
Returns
| Type | Description |
|---|---|
| \Elastica_Response | Response object |
getServerStatus(
)
:
voidRefresh serverStatus object
getShards(
)
:
array
Returns
| Type | Description |
|---|---|
| array | Shards info |
indexExists(
string $name
)
:
boolChecks if the given index exists
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | Index name to check |
| Type | Description |
|---|---|
| bool | True if index exists |
refresh(
)
:
voidRefresh status object