Skip to content

Commit d2d22d2

Browse files
committed
Documentation updated after adding clickhouse and mariadb.
1 parent f28d280 commit d2d22d2

File tree

220 files changed

+58906
-1534
lines changed

Some content is hidden

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

220 files changed

+58906
-1534
lines changed

distribution/python/dqops/client/models/__init__.py

+8
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,8 @@
131131
from .check_template import CheckTemplate
132132
from .check_time_scale import CheckTimeScale
133133
from .check_type import CheckType
134+
from .click_house_parameters_spec import ClickHouseParametersSpec
135+
from .click_house_parameters_spec_properties import ClickHouseParametersSpecProperties
134136
from .cloud_synchronization_folders_status_model import (
135137
CloudSynchronizationFoldersStatusModel,
136138
)
@@ -1610,6 +1612,7 @@
16101612
from .parquet_file_format_spec import ParquetFileFormatSpec
16111613
from .partition_incremental_time_window_spec import PartitionIncrementalTimeWindowSpec
16121614
from .physical_table_name import PhysicalTableName
1615+
from .postgresql_engine_type import PostgresqlEngineType
16131616
from .postgresql_parameters_spec import PostgresqlParametersSpec
16141617
from .postgresql_parameters_spec_properties import PostgresqlParametersSpecProperties
16151618
from .postgresql_ssl_mode import PostgresqlSslMode
@@ -1645,6 +1648,7 @@
16451648
from .run_checks_parameters import RunChecksParameters
16461649
from .run_checks_queue_job_result import RunChecksQueueJobResult
16471650
from .run_checks_result import RunChecksResult
1651+
from .run_checks_target import RunChecksTarget
16481652
from .schedule_enabled_status_model import ScheduleEnabledStatusModel
16491653
from .schema_model import SchemaModel
16501654
from .schema_remote_model import SchemaRemoteModel
@@ -2183,6 +2187,8 @@
21832187
"CheckTemplate",
21842188
"CheckTimeScale",
21852189
"CheckType",
2190+
"ClickHouseParametersSpec",
2191+
"ClickHouseParametersSpecProperties",
21862192
"CloudSynchronizationFoldersStatusModel",
21872193
"CollectErrorSamplesOnTableParameters",
21882194
"CollectErrorSamplesParameters",
@@ -2844,6 +2850,7 @@
28442850
"ParquetFileFormatSpec",
28452851
"PartitionIncrementalTimeWindowSpec",
28462852
"PhysicalTableName",
2853+
"PostgresqlEngineType",
28472854
"PostgresqlParametersSpec",
28482855
"PostgresqlParametersSpecProperties",
28492856
"PostgresqlSslMode",
@@ -2877,6 +2884,7 @@
28772884
"RunChecksParameters",
28782885
"RunChecksQueueJobResult",
28792886
"RunChecksResult",
2887+
"RunChecksTarget",
28802888
"ScheduleEnabledStatusModel",
28812889
"SchemaModel",
28822890
"SchemaRemoteModel",
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union
2+
3+
from attrs import define as _attrs_define
4+
from attrs import field as _attrs_field
5+
6+
from ..types import UNSET, Unset
7+
8+
if TYPE_CHECKING:
9+
from ..models.click_house_parameters_spec_properties import (
10+
ClickHouseParametersSpecProperties,
11+
)
12+
13+
14+
T = TypeVar("T", bound="ClickHouseParametersSpec")
15+
16+
17+
@_attrs_define
18+
class ClickHouseParametersSpec:
19+
"""
20+
Attributes:
21+
host (Union[Unset, str]): ClickHouse host name. Supports also a ${CLICKHOUSE_HOST} configuration with a custom
22+
environment variable.
23+
port (Union[Unset, str]): ClickHouse port number. The default port is 30015. Supports also a ${CLICKHOUSE_PORT}
24+
configuration with a custom environment variable.
25+
database (Union[Unset, str]): ClickHouse instance number. Supports also a ${CLICKHOUSE_DATABASE_NAME}
26+
configuration with a custom environment variable.
27+
user (Union[Unset, str]): ClickHouse user name. The value can be in the ${ENVIRONMENT_VARIABLE_NAME} format to
28+
use dynamic substitution.
29+
password (Union[Unset, str]): ClickHouse database password. The value can be in the ${ENVIRONMENT_VARIABLE_NAME}
30+
format to use dynamic substitution.
31+
properties (Union[Unset, ClickHouseParametersSpecProperties]): A dictionary of custom JDBC parameters that are
32+
added to the JDBC connection string, a key/value dictionary.
33+
"""
34+
35+
host: Union[Unset, str] = UNSET
36+
port: Union[Unset, str] = UNSET
37+
database: Union[Unset, str] = UNSET
38+
user: Union[Unset, str] = UNSET
39+
password: Union[Unset, str] = UNSET
40+
properties: Union[Unset, "ClickHouseParametersSpecProperties"] = UNSET
41+
additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
42+
43+
def to_dict(self) -> Dict[str, Any]:
44+
host = self.host
45+
port = self.port
46+
database = self.database
47+
user = self.user
48+
password = self.password
49+
properties: Union[Unset, Dict[str, Any]] = UNSET
50+
if not isinstance(self.properties, Unset):
51+
properties = self.properties.to_dict()
52+
53+
field_dict: Dict[str, Any] = {}
54+
field_dict.update(self.additional_properties)
55+
field_dict.update({})
56+
if host is not UNSET:
57+
field_dict["host"] = host
58+
if port is not UNSET:
59+
field_dict["port"] = port
60+
if database is not UNSET:
61+
field_dict["database"] = database
62+
if user is not UNSET:
63+
field_dict["user"] = user
64+
if password is not UNSET:
65+
field_dict["password"] = password
66+
if properties is not UNSET:
67+
field_dict["properties"] = properties
68+
69+
return field_dict
70+
71+
@classmethod
72+
def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
73+
from ..models.click_house_parameters_spec_properties import (
74+
ClickHouseParametersSpecProperties,
75+
)
76+
77+
d = src_dict.copy()
78+
host = d.pop("host", UNSET)
79+
80+
port = d.pop("port", UNSET)
81+
82+
database = d.pop("database", UNSET)
83+
84+
user = d.pop("user", UNSET)
85+
86+
password = d.pop("password", UNSET)
87+
88+
_properties = d.pop("properties", UNSET)
89+
properties: Union[Unset, ClickHouseParametersSpecProperties]
90+
if isinstance(_properties, Unset):
91+
properties = UNSET
92+
else:
93+
properties = ClickHouseParametersSpecProperties.from_dict(_properties)
94+
95+
click_house_parameters_spec = cls(
96+
host=host,
97+
port=port,
98+
database=database,
99+
user=user,
100+
password=password,
101+
properties=properties,
102+
)
103+
104+
click_house_parameters_spec.additional_properties = d
105+
return click_house_parameters_spec
106+
107+
@property
108+
def additional_keys(self) -> List[str]:
109+
return list(self.additional_properties.keys())
110+
111+
def __getitem__(self, key: str) -> Any:
112+
return self.additional_properties[key]
113+
114+
def __setitem__(self, key: str, value: Any) -> None:
115+
self.additional_properties[key] = value
116+
117+
def __delitem__(self, key: str) -> None:
118+
del self.additional_properties[key]
119+
120+
def __contains__(self, key: str) -> bool:
121+
return key in self.additional_properties
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
from typing import Any, Dict, List, Type, TypeVar
2+
3+
from attrs import define as _attrs_define
4+
from attrs import field as _attrs_field
5+
6+
T = TypeVar("T", bound="ClickHouseParametersSpecProperties")
7+
8+
9+
@_attrs_define
10+
class ClickHouseParametersSpecProperties:
11+
"""A dictionary of custom JDBC parameters that are added to the JDBC connection string, a key/value dictionary."""
12+
13+
additional_properties: Dict[str, str] = _attrs_field(init=False, factory=dict)
14+
15+
def to_dict(self) -> Dict[str, Any]:
16+
17+
field_dict: Dict[str, Any] = {}
18+
field_dict.update(self.additional_properties)
19+
field_dict.update({})
20+
21+
return field_dict
22+
23+
@classmethod
24+
def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
25+
d = src_dict.copy()
26+
click_house_parameters_spec_properties = cls()
27+
28+
click_house_parameters_spec_properties.additional_properties = d
29+
return click_house_parameters_spec_properties
30+
31+
@property
32+
def additional_keys(self) -> List[str]:
33+
return list(self.additional_properties.keys())
34+
35+
def __getitem__(self, key: str) -> str:
36+
return self.additional_properties[key]
37+
38+
def __setitem__(self, key: str, value: str) -> None:
39+
self.additional_properties[key] = value
40+
41+
def __delitem__(self, key: str) -> None:
42+
del self.additional_properties[key]
43+
44+
def __contains__(self, key: str) -> bool:
45+
return key in self.additional_properties

distribution/python/dqops/client/models/connection_model.py

+18
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
if TYPE_CHECKING:
1010
from ..models.big_query_parameters_spec import BigQueryParametersSpec
1111
from ..models.check_search_filters import CheckSearchFilters
12+
from ..models.click_house_parameters_spec import ClickHouseParametersSpec
1213
from ..models.connection_model_advanced_properties import (
1314
ConnectionModelAdvancedProperties,
1415
)
@@ -66,6 +67,7 @@ class ConnectionModel:
6667
hana (Union[Unset, HanaParametersSpec]):
6768
db2 (Union[Unset, Db2ParametersSpec]):
6869
mariadb (Union[Unset, MariaDbParametersSpec]):
70+
clickhouse (Union[Unset, ClickHouseParametersSpec]):
6971
run_checks_job_template (Union[Unset, CheckSearchFilters]): Target data quality checks filter, identifies which
7072
checks on which tables and columns should be executed.
7173
run_profiling_checks_job_template (Union[Unset, CheckSearchFilters]): Target data quality checks filter,
@@ -109,6 +111,7 @@ class ConnectionModel:
109111
hana: Union[Unset, "HanaParametersSpec"] = UNSET
110112
db2: Union[Unset, "Db2ParametersSpec"] = UNSET
111113
mariadb: Union[Unset, "MariaDbParametersSpec"] = UNSET
114+
clickhouse: Union[Unset, "ClickHouseParametersSpec"] = UNSET
112115
run_checks_job_template: Union[Unset, "CheckSearchFilters"] = UNSET
113116
run_profiling_checks_job_template: Union[Unset, "CheckSearchFilters"] = UNSET
114117
run_monitoring_checks_job_template: Union[Unset, "CheckSearchFilters"] = UNSET
@@ -194,6 +197,10 @@ def to_dict(self) -> Dict[str, Any]:
194197
if not isinstance(self.mariadb, Unset):
195198
mariadb = self.mariadb.to_dict()
196199

200+
clickhouse: Union[Unset, Dict[str, Any]] = UNSET
201+
if not isinstance(self.clickhouse, Unset):
202+
clickhouse = self.clickhouse.to_dict()
203+
197204
run_checks_job_template: Union[Unset, Dict[str, Any]] = UNSET
198205
if not isinstance(self.run_checks_job_template, Unset):
199206
run_checks_job_template = self.run_checks_job_template.to_dict()
@@ -279,6 +286,8 @@ def to_dict(self) -> Dict[str, Any]:
279286
field_dict["db2"] = db2
280287
if mariadb is not UNSET:
281288
field_dict["mariadb"] = mariadb
289+
if clickhouse is not UNSET:
290+
field_dict["clickhouse"] = clickhouse
282291
if run_checks_job_template is not UNSET:
283292
field_dict["run_checks_job_template"] = run_checks_job_template
284293
if run_profiling_checks_job_template is not UNSET:
@@ -318,6 +327,7 @@ def to_dict(self) -> Dict[str, Any]:
318327
def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
319328
from ..models.big_query_parameters_spec import BigQueryParametersSpec
320329
from ..models.check_search_filters import CheckSearchFilters
330+
from ..models.click_house_parameters_spec import ClickHouseParametersSpec
321331
from ..models.connection_model_advanced_properties import (
322332
ConnectionModelAdvancedProperties,
323333
)
@@ -463,6 +473,13 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
463473
else:
464474
mariadb = MariaDbParametersSpec.from_dict(_mariadb)
465475

476+
_clickhouse = d.pop("clickhouse", UNSET)
477+
clickhouse: Union[Unset, ClickHouseParametersSpec]
478+
if isinstance(_clickhouse, Unset):
479+
clickhouse = UNSET
480+
else:
481+
clickhouse = ClickHouseParametersSpec.from_dict(_clickhouse)
482+
466483
_run_checks_job_template = d.pop("run_checks_job_template", UNSET)
467484
run_checks_job_template: Union[Unset, CheckSearchFilters]
468485
if isinstance(_run_checks_job_template, Unset):
@@ -567,6 +584,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
567584
hana=hana,
568585
db2=db2,
569586
mariadb=mariadb,
587+
clickhouse=clickhouse,
570588
run_checks_job_template=run_checks_job_template,
571589
run_profiling_checks_job_template=run_profiling_checks_job_template,
572590
run_monitoring_checks_job_template=run_monitoring_checks_job_template,

distribution/python/dqops/client/models/connection_spec.py

+18
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
if TYPE_CHECKING:
1010
from ..models.auto_import_tables_spec import AutoImportTablesSpec
1111
from ..models.big_query_parameters_spec import BigQueryParametersSpec
12+
from ..models.click_house_parameters_spec import ClickHouseParametersSpec
1213
from ..models.comment_spec import CommentSpec
1314
from ..models.connection_incident_grouping_spec import (
1415
ConnectionIncidentGroupingSpec,
@@ -57,6 +58,7 @@ class ConnectionSpec:
5758
hana (Union[Unset, HanaParametersSpec]):
5859
db2 (Union[Unset, Db2ParametersSpec]):
5960
mariadb (Union[Unset, MariaDbParametersSpec]):
61+
clickhouse (Union[Unset, ClickHouseParametersSpec]):
6062
parallel_jobs_limit (Union[Unset, int]): The concurrency limit for the maximum number of parallel SQL queries
6163
executed on this connection.
6264
default_grouping_configuration (Union[Unset, DataGroupingConfigurationSpec]):
@@ -92,6 +94,7 @@ class ConnectionSpec:
9294
hana: Union[Unset, "HanaParametersSpec"] = UNSET
9395
db2: Union[Unset, "Db2ParametersSpec"] = UNSET
9496
mariadb: Union[Unset, "MariaDbParametersSpec"] = UNSET
97+
clickhouse: Union[Unset, "ClickHouseParametersSpec"] = UNSET
9598
parallel_jobs_limit: Union[Unset, int] = UNSET
9699
default_grouping_configuration: Union[Unset, "DataGroupingConfigurationSpec"] = (
97100
UNSET
@@ -170,6 +173,10 @@ def to_dict(self) -> Dict[str, Any]:
170173
if not isinstance(self.mariadb, Unset):
171174
mariadb = self.mariadb.to_dict()
172175

176+
clickhouse: Union[Unset, Dict[str, Any]] = UNSET
177+
if not isinstance(self.clickhouse, Unset):
178+
clickhouse = self.clickhouse.to_dict()
179+
173180
parallel_jobs_limit = self.parallel_jobs_limit
174181
default_grouping_configuration: Union[Unset, Dict[str, Any]] = UNSET
175182
if not isinstance(self.default_grouping_configuration, Unset):
@@ -241,6 +248,8 @@ def to_dict(self) -> Dict[str, Any]:
241248
field_dict["db2"] = db2
242249
if mariadb is not UNSET:
243250
field_dict["mariadb"] = mariadb
251+
if clickhouse is not UNSET:
252+
field_dict["clickhouse"] = clickhouse
244253
if parallel_jobs_limit is not UNSET:
245254
field_dict["parallel_jobs_limit"] = parallel_jobs_limit
246255
if default_grouping_configuration is not UNSET:
@@ -268,6 +277,7 @@ def to_dict(self) -> Dict[str, Any]:
268277
def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
269278
from ..models.auto_import_tables_spec import AutoImportTablesSpec
270279
from ..models.big_query_parameters_spec import BigQueryParametersSpec
280+
from ..models.click_house_parameters_spec import ClickHouseParametersSpec
271281
from ..models.comment_spec import CommentSpec
272282
from ..models.connection_incident_grouping_spec import (
273283
ConnectionIncidentGroupingSpec,
@@ -407,6 +417,13 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
407417
else:
408418
mariadb = MariaDbParametersSpec.from_dict(_mariadb)
409419

420+
_clickhouse = d.pop("clickhouse", UNSET)
421+
clickhouse: Union[Unset, ClickHouseParametersSpec]
422+
if isinstance(_clickhouse, Unset):
423+
clickhouse = UNSET
424+
else:
425+
clickhouse = ClickHouseParametersSpec.from_dict(_clickhouse)
426+
410427
parallel_jobs_limit = d.pop("parallel_jobs_limit", UNSET)
411428

412429
_default_grouping_configuration = d.pop("default_grouping_configuration", UNSET)
@@ -478,6 +495,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
478495
hana=hana,
479496
db2=db2,
480497
mariadb=mariadb,
498+
clickhouse=clickhouse,
481499
parallel_jobs_limit=parallel_jobs_limit,
482500
default_grouping_configuration=default_grouping_configuration,
483501
schedules=schedules,
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
from enum import Enum
2+
3+
4+
class PostgresqlEngineType(str, Enum):
5+
POSTGRESQL = "postgresql"
6+
TIMESCALE = "timescale"
7+
8+
def __str__(self) -> str:
9+
return str(self.value)

0 commit comments

Comments
 (0)