Skip to content

Commit 5c1b0dc

Browse files
committed
add javadoc
Signed-off-by: Lantao Jin <ltjin@amazon.com>
1 parent b97a1b5 commit 5c1b0dc

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

core/src/main/java/org/opensearch/sql/calcite/plan/Scannable.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@
88
import org.apache.calcite.linq4j.Enumerable;
99
import org.checkerframework.checker.nullness.qual.Nullable;
1010

11+
/**
12+
* The customized table scan is implemented in OpenSearch module, to invoke this scan() method in
13+
* core module, we add this interface. Now the only implementation is CalciteEnumerableIndexScan.
14+
* When a RelNode after optimization is a Scannable, we can directly invoke scan() method to get the
15+
* result of the scan instead of codegen and compile via Linq4j expression.
16+
*/
1117
public interface Scannable {
1218

1319
public Enumerable<@Nullable Object> scan();

0 commit comments

Comments
 (0)