dbxio: High-level Databricks client
Overview
dbxio is a high-level client for Databricks that simplifies working with tables and volumes. It provides a simple interface for reading and writing data, creating and deleting objects, and running SQL queries and fetching results.
Why dbxio?
- dbxio connects the power of Databricks SQL and Python for local data manipulation.
- dbxio provides a simple and intuitive interface for working with Databricks Tables and Volumes. Now it's possible to read/write data with just a few lines of code.
- For large amounts of data, dbxio uses intermediate object storage of your choice to perform bulk upload later (see COPY INTO for more details). So, you can upload any amount of data, and dbxio will take care of synchronizing the data with the table in Databricks.
Alternatives
Currently, we are not aware of any alternatives that offer the same functionality as dbxio. If you come across any, we would be interested to learn about them. Please let us know by opening an issue in our GitHub repository.
Installation
dbxio requires Python 3.9 or later. You can install dbxio using pip:
pip install dbxio
dbxio by Example
import dbxio
client = dbxio.DbxIOClient.from_cluster_settings(
cluster_type=dbxio.ClusterType.SQL_WAREHOUSE,
http_path='<YOUR_HTTP_PATH>',
server_hostname='<YOUR_SERVER_HOSTNAME>',
settings=dbxio.Settings(cloud_provider=dbxio.CloudProvider.AZURE),
)
# read table
table = list(dbxio.read_table('catalog.schema.table', client=client))
# write table
data = [
{'col1': 1, 'col2': 'a', 'col3': [1, 2, 3]},
{'col1': 2, 'col2': 'b', 'col3': [4, 5, 6]},
]
schema = dbxio.TableSchema.from_obj(
{
'col1': dbxio.types.IntType(),
'col2': dbxio.types.StringType(),
'col3': dbxio.types.ArrayType(dbxio.types.IntType()),
}
)
dbxio.bulk_write_table(
dbxio.Table('domain.schema.table', schema=schema),
data,
client=client,
abs_name='blob_storage_name',
abs_container_name='container_name',
append=True,
)
Cloud Support
dbxio supports the following cloud providers:
- Azure
- AWS (in plans)
- GCP (in plans)
Project Information
Metadata
Release files for dbxio 0.5.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| dbxio-0.5.3.tar.gz | 36.3 kB | With provenance | Details for dbxio-0.5.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| dbxio-0.5.3-py3-none-any.whl | Python 3 | none | any | Details for dbxio-0.5.3-py3-none-any.whl |
Total release size: 83.2 kB
Release files / dbxio-0.5.3.tar.gz
| Download URL | dbxio-0.5.3.tar.gz |
|---|---|
| Size | 36.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4bfe11291c391c14ffe71a5b77a01b88383b7b6b870a2cca0fc2547d01129c1e
|
|
BLAKE2b-256 checksum How to use checksums |
ab780eae1d4f1b0c29f5102743007a3ab5f1abcb54ce2e04fe8d5fe9944da52c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 5, 2025.
Transparency logRelease files / dbxio-0.5.3-py3-none-any.whl
| Download URL | dbxio-0.5.3-py3-none-any.whl |
|---|---|
| Size | 46.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
96d1f25d8f9d71662bd3238750897f560aeb9264be8915d45d65588ae38ba3bd
|
|
BLAKE2b-256 checksum How to use checksums |
6c1dd9528f7173867300f41a543b6726e2684451b21614bbbce936a7f6e8c7c2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 5, 2025.
Transparency logSecurity for dbxio 0.5.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for dbxio-0.5.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 5, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.