Cluster Overloads

Cluster

Important

Not all class methods are listed. Only methods that allow overloads.

class couchbase_columnar.cluster.Cluster

execute_query(statement: str) → BlockingQueryResult

execute_query(statement: str, options: QueryOptions) → BlockingQueryResult

execute_query(statement: str, **kwargs: QueryOptionsKwargs) → BlockingQueryResult

execute_query(statement: str, options: QueryOptions, **kwargs: QueryOptionsKwargs) → BlockingQueryResult

execute_query(statement: str, options: QueryOptions, *args: JSONType, **kwargs: QueryOptionsKwargs) → BlockingQueryResult

execute_query(statement: str, options: QueryOptions, *args: JSONType, **kwargs: str) → BlockingQueryResult

execute_query(statement: str, *args: JSONType, **kwargs: str) → BlockingQueryResult

execute_query(statement: str, cancel_token: CancelToken) → Future[BlockingQueryResult]

execute_query(statement: str, cancel_token: CancelToken, *args: JSONType) → Future[BlockingQueryResult]

execute_query(statement: str, options: QueryOptions, cancel_token: CancelToken) → Future[BlockingQueryResult]

execute_query(statement: str, cancel_token: CancelToken, **kwargs: QueryOptionsKwargs) → Future[BlockingQueryResult]

execute_query(statement: str, options: QueryOptions, cancel_token: CancelToken, **kwargs: QueryOptionsKwargs) → Future[BlockingQueryResult]

execute_query(statement: str, options: QueryOptions, cancel_token: CancelToken, *args: JSONType, **kwargs: QueryOptionsKwargs) → Future[BlockingQueryResult]

execute_query(statement: str, options: QueryOptions, *args: JSONType, cancel_token: CancelToken, **kwargs: QueryOptionsKwargs) → Future[BlockingQueryResult]

execute_query(statement: str, options: QueryOptions, cancel_token: CancelToken, *args: JSONType, **kwargs: str) → Future[BlockingQueryResult]

execute_query(statement: str, options: QueryOptions, *args: JSONType, cancel_token: CancelToken, **kwargs: str) → Future[BlockingQueryResult]

execute_query(statement: str, cancel_token: CancelToken, *args: JSONType, **kwargs: str) → Future[BlockingQueryResult]

execute_query(statement: str, *args: JSONType, cancel_token: CancelToken, **kwargs: str) → Future[BlockingQueryResult]

Executes a query against a Capella Columnar cluster.

Important

The cancel API is VOLATILE and is subject to change at any time.

Parameters:

statement (str) – The SQL++ statement to execute.
options (Optional[QueryOptions]) – Options to set for the query.
cancel_token (Optional[CancelToken]) – A cancel token used to cancel the results stream.
*args (Optional[JSONType]) – Can be used to pass in positional query placeholders.
**kwargs (Optional[Union[QueryOptionsKwargs, str]]) – Keyword arguments that can be used in place or to overrride provided ClusterOptions. Can also be used to pass in named query placeholders.

Returns:

An instance of BlockingQueryResult. When a cancel token is provided a Future is returned. Once the Future completes, an instance of a BlockingQueryResult will be available.

Return type:

Union[Future[BlockingQueryResult], BlockingQueryResult]

classmethod create_instance(connstr: str, credential: Credential) → Cluster

classmethod create_instance(connstr: str, credential: Credential, options: ClusterOptions) → Cluster

classmethod create_instance(connstr: str, credential: Credential, **kwargs: ClusterOptionsKwargs) → Cluster

classmethod create_instance(connstr: str, credential: Credential, options: ClusterOptions, **kwargs: ClusterOptionsKwargs) → Cluster

Create a Cluster instance

Parameters:

connstr (str) – The connection string to use for connecting to the cluster. The format of the connection string is the scheme (couchbases as TLS enabled connections are _required_), followed a hostname
credential (Credential) – The user credentials.
options (Optional[ClusterOptions]) – Global options to set for the cluster. Some operations allow the global options to be overriden by passing in options to the operation.
**kwargs (Optional[ClusterOptionsKwargs]) – Keyword arguments that can be used in place or to overrride provided ClusterOptions

Returns:

A Capella Columnar Cluster instance.

Return type:

Cluster

Raises: