AsyncScope Overloads

AsyncScope

Important

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

class acouchbase_analytics.scope.AysncScope
execute_query(statement: str) → Awaitable[AsyncQueryResult]
execute_query(statement: str, options: QueryOptions) → Awaitable[AsyncQueryResult]
execute_query(statement: str, **kwargs: QueryOptionsKwargs) → Awaitable[AsyncQueryResult]
execute_query(statement: str, options: QueryOptions, **kwargs: QueryOptionsKwargs) → Awaitable[AysncQueryResult]
execute_query(statement: str, options: QueryOptions, *args: JSONType, **kwargs: QueryOptionsKwargs) → Awaitable[AsyncQueryResult]
execute_query(statement: str, options: QueryOptions, *args: JSONType, **kwargs: str) → Awaitable[AsyncQueryResult]
execute_query(statement: str, *args: JSONType, **kwargs: str) → Awaitable[AsyncQueryResult]

Executes a query against an analytics scope.

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.

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

AsyncQueryResult: An instance of a AsyncQueryResult.

Return type:

Awaitable[AsyncQueryResult]

start_query(statement: str) → Awaitable[AsyncQueryHandle]
start_query(statement: str, options: StartQueryOptions) → Awaitable[AsyncQueryHandle]
start_query(statement: str, **kwargs: StartQueryOptionsKwargs) → Awaitable[AsyncQueryHandle]
start_query(statement: str, options: StartQueryOptions, **kwargs: StartQueryOptionsKwargs) → Awaitable[AsyncQueryHandle]
start_query(statement: str, options: StartQueryOptions, *args: JSONType, **kwargs: StartQueryOptionsKwargs) → Awaitable[AsyncQueryHandle]
start_query(statement: str, options: StartQueryOptions, *args: JSONType, **kwargs: str) → Awaitable[AsyncQueryHandle]
start_query(statement: str, *args: JSONType, **kwargs: str) → Awaitable[AsyncQueryHandle]

Executes a query against an analytics scope using the asynchronous server requests API.

Parameters:

  • statement (str) – The SQL++ statement to execute.

  • options (Optional[StartQueryOptions]) – Options to set for the query.

  • *args (Optional[JSONType]) – Can be used to pass in positional query placeholders.

  • **kwargs (Optional[Union[StartQueryOptionsKwargs, str]]) – Keyword arguments that can be used in place or to overrride provided StartClusterOptions. Can also be used to pass in named query placeholders.

Returns:

AsyncQueryHandle: An instance of a AsyncQueryHandle

Return type:

Awaitable[AsyncQueryHandle]