tia_databricks 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,67 @@
1
+ # Python-generated files
2
+ **/__pycache__/
3
+ *.py[oc]
4
+ **/build/
5
+ **/dist/
6
+ **/wheels/
7
+ **/*.egg-info
8
+
9
+ # Virtual environments
10
+ .venv/
11
+ venv/
12
+ env/
13
+ ENV/
14
+ **/.venv/
15
+ **/venv/
16
+
17
+ # Coverage
18
+ .coverage
19
+ .coverage.*
20
+ **/htmlcov/
21
+ **/.pytest_cache/
22
+
23
+ # Environment variables and secrets
24
+ .env
25
+ .env.*
26
+ *.env
27
+ **/.env
28
+ **/.env.*
29
+ **/credentials.json
30
+ **/secrets.*
31
+ **/secret.*
32
+ **/*-credentials.json
33
+ **/*-secrets.*
34
+
35
+ # IDE and editor files
36
+ .vscode/
37
+ .idea/
38
+ *.swp
39
+ *.swo
40
+ *~
41
+ .DS_Store
42
+ **/.DS_Store
43
+
44
+ # Logs
45
+ *.log
46
+ **/logs/
47
+ **/*.log
48
+
49
+ # Database files
50
+ *.db
51
+ *.sqlite
52
+ *.sqlite3
53
+ **/*.db
54
+
55
+ # Custom
56
+ main.py
57
+ test.py
58
+ output
59
+ .output
60
+ metastore_db
61
+ spark-warehouse
62
+ .scratch
63
+ .checkpoints
64
+ tiozin.yaml
65
+ !secret.py
66
+ !secret.md
67
+ !secrets.md
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodness, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
@@ -0,0 +1,87 @@
1
+ Metadata-Version: 2.5
2
+ Name: tia_databricks
3
+ Version: 0.1.0
4
+ Summary: Databricks family for Tiozin, your friendly ETL framework
5
+ Project-URL: Homepage, https://github.com/fdmorison/tia_databricks
6
+ Project-URL: Repository, https://github.com/fdmorison/tia_databricks
7
+ Project-URL: Issues, https://github.com/fdmorison/tia_databricks/issues
8
+ Author-email: Fabricio D'Morison <fabricio.dmorison@gmail.com>
9
+ License-Expression: MPL-2.0
10
+ License-File: LICENSE
11
+ Keywords: data,databricks,etl,framework,pipeline,spark,tiozin
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Requires-Python: >=3.11
17
+ Requires-Dist: databricks-sdk~=0.102.0
18
+ Requires-Dist: tiozin[tio-kernel]<5.0.0,>=4.1.0
19
+ Provides-Extra: connect
20
+ Requires-Dist: databricks-connect<17.0.0,>=15.4.0; extra == 'connect'
21
+ Requires-Dist: tiozin[tio-spark-base]<5.0.0,>=4.1.0; extra == 'connect'
22
+ Provides-Extra: tio-spark
23
+ Requires-Dist: tiozin[tio-spark]<5.0.0,>=4.1.0; extra == 'tio-spark'
24
+ Description-Content-Type: text/markdown
25
+
26
+ # tia_databricks
27
+
28
+ `tia_databricks` is the Databricks family for [Tiozin](https://github.com/fdmorison/tiozin). It provides Tiozin plugins that run data jobs on [Databricks](https://docs.databricks.com/).
29
+
30
+ A family is an installable package of Tiozin plugins that share the same runtime. See [The Family Model](https://github.com/fdmorison/tiozin/blob/main/docs/concepts/family.md) for how families fit into Tiozin.
31
+
32
+ ## Installation
33
+
34
+ The package requires Python 3.11 or later and installs Tiozin 4.x as a dependency. It comes with two extras, one for each place where Spark runs.
35
+
36
+ To run jobs on a Databricks cluster, install the `connect` extra. It installs [Databricks Connect](https://docs.databricks.com/aws/en/dev-tools/databricks-connect/), which [DatabricksConnectRunner](https://github.com/fdmorison/tia_databricks/blob/main/docs/connect-runner.md) uses to reach the cluster:
37
+
38
+ ```bash
39
+ pip install "tia_databricks[connect]"
40
+ ```
41
+
42
+ To run Spark locally, install the `tio_spark` extra. It installs `tiozin[tio_spark]`, which brings the local PySpark that [DatabricksExternalRunner](https://github.com/fdmorison/tia_databricks/blob/main/docs/external-runner.md) runs on:
43
+
44
+ ```bash
45
+ pip install "tia_databricks[tio_spark]"
46
+ ```
47
+
48
+ The two extras cannot be combined. Databricks Connect ships its own PySpark, so the `connect` extra must go in an environment without `tiozin[tio_spark]` or a separate `pyspark` package.
49
+
50
+ ## How Tiozin Finds It
51
+
52
+ Tiozin discovers the family automatically through the `tiozin.family` entry point. The family is registered as `tia_databricks`, and its Python package is `tia_databricks`.
53
+
54
+ After installation, its plugins are available by class name in any job:
55
+
56
+ ```yaml
57
+ runner:
58
+ kind: DatabricksConnectRunner
59
+ host: "{{ ENV.DATABRICKS_HOST }}"
60
+ cluster_id: "{{ ENV.DATABRICKS_CLUSTER_ID }}"
61
+ client_id: "{{ ENV.DATABRICKS_CLIENT_ID }}"
62
+ client_secret: "{{ ENV.DATABRICKS_CLIENT_SECRET }}"
63
+ ```
64
+
65
+ If another installed family defines a class with the same name, qualify the kind with the family name:
66
+
67
+ ```yaml
68
+ runner:
69
+ kind: tia_databricks:DatabricksConnectRunner
70
+ host: "{{ ENV.DATABRICKS_HOST }}"
71
+ cluster_id: "{{ ENV.DATABRICKS_CLUSTER_ID }}"
72
+ client_id: "{{ ENV.DATABRICKS_CLIENT_ID }}"
73
+ client_secret: "{{ ENV.DATABRICKS_CLIENT_SECRET }}"
74
+ ```
75
+
76
+ ## Plugins
77
+
78
+ - [DatabricksConnectRunner](https://github.com/fdmorison/tia_databricks/blob/main/docs/connect-runner.md): runs Spark jobs inside a Databricks cluster through Databricks Connect. Requires the `connect` extra.
79
+ - [DatabricksExternalRunner](https://github.com/fdmorison/tia_databricks/blob/main/docs/external-runner.md): runs Spark jobs locally that read and write Unity Catalog tables from outside Databricks. Requires the `tio_spark` extra.
80
+
81
+ The [family documentation](https://github.com/fdmorison/tia_databricks/blob/main/docs/index.md) lists every plugin page.
82
+
83
+ ## Learn More
84
+
85
+ - [Examples](https://github.com/fdmorison/tia_databricks/blob/main/docs/examples.md)
86
+ - [Tiozin](https://github.com/fdmorison/tiozin)
87
+ - [Databricks Connect](https://docs.databricks.com/aws/en/dev-tools/databricks-connect/)
@@ -0,0 +1,62 @@
1
+ # tia_databricks
2
+
3
+ `tia_databricks` is the Databricks family for [Tiozin](https://github.com/fdmorison/tiozin). It provides Tiozin plugins that run data jobs on [Databricks](https://docs.databricks.com/).
4
+
5
+ A family is an installable package of Tiozin plugins that share the same runtime. See [The Family Model](https://github.com/fdmorison/tiozin/blob/main/docs/concepts/family.md) for how families fit into Tiozin.
6
+
7
+ ## Installation
8
+
9
+ The package requires Python 3.11 or later and installs Tiozin 4.x as a dependency. It comes with two extras, one for each place where Spark runs.
10
+
11
+ To run jobs on a Databricks cluster, install the `connect` extra. It installs [Databricks Connect](https://docs.databricks.com/aws/en/dev-tools/databricks-connect/), which [DatabricksConnectRunner](https://github.com/fdmorison/tia_databricks/blob/main/docs/connect-runner.md) uses to reach the cluster:
12
+
13
+ ```bash
14
+ pip install "tia_databricks[connect]"
15
+ ```
16
+
17
+ To run Spark locally, install the `tio_spark` extra. It installs `tiozin[tio_spark]`, which brings the local PySpark that [DatabricksExternalRunner](https://github.com/fdmorison/tia_databricks/blob/main/docs/external-runner.md) runs on:
18
+
19
+ ```bash
20
+ pip install "tia_databricks[tio_spark]"
21
+ ```
22
+
23
+ The two extras cannot be combined. Databricks Connect ships its own PySpark, so the `connect` extra must go in an environment without `tiozin[tio_spark]` or a separate `pyspark` package.
24
+
25
+ ## How Tiozin Finds It
26
+
27
+ Tiozin discovers the family automatically through the `tiozin.family` entry point. The family is registered as `tia_databricks`, and its Python package is `tia_databricks`.
28
+
29
+ After installation, its plugins are available by class name in any job:
30
+
31
+ ```yaml
32
+ runner:
33
+ kind: DatabricksConnectRunner
34
+ host: "{{ ENV.DATABRICKS_HOST }}"
35
+ cluster_id: "{{ ENV.DATABRICKS_CLUSTER_ID }}"
36
+ client_id: "{{ ENV.DATABRICKS_CLIENT_ID }}"
37
+ client_secret: "{{ ENV.DATABRICKS_CLIENT_SECRET }}"
38
+ ```
39
+
40
+ If another installed family defines a class with the same name, qualify the kind with the family name:
41
+
42
+ ```yaml
43
+ runner:
44
+ kind: tia_databricks:DatabricksConnectRunner
45
+ host: "{{ ENV.DATABRICKS_HOST }}"
46
+ cluster_id: "{{ ENV.DATABRICKS_CLUSTER_ID }}"
47
+ client_id: "{{ ENV.DATABRICKS_CLIENT_ID }}"
48
+ client_secret: "{{ ENV.DATABRICKS_CLIENT_SECRET }}"
49
+ ```
50
+
51
+ ## Plugins
52
+
53
+ - [DatabricksConnectRunner](https://github.com/fdmorison/tia_databricks/blob/main/docs/connect-runner.md): runs Spark jobs inside a Databricks cluster through Databricks Connect. Requires the `connect` extra.
54
+ - [DatabricksExternalRunner](https://github.com/fdmorison/tia_databricks/blob/main/docs/external-runner.md): runs Spark jobs locally that read and write Unity Catalog tables from outside Databricks. Requires the `tio_spark` extra.
55
+
56
+ The [family documentation](https://github.com/fdmorison/tia_databricks/blob/main/docs/index.md) lists every plugin page.
57
+
58
+ ## Learn More
59
+
60
+ - [Examples](https://github.com/fdmorison/tia_databricks/blob/main/docs/examples.md)
61
+ - [Tiozin](https://github.com/fdmorison/tiozin)
62
+ - [Databricks Connect](https://docs.databricks.com/aws/en/dev-tools/databricks-connect/)
@@ -0,0 +1,115 @@
1
+ [project]
2
+ name = "tia_databricks"
3
+ version = "0.1.0"
4
+ description = "Databricks family for Tiozin, your friendly ETL framework"
5
+ readme = "README.md"
6
+ requires-python = ">=3.11"
7
+
8
+ license = "MPL-2.0"
9
+ authors = [
10
+ { name = "Fabricio D'Morison", email = "fabricio.dmorison@gmail.com" }
11
+ ]
12
+
13
+ keywords = ["etl", "data", "pipeline", "framework", "tiozin", "databricks", "spark"]
14
+
15
+ classifiers = [
16
+ "Development Status :: 3 - Alpha",
17
+ "Programming Language :: Python :: 3",
18
+ "Programming Language :: Python :: 3.11",
19
+ "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
20
+ ]
21
+
22
+ dependencies = [
23
+ "tiozin[tio_kernel] >=4.1.0,<5.0.0",
24
+ "databricks-sdk ~=0.102.0",
25
+ ]
26
+
27
+ [project.optional-dependencies]
28
+ tio_spark = [
29
+ "tiozin[tio_spark] >=4.1.0,<5.0.0",
30
+ ]
31
+ connect = [
32
+ "tiozin[tio_spark_base] >=4.1.0,<5.0.0",
33
+ "databricks-connect >=15.4.0,<17.0.0",
34
+ ]
35
+
36
+ [dependency-groups]
37
+ dev = [
38
+ { include-group = "lint" },
39
+ { include-group = "test" },
40
+ ]
41
+ test = [
42
+ "pytest ==8.4.2",
43
+ "pytest-cov ==7.0.0",
44
+ "assertpy ==1.1",
45
+ ]
46
+ lint = [
47
+ "ruff ==0.14.10",
48
+ "pre-commit ==4.3.0",
49
+ ]
50
+ pyspark = [
51
+ "tia_databricks[tio_spark]",
52
+ ]
53
+ connect = [
54
+ "tia_databricks[connect]",
55
+ ]
56
+
57
+ [project.entry-points."tiozin.family"]
58
+ tia_databricks = "tia_databricks"
59
+
60
+ [project.urls]
61
+ Homepage = "https://github.com/fdmorison/tia_databricks"
62
+ Repository = "https://github.com/fdmorison/tia_databricks"
63
+ Issues = "https://github.com/fdmorison/tia_databricks/issues"
64
+
65
+ [tool.uv]
66
+ required-version = ">=0.8.1"
67
+ conflicts = [
68
+ [
69
+ { group = "pyspark" },
70
+ { group = "connect" },
71
+ ],
72
+ ]
73
+
74
+ [[tool.uv.index]]
75
+ name = "pypi"
76
+ url = "https://pypi.org/simple"
77
+ default = true
78
+
79
+ [tool.pytest.ini_options]
80
+ testpaths = ["tests"]
81
+ addopts = "--import-mode=importlib --cov --cov-report term"
82
+
83
+ [tool.coverage.run]
84
+ source = ["tia_databricks"]
85
+ omit = [
86
+ "tia_databricks/**/__init__.py",
87
+ ]
88
+
89
+ [tool.coverage.report]
90
+ fail_under = 60
91
+ show_missing = true
92
+
93
+ [tool.ruff]
94
+ line-length = 100
95
+
96
+ [tool.ruff.lint]
97
+ select = ["E", "F", "I", "B", "UP"]
98
+ ignore = ["B008", "B904", "B021", "B017"]
99
+
100
+ [tool.ruff.lint.pycodestyle]
101
+ max-doc-length = 100
102
+
103
+ [tool.ruff.lint.isort]
104
+ known-first-party = ["tia_databricks"]
105
+
106
+ [build-system]
107
+ requires = ["hatchling"]
108
+ build-backend = "hatchling.build"
109
+
110
+ [tool.hatch.build.targets.sdist]
111
+ only-include = [
112
+ "tia_databricks",
113
+ "README.md",
114
+ "pyproject.toml"
115
+ ]
@@ -0,0 +1,24 @@
1
+ """
2
+ tia_databricks public API.
3
+
4
+ This module defines the public, stable interface of the Databricks provider
5
+ used by Tiozin pipelines.
6
+
7
+ Only the symbols exported here are considered part of the supported API.
8
+ All other modules and classes inside this package are internal implementation
9
+ details and may change without notice.
10
+ """
11
+
12
+ from contextlib import suppress
13
+
14
+ __all__ = []
15
+
16
+ with suppress(ImportError):
17
+ from .runners.connect_runner import DatabricksConnectRunner
18
+
19
+ __all__ += ["DatabricksConnectRunner"]
20
+
21
+ with suppress(ImportError):
22
+ from .runners.external_runner import DatabricksExternalRunner
23
+
24
+ __all__ += ["DatabricksExternalRunner"]
@@ -0,0 +1,14 @@
1
+ from importlib.metadata import version
2
+
3
+ from . import env
4
+
5
+ # ===============================================
6
+ # General
7
+ # ===============================================
8
+ artifact_name = __package__
9
+ artifact_version = version(artifact_name)
10
+
11
+ # ===============================================
12
+ # Logging
13
+ # ===============================================
14
+ log_level = env.LOG_LEVEL
@@ -0,0 +1,11 @@
1
+ import logging
2
+
3
+ from environs import Env
4
+
5
+ _env = Env(expand_vars=True)
6
+
7
+ # ===============================================
8
+ # Logging
9
+ # ===============================================
10
+ # LOG_LEVEL - The logging level for the family.
11
+ LOG_LEVEL = _env.log_level("LOG_LEVEL", logging.INFO)
@@ -0,0 +1,108 @@
1
+ from databricks.connect import DatabricksSession
2
+ from databricks.sdk.core import Config
3
+ from tiozin import config
4
+ from tiozin.exceptions import RequiredArgumentError
5
+ from tiozin.family.tio_spark import SparkRunner
6
+ from tiozin.utils import trim
7
+
8
+
9
+ class DatabricksConnectRunner(SparkRunner):
10
+ """
11
+ Runs Spark jobs inside a Databricks cluster through Databricks Connect.
12
+
13
+ The job is planned locally and executed by the cluster, so steps read and
14
+ write Unity Catalog tables from inside Databricks, with the access and
15
+ features of the cluster.
16
+
17
+ Declare the workspace URL, the cluster ID and the service principal
18
+ credentials. The cluster must be running, or be able to start, and the
19
+ service principal must be allowed to attach to it.
20
+
21
+ The runner authenticates as a service principal using the OAuth M-2M
22
+ (client credentials) flow. Databricks Connect requests and refreshes the
23
+ access token itself, so long-running jobs keep a valid token.
24
+
25
+ The installed `databricks-connect` version must match the Databricks
26
+ Runtime version of the cluster.
27
+
28
+ For details about Databricks Connect, refer to:
29
+
30
+ https://docs.databricks.com/aws/en/dev-tools/databricks-connect/
31
+
32
+ Attributes:
33
+ host:
34
+ Databricks workspace URL (e.g. `https://my-workspace.cloud.databricks.com`).
35
+
36
+ cluster_id:
37
+ ID of the Databricks cluster that executes the job.
38
+
39
+ client_id:
40
+ Client ID of the service principal.
41
+
42
+ client_secret:
43
+ Client secret of the service principal.
44
+
45
+ **options:
46
+ Additional arguments accepted by `SparkRunner`, including Spark
47
+ configuration options.
48
+
49
+ Examples:
50
+
51
+ ```python
52
+ DatabricksConnectRunner(
53
+ host="https://my-workspace.cloud.databricks.com",
54
+ cluster_id="0123-456789-abcdefgh",
55
+ client_id="my-client-id",
56
+ client_secret="my-client-secret",
57
+ )
58
+ ```
59
+
60
+ ```yaml
61
+ runner:
62
+ kind: DatabricksConnectRunner
63
+ host: "{{ ENV.DATABRICKS_HOST }}"
64
+ cluster_id: "{{ ENV.DATABRICKS_CLUSTER_ID }}"
65
+ client_id: "{{ ENV.DATABRICKS_CLIENT_ID }}"
66
+ client_secret: "{{ ENV.DATABRICKS_CLIENT_SECRET }}"
67
+ ```
68
+ """
69
+
70
+ def __init__(
71
+ self,
72
+ host: str = None,
73
+ cluster_id: str = None,
74
+ client_id: str = None,
75
+ client_secret: str = None,
76
+ **options,
77
+ ) -> None:
78
+ super().__init__(**options)
79
+ RequiredArgumentError.raise_if_missing(
80
+ host=host,
81
+ cluster_id=cluster_id,
82
+ client_id=client_id,
83
+ client_secret=client_secret,
84
+ )
85
+ self.host = trim(host).rstrip("/")
86
+ self.cluster_id = trim(cluster_id)
87
+ self.client_id = trim(client_id)
88
+ self.client_secret = trim(client_secret)
89
+
90
+ def setup(self) -> None:
91
+ if self._spark:
92
+ return
93
+
94
+ self.info(f"🔌 Connecting to the Databricks cluster {self.cluster_id}")
95
+
96
+ sdk_config = Config(
97
+ host=self.host,
98
+ cluster_id=self.cluster_id,
99
+ client_id=self.client_id,
100
+ client_secret=self.client_secret,
101
+ )
102
+ self._spark = DatabricksSession.builder.sdkConfig(sdk_config).getOrCreate()
103
+ self._spark.conf.set("spark.sql.session.timeZone", str(config.app_timezone))
104
+
105
+ for name, value in self.options.items():
106
+ self._spark.conf.set(name, value)
107
+
108
+ self.info(f"🔥 SparkSession ready for {self.context.name}")
@@ -0,0 +1,147 @@
1
+ from tiozin.exceptions import RequiredArgumentError
2
+ from tiozin.family.tio_spark import SparkRunner
3
+ from tiozin.utils import default, trim, trim_lower
4
+
5
+ from ..typehints import DatabricksTableFormat
6
+
7
+ DEFAULT_OAUTH_SCOPE = "unity-catalog"
8
+ DEFAULT_TABLE_FORMAT = "delta"
9
+ DELTA_SQL_EXTENSIONS = "io.delta.sql.DeltaSparkSessionExtension"
10
+ DELTA_SESSION_CATALOG = "org.apache.spark.sql.delta.catalog.DeltaCatalog"
11
+ UNITY_CATALOG_CLASS = "io.unitycatalog.spark.UCSingleCatalog"
12
+ S3A_FILESYSTEM_CLASS = "org.apache.hadoop.fs.s3a.S3AFileSystem"
13
+ ICEBERG_SQL_EXTENSIONS = "org.apache.iceberg.spark.extensions.IcebergSparkSessionExtensions"
14
+ ICEBERG_CATALOG_CLASS = "org.apache.iceberg.spark.SparkCatalog"
15
+
16
+
17
+ class DatabricksExternalRunner(SparkRunner):
18
+ """
19
+ Runs Spark jobs that read and write Databricks Unity Catalog tables from
20
+ outside Databricks.
21
+
22
+ Declare the catalog, the workspace URL and the service principal
23
+ credentials. The catalog becomes the default catalog of the session, so
24
+ steps can refer to tables as `schema.table` or `catalog.schema.table`.
25
+
26
+ Choose the table format of the session with `format`. A session works
27
+ with one format at a time, so pair it with outputs that write the same
28
+ format.
29
+
30
+ The runner authenticates as a service principal using the OAuth M2M
31
+ (client credentials) flow. The catalog client requests and refreshes the
32
+ access token itself, so long-running jobs keep a valid token.
33
+
34
+ The target metastore must have external access enabled and the service
35
+ principal must hold the `EXTERNAL USE SCHEMA` grant on the target schema.
36
+
37
+ For details about Unity Catalog integration with Spark, refer to:
38
+
39
+ https://docs.databricks.com/aws/en/external-access/unity-rest
40
+ https://docs.databricks.com/aws/en/external-access/iceberg
41
+
42
+ Attributes:
43
+ catalog:
44
+ Name of the Unity Catalog catalog to register in Spark.
45
+
46
+ host:
47
+ Databricks workspace URL (e.g. `https://my-workspace.cloud.databricks.com`).
48
+
49
+ client_id:
50
+ Client ID of the service principal.
51
+
52
+ client_secret:
53
+ Client secret of the service principal.
54
+
55
+ scope:
56
+ OAuth scope requested with the token. Defaults to `unity-catalog`.
57
+
58
+ format:
59
+ Table format of the session, `delta` or `iceberg`. Defaults to `delta`.
60
+
61
+ **options:
62
+ Additional arguments accepted by `SparkRunner`, including Spark
63
+ configuration options.
64
+
65
+ Examples:
66
+
67
+ ```python
68
+ DatabricksExternalRunner(
69
+ catalog="my_catalog",
70
+ host="https://my-workspace.cloud.databricks.com",
71
+ client_id="my-client-id",
72
+ client_secret="my-client-secret",
73
+ )
74
+ ```
75
+
76
+ ```yaml
77
+ runner:
78
+ kind: DatabricksExternalRunner
79
+ catalog: my_catalog
80
+ host: "{{ ENV.DATABRICKS_HOST }}"
81
+ client_id: "{{ ENV.DATABRICKS_CLIENT_ID }}"
82
+ client_secret: "{{ ENV.DATABRICKS_CLIENT_SECRET }}"
83
+ format: iceberg
84
+ ```
85
+ """
86
+
87
+ def __init__(
88
+ self,
89
+ catalog: str = None,
90
+ host: str = None,
91
+ client_id: str = None,
92
+ client_secret: str = None,
93
+ scope: str = None,
94
+ format: DatabricksTableFormat = None,
95
+ **options,
96
+ ) -> None:
97
+ super().__init__(**options)
98
+ RequiredArgumentError.raise_if_missing(
99
+ catalog=catalog,
100
+ host=host,
101
+ client_id=client_id,
102
+ client_secret=client_secret,
103
+ )
104
+ self.format = trim_lower(default(format, DEFAULT_TABLE_FORMAT))
105
+ self.catalog = trim(catalog)
106
+ self.host = trim(host).rstrip("/")
107
+ self.token_url = f"{self.host}/oidc/v1/token"
108
+ self.client_id = trim(client_id)
109
+ self.client_secret = trim(client_secret)
110
+ self.scope = trim(default(scope, DEFAULT_OAUTH_SCOPE))
111
+
112
+ def setup(self) -> None:
113
+ if self._spark:
114
+ return
115
+
116
+ self.info(f"Setting up Unity Catalog: {self.catalog}")
117
+
118
+ catalog = f"spark.sql.catalog.{self.catalog}"
119
+
120
+ match self.format:
121
+ case "delta":
122
+ # Tested with Spark 4.0.2, Delta 4.3.0 and unitycatalog-spark 0.6.0
123
+ self.options["spark.sql.extensions"] = DELTA_SQL_EXTENSIONS
124
+ self.options["spark.sql.catalog.spark_catalog"] = DELTA_SESSION_CATALOG
125
+ self.options[catalog] = UNITY_CATALOG_CLASS
126
+ self.options[f"{catalog}.uri"] = self.host
127
+ self.options[f"{catalog}.auth.type"] = "oauth"
128
+ self.options[f"{catalog}.auth.oauth.uri"] = self.token_url
129
+ self.options[f"{catalog}.auth.oauth.clientId"] = self.client_id
130
+ self.options[f"{catalog}.auth.oauth.clientSecret"] = self.client_secret
131
+ self.options[f"{catalog}.auth.oauth.scope"] = self.scope
132
+ self.options["spark.hadoop.fs.s3.impl"] = S3A_FILESYSTEM_CLASS
133
+ case "iceberg":
134
+ # Tested with Spark 3.5.4 and Iceberg 1.7.1
135
+ self.options["spark.sql.extensions"] = ICEBERG_SQL_EXTENSIONS
136
+ self.options[catalog] = ICEBERG_CATALOG_CLASS
137
+ self.options[f"{catalog}.type"] = "rest"
138
+ self.options[f"{catalog}.uri"] = f"{self.host}/api/2.1/unity-catalog/iceberg-rest"
139
+ self.options[f"{catalog}.warehouse"] = self.catalog
140
+ self.options[f"{catalog}.rest.auth.type"] = "oauth2"
141
+ self.options[f"{catalog}.oauth2-server-uri"] = self.token_url
142
+ self.options[f"{catalog}.credential"] = f"{self.client_id}:{self.client_secret}"
143
+ self.options[f"{catalog}.scope"] = self.scope
144
+
145
+ self.options["spark.sql.defaultCatalog"] = self.catalog
146
+
147
+ super().setup()
@@ -0,0 +1,6 @@
1
+ from typing import Literal
2
+
3
+ DatabricksTableFormat = Literal[
4
+ "delta",
5
+ "iceberg",
6
+ ]