|
| 1 | +--- |
| 2 | +# Copyright (c) 2025 ADBC Drivers Contributors |
| 3 | +# |
| 4 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +# you may not use this file except in compliance with the License. |
| 6 | +# You may obtain a copy of the License at |
| 7 | +# |
| 8 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +# |
| 10 | +# Unless required by applicable law or agreed to in writing, software |
| 11 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +# See the License for the specific language governing permissions and |
| 14 | +# limitations under the License. |
| 15 | +{} |
| 16 | +--- |
| 17 | + |
| 18 | +{{ cross_reference|safe }} |
| 19 | +# Databricks Driver {{ version }} |
| 20 | + |
| 21 | +{{ heading|safe }} |
| 22 | + |
| 23 | +This driver provides access to [Databricks][databricks], a |
| 24 | +cloud-based platform for data analytics. |
| 25 | + |
| 26 | +## Installation |
| 27 | + |
| 28 | +The Databricks driver can be installed with [dbc](https://docs.columnar.tech/dbc): |
| 29 | + |
| 30 | +```bash |
| 31 | +dbc install databricks |
| 32 | +``` |
| 33 | + |
| 34 | +## Connecting |
| 35 | + |
| 36 | +TODO: This section once https://github.com/apache/arrow-adbc/pull/3771 is merged here. |
| 37 | + |
| 38 | +To connect, edit the `uri` option below to match your environment and run the following: |
| 39 | + |
| 40 | +```python |
| 41 | +from adbc_driver_manager import dbapi |
| 42 | + |
| 43 | +conn = dbapi.connect( |
| 44 | + driver="databricks", |
| 45 | + db_kwargs = { |
| 46 | + "uri": "TODO" |
| 47 | + } |
| 48 | +) |
| 49 | +``` |
| 50 | + |
| 51 | +Note: The example above is for Python using the [adbc-driver-manager](https://pypi.org/project/adbc-driver-manager) package but the process will be similar for other driver managers. |
| 52 | + |
| 53 | +### Connection String Format |
| 54 | + |
| 55 | +TODO: This section once https://github.com/apache/arrow-adbc/pull/3771 is merged here. |
| 56 | + |
| 57 | +## Feature & Type Support |
| 58 | + |
| 59 | +{{ features|safe }} |
| 60 | + |
| 61 | +### Types |
| 62 | + |
| 63 | +{{ types|safe }} |
| 64 | + |
| 65 | +## Compatibility |
| 66 | + |
| 67 | +{{ compatibility_info|safe }} |
| 68 | + |
| 69 | +## Previous Versions |
| 70 | + |
| 71 | +To see documentation for previous versions of this driver, see the following: |
| 72 | + |
| 73 | +- [v0.1.0](./v0.1.0.md) |
| 74 | + |
| 75 | +{{ footnotes|safe }} |
| 76 | + |
| 77 | +[databricks]: https://www.databricks.com |
0 commit comments