Skip to content

Commit

Permalink
[NodeSearchBundle] Elastic search version 6 support
Browse files Browse the repository at this point in the history 
* [NodeSearchBundle] Elastic search version 6 support

* [NodeSearchBundle] Elastic search version 6 support
  • Loading branch information
@treeleaf
treeleaf authored and Numkil committed Mar 29, 2018
1 parent 99a3bb5 commit 8bcf4e7
Show file tree
Hide file tree
Showing 5 changed files with 197 additions and 69 deletions.
2 changes: 1 addition & 1 deletion composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"twig/extensions": "~1.0",
"egulias/email-validator": "~1.2",
"box/spout": "^2.5",
"ruflin/elastica": "^5.1",
"ruflin/elastica": "^5.1|^6.0",
"behat/transliterator": "~1.2",
"defuse/php-encryption": "v2.1.0"
},
Expand Down
33 changes: 27 additions & 6 deletions src/Kunstmaan/NodeSearchBundle/DependencyInjection/Configuration.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Kunstmaan\NodeSearchBundle\Helper\ElasticSearchUtil;

/**
* This is the class that validates and merges configuration from your app/config files
Expand All @@ -28,16 +29,36 @@ public function getConfigTreeBuilder()
/** @var ArrayNodeDefinition $properties */
$properties = $rootNode->children()->arrayNode('mapping')->useAttributeAsKey('name')->prototype('array');

$properties->children()->scalarNode('type')->beforeNormalization()->ifNotInArray($types = [
'string', 'token_count', 'text', 'keyword',
$types = [
'token_count', 'text', 'keyword',
'float', 'double', 'byte', 'short', 'integer', 'long',
'date',
'boolean',
'binary',
])->thenInvalid('type must be one of: ' . implode(', ', $types));
$properties->children()->scalarNode('index')->beforeNormalization()->ifNotInArray(['analyzed', 'not_analyzed', 'no'])
->thenInvalid("index must be one of: analyzed, not_analyzed, no");
$properties->children()->booleanNode('include_in_all');
];
if (!ElasticSearchUtil::useVersion6()) {
$types[] = 'string';
}

$properties->children()->scalarNode('type')->beforeNormalization()->ifNotInArray($types)->thenInvalid('type must be one of: ' . implode(', ', $types));

if (ElasticSearchUtil::useVersion6()) {
$properties->children()->booleanNode('fielddata');
$properties->children()->booleanNode('doc_values');
$properties->children()
->scalarNode('index')
->beforeNormalization()
->ifNotInArray(['true', 'false', true, false])
->thenInvalid("index must be one of: true, false");
} else {
$properties->children()
->scalarNode('index')
->beforeNormalization()
->ifNotInArray(['analyzed', 'not_analyzed', 'no'])
->thenInvalid("index must be one of: analyzed, not_analyzed, no");
$properties->children()->booleanNode('include_in_all');
}

$properties->children()->booleanNode('store');
$properties->children()->floatNode('boost');
$properties->children()->scalarNode('null_value');
Expand Down
164 changes: 102 additions & 62 deletions src/Kunstmaan/NodeSearchBundle/DependencyInjection/KunstmaanNodeSearchExtension.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
use Symfony\Component\DependencyInjection\Loader;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Kunstmaan\NodeSearchBundle\Helper\ElasticSearchUtil;

/**
* This is the class that loads and manages your bundle configuration
Expand Down Expand Up @@ -48,67 +49,106 @@ public function load(array $configs, ContainerBuilder $container)
*/
public function prepend(ContainerBuilder $container)
{
$container->prependExtensionConfig('kunstmaan_node_search', [
'mapping' => [
'root_id' => [
'type' => 'integer',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'node_id' => [
'type' => 'integer',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'nodetranslation_id' => [
'type' => 'integer',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'nodeversion_id' => [
'type' => 'integer',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'title' => [
'type' => 'string',
'include_in_all' => true
],
'slug' => [
'type' => 'string',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'type' => [
'type' => 'string',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'page_class' => [
'type' => 'string',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'content' => [
'type' => 'string',
'include_in_all' => true
],
'created' => [
'type' => 'date',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'updated' => [
'type' => 'date',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'view_roles' => [
'type' => 'string',
'include_in_all' => true,
'index' => 'not_analyzed',
],
]
]);
if (ElasticSearchUtil::useVersion6()) {
$mapping = [
'mapping' => [
'root_id' => [
'type' => 'integer',
],
'node_id' => [
'type' => 'integer',
],
'nodetranslation_id' => [
'type' => 'integer',
],
'nodeversion_id' => [
'type' => 'integer',
],
'title' => [
'type' => 'text',
],
'slug' => [
'type' => 'text',
],
'type' => [
'type' => 'keyword',
],
'page_class' => [
'type' => 'keyword',
],
'content' => [
'type' => 'text',
],
'view_roles' => [
'type' => 'keyword',
],
]
];
} else {
$mapping = [
'mapping' => [
'root_id' => [
'type' => 'integer',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'node_id' => [
'type' => 'integer',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'nodetranslation_id' => [
'type' => 'integer',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'nodeversion_id' => [
'type' => 'integer',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'title' => [
'type' => 'string',
'include_in_all' => true
],
'slug' => [
'type' => 'string',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'type' => [
'type' => 'string',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'page_class' => [
'type' => 'string',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'content' => [
'type' => 'string',
'include_in_all' => true
],
'created' => [
'type' => 'date',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'updated' => [
'type' => 'date',
'include_in_all' => false,
'index' => 'not_analyzed'
],
'view_roles' => [
'type' => 'string',
'include_in_all' => true,
'index' => 'not_analyzed',
],
]
];
}

$container->prependExtensionConfig('kunstmaan_node_search', $mapping);
}
}
17 changes: 17 additions & 0 deletions src/Kunstmaan/NodeSearchBundle/Helper/ElasticSearchUtil.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

namespace Kunstmaan\NodeSearchBundle\Helper;

/**
* Class ElasticSearchUtil
*/
final class ElasticSearchUtil
{
/**
* @return bool
*/
public static function useVersion6()
{
return (PHP_MAJOR_VERSION == 7 && !class_exists('\Elastica\Tool\CrossIndex'));
}
}
50 changes: 50 additions & 0 deletions src/Kunstmaan/NodeSearchBundle/Resources/doc/ElasticSearch.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Elastic search support

We have added support for Elastic search up to version 6.x.

## Dynamic configuration
For the mapping and configuration we detect which version of the library your project is using.
Dependencies for using the configuration of version 6 is that your project uses PHP 7 and ruflin/elastica >= 6.0.

## Difference between versions

The biggest change in version 6, is that Elastica has dropped support for the "_all" meta field.
(see https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-all-field.html)

When using version 6.x, then you will no longer be able to use the "include_in_all" and "index => 'not_analysed".
use 'index => false' instead. Also some of the index types have been changed and some fields are no longer indexed (like the 'created' and 'updated' fields).

### Example

Some examples of the mapping that have changed (for the kunstmaan_node_search extension):

```
'node_id' => [
'type' => 'integer',
'include_in_all' => false,
'index' => 'not_analyzed'
],
...
'view_roles' => [
'type' => 'string',
'include_in_all' => true,
'index' => 'not_analyzed',
],
```

in


```
'node_id' => [
'type' => 'integer',
],
...
'view_roles' => [
'type' => 'keyword',
],
```

### Link to elastic search documentation

https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html

0 comments on commit 8bcf4e7

Please sign in to comment.