diff --git a/docs/Drivers/Java/Reference/README.md b/docs/Drivers/Java/Reference/README.md index c35bf9b2a..ea6307f54 100644 --- a/docs/Drivers/Java/Reference/README.md +++ b/docs/Drivers/Java/Reference/README.md @@ -8,6 +8,7 @@ - [Queries](Database/Queries.md) - [AQL User Functions](Database/AqlUserFunctions.md) - [Transactions](Database/Transactions.md) + - [Stream Transactions](Database/StreamTransactions.md) - [Graph Access](Database/GraphAccess.md) - [HTTP Routes](Database/HttpRoutes.md) - [Collection](Collection/README.md) @@ -18,6 +19,7 @@ - [View](View/README.md) - [View Manipulation](View/ViewManipulation.md) - [ArangoSearch Views](View/ArangoSearch.md) + - [Analyzers](View/Analyzers.md) - [Cursor](Cursor.md) - [Graph](Graph/README.md) - [Vertex Collection](Graph/VertexCollection.md) diff --git a/docs/Drivers/Java/Reference/View/Analyzers.md b/docs/Drivers/Java/Reference/View/Analyzers.md new file mode 100644 index 000000000..543a9bd48 --- /dev/null +++ b/docs/Drivers/Java/Reference/View/Analyzers.md @@ -0,0 +1,84 @@ +# Analyzers + +[HTTP Interface for Analyzers](https://www.arangodb.com/docs/devel/http/analyzers.html). + + +## Types + +- **AnalyzerEntity** + + - **name**: `String` + + The analyzer name. + + - **type**: `AnalyzerType` + + The analyzer type. Can be one of: `identity`, `delimiter`, `stem`, `norm`, `ngram`, `text` + + - **properties**: `Map` + + The properties used to configure the specified type. Value may be a string, an object or null. The default value is null. + + - **features**: `Set` + + The set of features to set on the analyzer generated fields. The default value is an empty array. + Values can be: `frequency`, `norm`, `position` + + +## ArangoDatabase.createArangoSearch + +`ArangoDatabase.createAnalyzer(AnalyzerEntity options) : AnalyzerEntity` + +Creates an Analyzer. + + +## ArangoDatabase.getAnalyzer + +`ArangoDatabase.getAnalyzer(String name) : AnalyzerEntity` + +Gets information about an Analyzer + +**Arguments** + +- **name**: `String` + + The name of the analyzer + + +## ArangoDatabase.getAnalyzers + +`ArangoDatabase.getAnalyzers() : Collection` + +Retrieves all analyzers definitions. + + +## ArangoDatabase.deleteAnalyzer + +`ArangoDatabase.deleteAnalyzer(String name) : void` + +Deletes an Analyzer. + +**Arguments** + +- **name**: `String` + + The name of the analyzer + + +## ArangoDatabase.deleteAnalyzer + +`ArangoDatabase.deleteAnalyzer(String name, AnalyzerDeleteOptions options) : void` + +Deletes an Analyzer. + +**Arguments** + +- **name**: `String` + + The name of the analyzer + +- **options**: `AnalyzerDeleteOptions` + + - **force**: `Boolean` + + The analyzer configuration should be removed even if it is in-use. The default value is false.