Class QueryOptions

couchbase/options.py:1510–1561

Available options to for a N1QL (SQL++) query. .. warning:: Importing options from ``couchbase.cluster`` is deprecated. All options should be imported from ``couchbase.options``. Args: timeout (timedelta, optional): The timeout for this operation. Defaults to global

class QueryOptions(QueryOptionsBase):
    """Available options to for a N1QL (SQL++) query.

    .. warning::
        Importing options from ``couchbase.cluster`` is deprecated.
        All options should be imported from ``couchbase.options``.

    Args:
        timeout (timedelta, optional): The timeout for this operation. Defaults to global
            query operation timeout.
        read_only (bool, optional): Specifies that this query should be executed in read-only mode,
            disabling the ability for the query to make any changes to the data. Defaults to False.
        scan_consistency (:class:`~couchbase.n1ql.QueryScanConsistency`, optional): Specifies the consistency
            requirements when executing the query.
        adhoc (bool, optional): Specifies whether this is an ad-hoc query, or if it should be prepared for
            faster execution in the future. Defaults to True.
        client_context_id (str, optional): The returned client context id for this query. Defaults to None.
        max_parallelism (int, optional): This is an advanced option, see the query service reference for more
            information on the proper use and tuning of this option. Defaults to None.
        positional_parameters (Iterable[JSONType], optional): Positional values to be used for the placeholders
            within the query. Defaults to None.
        named_parameters (Iterable[Dict[str, JSONType]], optional): Named values to be used for the placeholders
            within the query. Defaults to None.
        pipeline_batch (int, optional): This is an advanced option, see the query service reference for more
            information on the proper use and tuning of this option. Defaults to None.
        pipeline_cap (int, optional):  This is an advanced option, see the query service reference for more
            information on the proper use and tuning of this option. Defaults to None.
        profile (:class:`~couchbase.n1ql.QueryProfile`, optional): Specifies the level of profiling that should
            be used for the query. Defaults to `Off`.
        query_context (str, optional): Specifies the context within which this query should be executed. This can
            be scoped to a scope or a collection within the dataset. Defaults to None.
        scan_cap (int, optional):  This is an advanced option, see the query service reference for more
            information on the proper use and tuning of this option. Defaults to None.
        scan_wait (timedelta, optional):  This is an advanced option, see the query service reference for more
            information on the proper use and tuning of this option. Defaults to None.
        metrics (bool, optional): Specifies whether metrics should be captured as part of the execution of the query.
            Defaults to False.
        flex_index (bool, optional): Specifies whether flex-indexes should be enabled. Allowing the use of full-text
            search from the query service. Defaults to False.
        preserve_expiry (bool, optional): Specifies that any existing expiry on the document should be preserved.
            Defaults to False.
        use_replica (bool, optional): Specifies that the query engine should use replica nodes for KV fetches if the
            active node is down. Defaults to None.
        consistent_with (:class:`~couchbase.mutation_state.MutationState`, optional): Specifies a
            :class:`~couchbase.mutation_state.MutationState` which the query should be consistent with. Defaults to
            None.
        serializer (:class:`~couchbase.serializer.Serializer`, optional): Specifies an explicit serializer
            to use for this specific N1QL operation. Defaults to
            :class:`~couchbase.serializer.DefaultJsonSerializer`.
        raw (Dict[str, Any], optional): Specifies any additional parameters which should be passed to the query engine
            when executing the query. Defaults to None.
    """


class AnalyticsOptions(AnalyticsOptionsBase):