title: 'Delta Lake Data Connector'
sidebar_label: 'Delta Lake Data Connector'
description: 'Delta Lake Data Connector Documentation'
pagination_prev: null
tags:
- data-connectors
- delta-lake
- data-lake
Delta Lake data connector enables SQL queries from Delta Lake (opens in a new tab) tables.
Configuration
from
The from field for the Delta Lake connector takes the form of delta_lake:path where path is any supported path, either local or to a cloud storage location. See the examples (opens in a new tab) section below.
name
The dataset name. This will be used as the table name within Spice.
Example:
The dataset name cannot be a reserved keyword (opens in a new tab).
params
Use the secret replacement syntax (opens in a new tab) to reference a secret, e.g. ${secrets:aws_access_key_id}.
| Parameter Name | Description |
|---|
client_timeout | Optional. Specifies timeout for object store operations. No default; uses the underlying HTTP client timeout when not set. E.g. client_timeout: 60s |
Delta Lake object store parameters
AWS S3
| Parameter Name | Description |
|---|
delta_lake_aws_region | Optional. The AWS region for the S3 object store. E.g. us-west-2. |
delta_lake_aws_access_key_id | The access key ID for the S3 object store. |
delta_lake_aws_secret_access_key | The secret access key for the S3 object store. |
delta_lake_aws_session_token | Optional. The AWS session token for S3 object store. |
delta_lake_aws_endpoint | Optional. The endpoint for the S3 object store. E.g. s3.us-west-2.amazonaws.com. |
delta_lake_aws_allow_http | Optional. Enables insecure HTTP connections to delta_lake_aws_endpoint. Defaults to false. |
Azure Blob
:::info Note
One of the following auth values must be provided for Azure Blob:
delta_lake_azure_storage_account_key,
delta_lake_azure_storage_client_id and delta_lake_azure_storage_client_secret, or
delta_lake_azure_storage_sas_key.
:::
| Parameter Name | Description |
|---|
delta_lake_azure_storage_account_name | The Azure Storage account name. |
delta_lake_azure_storage_account_key | The Azure Storage master key for accessing the storage account. |
delta_lake_azure_storage_client_id | The service principal client id for accessing the storage account. |
delta_lake_azure_storage_client_secret | The service principal client secret for accessing the storage account. |
delta_lake_azure_storage_sas_key | The shared access signature key for accessing the storage account. |
delta_lake_azure_storage_endpoint | Optional. The endpoint for the Azure Blob storage account. |
Google Storage (GCS)
| Parameter Name | Description |
|---|
delta_lake_google_service_account | Filesystem path to the Google service account JSON key file. |
Examples
Delta Lake + Local
Delta Lake + S3
Delta Lake + MinIO
Delta Lake + Azure Blob
Delta Lake + Google Storage
Types
The table below shows the Delta Lake data types supported, along with the type mapping to Apache Arrow types in Spice.
| Delta Lake Type | Arrow Type |
|---|
String | Utf8 |
Long | Int64 |
Integer | Int32 |
Short | Int16 |
Byte | Int8 |
Float | Float32 |
Double | Float64 |
Boolean | Boolean |
Binary | |
Limitations
-
Delta Lake connector does not support reading Delta tables with the V2Checkpoint feature enabled. To use the Delta Lake connector with such tables, drop the V2Checkpoint feature by executing the following command:
For more details on dropping Delta table features, refer to the official documentation: Drop Delta table features (opens in a new tab)
Secrets
Spice integrates with multiple secret stores to help manage sensitive data securely. For detailed information on supported secret stores, refer to the secret stores documentation (opens in a new tab). Additionally, learn how to use referenced secrets in component parameters by visiting the using referenced secrets guide (opens in a new tab).