Skip to content

Commit b303f95

Browse files
khalidmammadovethan-tyler
authored andcommitted
docs: add uc supported env vars
Signed-off-by: Khalid Mammadov <khalidmammadov9@gmail.com>
1 parent 86d97cc commit b303f95

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

docs/usage/loading-table.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,3 +214,57 @@ You may load a Delta Table from your Databricks or Open Source Unity Catalog usi
214214
dt.is_deltatable(dt.table_uri)
215215
# True
216216
```
217+
218+
### Following environmental variables are supported
219+
220+
#### Connection Configuration
221+
222+
| Environment Variable | Description |
223+
|---------------------|-------------|
224+
| `DATABRICKS_HOST` | Databricks workspace host URL |
225+
| `DATABRICKS_WORKSPACE_URL` | Alternative workspace URL variable |
226+
| `UNITY_WORKSPACE_URL` | Unity-prefixed workspace URL |
227+
228+
#### Authentication Credentials
229+
230+
| Environment Variable | Description |
231+
|---------------------|-------------|
232+
| `DATABRICKS_TOKEN` | Access token for Databricks authentication|
233+
| `DATABRICKS_ACCESS_TOKEN` | Alternative access token variable |
234+
| `UNITY_ACCESS_TOKEN` | Unity-prefixed access token variable |
235+
236+
#### OAuth / Service Principal Authentication
237+
238+
| Environment Variable | Description |
239+
|---------------------|-------------|
240+
| `DATABRICKS_AUTHORITY_HOST` | Authority host for OAuth flows |
241+
| `DATABRICKS_AUTHORITY_ID` | Authority (tenant) ID for OAuth flows |
242+
| `DATABRICKS_CLIENT_ID` | Service principal client ID |
243+
| `DATABRICKS_CLIENT_SECRET` | Service principal client secret |
244+
| or ||
245+
| `UNITY_AUTHORITY_HOST` | Unity-prefixed authority host |
246+
| `UNITY_AUTHORITY_ID` | Unity-prefixed authority ID |
247+
| `UNITY_CLIENT_ID` | Unity-prefixed client ID |
248+
| `UNITY_CLIENT_SECRET` | Unity-prefixed client secret |
249+
250+
#### Azure Managed Identity Authentication
251+
252+
| Environment Variable | Description |
253+
|---------------------|-------------|
254+
| `DATABRICKS_FEDERATED_TOKEN_FILE` | File containing token for Azure AD workload identity federation |
255+
| `DATABRICKS_MSI_ENDPOINT` | Endpoint to request managed identity token |
256+
| `DATABRICKS_MSI_RESOURCE_ID` | MSI resource ID for managed identity |
257+
| `DATABRICKS_OBJECT_ID` | Object ID for managed identity authentication |
258+
| `DATABRICKS_USE_AZURE_CLI` | Use Azure CLI for acquiring access token |
259+
| or ||
260+
| `UNITY_FEDERATED_TOKEN_FILE` | Unity-prefixed federated token file |
261+
| `UNITY_MSI_ENDPOINT` | Unity-prefixed MSI endpoint |
262+
| `UNITY_MSI_RESOURCE_ID` | Unity-prefixed MSI resource ID |
263+
| `UNITY_OBJECT_ID` | Unity-prefixed object ID |
264+
| `UNITY_USE_AZURE_CLI` | Unity-prefixed Azure CLI flag |
265+
266+
#### Additional Settings
267+
268+
| Environment Variable | Description |
269+
|---------------------|-------------|
270+
| `UNITY_ALLOW_HTTP_URL` | Allow HTTP URLs (e.g., http://localhost:8080) for testing |

0 commit comments

Comments
 (0)