# ルールエンジン

EMQXは、データ処理のためのルールエンジン機能を提供しており、[データ統合](./data-bridges.md)と連携してIoTデータの抽出、フィルタリング、強化、変換、保存を行います。これにより、アプリケーション統合が加速し、ビジネスのイノベーションを促進します。

![data-integration-arch](./assets/rules/data-integration-arch.jpg)

EMQXのルールエンジンは、特に受信したメッセージの変換やルーティングに有効です。例えば、不要なデータをフィルタリングしたり、変換を行ったり、特定のイベントや条件に基づいてアラートや通知をトリガーするルールを作成できます。

本章では、ルールエンジンの詳細な機能とその使い方について解説します。

## ルールエンジンの仕組み

ルールは、**データソース**からデータを取得し、**データ変換**を行い、その結果に対して適用すべき**アクション**を指定します。

<img src="./assets/sql_process.png" alt="sql_process" style="zoom:50%;" />

- **データソース**：ルールのデータソースは、メッセージ、イベント、または外部データシステムが対象となります。ルールのSQLの`FROM`句でデータソースを指定し、`WHERE`句で処理対象となるメッセージに対する追加の制約を設定します。

  対応するデータソースの種類や`WHERE`句で参照可能なフィールドの詳細については、[データソースとフィールド](./rule-sql-events-and-fields.md)をご参照ください。

- **データ変換**：データ変換は入力メッセージを変換する処理を指します。SQLの`SELECT`部分で入力メッセージからデータを抽出・変換します。埋め込みSQLのサンプル文を用いて、出力メッセージにタイムスタンプを付加するなどの高度な変換も実装可能です。

  SQL文法や組み込みSQL関数の詳細は、[ルールSQLリファレンス](./rule-sql-syntax.md)および[組み込みSQL関数](./rule-sql-builtin-functions.md)をご覧ください。

- **アクション**：入力がルールに従って処理された後、SQLの実行結果に対して1つ以上のアクションを定義できます。ルールエンジンは順次対応するアクションを実行し、処理結果をデータベースに保存したり、別のMQTTトピックにパブリッシュしたりします。サポートされるアクションは以下の通りです。

  - [メッセージの再パブリッシュ](./rule-get-started.md#add-republish-action)：結果を指定したMQTTトピックにパブリッシュする。
  - [コンソール出力](./rule-get-started.md#add-console-output-action)：結果をコンソールやログに出力する。
  - [シンクへの転送](./data-bridges.md#add-forwarding-with-sinks-action)：結果をMQTTサービス、Kafka、PostgreSQLなどの外部データシステムに送信する。

EMQXダッシュボードでルールを作成する手順については、[ルールの作成](./rule-get-started.md)をご参照ください。

## ルールSQLの例

ルールSQLは、ルールのデータソースを指定し、データ処理の手順を定義するために使用します。以下はSQL文の例です。

```sql
SELECT
    payload.data as d
FROM
    "t/#"
WHERE
    clientid = 'foo'
```

上記のSQL文では、

- データソース：トピック`t/#`のメッセージ
- データ処理：メッセージ送信者のクライアントIDが`foo`の場合、メッセージ内容の`data`フィールドを抽出し、新しい変数`d`に割り当てる

::: tip

`.`構文はデータがJSONまたはMap形式である必要があります。別のデータ型の場合は、SQL関数を用いて型変換を行う必要があります。

:::

ルールSQL文の形式や使い方の詳細は、[SQLマニュアル](./rule-sql-syntax.md)をご参照ください。

## ルールの典型的な適用シナリオ

- **アクション監視**：スマートホームのインテリジェントロック開発において、ネットワーク障害や電源切れ、破壊行為によりロックがオフラインになると機能異常が発生します。ルールでオフラインイベントを監視し、この障害情報をアプリケーションサービスにプッシュすることで、アクセス層での即時障害検知が可能になります。
- **データフィルタリング**：コネクテッドビークルのトラック車両管理では、車両センサーが大量の運行データを収集・報告します。アプリケーションプラットフォームは車速が40km/hを超えた場合のみデータを必要とします。この場合、ルールで条件付きフィルタリングを行い、関連するデータのみを業務用メッセージキューに書き込みます。
- **メッセージルーティング**：スマート課金アプリケーションでは、端末デバイスが異なるトピックで業務種別を区別します。ルールを設定することで、課金関連メッセージを課金メッセージキューに振り分け、端末到着時に業務システムへ確認通知を送信します。課金以外の情報は別のメッセージキューに振り分けることで、業務メッセージのルーティング設定を実現します。
- **メッセージのエンコード／デコード**：他のパブリック／プライベートTCPプロトコルアクセスや産業用途などのアプリケーションでは、ルール内のローカル処理機能（EMQX上でカスタム開発可能）を使ってバイナリや特殊フォーマットのメッセージボディをエンコード／デコードできます。また、ルールを通じてメッセージをサーバーレス関数など外部計算リソースにルーティングし（ユーザー開発可能）、業務アプリケーションで扱いやすいJSON形式に変換することも可能です。これによりプロジェクト統合の難易度が軽減され、迅速なアプリケーション開発・提供が促進されます。

## 主なメリット

EMQXのルールエンジン機能は、ユーザーに以下のメリットを提供します。

**データ処理の簡素化**

SQLライクな文法とストリーム処理機能により、カスタムコードや追加ツールなしでデータのフィルタリング、変換、配信を効率的に行えます。

**リアルタイムのインサイトとアクション**

特定条件に基づくアクションのトリガーにより、リアルタイムでのインサイト取得と適切な対応が可能です。

**開発時間と工数の削減**

豊富な組み込み機能により、カスタムコードやメンテナンスの負担を軽減し、IoTアプリケーション開発を容易にします。

**スケーラビリティと信頼性**

高スループットおよび多数の接続デバイスに対応できる設計で、性能や信頼性を損なうことなくIoTソリューションのスケールアップが可能です。
