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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
#------------------------------------------------------------------------------
# Copyright (c) 2021, 2022, Oracle and/or its affiliates.
#
# This software is dual-licensed to you under the Universal Permissive License
# (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
# 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
# either license.
#
# If you elect to accept the software under the Apache License, Version 2.0,
# the following applies:
#
# 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
#
# https://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.
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
# connect_params.py
#
# Contains the ConnectParams class used for managing the parameters required to
# establish a connection to the database.
#
# #{{ generated_notice }}
#------------------------------------------------------------------------------
import functools
from typing import Union, Callable
import oracledb
from . import base_impl, constants, errors, utils
class ConnectParams:
"""
Contains all parameters used for establishing a connection to the
database.
"""
__module__ = oracledb.__name__
__slots__ = ["_impl"]
_impl_class = base_impl.ConnectParamsImpl
@utils.params_initer
def __init__(self, *,
#{{ args_with_defaults }}
):
"""
All parameters are optional. A brief description of each parameter
follows:
#{{ args_help_with_defaults }}
"""
pass
def __repr__(self):
return self.__class__.__qualname__ + "(" + \
#{{ params_repr_parts }} + \
")"
def _address_attr(f):
"""
Helper function used to get address level attributes.
"""
@functools.wraps(f)
def wrapped(self):
values = [getattr(a, f.__name__) \
for a in self._impl._get_addresses()]
return values if len(values) > 1 else values[0]
return wrapped
def _description_attr(f):
"""
Helper function used to get description level attributes.
"""
@functools.wraps(f)
def wrapped(self):
values = [getattr(d, f.__name__) \
for d in self._impl.description_list.descriptions]
return values if len(values) > 1 else values[0]
return wrapped
#{{ params_properties }}
def copy(self) -> "ConnectParams":
"""
Creates a copy of the parameters and returns it.
"""
params = ConnectParams.__new__(ConnectParams)
params._impl = self._impl.copy()
return params
def get_connect_string(self) -> str:
"""
Returns a connect string generated from the parameters.
"""
return self._impl.get_connect_string()
def parse_connect_string(self, connect_string: str) -> None:
"""
Parses the connect string into its components and stores the
parameters. The connect string could be an Easy Connect string,
name-value pairs or a simple alias which is looked up in tnsnames.ora.
Any parameters found in the connect string override any currently
stored values.
"""
self._impl.parse_connect_string(connect_string)
@utils.params_setter
def set(self, *,
#{{ args_without_defaults }}
):
"""
All parameters are optional. A brief description of each parameter
follows:
#{{ args_help_without_defaults }}
"""
pass
|
