Packages

o

com.couchbase.spark.analytics

AnalyticsOptions

object AnalyticsOptions

Helper object to provide type-safe keys and values for Spark SQL analytics query options.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AnalyticsOptions
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val Bucket: String

    Option Key: The name of the bucket, which overrides the implicit bucket configured.

    Option Key: The name of the bucket, which overrides the implicit bucket configured.

    Note: only works against Couchbase Server 7.0 or later, since it used in conjunction with scope.

  5. val ConnectionIdentifier: String

    Option Key: Instead of using the "default" connection, allows to connect to a different cluster.

  6. val Dataset: String

    Option Key: The name of the dataset.

  7. val Filter: String

    Option Key: a Analytics N1QL expression which acts as an additional filter on every analytics query, including schema inference.

  8. val IdFieldName: String

    Option Key: The field name of the document ID, used to override the default.

    Option Key: The field name of the document ID, used to override the default.

    The default can be located in DefaultConstants.DefaultIdFieldName

  9. val InferLimit: String

    Option Key: The limit of how many records to load during schema inference.

    Option Key: The limit of how many records to load during schema inference.

    The default can be found in DefaultConstants.DefaultInferLimit

  10. val NotBoundedScanConsistency: String

    Option Value: Not bounded scan consistency - to be used with ScanConsistency as the key.

    Option Value: Not bounded scan consistency - to be used with ScanConsistency as the key.

    This is the default and usually does not need to be specified. The query will be executed immediately, and it might not include documents which have just been written and not made it into the index yet.

  11. val PushDownAggregate: String

    Option Key: If aggregates should be allowed to be pushed down by spark into the analytics engine.

    Option Key: If aggregates should be allowed to be pushed down by spark into the analytics engine.

    This value is true by default for performance reasons. It is available to be disabled should there be any issues identified in the field.

  12. val RequestPlusScanConsistency: String

    Option Value: Request plus scan consistency - to be used with ScanConsistency as the key.

    Option Value: Request plus scan consistency - to be used with ScanConsistency as the key.

    If this value is set, the indexer will wait until it has caught up to the recent mutations, which will make sure that documents which just have been written are part of the result set.

  13. val ScanConsistency: String

    Option Key: Allows to override the scan consistency for the query performed.

  14. val Scope: String

    Option Key: The name of the scope, which overrides the implicit scope (if configured at all).

    Option Key: The name of the scope, which overrides the implicit scope (if configured at all).

    Note: only works against Couchbase Server 7.0 or later.

  15. val Timeout: String

    Option Key: The timeout to use which overrides the default configured.

    Option Key: The timeout to use which overrides the default configured.

    The value is a string and must be parsable from a scala Duration.

  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped