QueryOptions for transactions. Args: raw (Dict[str, Any], optional): Specifies any additional parameters which should be passed to the query engine when executing the query. Defaults to None. adhoc (bool, optional): Specifies whether this is
(self,
raw=None, # type: Optional[Dict[str, JSONType]]
adhoc=None, # type: Optional[bool]
scan_consistency=None, # type: Optional[QueryScanConsistency]
profile=None, # type: Optional[Any]
client_context_id=None, # type: Optional[str]
scan_wait=None, # type: Optional[timedelta]
read_only=None, # type: Optional[bool]
scan_cap=None, # type: Optional[int]
pipeline_batch=None, # type: Optional[int]
pipeline_cap=None, # type: Optional[int]
positional_parameters=None, # type: Optional[Iterable[JSONType]]
named_parameters=None, # type: Optional[Dict[str, JSONType]]
scope=None, # type: Optional[Any]
metrics=None, # type: Optional[bool]
max_parallelism=None # type: Optional[int]
)
| 1937 | |
| 1938 | @overload |
| 1939 | def __init__(self, |
| 1940 | raw=None, # type: Optional[Dict[str, JSONType]] |
| 1941 | adhoc=None, # type: Optional[bool] |
| 1942 | scan_consistency=None, # type: Optional[QueryScanConsistency] |
| 1943 | profile=None, # type: Optional[Any] |
| 1944 | client_context_id=None, # type: Optional[str] |
| 1945 | scan_wait=None, # type: Optional[timedelta] |
| 1946 | read_only=None, # type: Optional[bool] |
| 1947 | scan_cap=None, # type: Optional[int] |
| 1948 | pipeline_batch=None, # type: Optional[int] |
| 1949 | pipeline_cap=None, # type: Optional[int] |
| 1950 | positional_parameters=None, # type: Optional[Iterable[JSONType]] |
| 1951 | named_parameters=None, # type: Optional[Dict[str, JSONType]] |
| 1952 | scope=None, # type: Optional[Any] |
| 1953 | metrics=None, # type: Optional[bool] |
| 1954 | max_parallelism=None # type: Optional[int] |
| 1955 | ): |
| 1956 | """ |
| 1957 | QueryOptions for transactions. |
| 1958 | |
| 1959 | Args: |
| 1960 | raw (Dict[str, Any], optional): Specifies any additional parameters which should be passed to the query |
| 1961 | engine when executing the query. Defaults to None. |
| 1962 | adhoc (bool, optional): Specifies whether this is an ad-hoc query, or if it should be prepared for |
| 1963 | faster execution in the future. Defaults to True. |
| 1964 | scan_consistency (:class:`~couchbase.analytics.AnalyticsScanConsistency`, optional): Specifies |
| 1965 | the consistency requirements when executing the transactional query. |
| 1966 | profile (:class:`~couchbase.n1ql.QueryProfile`, optional): Specifies the level of profiling that should |
| 1967 | be used for the transactional query. Defaults to `Off`. |
| 1968 | client_context_id (str, optional): Specifies an client id for this query. This is returned with the |
| 1969 | response, and can be helpful when debugging. |
| 1970 | scan_cap (int, optional): This is an advanced option, see the query service reference for more |
| 1971 | information on the proper use and tuning of this option. Defaults to None. |
| 1972 | scan_wait (timedelta, optional): This is an advanced option, see the query service reference for more |
| 1973 | information on the proper use and tuning of this option. Defaults to None. |
| 1974 | metrics (bool, optional): Specifies whether metrics should be captured as part of the execution of the |
| 1975 | query. Defaults to False. |
| 1976 | read_only: (bool, optional): Specifies that the query should be considered read-only, and not allowed to |
| 1977 | mutate documents on the server-side. See query service reference for more details. |
| 1978 | pipeline_batch (int, optional): This is an advanced option, see the query service reference for more |
| 1979 | information on the proper use and tuning of this option. Defaults to None. |
| 1980 | pipeline_cap (int, optional): This is an advanced option, see the query service reference for more |
| 1981 | information on the proper use and tuning of this option. Defaults to None. |
| 1982 | positional_parameters (Iterable[JSONType], optional): Positional values to be used for the placeholders |
| 1983 | within the query. Defaults to None. |
| 1984 | named_parameters (Dict[str, JSONType], optional): Named values to be used for the placeholders |
| 1985 | within the query. Defaults to None. |
| 1986 | scope (Union[:class:`~acouchbase.scope.Scope`,:class:`~couchbase.scope.Scope`], optional): Specify the |
| 1987 | scope of the query. Defaults to None. |
| 1988 | max_parallelism (int, optional): This is an advanced option, see the query service reference for more |
| 1989 | information on the proper use and tuning of this option. Defaults to None. |
| 1990 | """ |
| 1991 | pass |
| 1992 | |
| 1993 | def __init__(self, # noqa: C901 |
| 1994 | **kwargs # type: Dict[str, JSONType] |
nothing calls this directly
no test coverage detected