Skip to content

Commit fbb77c2

Browse files
authored
added documentation for inBackground index flag (#295)
1 parent 70cfb15 commit fbb77c2

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
@@ -29,6 +29,11 @@ Creates a hash index for the collection if it does not already exist.
2929

3030
If false, the de-duplication of array values is turned off.
3131

32+
- **inBackground**: `Boolean`
33+
34+
Indexes created with the 'inBackground' option, will not hold an exclusive collection
35+
lock for the entire index creation period (rocksdb only).
36+
3237
**Examples**
3338

3439
```Java
@@ -66,6 +71,11 @@ Creates a skip-list index for the collection if it does not already exist.
6671

6772
If false, the de-duplication of array values is turned off.
6873

74+
- **inBackground**: `Boolean`
75+
76+
Indexes created with the 'inBackground' option, will not hold an exclusive collection
77+
lock for the entire index creation period (rocksdb only).
78+
6979
**Examples**
7080

7181
```Java
@@ -99,6 +109,11 @@ Creates a geo index for the collection if it does not already exist.
99109
then the order within the array is longitude followed by latitude.
100110
This corresponds to the format described in.
101111

112+
- **inBackground**: `Boolean`
113+
114+
Indexes created with the 'inBackground' option, will not hold an exclusive collection
115+
lock for the entire index creation period (rocksdb only).
116+
102117
**Examples**
103118

104119
```Java
@@ -132,6 +147,11 @@ Creates a fulltext index for the collection if it does not already exist.
132147
value if unspecified. It is thus recommended to set this value explicitly
133148
when creating the index.
134149

150+
- **inBackground**: `Boolean`
151+
152+
Indexes created with the 'inBackground' option, will not hold an exclusive collection
153+
lock for the entire index creation period (rocksdb only).
154+
135155
**Examples**
136156

137157
```Java
@@ -167,6 +187,11 @@ Creates a persistent index for the collection if it does not already exist.
167187

168188
If true, then create a sparse index
169189

190+
- **inBackground**: `Boolean`
191+
192+
Indexes created with the 'inBackground' option, will not hold an exclusive collection
193+
lock for the entire index creation period (rocksdb only).
194+
170195
**Examples**
171196

172197
```Java

0 commit comments

Comments
 (0)