analytics-python-client/acouchbase_analytics/cluster.pyi at 1cd3532a1bd3bfd5537a886c1c7a53d36920fac5 · couchbase/analytics-python-client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
#  Copyright 2016-2025. Couchbase, Inc.
#  All Rights Reserved.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.

import sys
from typing import Awaitable, overload

if sys.version_info < (3, 11):
    from typing_extensions import Unpack
else:
    from typing import Unpack

from acouchbase_analytics import JSONType
from acouchbase_analytics.credential import Credential
from acouchbase_analytics.database import AsyncDatabase
from acouchbase_analytics.options import (
    ClusterOptions,
    ClusterOptionsKwargs,
    QueryOptions,
    QueryOptionsKwargs,
    StartQueryOptions,
    StartQueryOptionsKwargs,
)
from acouchbase_analytics.query_handle import AsyncQueryHandle
from acouchbase_analytics.result import AsyncQueryResult

class AsyncCluster:
    @overload
    def __init__(self, endpoint: str, credential: Credential) -> None: ...
    @overload
    def __init__(self, endpoint: str, credential: Credential, options: ClusterOptions) -> None: ...
    @overload
    def __init__(self, endpoint: str, credential: Credential, **kwargs: Unpack[ClusterOptionsKwargs]) -> None: ...
    @overload
    def __init__(
        self,
        endpoint: str,
        credential: Credential,
        options: ClusterOptions,
        **kwargs: Unpack[ClusterOptionsKwargs],
    ) -> None: ...
    def database(self, database_name: str) -> AsyncDatabase: ...
    @overload
    def execute_query(self, statement: str) -> Awaitable[AsyncQueryResult]: ...
    @overload
    def execute_query(self, statement: str, options: QueryOptions) -> Awaitable[AsyncQueryResult]: ...
    @overload
    def execute_query(self, statement: str, **kwargs: Unpack[QueryOptionsKwargs]) -> Awaitable[AsyncQueryResult]: ...
    @overload
    def execute_query(
        self, statement: str, options: QueryOptions, **kwargs: Unpack[QueryOptionsKwargs]
    ) -> Awaitable[AsyncQueryResult]: ...
    @overload
    def execute_query(
        self, statement: str, options: QueryOptions, *args: JSONType, **kwargs: Unpack[QueryOptionsKwargs]
    ) -> Awaitable[AsyncQueryResult]: ...
    @overload
    def execute_query(
        self, statement: str, options: QueryOptions, *args: JSONType, **kwargs: str
    ) -> Awaitable[AsyncQueryResult]: ...
    @overload
    def execute_query(self, statement: str, *args: JSONType, **kwargs: str) -> Awaitable[AsyncQueryResult]: ...
    @overload
    def start_query(self, statement: str) -> AsyncQueryHandle: ...
    @overload
    def start_query(self, statement: str, options: StartQueryOptions) -> AsyncQueryHandle: ...
    @overload
    def start_query(self, statement: str, **kwargs: Unpack[StartQueryOptionsKwargs]) -> AsyncQueryHandle: ...
    @overload
    def start_query(
        self, statement: str, options: StartQueryOptions, **kwargs: Unpack[StartQueryOptionsKwargs]
    ) -> AsyncQueryHandle: ...
    @overload
    def start_query(
        self, statement: str, options: StartQueryOptions, *args: JSONType, **kwargs: Unpack[StartQueryOptionsKwargs]
    ) -> AsyncQueryHandle: ...
    @overload
    def start_query(
        self, statement: str, options: StartQueryOptions, *args: JSONType, **kwargs: str
    ) -> AsyncQueryHandle: ...
    @overload
    def start_query(self, statement: str, *args: JSONType, **kwargs: str) -> AsyncQueryHandle: ...
    def shutdown(self) -> Awaitable[None]: ...
    @overload
    @classmethod
    def create_instance(cls, endpoint: str, credential: Credential) -> AsyncCluster: ...
    @overload
    @classmethod
    def create_instance(cls, endpoint: str, credential: Credential, options: ClusterOptions) -> AsyncCluster: ...
    @overload
    @classmethod
    def create_instance(
        cls, endpoint: str, credential: Credential, **kwargs: Unpack[ClusterOptionsKwargs]
    ) -> AsyncCluster: ...
    @overload
    @classmethod
    def create_instance(
        cls, endpoint: str, credential: Credential, options: ClusterOptions, **kwargs: Unpack[ClusterOptionsKwargs]
    ) -> AsyncCluster: ...