class CollectionQueryIndexManager extends AnyRef
Allows query indexes to be managed, at the Collection level.
- Alphabetic
- By Inheritance
- CollectionQueryIndexManager
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CollectionQueryIndexManager(async: AsyncCollectionQueryIndexManager)(implicit ec: ExecutionContext)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def buildDeferredIndexes(timeout: Duration = DefaultTimeout, retryStrategy: RetryStrategy = DefaultRetryStrategy): Try[Unit]
Build all deferred indexes on this collection .
Build all deferred indexes on this collection .
- timeout
when the operation will timeout. This will default to
timeoutConfig().managementTimeout ()in the provided com.couchbase.client.scala.env.ClusterEnvironment.- retryStrategy
provides some control over how the SDK handles failures. Will default to
retryStrategy()in the provided com.couchbase.client.scala.env.ClusterEnvironment.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def createIndex(indexName: String, fields: Iterable[String], ignoreIfExists: Boolean = false, numReplicas: Option[Int] = None, deferred: Option[Boolean] = None, timeout: Duration = DefaultTimeout, retryStrategy: RetryStrategy = DefaultRetryStrategy): Try[Unit]
Creates a new query index on this collection, with the specified parameters.
Creates a new query index on this collection, with the specified parameters.
- indexName
the name of the index.
- ignoreIfExists
if an index with the same name already exists, the operation will fail.
- numReplicas
how many replicas of the index to create.
- deferred
set to true to defer building the index until buildDeferredIndexes is called. This can provide improved performance when creating multiple indexes.
- timeout
when the operation will timeout. This will default to
timeoutConfig().managementTimeout ()in the provided com.couchbase.client.scala.env.ClusterEnvironment.- retryStrategy
provides some control over how the SDK handles failures. Will default to
retryStrategy()in the provided com.couchbase.client.scala.env.ClusterEnvironment.
- def createPrimaryIndex(indexName: Option[String] = None, ignoreIfExists: Boolean = false, numReplicas: Option[Int] = None, deferred: Option[Boolean] = None, timeout: Duration = DefaultTimeout, retryStrategy: RetryStrategy = DefaultRetryStrategy): Try[Unit]
Creates a new primary query index on this collection, with the specified parameters.
Creates a new primary query index on this collection, with the specified parameters.
- indexName
the name of the index. If not set the server assigns the default primary index name.
- ignoreIfExists
if a primary index already exists, the operation will fail.
- numReplicas
how many replicas of the index to create.
- deferred
set to true to defer building the index until buildDeferredIndexes is called. This can provide improved performance when creating multiple indexes.
- timeout
when the operation will timeout. This will default to
timeoutConfig().managementTimeout ()in the provided com.couchbase.client.scala.env.ClusterEnvironment.- retryStrategy
provides some control over how the SDK handles failures. Will default to
retryStrategy()in the provided com.couchbase.client.scala.env.ClusterEnvironment.
- def dropIndex(indexName: String, ignoreIfNotExists: Boolean = false, timeout: Duration = DefaultTimeout, retryStrategy: RetryStrategy = DefaultRetryStrategy): Try[Unit]
Drops an existing index on this collection.
Drops an existing index on this collection.
- indexName
the name of the index.
- ignoreIfNotExists
sets whether the operation should fail if the index does not exists
- timeout
when the operation will timeout. This will default to
timeoutConfig().managementTimeout ()in the provided com.couchbase.client.scala.env.ClusterEnvironment.- retryStrategy
provides some control over how the SDK handles failures. Will default to
retryStrategy()in the provided com.couchbase.client.scala.env.ClusterEnvironment.
- def dropPrimaryIndex(ignoreIfNotExists: Boolean = false, timeout: Duration = DefaultTimeout, retryStrategy: RetryStrategy = DefaultRetryStrategy): Try[Unit]
Drops an existing primary index on this collection.
Drops an existing primary index on this collection.
- ignoreIfNotExists
sets whether the operation should fail if the index does not exists
- timeout
when the operation will timeout. This will default to
timeoutConfig().managementTimeout ()in the provided com.couchbase.client.scala.env.ClusterEnvironment.- retryStrategy
provides some control over how the SDK handles failures. Will default to
retryStrategy()in the provided com.couchbase.client.scala.env.ClusterEnvironment.
- implicit val ec: ExecutionContext
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def getAllIndexes(timeout: Duration = DefaultTimeout, retryStrategy: RetryStrategy = DefaultRetryStrategy): Try[Seq[QueryIndex]]
Gets all indexes on this collection.
Gets all indexes on this collection.
- timeout
when the operation will timeout. This will default to
timeoutConfig().managementTimeout ()in the provided com.couchbase.client.scala.env.ClusterEnvironment.- retryStrategy
provides some control over how the SDK handles failures. Will default to
retryStrategy()in the provided com.couchbase.client.scala.env.ClusterEnvironment.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def watchIndexes(indexNames: Iterable[String], timeout: Duration, watchPrimary: Boolean = false, retryStrategy: RetryStrategy = DefaultRetryStrategy): Try[Unit]
Polls the specified indexes on this collection until they are all online.
Polls the specified indexes on this collection until they are all online.
- indexNames
the indexes to poll.
- timeout
when the operation will timeout.
- watchPrimary
include the bucket's primary index. If the bucket has no primary index, the operation will fail with
IndexNotFoundException- retryStrategy
provides some control over how the SDK handles failures. Will default to
retryStrategy()in the provided com.couchbase.client.scala.env.ClusterEnvironment.
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)