[ https://issues.apache.org/jira/browse/CALCITE-3262?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
jin xing updated CALCITE-3262: ------------------------------ Description: Current doc of {{SubstitutionVisitor.java}} says the supported core relational operators are {{@link org.apache.calcite.rel.logical.LogicalTableScan}}, and so on. But with {{convertTableAccess=true}} (https://github.com/apache/calcite/blob/master/core/src/main/java/org/apache/calcite/sql2rel/SqlToRelConverter.java#L5636), it's a {{EnumerableTableScan}} under {{MutableScan}}, which is inconsistent with the doc. And what's more, {{MutableRels}} and {{SubstitutionVisitor}} supporting scope doesn't limit to be org.apache.calcite.rel.logical.LogicalXXX. So I think it might make sense to update/refine the doc to say that the supported core relational operators are {code:java} * {@link org.apache.calcite.rel.core.TableScan}, * {@link org.apache.calcite.rel.core.Filter}, * {@link org.apache.calcite.rel.core.Project}, * {@link org.apache.calcite.rel.core.Join}, * {@link org.apache.calcite.rel.core.Union}, * {@link org.apache.calcite.rel.core.Aggregate}.</p> {code} was: Current doc of {{SubstitutionVisitor.java}} says the supported core relational operators are {{@link org.apache.calcite.rel.logical.LogicalTableScan}}, and so on. But with {{convertTableAccess=true}} (https://github.com/apache/calcite/blob/master/core/src/main/java/org/apache/calcite/sql2rel/SqlToRelConverter.java#L5636), it's a {{EnumerableTableScan}} below {{MutableScan}}, which is inconsistent with the doc. And what's more, {{MutableRels}} and {{SubstitutionVisitor}} supporting scope doesn't limit to be org.apache.calcite.rel.logical.LogicalXXX. So I think it might make sense to update/refine the doc to say that the supported core relational operators are {code:java} * {@link org.apache.calcite.rel.core.TableScan}, * {@link org.apache.calcite.rel.core.Filter}, * {@link org.apache.calcite.rel.core.Project}, * {@link org.apache.calcite.rel.core.Join}, * {@link org.apache.calcite.rel.core.Union}, * {@link org.apache.calcite.rel.core.Aggregate}.</p> {code} > Refine doc of SubstitutionVisitor.java > -------------------------------------- > > Key: CALCITE-3262 > URL: https://issues.apache.org/jira/browse/CALCITE-3262 > Project: Calcite > Issue Type: Improvement > Components: core > Reporter: jin xing > Assignee: jin xing > Priority: Minor > > Current doc of {{SubstitutionVisitor.java}} says the supported core > relational operators are {{@link > org.apache.calcite.rel.logical.LogicalTableScan}}, and so on. > But with {{convertTableAccess=true}} > (https://github.com/apache/calcite/blob/master/core/src/main/java/org/apache/calcite/sql2rel/SqlToRelConverter.java#L5636), > it's a {{EnumerableTableScan}} under {{MutableScan}}, which is inconsistent > with the doc. > And what's more, {{MutableRels}} and {{SubstitutionVisitor}} supporting scope > doesn't limit to be org.apache.calcite.rel.logical.LogicalXXX. > So I think it might make sense to update/refine the doc to say that the > supported core relational operators are > {code:java} > * {@link org.apache.calcite.rel.core.TableScan}, > * {@link org.apache.calcite.rel.core.Filter}, > * {@link org.apache.calcite.rel.core.Project}, > * {@link org.apache.calcite.rel.core.Join}, > * {@link org.apache.calcite.rel.core.Union}, > * {@link org.apache.calcite.rel.core.Aggregate}.</p> > {code} -- This message was sent by Atlassian JIRA (v7.6.14#76016)