Skip to content

Commit c05c3b7

Browse files
authored
analyzers doc (#302)
* analyzers doc * stream transactions doc links * doc bugfix
1 parent b0b2036 commit c05c3b7

File tree

2 files changed

+86
-0
lines changed

2 files changed

+86
-0
lines changed

docs/Drivers/Java/Reference/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [Queries](Database/Queries.md)
99
- [AQL User Functions](Database/AqlUserFunctions.md)
1010
- [Transactions](Database/Transactions.md)
11+
- [Stream Transactions](Database/StreamTransactions.md)
1112
- [Graph Access](Database/GraphAccess.md)
1213
- [HTTP Routes](Database/HttpRoutes.md)
1314
- [Collection](Collection/README.md)
@@ -18,6 +19,7 @@
1819
- [View](View/README.md)
1920
- [View Manipulation](View/ViewManipulation.md)
2021
- [ArangoSearch Views](View/ArangoSearch.md)
22+
- [Analyzers](View/Analyzers.md)
2123
- [Cursor](Cursor.md)
2224
- [Graph](Graph/README.md)
2325
- [Vertex Collection](Graph/VertexCollection.md)
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
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

Comments
 (0)