Index Operationsedit
This section will walk you through the various index APIs that are exposed through the client. Index operations include anything that manages an index itself (e.g. create an index, delete, change mappings, etc).
We’ll walk through a few common operations with detailed code snippets, then list the rest of the methods in a table. The parameters are identical to the REST api, so it should be easy to perform the operation you need.
Create an indexedit
The index operations are all contained under a distinct namespace, separated from other methods that are on the root client object. As an example, let’s create a new index:
$client = new Elasticsearch\Client(); $indexParams['index'] = 'my_index'; //index $client->indices()->create($indexParams);
You can, of course, specify any parameters that would normally be included in a new index creation API. All parameters that would normally go in the request body are located in the body associative array:
$client = new Elasticsearch\Client();
$indexParams['index'] = 'my_index';
// Index Settings
$indexParams['body']['settings']['number_of_shards'] = 3;
$indexParams['body']['settings']['number_of_replicas'] = 2;
// Example Index Mapping
$myTypeMapping = array(
'_source' => array(
'enabled' => true
),
'properties' => array(
'first_name' => array(
'type' => 'string',
'analyzer' => 'standard'
),
'age' => array(
'type' => 'integer'
)
)
);
$indexParams['body']['mappings']['my_type'] = $myTypeMapping;
// Create the index
$client->indices()->create($indexParams);
Create an index (advanced example)edit
This is a more complicated example of creating an index, showing how to define analyzers, tokenizers, filters and index settings. Although essentially the same as the previous example, the more complicated example can be helpful for "real world" usage of the client, since this particular syntax is easy to mess up.
For brevity, the example is presented using PHP 5.4+ short array syntax ([] as opposed to array()).
$params = [
'index' => 'reuters',
'body' => [
'settings' => [ 
'number_of_shards' => 1,
'number_of_replicas' => 0,
'analysis' => [ 
'filter' => [
'shingle' => [
'type' => 'shingle'
]
],
'char_filter' => [
'pre_negs' => [
'type' => 'pattern_replace',
'pattern' => '(\\w+)\\s+((?i:never|no|nothing|nowhere|noone|none|not|havent|hasnt|hadnt|cant|couldnt|shouldnt|wont|wouldnt|dont|doesnt|didnt|isnt|arent|aint))\\b',
'replacement' => '~$1 $2'
],
'post_negs' => [
'type' => 'pattern_replace',
'pattern' => '\\b((?i:never|no|nothing|nowhere|noone|none|not|havent|hasnt|hadnt|cant|couldnt|shouldnt|wont|wouldnt|dont|doesnt|didnt|isnt|arent|aint))\\s+(\\w+)',
'replacement' => '$1 ~$2'
]
],
'analyzer' => [
'reuters' => [
'type' => 'custom',
'tokenizer' => 'standard',
'filter' => ['lowercase', 'stop', 'kstem']
]
]
]
],
'mappings' => [ 
'_default_' => [ 
'properties' => [
'title' => [
'type' => 'string',
'analyzer' => 'reuters',
'term_vector' => 'yes',
'copy_to' => 'combined'
],
'body' => [
'type' => 'string',
'analyzer' => 'reuters',
'term_vector' => 'yes',
'copy_to' => 'combined'
],
'combined' => [
'type' => 'string',
'analyzer' => 'reuters',
'term_vector' => 'yes'
],
'topics' => [
'type' => 'string',
'index' => 'not_analyzed'
],
'places' => [
'type' => 'string',
'index' => 'not_analyzed'
]
]
],
'my_type' => [ 
'properties' => [
'my_field' => [
'type' => 'string'
]
]
]
]
]
];
$client->indices()->create($params);
|
The top level |
|
|
|
|
|
The |
|
The |
Delete an indexedit
Deleting an index is very simple:
$deleteParams['index'] = 'my_index'; $client->indices()->delete($deleteParams);
Put Settings APIedit
The Put Settings API allows you to modify any index setting that is dynamic:
$params['index'] = 'my_index'; $params['body']['index']['number_of_replicas'] = 0; $params['body']['index']['refresh_interval'] = -1; $ret = $client->indices()->putSettings($params);
Get Settings APIedit
Get Settings API will show you the currently configured settings for one or more indexes:
// Get settings for one index
$params['index'] = 'my_index';
$ret = $client->indices()->getSettings($params);
// Get settings for several indexes
$params['index'] = array('my_index', 'my_index2');
$ret = $client->indices()->getSettings($params);
Put Mappings APIedit
The Put Mappings API allows you to modify or add to an existing index’s mapping.
// Set the index and type
$params['index'] = 'my_index';
$params['type'] = 'my_type2';
// Adding a new type to an existing index
$myTypeMapping2 = array(
'_source' => array(
'enabled' => true
),
'properties' => array(
'first_name' => array(
'type' => 'string',
'analyzer' => 'standard'
),
'age' => array(
'type' => 'integer'
)
)
);
$params['body']['my_type2'] = $myTypeMapping2;
// Update the index mapping
$client->indices()->putMapping($params);
Get Mappings APIedit
The Get Mappings API will return the mapping details about your indexes and types. Depending on the mappings that you wish to retrieve, you can specify a number of combinations of index and type:
// Get mappings for all indexes and types
$ret = $client->indices()->getMapping();
// Get mappings for all types in 'my_index'
$params['index'] = 'my_index';
$ret = $client->indices()->getMapping($params);
// Get mappings for all types of 'my_type', regardless of index
$params['type'] = 'my_type';
$ret = $client->indices()->getMapping($params);
// Get mapping 'my_type' in 'my_index'
$params['index'] = 'my_index';
$params['type'] = 'my_type'
$ret = $client->indices()->getMapping($params);
// Get mappings for two indexes
$params['index'] = array('my_index', 'my_index2');
$ret = $client->indices()->getMapping($params);
Other APIs in the Indices Namespaceedit
There are a number of other APIs in the indices namespace that allow you to manage your elasticsearch indexes (add/remove templates, flush segments, close indexes, etc).
If you use an IDE with autocompletion, you should be able to easily explore the indices namespace by typing:
$client->indices()->
And perusing the list of available methods. Alternatively, browsing the \Elasticsearch\Namespaces\Indices.php file will show you the full list of available method calls (as well as parameter lists in the comments for each method).