Skip to content

Commit 8d45e96

Browse files
MCPNMCPN
authored
BI-4944: add ydb connector (#106)
1 parent a87925e commit 8d45e96

File tree

93 files changed

+3717
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+3717
-1
lines changed

‎lib/dl_connector_ydb/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2023 YANDEX LLC
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎lib/dl_connector_ydb/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# dl_connector_ydb

‎lib/dl_connector_ydb/dl_connector_ydb/__init__.py

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
try:
2+
from ydb_proto_stubs_import import init_ydb_stubs
3+
4+
init_ydb_stubs()
5+
except ImportError:
6+
pass # stubs will be initialized from the ydb package

‎lib/dl_connector_ydb/dl_connector_ydb/api/__init__.py

Whitespace-only changes.

‎lib/dl_connector_ydb/dl_connector_ydb/api/ydb/__init__.py

Whitespace-only changes.

‎lib/dl_connector_ydb/dl_connector_ydb/api/ydb/api_schema/__init__.py

Whitespace-only changes.

‎lib/dl_connector_ydb/dl_connector_ydb/api/ydb/api_schema/connection.py

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
from __future__ import annotations
2+
3+
from marshmallow import fields as ma_fields
4+
5+
from dl_api_connector.api_schema.connection_base import ConnectionSchema
6+
from dl_api_connector.api_schema.connection_base_fields import (
7+
cache_ttl_field,
8+
secret_string_field,
9+
)
10+
from dl_api_connector.api_schema.connection_mixins import RawSQLLevelMixin
11+
from dl_api_connector.api_schema.connection_sql import DBHostField
12+
from dl_api_connector.api_schema.extras import FieldExtra
13+
14+
from dl_connector_ydb.core.ydb.us_connection import YDBConnection
15+
16+
17+
class YDBConnectionSchema(RawSQLLevelMixin, ConnectionSchema):
18+
TARGET_CLS = YDBConnection
19+
20+
host = DBHostField(attribute="data.host", required=True, bi_extra=FieldExtra(editable=True))
21+
port = ma_fields.Integer(attribute="data.port", required=True, bi_extra=FieldExtra(editable=True))
22+
db_name = ma_fields.String(attribute="data.db_name", required=True, bi_extra=FieldExtra(editable=True))
23+
24+
token = secret_string_field(attribute="data.token", required=False, allow_none=True)
25+
cache_ttl_sec = cache_ttl_field(attribute="data.cache_ttl_sec")

‎lib/dl_connector_ydb/dl_connector_ydb/api/ydb/connection_form/__init__.py

Whitespace-only changes.

‎lib/dl_connector_ydb/dl_connector_ydb/api/ydb/connection_form/form_config.py

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
from __future__ import annotations
2+
3+
from enum import Enum
4+
from typing import (
5+
Optional,
6+
Sequence,
7+
Type,
8+
)
9+
10+
from dl_api_commons.base_models import TenantDef
11+
from dl_api_connector.form_config.models.api_schema import (
12+
FormActionApiSchema,
13+
FormApiSchema,
14+
FormFieldApiSchema,
15+
)
16+
from dl_api_connector.form_config.models.base import (
17+
ConnectionForm,
18+
ConnectionFormFactory,
19+
ConnectionFormMode,
20+
)
21+
from dl_api_connector.form_config.models.common import (
22+
CommonFieldName,
23+
OAuthApplication,
24+
)
25+
import dl_api_connector.form_config.models.rows as C
26+
from dl_api_connector.form_config.models.rows.base import FormRow
27+
from dl_api_connector.form_config.models.shortcuts.rows import RowConstructor
28+
from dl_configs.connectors_settings import ConnectorSettingsBase
29+
30+
from dl_connector_ydb.api.ydb.connection_info import YDBConnectionInfoProvider
31+
from dl_connector_ydb.core.ydb.settings import YDBConnectorSettings
32+
33+
34+
class YDBOAuthApplication(OAuthApplication):
35+
ydb = "ydb"
36+
37+
38+
class YDBConnectionFormFactory(ConnectionFormFactory):
39+
def _get_base_common_api_schema_items(self, names_source: Type[Enum]) -> list[FormFieldApiSchema]:
40+
return [
41+
FormFieldApiSchema(name=names_source.host, required=True),
42+
FormFieldApiSchema(name=names_source.port, required=True),
43+
FormFieldApiSchema(name=names_source.db_name, required=True),
44+
]
45+
46+
def _get_default_db_section(self, rc: RowConstructor, connector_settings: YDBConnectorSettings) -> list[FormRow]:
47+
return [
48+
C.OAuthTokenRow(
49+
name=CommonFieldName.token,
50+
fake_value="******" if self.mode == ConnectionFormMode.edit else None,
51+
application=YDBOAuthApplication.ydb,
52+
),
53+
rc.host_row(default_value=connector_settings.DEFAULT_HOST_VALUE),
54+
rc.port_row(default_value="2135"),
55+
rc.db_name_row(),
56+
]
57+
58+
def _get_base_edit_api_schema(self) -> FormActionApiSchema:
59+
return FormActionApiSchema(
60+
items=[
61+
FormFieldApiSchema(name=CommonFieldName.cache_ttl_sec, nullable=True),
62+
FormFieldApiSchema(name=CommonFieldName.raw_sql_level),
63+
]
64+
)
65+
66+
def _get_base_create_api_schema(self, edit_api_schema: FormActionApiSchema) -> FormActionApiSchema:
67+
return FormActionApiSchema(
68+
items=[
69+
*edit_api_schema.items,
70+
*self._get_top_level_create_api_schema_items(),
71+
]
72+
)
73+
74+
def _get_base_check_api_schema(self, common_api_schema_items: list[FormFieldApiSchema]) -> FormActionApiSchema:
75+
return FormActionApiSchema(
76+
items=[
77+
*common_api_schema_items,
78+
*self._get_top_level_check_api_schema_items(),
79+
]
80+
)
81+
82+
def _get_base_form_config(
83+
self,
84+
db_section_rows: Sequence[FormRow],
85+
create_api_schema: FormActionApiSchema,
86+
edit_api_schema: FormActionApiSchema,
87+
check_api_schema: FormActionApiSchema,
88+
rc: RowConstructor,
89+
) -> ConnectionForm:
90+
return ConnectionForm(
91+
title=YDBConnectionInfoProvider.get_title(self._localizer),
92+
rows=[
93+
*db_section_rows,
94+
C.CacheTTLRow(name=CommonFieldName.cache_ttl_sec),
95+
rc.raw_sql_level_row(),
96+
],
97+
api_schema=FormApiSchema(
98+
create=create_api_schema if self.mode == ConnectionFormMode.create else None,
99+
edit=edit_api_schema if self.mode == ConnectionFormMode.edit else None,
100+
check=check_api_schema,
101+
),
102+
)
103+
104+
def get_form_config(
105+
self,
106+
connector_settings: Optional[ConnectorSettingsBase],
107+
tenant: Optional[TenantDef],
108+
) -> ConnectionForm:
109+
assert connector_settings is not None and isinstance(connector_settings, YDBConnectorSettings)
110+
rc = RowConstructor(localizer=self._localizer)
111+
112+
edit_api_schema = self._get_base_edit_api_schema()
113+
common_api_schema_items = self._get_base_common_api_schema_items(names_source=CommonFieldName)
114+
db_section_rows = self._get_default_db_section(rc=rc, connector_settings=connector_settings)
115+
common_api_schema_items.append(
116+
FormFieldApiSchema(name=CommonFieldName.token, required=self.mode == ConnectionFormMode.create)
117+
)
118+
edit_api_schema.items.extend(common_api_schema_items)
119+
120+
create_api_schema = self._get_base_create_api_schema(edit_api_schema=edit_api_schema)
121+
check_api_schema = self._get_base_check_api_schema(common_api_schema_items=common_api_schema_items)
122+
return self._get_base_form_config(
123+
db_section_rows=db_section_rows,
124+
create_api_schema=create_api_schema,
125+
edit_api_schema=edit_api_schema,
126+
check_api_schema=check_api_schema,
127+
rc=rc,
128+
)

‎lib/dl_connector_ydb/dl_connector_ydb/api/ydb/connection_info.py

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
from dl_api_connector.connection_info import ConnectionInfoProvider
2+
3+
from dl_connector_ydb.api.ydb.i18n.localizer import Translatable
4+
5+
6+
class YDBConnectionInfoProvider(ConnectionInfoProvider):
7+
title_translatable = Translatable("label_connector-ydb")

0 commit comments

Comments
 (0)