Skip to content

Commit c9be5e0

Browse files
hkernbachrashtao
authored andcommitted
added docu for named indices (#297)
1 parent 2f4facb commit c9be5e0

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/Drivers/Java/Reference/Collection/Indexes.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ Creates a hash index for the collection if it does not already exist.
1717

1818
- **options**: `HashIndexOptions`
1919

20+
- **name**: `String`
21+
22+
Specify a custom name during index creation (optional). When running AQL queries you might then refer
23+
to these name as your preferred index for lookups (e.g. Index Hints).
24+
2025
- **unique**: `Boolean`
2126

2227
If true, then create a unique index
@@ -59,6 +64,11 @@ Creates a skip-list index for the collection if it does not already exist.
5964

6065
- **options**: `SkipListIndexOptions`
6166

67+
- **name**: `String`
68+
69+
Specify a custom name during index creation (optional). When running AQL queries you might then refer
70+
to these name as your preferred index for lookups (e.g. Index Hints).
71+
6272
- **unique**: `Boolean`
6373

6474
If true, then create a unique index
@@ -103,6 +113,11 @@ Creates a geo index for the collection if it does not already exist.
103113

104114
- **options**: `GeoIndexOptions`
105115

116+
- **name**: `String`
117+
118+
Specify a custom name during index creation (optional). When running AQL queries you might then refer
119+
to these name as your preferred index for lookups (e.g. Index Hints).
120+
106121
- **geoJson**: `Boolean`
107122

108123
If a geo-spatial index on a location is constructed and geoJson is true,
@@ -141,6 +156,11 @@ Creates a fulltext index for the collection if it does not already exist.
141156

142157
- **options**: `FulltextIndexOptions`
143158

159+
- **name**: `String`
160+
161+
Specify a custom name during index creation (optional). When running AQL queries you might then refer
162+
to these name as your preferred index for lookups (e.g. Index Hints).
163+
144164
- **minLength**: `Integer`
145165

146166
Minimum character length of words to index. Will default to a server-defined
@@ -179,6 +199,11 @@ Creates a persistent index for the collection if it does not already exist.
179199

180200
- **options**: `PersistentIndexOptions`
181201

202+
- **name**: `String`
203+
204+
Specify a custom name during index creation (optional). When running AQL queries you might then refer
205+
to these name as your preferred index for lookups (e.g. Index Hints).
206+
182207
- **unique**: `Boolean`
183208

184209
If true, then create a unique index

0 commit comments

Comments
 (0)