-
Notifications
You must be signed in to change notification settings - Fork 4k
/
spec.json
228 lines (228 loc) · 8.84 KB
/
spec.json
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
{
"documentationUrl": "https://docs.airbyte.com/integrations/sources/mysql",
"connectionSpecification": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "MySql Source Spec",
"type": "object",
"required": ["host", "port", "database", "username", "replication_method"],
"properties": {
"host": {
"description": "The host name of the database.",
"title": "Host",
"type": "string",
"order": 0
},
"port": {
"description": "The port to connect to.",
"title": "Port",
"type": "integer",
"minimum": 0,
"maximum": 65536,
"default": 3306,
"examples": ["3306"],
"order": 1
},
"database": {
"description": "The database name.",
"title": "Database",
"type": "string",
"order": 2
},
"username": {
"description": "The username which is used to access the database.",
"title": "Username",
"type": "string",
"order": 3
},
"password": {
"description": "The password associated with the username.",
"title": "Password",
"type": "string",
"airbyte_secret": true,
"order": 4
},
"jdbc_url_params": {
"description": "Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). For more information read about <a href=\"https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-jdbc-url-format.html\">JDBC URL parameters</a>.",
"title": "JDBC URL Parameters (Advanced)",
"type": "string",
"order": 5
},
"ssl": {
"title": "SSL Connection",
"description": "Encrypt data using SSL.",
"type": "boolean",
"default": true,
"order": 6
},
"ssl_mode": {
"title": "SSL modes",
"description": "SSL connection modes. Read more <a href=\"https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-using-ssl.html\"> in the docs</a>.",
"type": "object",
"order": 7,
"oneOf": [
{
"title": "preferred",
"description": "Automatically attempt SSL connection. If the MySQL server does not support SSL, continue with a regular connection.",
"required": ["mode"],
"properties": {
"mode": {
"type": "string",
"const": "preferred",
"order": 0
}
}
},
{
"title": "required",
"description": "Always connect with SSL. If the MySQL server doesn’t support SSL, the connection will not be established. Certificate Authority (CA) and Hostname are not verified.",
"required": ["mode"],
"properties": {
"mode": {
"type": "string",
"const": "required",
"order": 0
}
}
},
{
"title": "Verify CA",
"description": "Always connect with SSL. Verifies CA, but allows connection even if Hostname does not match.",
"required": ["mode", "ca_certificate"],
"properties": {
"mode": {
"type": "string",
"const": "verify_ca",
"order": 0
},
"ca_certificate": {
"type": "string",
"title": "CA certificate",
"description": "CA certificate",
"airbyte_secret": true,
"multiline": true,
"order": 1
},
"client_certificate": {
"type": "string",
"title": "Client certificate",
"description": "Client certificate (this is not a required field, but if you want to use it, you will need to add the <b>Client key</b> as well)",
"airbyte_secret": true,
"multiline": true,
"order": 2,
"always_show": true
},
"client_key": {
"type": "string",
"title": "Client key",
"description": "Client key (this is not a required field, but if you want to use it, you will need to add the <b>Client certificate</b> as well)",
"airbyte_secret": true,
"multiline": true,
"order": 3,
"always_show": true
},
"client_key_password": {
"type": "string",
"title": "Client key password",
"description": "Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.",
"airbyte_secret": true,
"order": 4
}
}
},
{
"title": "Verify Identity",
"description": "Always connect with SSL. Verify both CA and Hostname.",
"required": ["mode", "ca_certificate"],
"properties": {
"mode": {
"type": "string",
"const": "verify_identity",
"order": 0
},
"ca_certificate": {
"type": "string",
"title": "CA certificate",
"description": "CA certificate",
"airbyte_secret": true,
"multiline": true,
"order": 1
},
"client_certificate": {
"type": "string",
"title": "Client certificate",
"description": "Client certificate (this is not a required field, but if you want to use it, you will need to add the <b>Client key</b> as well)",
"airbyte_secret": true,
"multiline": true,
"order": 2,
"always_show": true
},
"client_key": {
"type": "string",
"title": "Client key",
"description": "Client key (this is not a required field, but if you want to use it, you will need to add the <b>Client certificate</b> as well)",
"airbyte_secret": true,
"multiline": true,
"order": 3,
"always_show": true
},
"client_key_password": {
"type": "string",
"title": "Client key password",
"description": "Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.",
"airbyte_secret": true,
"order": 4
}
}
}
]
},
"replication_method": {
"type": "object",
"title": "Replication Method",
"description": "Replication method to use for extracting data from the database.",
"order": 8,
"oneOf": [
{
"title": "Standard",
"description": "Standard replication requires no setup on the DB side but will not be able to represent deletions incrementally.",
"required": ["method"],
"properties": {
"method": {
"type": "string",
"const": "STANDARD",
"order": 0
}
}
},
{
"title": "Logical Replication (CDC)",
"description": "CDC uses the Binlog to detect inserts, updates, and deletes. This needs to be configured on the source database itself.",
"required": ["method"],
"properties": {
"method": {
"type": "string",
"const": "CDC",
"order": 0
},
"initial_waiting_seconds": {
"type": "integer",
"title": "Initial Waiting Time in Seconds (Advanced)",
"description": "The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Read about <a href=\"https://docs.airbyte.com/integrations/sources/mysql/#change-data-capture-cdc\">initial waiting time</a>.",
"default": 300,
"min": 120,
"max": 1200,
"order": 1
},
"server_time_zone": {
"type": "string",
"title": "Configured server timezone for the MySQL source (Advanced)",
"description": "Enter the configured MySQL server timezone. This should only be done if the configured timezone in your MySQL instance does not conform to IANNA standard.",
"order": 2
}
}
}
]
}
}
}
}