xinyiZzz commented on a change in pull request #6154:
URL: https://github.com/apache/incubator-doris/pull/6154#discussion_r666701593
##########
File path: docs/en/administrator-guide/runtime-filter.md
##########
@@ -0,0 +1,225 @@
+---
+{
+ "title": "Runtime Filter",
+ "language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Runtime Filter
+Runtime Filter is a new feature officially added in Doris 0.15. It is designed
to dynamically generate filter conditions for certain Join queries at runtime
to reduce the amount of scanned data, avoid unnecessary I/O and network
transmission, and speed up the query.
+
+It's design, implementation and effects, please refer to [ISSUE
6116](https://github.com/apache/incubator-doris/issues/6116).
+
+## Noun Interpretation
+* FE: Frontend, the front-end node of Doris. Responsible for metadata
management and request access.
+* BE: Backend, the back-end node of Doris. Responsible for query execution and
data storage.
+* Left table: the table on the left during Join query. Perform Probe
operation. The order can be adjusted by Join Reorder.
+* Right table: the table on the right during Join query. Perform the Build
operation. The order can be adjusted by Join Reorder.
+* Fragment: FE will convert the execution of specific SQL statements into
corresponding fragments and send them to BE for execution. The corresponding
Fragment is executed on the BE, and the results are aggregated and returned to
the FE.
+* Join on clause: `Aa=Bb` in `A join B on Aa=Bb`, based on this to generate
join conjuncts during query planning, including expr used by join Build and
Probe, where Build expr is called in Runtime Filter src expr, Probe expr are
called target expr in Runtime Filter.
+
+## Principle
+Runtime Filter is generated during query planning, constructed in
HashJoinNode, and applied in ScanNode.
+
+For example, there is currently a Join query between the T1 table and the T2
table. Its Join mode is HashJoin. T1 is a fact table with 100,000 rows of data.
T2 is a dimension table with 100 rows of data. Doris join The actual situation
is:
+```
Review comment:
Modified, thks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
