case class TransactionQueryOptions extends Product with Serializable

Customize the execution of a N1QL query performed inside a transaction.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransactionQueryOptions
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. def adhoc(adhoc: Boolean): TransactionQueryOptions

    If true (the default), adhoc mode is enabled: queries are just run.

    If true (the default), adhoc mode is enabled: queries are just run.

    If false, adhoc mode is disabled and transparent prepared statement mode is enabled: queries are first prepared so they can be executed more efficiently in the future.

    returns

    a copy of this with the change applied, for chaining.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clientContextId(contextId: String): TransactionQueryOptions

    Adds a client context ID to the request, that will be sent back in the response, allowing clients to meaningfully trace requests/responses when many are exchanged.

    Adds a client context ID to the request, that will be sent back in the response, allowing clients to meaningfully trace requests/responses when many are exchanged.

    returns

    a copy of this with the change applied, for chaining.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def flexIndex(flexIndex: Boolean): TransactionQueryOptions

    Tells the query engine to use a flex index (utilizing the search service).

    Tells the query engine to use a flex index (utilizing the search service).

    The default is false.

    returns

    a copy of this with the change applied, for chaining.

  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def parameters(values: QueryParameters): TransactionQueryOptions

    Provides named or positional parameters, for queries parameterised that way.

    Provides named or positional parameters, for queries parameterised that way.

    See QueryParameters for details.

    returns

    a copy of this with the change applied, for chaining.

  17. def pipelineBatch(pipelineBatch: Int): TransactionQueryOptions

    Advanced: Controls the number of items execution operators can batch for Fetch from the KV.

    Advanced: Controls the number of items execution operators can batch for Fetch from the KV.

    pipelineBatch

    the pipeline_batch param.

    returns

    a copy of this with the change applied, for chaining.

  18. def pipelineCap(pipelineCap: Int): TransactionQueryOptions

    Advanced: Maximum number of items each execution operator can buffer between various operators.

    Advanced: Maximum number of items each execution operator can buffer between various operators.

    pipelineCap

    the pipeline_cap param.

    returns

    a copy of this with the change applied, for chaining.

  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. def profile(profile: QueryProfile): TransactionQueryOptions

    Set the profiling information level for query execution

    Set the profiling information level for query execution

    This is an Enterprise Edition feature. On Community Edition the parameter will be accepted, but no profiling information returned.

    profile

    the query profile level to be used

    returns

    a copy of this with the change applied, for chaining.

  21. def raw(raw: Map[String, Any]): TransactionQueryOptions

    Allows providing custom JSON key/value pairs for advanced usage.

    Allows providing custom JSON key/value pairs for advanced usage.

    If available, it is recommended to use the methods on this object to customize the query. This method should only be used if no such setter can be found (i.e. if an undocumented property should be set or you are using an older client and a new server-configuration property has been added to the cluster).

    returns

    a copy of this with the change applied, for chaining.

  22. def readonly(readonly: Boolean): TransactionQueryOptions

    If set to true, it will signal the query engine on the server that only non-data modifying requests are allowed.

    If set to true, it will signal the query engine on the server that only non-data modifying requests are allowed. Note that this rule is enforced on the server and not the SDK side.

    Controls whether a query can change a resulting record set.

    If readonly is true, then the following statements are not allowed:

    • CREATE INDEX
    • DROP INDEX
    • INSERT
    • MERGE
    • UPDATE
    • UPSERT
    • DELETE
    readonly

    true if readonly should be forced, false is the default and will use the server side default.

    returns

    a copy of this with the change applied, for chaining.

  23. def scanCap(scanCap: Int): TransactionQueryOptions

    Advanced: Maximum buffered channel size between the indexer client and the query service for index scans.

    Advanced: Maximum buffered channel size between the indexer client and the query service for index scans.

    This parameter controls when to use scan backfill. Use 0 or a negative number to disable.

    scanCap

    the scan_cap param, use 0 or negative number to disable.

    returns

    a copy of this with the change applied, for chaining.

  24. def scanConsistency(scanConsistency: QueryScanConsistency): TransactionQueryOptions

    Scan consistency for the query.

    Scan consistency for the query.

    The default inside a transaction is QueryScanConsistency.RequestPlus.

    scanConsistency

    the index scan consistency to be used

    returns

    a copy of this with the change applied, for chaining.

  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped