Cluster Overloads

Cluster

Important

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

class couchbase_analytics.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, enable_cancel: bool) → Future[BlockingQueryResult]
execute_query(statement: str, enable_cancel: bool, *args: JSONType) → Future[BlockingQueryResult]
execute_query(statement: str, options: QueryOptions, enable_cancel: bool) → Future[BlockingQueryResult]
execute_query(statement: str, enable_cancel: bool, **kwargs: QueryOptionsKwargs) → Future[BlockingQueryResult]
execute_query(statement: str, options: QueryOptions, enable_cancel: bool, **kwargs: QueryOptionsKwargs) → Future[BlockingQueryResult]
execute_query(statement: str, options: QueryOptions, enable_cancel: bool, *args: JSONType, **kwargs: QueryOptionsKwargs) → Future[BlockingQueryResult]
execute_query(statement: str, options: QueryOptions, *args: JSONType, enable_cancel: bool, **kwargs: QueryOptionsKwargs) → Future[BlockingQueryResult]
execute_query(statement: str, options: QueryOptions, enable_cancel: bool, *args: JSONType, **kwargs: str) → Future[BlockingQueryResult]
execute_query(statement: str, options: QueryOptions, *args: JSONType, enable_cancel: bool, **kwargs: str) → Future[BlockingQueryResult]
execute_query(statement: str, enable_cancel: bool, *args: JSONType, **kwargs: str) → Future[BlockingQueryResult]
execute_query(statement: str, *args: JSONType, enable_cancel: bool, **kwargs: str) → Future[BlockingQueryResult]

Executes a query against an Analytics 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.

  • enable_cancel (Optional[bool]) – Enable cancellation of the result or 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(endpoint: str, credential: Credential) → Cluster
classmethod create_instance(endpoint: str, credential: Credential, options: ClusterOptions) → Cluster
classmethod create_instance(endpoint: str, credential: Credential, **kwargs: ClusterOptionsKwargs) → Cluster
classmethod create_instance(endpoint: str, credential: Credential, options: ClusterOptions, **kwargs: ClusterOptionsKwargs) → Cluster

Create a Cluster instance

Important

The appropriate port needs to be specified. The SDK’s default ports are 80 (http) and 443 (https). If attempting to connect to Capella, the correct ports are most likely to be 8095 (http) and 18095 (https).

Capella example: https://cb.2xg3vwszqgqcrsix.cloud.couchbase.com:18095

Parameters:

  • endpoint (str) – The endpoint to use for sending HTTP requests to the Analytics server. The format of the endpoint string is the scheme (http or https is required, use https for TLS enabled connections), followed a hostname and optional port.

  • 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:

An Analytics Cluster instance.

Return type:

Cluster

Raises:

  • ValueError – If incorrect endpoint is provided.

  • ValueError – If incorrect options are provided.