Class CreateQueryIndexOptions
- java.lang.Object
-
- com.couchbase.client.java.CommonOptions<CreateQueryIndexOptions>
-
- com.couchbase.client.java.manager.query.CreateQueryIndexOptions
-
public class CreateQueryIndexOptions extends CommonOptions<CreateQueryIndexOptions>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
CreateQueryIndexOptions.Built
-
Nested classes/interfaces inherited from class com.couchbase.client.java.CommonOptions
CommonOptions.BuiltCommonOptions
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateQueryIndexOptions.Built
build()
static CreateQueryIndexOptions
createQueryIndexOptions()
CreateQueryIndexOptions
deferred(boolean deferred)
Set totrue
to defer building of the index untilQueryIndexManager.buildDeferredIndexes(java.lang.String)
is called.CreateQueryIndexOptions
ignoreIfExists(boolean ignore)
If an index with the same name already exists, an exception will be thrown unless this is set to true.CreateQueryIndexOptions
numReplicas(int numReplicas)
Specifies the number of replicas of the index to create.CreateQueryIndexOptions
with(String optionName, Object optionValue)
Escape hatch for specifying extra options in theWITH
clause.-
Methods inherited from class com.couchbase.client.java.CommonOptions
clientContext, parentSpan, retryStrategy, self, timeout
-
-
-
-
Method Detail
-
createQueryIndexOptions
public static CreateQueryIndexOptions createQueryIndexOptions()
-
ignoreIfExists
public CreateQueryIndexOptions ignoreIfExists(boolean ignore)
If an index with the same name already exists, an exception will be thrown unless this is set to true.
-
numReplicas
public CreateQueryIndexOptions numReplicas(int numReplicas)
Specifies the number of replicas of the index to create.
-
deferred
public CreateQueryIndexOptions deferred(boolean deferred)
Set totrue
to defer building of the index untilQueryIndexManager.buildDeferredIndexes(java.lang.String)
is called.If you are creating multiple indexes on the same bucket, you may see improved performance by creating them in deferred mode and then building them all at once.
-
with
public CreateQueryIndexOptions with(String optionName, Object optionValue)
Escape hatch for specifying extra options in theWITH
clause. Intended for options that are supported by Couchbase Server but not by this version of the SDK.
-
build
@Internal public CreateQueryIndexOptions.Built build()
-
-