com.hazelcast.jet.sql.impl.opt.logical.UpdateByKeyMapLogicalRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hazelcast-sql Show documentation
SQL Parser and Optimizer
There is a newer version: 5.5.0
/*
 * Copyright 2021 Hazelcast Inc.
 *
 * Licensed under the Hazelcast Community License (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://hazelcast.com/hazelcast-community-license
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hazelcast.jet.sql.impl.opt.logical;

import com.hazelcast.jet.sql.impl.opt.OptUtils;
import com.hazelcast.sql.impl.schema.map.PartitionedMapTable;
import com.hazelcast.org.apache.calcite.plan.RelOptRule;
import com.hazelcast.org.apache.calcite.plan.RelOptRuleCall;
import com.hazelcast.org.apache.calcite.plan.RelOptTable;
import com.hazelcast.org.apache.calcite.rel.logical.LogicalProject;
import com.hazelcast.org.apache.calcite.rel.logical.LogicalTableModify;
import com.hazelcast.org.apache.calcite.rel.logical.LogicalTableScan;
import com.hazelcast.org.apache.calcite.rex.RexNode;

/**
 * Planner rule that matches single key, constant expression,
 * {@link PartitionedMapTable} UPDATE.
 * For example,
 * UPDATE map SET this = 2 WHERE __key = 1
 * 
 * Such UPDATE is translated to optimized, direct key {@code IMap} operation
 * which does not involve starting any job.
 */
final class UpdateByKeyMapLogicalRule extends RelOptRule {

    static final RelOptRule INSTANCE = new UpdateByKeyMapLogicalRule();

    private UpdateByKeyMapLogicalRule() {
        super(
                operandJ(
                        LogicalTableModify.class, null, modify -> !OptUtils.requiresJob(modify) && modify.isUpdate(),
                        operand(
                                LogicalProject.class,
                                operandJ(
                                        LogicalTableScan.class,
                                        null,
                                        scan -> OptUtils.hasTableType(scan, PartitionedMapTable.class),
                                        none()
                                )
                        )
                ),
                UpdateByKeyMapLogicalRule.class.getSimpleName()
        );
    }

    @Override
    public void onMatch(RelOptRuleCall call) {
        LogicalTableModify update = call.rel(0);
        LogicalTableScan scan = call.rel(2);

        RelOptTable table = scan.getTable();
        RexNode keyCondition = OptUtils.extractKeyConstantExpression(table, update.getCluster().getRexBuilder());
        if (keyCondition != null) {
            UpdateByKeyMapLogicalRel rel = new UpdateByKeyMapLogicalRel(
                    update.getCluster(),
                    OptUtils.toLogicalConvention(update.getTraitSet()),
                    table,
                    keyCondition,
                    update.getUpdateColumnList(),
                    update.getSourceExpressionList()
            );
            call.transformTo(rel);
        }
    }
}