|
| 1 | +# Analyzers |
| 2 | + |
| 3 | +[HTTP Interface for Analyzers](https://www.arangodb.com/docs/devel/http/analyzers.html). |
| 4 | + |
| 5 | + |
| 6 | +## Types |
| 7 | + |
| 8 | +- **AnalyzerEntity** |
| 9 | + |
| 10 | + - **name**: `String` |
| 11 | + |
| 12 | + The analyzer name. |
| 13 | + |
| 14 | + - **type**: `AnalyzerType` |
| 15 | + |
| 16 | + The analyzer type. Can be one of: `identity`, `delimiter`, `stem`, `norm`, `ngram`, `text` |
| 17 | + |
| 18 | + - **properties**: `Map<String, Object>` |
| 19 | + |
| 20 | + The properties used to configure the specified type. Value may be a string, an object or null. The default value is null. |
| 21 | + |
| 22 | + - **features**: `Set<AnalyzerFeature>` |
| 23 | + |
| 24 | + The set of features to set on the analyzer generated fields. The default value is an empty array. |
| 25 | + Values can be: `frequency`, `norm`, `position` |
| 26 | + |
| 27 | + |
| 28 | +## ArangoDatabase.createArangoSearch |
| 29 | + |
| 30 | +`ArangoDatabase.createAnalyzer(AnalyzerEntity options) : AnalyzerEntity` |
| 31 | + |
| 32 | +Creates an Analyzer. |
| 33 | + |
| 34 | + |
| 35 | +## ArangoDatabase.getAnalyzer |
| 36 | + |
| 37 | +`ArangoDatabase.getAnalyzer(String name) : AnalyzerEntity` |
| 38 | + |
| 39 | +Gets information about an Analyzer |
| 40 | + |
| 41 | +**Arguments** |
| 42 | + |
| 43 | +- **name**: `String` |
| 44 | + |
| 45 | + The name of the analyzer |
| 46 | + |
| 47 | + |
| 48 | +## ArangoDatabase.getAnalyzers |
| 49 | + |
| 50 | +`ArangoDatabase.getAnalyzers() : Collection<AnalyzerEntity>` |
| 51 | + |
| 52 | +Retrieves all analyzers definitions. |
| 53 | + |
| 54 | + |
| 55 | +## ArangoDatabase.deleteAnalyzer |
| 56 | + |
| 57 | +`ArangoDatabase.deleteAnalyzer(String name) : void` |
| 58 | + |
| 59 | +Deletes an Analyzer. |
| 60 | + |
| 61 | +**Arguments** |
| 62 | + |
| 63 | +- **name**: `String` |
| 64 | + |
| 65 | + The name of the analyzer |
| 66 | + |
| 67 | + |
| 68 | +## ArangoDatabase.deleteAnalyzer |
| 69 | + |
| 70 | +`ArangoDatabase.deleteAnalyzer(String name, AnalyzerDeleteOptions options) : void` |
| 71 | + |
| 72 | +Deletes an Analyzer. |
| 73 | + |
| 74 | +**Arguments** |
| 75 | + |
| 76 | +- **name**: `String` |
| 77 | + |
| 78 | + The name of the analyzer |
| 79 | + |
| 80 | +- **options**: `AnalyzerDeleteOptions` |
| 81 | + |
| 82 | + - **force**: `Boolean` |
| 83 | + |
| 84 | + The analyzer configuration should be removed even if it is in-use. The default value is false. |
0 commit comments