Databricks のデータフレームにて Azure Event Hubs に対して Avro 形式でデータの書き込みと読み込みを実施する方法

## 概要

Databricks のデータフレームにて Azure Event Hubs に対して Avro 形式でデータの書き込みと読み込みを実施する方法を共有します。

## 事前準備

### Azure Event Hubs の SAS を取得

下記の記事を参考に SAS 認証により Databricks から Azure Event Hubs の SAS を取得してください。

- [Databricks DLT にて Azure Event Hubs から SAS 認証によりデータを取得する方法 #dlt - Qiita](https://qiita.com/manabian/items/072903132cff47937004)
- [Databricks のデータフレームにて Azure Event Hubs へ SAS 認証によりデータを書き込む方法 #AzureEventHubs - Qiita](https://qiita.com/manabian/items/d60910bede20a52404e0)

### Databricks にてデータベースオブジェクトを作成

カレントカタログを設定します。

```sql
%sql
USE CATALOG manabian_test_01;
```

スキーマを作成します。

```sql
%sql
CREATE SCHEMA IF NOT EXISTS eh_test_01;
```

ソースのテーブルを作成します。

```sql
%sql
CREATE OR REPLACE TABLE eh_test_01.table_01
AS
SELECT
  1 AS id,
  'John' AS string_col,
  CAST('2025-01-01' AS TIMESTAMP) AS ingest_ts
  ;
SELECT * FROM eh_test_01.table_01;
```

処理時のチェックポイントに利用する Volume を作成します。

```sql
%sql
CREATE VOLUME IF NOT EXISTS eh_test_01.volume_01;
```

```python
volume_path = "/Volumes/manabian_test_01/eh_test_01/volume_01"
dbutils.fs.rm(volume_path, True)
```

### Azure Event Hubs にて`avro-test-01`という名称の Azure Event Hubs のインスタンスを作成

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/24031/db0755df-f32a-4eca-adc5-e73f7849973a.png)

## 手順

### 1. Databricks にて Azure Event Hubs に対する書き込みの実施


```python
# Azure Event Hubs に接続するための設定値をセット
eh_namespace_name = "kafka-test-01"  ## Azure Event Hubs の名前空間をセット
ehi_name = topic_name = "avro-test-01"  ## Azure Event Hubs のEvent Hubs のインスタンスをセット
connection_string = "Endpoint=sb://kafka-test-01.servicebus.windows.net/;SharedAccessKeyName=dbt-to-eh-01;SharedAccessKey=hnyXXXX="  ## SAS 接続文字列をセット
```

```python
# Databricks から Azure Event Hubs に設定する際の設定をセット
eh_sasl = (
    "kafkashaded.org.apache.kafka.common.security.plain.PlainLoginModule "
    f'required username="$ConnectionString" password="{connection_string}";'
)
bootstrap_servers = f"{eh_namespace_name}.servicebus.windows.net:9093"
kafka_options = {
    "kafka.bootstrap.servers": bootstrap_servers,
    "kafka.sasl.mechanism": "PLAIN",
    "kafka.security.protocol": "SASL_SSL",
    "kafka.sasl.jaas.config": eh_sasl,
}
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/24031/b66beade-e36b-459c-b783-2dab506ed362.png)


### 2. Databricks から Azure Event Hubs から読み込みの実施

```python
# Azure Event Hubs へデータを書き込む
from pyspark.sql.functions import col, expr, from_json

df = spark.readStream.table("eh_test_01.table_01")
df = df.selectExpr("to_avro(struct(id, string_col, ingest_ts)) AS value")


_ = (
    df.writeStream.format("kafka")
    .options(**kafka_options)
    .option("topic", topic_name)
    .option("checkpointLocation", volume_path+"/avro_test_01")
    .trigger(availableNow=True)
    .start()
)
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/24031/37d06aef-c4b5-447d-b82b-3c0d08a53f70.png)


Azure Event Hubs の画面にてデータが書きこまれたことを確認します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/24031/a8c59239-e4d3-4718-8e93-658798006756.png)

### 3. Databricks から Azure Event Hubs から読み込みの実施

```python
schema = """
{
  "name": "kafka_test_01.avro_0",
  "type": "record",
  "fields": [
    {
      "name": "id",
      "type": "long"
    },
    {
      "name": "string_col",
      "type": "string"
    },
    {
      "name": "ingest_ts",
      "type": {
        "type": "long",
        "logicalType": "timestamp-micros"
      }
    }
  ]
}
"""

# Azure Event Hubs からデータを取得
from pyspark.sql.functions import col
from pyspark.sql.avro.functions import from_avro

df = (
    spark.readStream.format("kafka")
    .options(**kafka_options)
    .option("subscribe", topic_name)
    .option("startingOffsets", "earliest")  # 検証目的であるため earliest に設定
    .load()
)
df = df.withColumn(
    "decoded_value",
    from_avro(
        col("value"),
        schema,
    ),
)
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/24031/3bab6432-dbf2-45ba-b488-fda43f2160bd.png)


```python
df.display()
```


![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/24031/a90093c6-89a5-48b0-8257-c560a2e78d97.png)