ランタイムフィルタ

Runtime Filterは主に2つのタイプから構成されます：Join Runtime FilterとTopN Runtime Filterです。この記事では、これら2つのタイプのRuntime Filterの動作原理、使用ガイドライン、およびチューニング方法について詳しく紹介します。

Join Runtime Filter

Join Runtime Filter（以下JRFと呼ぶ）は、Join条件を活用してランタイムデータに基づいてJoinノードで動的にフィルタを生成する最適化技術です。この技術はJoin Probeのサイズを削減するだけでなく、データI/Oとネットワーク伝送を効果的に最小化します。

原理

TPC-H Schemaで見られるようなJoin操作を使用して、JRFの動作原理を説明します。

データベースに2つのテーブルがあると仮定します：

• Orders Table：1億行のデータを含み、注文キー（o_orderkey）、顧客キー（o_custkey）、およびその他の注文情報を記録します。

• Customer Table：10万行のデータを含み、顧客キー（c_custkey）、顧客の国（c_nation）、およびその他の顧客情報を記録します。このテーブルは25カ国の顧客を記録しており、1カ国あたり約4,000人の顧客がいます。

中国の顧客からの注文数をカウントするため、クエリ文は以下のようになります：

select count(*)
from orders join customer on o_custkey = c_custkey
where c_nation = "china"

このクエリの実行プランの主要なコンポーネントはJoinです。以下に示します：

JRFなし：Scanノードはordersテーブルをスキャンし、1億行のデータを読み取ります。その後、Joinノードはこれらの1億行に対してHash Probeを実行し、Join結果を生成します。

1. 最適化

フィルター条件c_nation = 'china'は中国以外の顧客をすべて除外するため、customerテーブルの一部分（約1/25）のみがJoinに関与します。後続のJoin条件o_custkey = c_custkeyを考慮すると、フィルターされた結果で選択されたc_custkeyの値に注目する必要があります。フィルターされたc_custkeyの値を集合Aとします。以下のテキストでは、集合AはJoinに参加するc_custkeyの集合を特に指します。

集合AがIN条件としてordersテーブルにプッシュダウンされると、ordersテーブルのScanノードは該当するordersをフィルタリングできます。これは、フィルター条件o_custkey IN (c001, c003)を追加することに類似しています。

この最適化の概念に基づいて、SQLは以下のように最適化できます：

select count(*)
from orders join customer on o_custkey = c_custkey
where c_nation = "china" and o_custkey in (c001, c003)

最適化された実行プランを以下に示します：

ordersテーブルにフィルタ条件を追加することで、Joinに参加する実際の注文数が1億から40万に削減され、クエリ速度が大幅に向上します。

2. 実装

上記で説明した最適化は重要ですが、オプティマイザは選択される実際のc_custkey値（集合A）を知らないため、最適化フェーズ中に固定のin-predicate filterオペレータを静的に生成することができません。

実用的なアプリケーションでは、Joinノードで右側のデータを収集し、実行時に集合Aを生成し、集合Aをordersテーブルのscanノードにプッシュダウンします。通常、このJRFをRF(c_custkey -> [o_custkey])と表記します。

Dorisは分散データベースであるため、JRFは分散シナリオに対応するための追加のマージステップが必要です。この例のJoinがShuffle Joinであると仮定すると、このJoinの複数のインスタンスがordersテーブルとcustomerテーブルの個別のシャードを処理します。その結果、各Joinインスタンスは集合Aの一部のみを取得します。

現在のバージョンのDorisでは、Runtime Filter Managerとして機能するノードを選択します。各Joinインスタンスはそのシャード内のc_custkey値に基づいてPartial JRFを生成し、それをManagerに送信します。Managerはすべての Partial JRFを収集し、それらをGlobal JRFにマージし、その後Global JRFをordersテーブルのすべてのScanインスタンスに送信します。

Global JRFを生成するプロセスを以下に示します：

フィルタタイプ

JRF（Join Runtime Filter）を実装するために使用できるさまざまなデータ構造があり、それぞれ生成、マージ、送信、適用における効率が異なり、異なるシナリオに適しています。

1. In Filter

JRFを実装する最もシンプルなアプローチは、In Filterの使用です。前の例を取ると、In Filterを使用する場合、実行エンジンは左側のテーブルで述語o_custkey in (...集合A内の要素のリスト...)を生成します。このIn filterの条件は、ordersテーブルをフィルタリングするために適用できます。集合A内の要素数が少ない場合、In Filterは効率的です。

しかし、集合A内の要素数が多い場合、In Filterの使用は問題となります：

1. 第一に、In Filterの生成コストが高く、特にJRFマージが必要な場合です。異なるデータパーティションに対応するJoinノードから収集された値には重複が含まれる可能性があります。例えば、c_custkeyがテーブルの主キーでない場合、c001やc003などの値が複数回現れる可能性があり、時間のかかる重複除去プロセスが必要になります。

2. 第二に、集合Aに多くの要素が含まれる場合、JoinノードとordersテーブルのScanノード間でのデータ送信コストが重要になります。

3. 最後に、ordersテーブルのScanノードでIn述語を実行することにも時間がかかります。

これらの要因を考慮して、Bloom Filterを導入します。

2. Bloom Filter

Bloom Filterに馴染みのない方は、それらを重ね合わされたハッシュテーブルのセットと考えることができます。フィルタリングにBloom Filter（またはハッシュテーブル）を使用することは、以下の特性を活用します：

• 集合Aに基づいてハッシュテーブルTが生成されます。要素がハッシュテーブルTにない場合、その要素が集合Aにないことを確実に結論できます。しかし、逆は真ではありません。

  したがって、o_orderkeyがBloom Filterによってフィルタリングされた場合、Joinの右側に一致するc_custkeyがないことを結論できます。それでも、ハッシュ衝突のため、一致するc_custkeyがない場合でも、一部のo_custkeyがBloom Filterを通過する可能性があります。

  Bloom Filterは精密なフィルタリングを実現できませんが、それでもある程度のフィルタリング効果を提供します。

• ハッシュテーブル内のバケット数がフィルタリングの精度を決定します。バケット数が多いほど、Filterはより大きくより正確になりますが、生成、送信、使用における計算オーバーヘッドの増加という代償があります。

  したがって、Bloom Filterのサイズは、フィルタリング効果と使用コスト間のバランスを取る必要があります。この目的のため、RUNTIME_BLOOM_FILTER_MIN_SIZEとRUNTIME_BLOOM_FILTER_MAX_SIZEで定義される、Bloom Filterサイズの設定可能な範囲を設定しています。

3. Min/Max Filter

Bloom Filter以外に、Min-Max Filterも近似フィルタリングに使用できます。データ列が順序付けされている場合、Min-Max Filterは優れたフィルタリング結果を達成できます。さらに、Min-Max Filterの生成、マージ、使用コストは、In FilterやBloom Filterよりも大幅に低くなります。

非等価Joinの場合、In FilterとBloom Filterの両方が効果的でなくなりますが、Min-Max Filterは依然として機能できます。前の例からクエリを次のように変更したとします：

select count(*)
from orders join customer on o_custkey > c_custkey
where c_name = "China"

この場合、フィルタリングされた c_custkey の最大値を選択し、それを n として表記し、orders テーブルの Scan ノードに渡すことができます。Scan ノードは o_custkey > n の行のみを出力します。

Join Runtime Filter の表示

特定のクエリに対してどの JRF (Join Runtime Filter) が生成されているかを確認するには、explain、explain shape plan、または explain physical plan コマンドを使用できます。

TPC-H Schema を例として、これら3つのコマンドを使用して JRF を表示する方法を詳しく説明します。

select count(*) from orders join customer on o_custkey=c_custkey;

1. Explain

従来のExplain出力では、JRF情報は通常、以下の例に示すようにJoinノードとScanノードに表示されます。

4: VHASH JOIN(258)  
| join op: INNER JOIN(PARTITIONED)[]  
|  equal join conjunct: (o_custkey[#10] = c_custkey[#0])  
|  runtime filters: RF000[bloom] <- c_custkey[#0] (150000000/134217728/16777216)  
|  cardinality=1,500,000,000  
|  vec output tuple id: 3  
|  output tuple id: 3  
|  vIntermediate tuple ids: 2  
|  hash output slot ids: 10  
|  final projections: o_custkey[#17]  
|  final project output tuple id: 3  
|  distribute expr lists: o_custkey[#10]
|  distribute expr lists: c_custkey[#0]  
|  
|---1: VEXCHANGE  
|      offset: 0  
|      distribute expr lists: c_custkey[#0]   
3: VEXCHANGE  
|  offset: 0  
|  distribute expr lists:  
  
PLAN FRAGMENT 2  
| PARTITION: HASH_PARTITIONED: o_orderkey[#8]  
| HAS_COLO_PLAN_NODE: false  
| STREAM DATA SINK  
|   EXCHANGE ID: 03  
|   HASH_PARTITIONED: o_custkey[#10]  
  
2: VOlapScanNode(242)  
|  TABLE: regression_test_nereids_tpch_shape_sf1000_p0.orders(orders)  
|  PREAGGREGATION: ON  
|  runtime filters: RF000[bloom] -> o_custkey[#10]  
|  partitions=1/1 (orders)  
|  tablets=96/96, tabletList=54990,54992,54994 ...  
|  cardinality=0, avgRowSize=0.0, numNodes=1  
|  pushAggOp=NONE

• Join Side: runtime filters: RF000[bloom] <- c_custkey[#0] (150000000/134217728/16777216)

  これは、ID 000のBloom Filterが生成され、c_custkeyを入力として使用してJRFを作成していることを示します。その後に続く3つの数値はBloom Filterのサイズ計算に関連しており、現時点では無視して構いません。

• Scan Side: runtime filters: RF000[bloom] -> o_custkey[#10]

  これは、JRF 000がordersテーブルのScanノードに適用され、o_custkeyフィールドをフィルタリングすることを示します。

2. Shape Planの説明

Explain Planシリーズでは、JRFの表示方法を示す例としてShape Planを使用します。

mysql> explain shape plan select count(*) from orders join customer on o_custkey=c_custkey where c_nationkey=5;  
+--------------------------------------------------------------------------------------------------------------------------+
Explain String(Nereids Planner)                                                                                            ｜
+--------------------------------------------------------------------------------------------------------------------------+
PhysicalResultSink                                                                                                         ｜  
--hashAgg[GLOBAL]                                                                                                          ｜  
----PhysicalDistribute[DistributionSpecGather]                                                                             ｜   
------hashAgg[LOCAL]                                                                                                       ｜ 
--------PhysicalProject                                                                                                    ｜
----------hashJoin[INNER_JOIN shuffle]                                                                                     ｜
------------hashCondition=((orders.o_custkey=customer.c_custkey)) otherCondition=() buildRFs:RF0 c_custkey->[o_custkey]    ｜  
--------------PhysicalProject                                                                                              ｜  
----------------Physical0lapScan[orders] apply RFs: RF0                                                                    ｜
--------------PhysicalProject                                                                                              ｜ 
----------------filter((customer.c_nationkey=5))                                                                           ｜ 
------------------Physical0lapScan[customer]                                                                               ｜
+--------------------------------------------------------------------------------------------------------------------------+
11 rows in set (0.02 sec)

上記の通り：

• Join Side: build RFs: RF0 c_custkey -> [o_custkey]は、JRF 0がc_custkeyデータを使用して生成され、o_custkeyに適用されることを示しています。

• Scan Side: PhysicalOlapScan[orders] apply RFs: RF0は、ordersテーブルがJRF 0によってフィルタされることを示しています。

3. Profile

実際の実行中、BEはJRF使用詳細をProfile（set enable_profile=trueが必要）に出力します。同じSQLクエリを例として、ProfileでJRF実行詳細を確認できます。

• Join Side

  HASH_JOIN_SINK_OPERATOR  (id=3  ,  nereids_id=367):(ExecTime:  703.905us)
        -  JoinType:  INNER_JOIN
        。。。
        -  BuildRows:  617
        。。。
        -  RuntimeFilterComputeTime:  70.741us
        -  RuntimeFilterInitTime:  10.882us

これはJoinのBuild側のプロファイルです。この例では、617行の入力データでJRFの生成に70.741usかかりました。JRFのサイズとタイプはScan側に表示されます。

• Scan側

  OLAP_SCAN_OPERATOR  (id=2.  nereids_id=351.  table  name  =  orders(orders)):(ExecTime:  13.32ms)
              -  RuntimeFilters:  :  RuntimeFilter:  (id  =  0,  type  =  bloomfilter,  need_local_merge:  false,  is_broadcast:  true,  build_bf_cardinality:  false,  
              。。。
              -  RuntimeFilterInfo:  
                  -  filter  id  =  0  filtered:  714.761K  (714761)
                  -  filter  id  =  0  input:  747.862K  (747862)
              。。。
              -  WaitForRuntimeFilter:  6.317ms
            RuntimeFilter:  (id  =  0,  type  =  bloomfilter):
                  -  Info:  [IsPushDown  =  true,  RuntimeFilterState  =  READY,  HasRemoteTarget  =  false,  HasLocalTarget  =  true,  Ignored  =  false]
                  -  RealRuntimeFilterType:  bloomfilter
                  -  BloomFilterSize:  1024

注意:

1. 5-6行は、入力行数とフィルタリングされた行数を示しています。フィルタリングされた行数が多いほど、JRFの効果が高いことを示します。

2. 10行目のIsPushDown = trueは、JRF計算がストレージ層にプッシュダウンされていることを示しており、遅延マテリアライゼーションによってIOの削減に役立ちます。

3. ScanノードがJRFを適用したかどうかを示す10行目のRuntimeFilterState = READY。JRFはtry-bestメカニズムを使用しているため、JRF生成に時間がかかりすぎる場合、Scanノードは待機期間後にデータのスキャンを開始し、フィルタリングされていないデータを出力する可能性があります。

4. 12行目のBloomFilterSize: 1024は、Bloom Filterのサイズをバイト単位で表示しています。

チューニング

Join Runtime Filterのチューニングについて、ほとんどの場合、この機能は適応的であり、ユーザーが手動でチューニングする必要はありません。ただし、パフォーマンスを最適化するためにいくつかの調整を行うことができます。

1. JRFの有効化または無効化

セッション変数runtime_filter_modeは、JRFを生成するかどうかを制御します。

• JRFを有効にする場合: set runtime_filter_mode = GLOBAL

• JRFを無効にする場合: set runtime_filter_mode = OFF

2. JRFタイプの設定

セッション変数runtime_filter_typeは、JRFのタイプを制御し、以下が含まれます:

• IN(1)

• BLOOM(2)

• MIN_MAX(4)

• IN_OR_BLOOM(8)

IN_OR_BLOOM Filterは、実際のデータの行数に基づいてIN FilterまたはBLOOM Filterの生成をBEが適応的に選択することを可能にします。

runtime_filter_typeを対応する列挙値の合計に設定することで、単一のJoin条件に対して複数のJRFタイプを生成できます。

例えば:

• 各Join条件に対してBLOOM FilterとMIN_MAX Filterの両方を生成する場合: set runtime_filter_type = 6

• バージョン2.1では、runtime_filter_typeのデフォルト値は12で、MIN_MAX FilterとIN_OR_BLOOM Filterの両方を生成します。

括弧内の整数は、Runtime Filter Typesの列挙値を表しています。

3. 待機時間の設定

前述したように、JRFはTry-bestメカニズムを使用し、ScanノードはJRFを待ってから開始します。Dorisは実行時条件に基づいて待機時間を計算します。ただし、場合によっては、計算された待機時間が十分でなく、JRFが完全に効果的でない結果となり、Scanノードが予想以上の行を出力する可能性があります。Profileセクションで説明したように、ScanノードのProfileでRuntimeFilterState = falseの場合、ユーザーは手動でより長い待機時間を設定できます。

セッション変数runtime_filter_wait_time_msは、ScanノードがJRFを待機する待機時間を制御します。デフォルト値は1000ミリ秒です。

4. JRFのプルーニング

場合によっては、JRFがフィルタリング効果を提供しない場合があります。例えば、ordersとcustomerテーブルに主キー-外部キーの関係がある場合でも、customerテーブルにフィルタリング条件がない場合、JRFへの入力はすべてのcustkeysとなり、ordersテーブルのすべての行がJRFを通過できるようになります。オプティマイザは列統計に基づいて非効率的なJRFをプルーニングします。

セッション変数enable_runtime_filter_prune = true/falseは、プルーニングを実行するかどうかを制御します。デフォルト値はtrueです。

TopN Runtime Filter

原理

Dorisでは、データはブロックストリーミング方式で処理されます。したがって、SQL文にtopN演算子が含まれる場合、Dorisはすべての結果を計算するのではなく、代わりに動的フィルタを生成してデータを早期に事前フィルタリングします。

以下のSQL文を例として考えてみましょう:

select o_orderkey from orders order by o_orderdate limit 5;

このSQL文の実行プランを以下に示します：

mysql> explain select o_orderkey from orders order by o_orderdate limit 5;
+-----------------------------------------------------+
| Explain String(Nereids Planner)                     |
+-----------------------------------------------------+
| PLAN FRAGMENT 0                                     |
|   OUTPUT EXPRS:                                     |
|     o_orderkey[#11]                                 |
|   PARTITION: UNPARTITIONED                          |
|                                                     |
|   HAS_COLO_PLAN_NODE: false                         |
|                                                     |
|   VRESULT SINK                                      |
|      MYSQL_PROTOCAL                                 |
|                                                     |
|   2:VMERGING-EXCHANGE                               |
|      offset: 0                                      |
|      limit: 5                                       |
|      final projections: o_orderkey[#9]              |
|      final project output tuple id: 2               |
|      distribute expr lists:                         |
|                                                     |
| PLAN FRAGMENT 1                                     |
|                                                     |
|   PARTITION: HASH_PARTITIONED: O_ORDERKEY[#0]       |
|                                                     |
|   HAS_COLO_PLAN_NODE: false                         |
|                                                     |
|   STREAM DATA SINK                                  |
|     EXCHANGE ID: 02                                 |
|     UNPARTITIONED                                   |
|                                                     |
|   1:VTOP-N(119)                                     |
|   |  order by: o_orderdate[#10] ASC                 |
|   |  TOPN OPT                                       |
|   |  offset: 0                                      |
|   |  limit: 5                                       |
|   |  distribute expr lists: O_ORDERKEY[#0]          |
|   |                                                 |
|   0:VOlapScanNode(113)                              |
|      TABLE: tpch.orders(orders), PREAGGREGATION: ON |
|      TOPN OPT:1                                     |
|      partitions=1/1 (orders)                        |
|      tablets=3/3, tabletList=135112,135114,135116   |
|      cardinality=150000, avgRowSize=0.0, numNodes=1 |
|      pushAggOp=NONE                                 |
+-----------------------------------------------------+
41 rows in set (0.06 sec)

topn filterがなければ、scan nodeはordersテーブルから各データブロックを順次読み取り、TopN nodeに渡します。TopN nodeはヒープソートを通じてordersテーブルから現在のトップ5行を維持します。

データブロックは通常約1024行を含むため、TopN nodeは最初のデータブロックを処理した後、そのブロック内で5位の行を特定できます。

このo_orderdateが1995-01-01であると仮定すると、scan nodeは2番目のデータブロックを出力する際に1995-01-01をフィルタ条件として使用でき、o_orderdateが1995-01-01より大きい行をTopN nodeに送信してさらに処理する必要がなくなります。

この閾値は動的に更新されます。例えば、TopN nodeが2番目のフィルタリングされたデータブロックを処理する際により小さいo_orderdateを発見した場合、最初の2つのデータブロックの中で5位のo_orderdateに閾値を更新します。

TopN Runtime Filterの表示

Explainコマンドを使用して、オプティマイザによって計画されたTopN Runtime Filterを確認できます。

1:VTOP-N(119)
| order by: o_orderdate[#10] ASC  
| TOPN OPT  
| offset: 0
| limit: 5  
| distribute expr lists: O_ORDERKEY[#0]  
|
 
0:VLapScanNode[113]  
    TABLE: regression_test_nereids_tpch_p0.(orders), PREAGGREGATION: ON  
    TOPN OPT: 1  
    partitions=1/1 (orders)  
    tablets=3/3, tabletList=135112,135114,135116  
    cardinality=150000, avgRowSize=0.0, numNodes=1  
    pushAggOp: NONE

上記の例に示すように：

1. TopNノードはTOPN OPTを表示し、このTopNノードがTopN Runtime Filterを生成することを示しています。

2. ScanノードはどのTopNノードが使用するTopN Runtime Filterを生成するかを示します。例えば、この例では、11行目でordersテーブルのScanノードがTopNノード1によって生成されたRuntime Filterを使用することを示しており、プランではTOPN OPT: 1として表示されます。

分散データベースとして、DorisはTopNノードとScanノードが実際に動作する物理マシンを考慮します。BE間通信のコストが高いため、BEはTopN Runtime Filterを使用するかどうか、またどの程度使用するかを適応的に決定します。現在、TopNとScanが同じBE上に存在するBEレベルのTopN Runtime Filterを実装しています。これは、TopN Runtime Filterの閾値の更新にはスレッド間通信のみが必要で、比較的コストが低いためです。

チューニング

セッション変数topn_filter_ratioはTopN Runtime Filterの生成を制御します。

SQLのlimit句で指定される行数が少ないほど、TopN Runtime Filterのフィルタリング効果は強くなります。そのため、デフォルトでは、Dorisはlimitの数がテーブル内のデータの半分未満の場合にのみ、対応するTopN Runtime Filterの生成を有効にします。

例えば、set topn_filter_ratio=0を設定すると、以下のクエリに対してTopN Runtime Filterの生成を防ぐことができます：

select o_orderkey from orders order by o_orderdate limit 20;