Skip to content

added documentation for inBackground index flag #295

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.

Sign up for GitHub

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 1 commit into from
Aug 19, 2019
Merged

added documentation for inBackground index flag #295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions docs/Drivers/Java/Reference/Collection/Indexes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ Creates a hash index for the collection if it does not already exist.

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

- **inBackground**: `Boolean`

Indexes created with the 'inBackground' option, will not hold an exclusive collection
lock for the entire index creation period (rocksdb only).

**Examples**

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

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

- **inBackground**: `Boolean`

Indexes created with the 'inBackground' option, will not hold an exclusive collection
lock for the entire index creation period (rocksdb only).

**Examples**

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

- **inBackground**: `Boolean`

Indexes created with the 'inBackground' option, will not hold an exclusive collection
lock for the entire index creation period (rocksdb only).

**Examples**

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

- **inBackground**: `Boolean`

Indexes created with the 'inBackground' option, will not hold an exclusive collection
lock for the entire index creation period (rocksdb only).

**Examples**

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

If true, then create a sparse index

- **inBackground**: `Boolean`

Indexes created with the 'inBackground' option, will not hold an exclusive collection
lock for the entire index creation period (rocksdb only).

**Examples**

```Java
Expand Down