Uploaded image for project: 'Calcite'
  1. Calcite
  2. CALCITE-3262

Refine doc of SubstitutionVisitor.java

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.21.0
    • Component/s: core

      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

       * {@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>
      

        Attachments

          Activity

            People

            • Assignee:
              jinxing6042@126.com Jin Xing
              Reporter:
              jinxing6042@126.com Jin Xing
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 0.5h
                0.5h