Skip to content

added docu for named indices #297

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 docu for named indices #297

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

- **options**: `HashIndexOptions`

- **name**: `String`

Specify a custom name during index creation (optional). When running AQL queries you might then refer
to these name as your preferred index for lookups (e.g. Index Hints).

- **unique**: `Boolean`

If true, then create a unique index
Expand Down Expand Up @@ -54,6 +59,11 @@ Creates a skip-list index for the collection if it does not already exist.

- **options**: `SkipListIndexOptions`

- **name**: `String`

Specify a custom name during index creation (optional). When running AQL queries you might then refer
to these name as your preferred index for lookups (e.g. Index Hints).

- **unique**: `Boolean`

If true, then create a unique index
Expand Down Expand Up @@ -93,6 +103,11 @@ Creates a geo index for the collection if it does not already exist.

- **options**: `GeoIndexOptions`

- **name**: `String`

Specify a custom name during index creation (optional). When running AQL queries you might then refer
to these name as your preferred index for lookups (e.g. Index Hints).

- **geoJson**: `Boolean`

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

- **options**: `FulltextIndexOptions`

- **name**: `String`

Specify a custom name during index creation (optional). When running AQL queries you might then refer
to these name as your preferred index for lookups (e.g. Index Hints).

- **minLength**: `Integer`

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

- **options**: `PersistentIndexOptions`

- **name**: `String`

Specify a custom name during index creation (optional). When running AQL queries you might then refer
to these name as your preferred index for lookups (e.g. Index Hints).

- **unique**: `Boolean`

If true, then create a unique index
Expand Down