Skip to content

analyzers doc #302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/Drivers/Java/Reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down
84 changes: 84 additions & 0 deletions docs/Drivers/Java/Reference/View/Analyzers.md
Original file line number Diff line number Diff line change
@@ -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<String, Object>`

The properties used to configure the specified type. Value may be a string, an object or null. The default value is null.

- **features**: `Set<AnalyzerFeature>`

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<AnalyzerEntity>`

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.