Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.hazelcast.jet.sql.impl.JetPlan Maven / Gradle / Ivy
/*
* 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;
import com.hazelcast.jet.config.JobConfig;
import com.hazelcast.jet.core.DAG;
import com.hazelcast.jet.core.Vertex;
import com.hazelcast.jet.sql.impl.connector.keyvalue.KvRowProjector;
import com.hazelcast.jet.sql.impl.connector.map.UpdatingEntryProcessor;
import com.hazelcast.jet.sql.impl.parse.SqlAlterJob.AlterJobOperation;
import com.hazelcast.jet.sql.impl.parse.SqlShowStatement.ShowStatementTarget;
import com.hazelcast.security.permission.MapPermission;
import com.hazelcast.security.permission.SqlPermission;
import com.hazelcast.sql.SqlResult;
import com.hazelcast.sql.SqlRowMetadata;
import com.hazelcast.sql.impl.QueryException;
import com.hazelcast.sql.impl.QueryId;
import com.hazelcast.sql.impl.QueryParameterMetadata;
import com.hazelcast.sql.impl.expression.Expression;
import com.hazelcast.sql.impl.expression.ExpressionEvalContext;
import com.hazelcast.sql.impl.optimizer.PlanCheckContext;
import com.hazelcast.sql.impl.optimizer.PlanKey;
import com.hazelcast.sql.impl.optimizer.PlanObjectKey;
import com.hazelcast.sql.impl.optimizer.SqlPlan;
import com.hazelcast.sql.impl.schema.Mapping;
import com.hazelcast.sql.impl.security.SqlSecurityContext;
import com.hazelcast.org.apache.calcite.rel.core.TableModify;
import com.hazelcast.org.apache.calcite.rel.core.TableModify.Operation;
import java.security.Permission;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.function.Function;
import static com.hazelcast.security.permission.ActionConstants.ACTION_CREATE;
import static com.hazelcast.security.permission.ActionConstants.ACTION_DESTROY;
import static com.hazelcast.security.permission.ActionConstants.ACTION_PUT;
import static com.hazelcast.security.permission.ActionConstants.ACTION_READ;
import static com.hazelcast.security.permission.ActionConstants.ACTION_REMOVE;
abstract class JetPlan extends SqlPlan {
protected JetPlan(PlanKey planKey) {
super(planKey);
}
protected void checkPermissions(SqlSecurityContext context, DAG dag) {
if (!context.isSecurityEnabled()) {
return;
}
for (Vertex vertex : dag) {
Permission permission = vertex.getMetaSupplier().getRequiredPermission();
if (permission != null) {
context.checkPermission(permission);
}
}
}
@Override
public void checkPermissions(SqlSecurityContext context) {
}
static class CreateMappingPlan extends JetPlan {
private final Mapping mapping;
private final boolean replace;
private final boolean ifNotExists;
private final JetPlanExecutor planExecutor;
CreateMappingPlan(
PlanKey planKey,
Mapping mapping,
boolean replace,
boolean ifNotExists,
JetPlanExecutor planExecutor
) {
super(planKey);
this.mapping = mapping;
this.replace = replace;
this.ifNotExists = ifNotExists;
this.planExecutor = planExecutor;
}
Mapping mapping() {
return mapping;
}
boolean replace() {
return replace;
}
boolean ifNotExists() {
return ifNotExists;
}
@Override
public boolean isCacheable() {
return false;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return true;
}
@Override
public void checkPermissions(SqlSecurityContext context) {
context.checkPermission(new SqlPermission(mapping.name(), ACTION_CREATE));
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
JetPlan.ensureNoArguments("CREATE MAPPING", arguments);
JetPlan.ensureNoTimeout("CREATE MAPPING", timeout);
return planExecutor.execute(this);
}
}
static class DropMappingPlan extends JetPlan {
private final String name;
private final boolean ifExists;
private final JetPlanExecutor planExecutor;
DropMappingPlan(
PlanKey planKey,
String name,
boolean ifExists,
JetPlanExecutor planExecutor
) {
super(planKey);
this.name = name;
this.ifExists = ifExists;
this.planExecutor = planExecutor;
}
String name() {
return name;
}
boolean ifExists() {
return ifExists;
}
@Override
public boolean isCacheable() {
return false;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return true;
}
@Override
public void checkPermissions(SqlSecurityContext context) {
context.checkPermission(new SqlPermission(name, ACTION_DESTROY));
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
JetPlan.ensureNoArguments("DROP MAPPING", arguments);
JetPlan.ensureNoTimeout("DROP MAPPING", timeout);
return planExecutor.execute(this);
}
}
static class CreateJobPlan extends JetPlan {
private final JobConfig jobConfig;
private final boolean ifNotExists;
private final DmlPlan dmlPlan;
private final JetPlanExecutor planExecutor;
CreateJobPlan(
PlanKey planKey,
JobConfig jobConfig,
boolean ifNotExists,
DmlPlan dmlPlan,
JetPlanExecutor planExecutor
) {
super(planKey);
assert dmlPlan.operation == Operation.INSERT : dmlPlan.operation;
this.jobConfig = jobConfig;
this.ifNotExists = ifNotExists;
this.dmlPlan = dmlPlan;
this.planExecutor = planExecutor;
}
JobConfig getJobConfig() {
return jobConfig;
}
boolean isIfNotExists() {
return ifNotExists;
}
DmlPlan getExecutionPlan() {
return dmlPlan;
}
QueryParameterMetadata getParameterMetadata() {
return dmlPlan.getParameterMetadata();
}
@Override
public boolean isCacheable() {
return dmlPlan.isCacheable();
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return dmlPlan.isPlanValid(context);
}
@Override
public void checkPermissions(SqlSecurityContext context) {
dmlPlan.checkPermissions(context);
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
JetPlan.ensureNoTimeout("CREATE JOB", timeout);
return planExecutor.execute(this, arguments);
}
}
static class AlterJobPlan extends JetPlan {
private final String jobName;
private final AlterJobOperation operation;
private final JetPlanExecutor planExecutor;
AlterJobPlan(
PlanKey planKey,
String jobName,
AlterJobOperation operation,
JetPlanExecutor planExecutor
) {
super(planKey);
this.jobName = jobName;
this.operation = operation;
this.planExecutor = planExecutor;
}
String getJobName() {
return jobName;
}
AlterJobOperation getOperation() {
return operation;
}
@Override
public boolean isCacheable() {
return false;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return true;
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
JetPlan.ensureNoArguments("ALTER JOB", arguments);
JetPlan.ensureNoTimeout("ALTER JOB", timeout);
return planExecutor.execute(this);
}
}
static class DropJobPlan extends JetPlan {
private final String jobName;
private final boolean ifExists;
private final String withSnapshotName;
private final JetPlanExecutor planExecutor;
DropJobPlan(
PlanKey planKey,
String jobName,
boolean ifExists,
String withSnapshotName,
JetPlanExecutor planExecutor
) {
super(planKey);
this.jobName = jobName;
this.ifExists = ifExists;
this.withSnapshotName = withSnapshotName;
this.planExecutor = planExecutor;
}
String getJobName() {
return jobName;
}
boolean isIfExists() {
return ifExists;
}
String getWithSnapshotName() {
return withSnapshotName;
}
@Override
public boolean isCacheable() {
return false;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return true;
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
JetPlan.ensureNoArguments("DROP JOB", arguments);
JetPlan.ensureNoTimeout("DROP JOB", timeout);
return planExecutor.execute(this);
}
}
static class CreateSnapshotPlan extends JetPlan {
private final String snapshotName;
private final String jobName;
private final JetPlanExecutor planExecutor;
CreateSnapshotPlan(
PlanKey planKey,
String snapshotName,
String jobName,
JetPlanExecutor planExecutor
) {
super(planKey);
this.snapshotName = snapshotName;
this.jobName = jobName;
this.planExecutor = planExecutor;
}
String getSnapshotName() {
return snapshotName;
}
String getJobName() {
return jobName;
}
@Override
public boolean isCacheable() {
return false;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return true;
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
JetPlan.ensureNoArguments("CREATE SNAPSHOT", arguments);
JetPlan.ensureNoTimeout("CREATE SNAPSHOT", timeout);
return planExecutor.execute(this);
}
}
static class DropSnapshotPlan extends JetPlan {
private final String snapshotName;
private final boolean ifExists;
private final JetPlanExecutor planExecutor;
DropSnapshotPlan(
PlanKey planKey,
String snapshotName,
boolean ifExists,
JetPlanExecutor planExecutor
) {
super(planKey);
this.snapshotName = snapshotName;
this.ifExists = ifExists;
this.planExecutor = planExecutor;
}
String getSnapshotName() {
return snapshotName;
}
boolean isIfExists() {
return ifExists;
}
@Override
public boolean isCacheable() {
return false;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return true;
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
JetPlan.ensureNoArguments("DROP SNAPSHOT", arguments);
JetPlan.ensureNoTimeout("DROP SNAPSHOT", timeout);
return planExecutor.execute(this);
}
}
static class ShowStatementPlan extends JetPlan {
private final ShowStatementTarget showTarget;
private final JetPlanExecutor planExecutor;
ShowStatementPlan(
PlanKey planKey,
ShowStatementTarget showTarget,
JetPlanExecutor planExecutor
) {
super(planKey);
this.showTarget = showTarget;
this.planExecutor = planExecutor;
}
ShowStatementTarget getShowTarget() {
return showTarget;
}
@Override
public boolean isCacheable() {
return false;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return true;
}
@Override
public boolean producesRows() {
return true;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
JetPlan.ensureNoArguments("SHOW " + showTarget, arguments);
JetPlan.ensureNoTimeout("SHOW " + showTarget, timeout);
return planExecutor.execute(this);
}
}
static class SelectPlan extends JetPlan {
private final Set objectKeys;
private final QueryParameterMetadata parameterMetadata;
private final DAG dag;
private final boolean isStreaming;
private final SqlRowMetadata rowMetadata;
private final JetPlanExecutor planExecutor;
private final List permissions;
SelectPlan(
PlanKey planKey,
QueryParameterMetadata parameterMetadata,
Set objectKeys,
DAG dag,
boolean isStreaming,
SqlRowMetadata rowMetadata,
JetPlanExecutor planExecutor,
List permissions
) {
super(planKey);
this.objectKeys = objectKeys;
this.parameterMetadata = parameterMetadata;
this.dag = dag;
this.isStreaming = isStreaming;
this.rowMetadata = rowMetadata;
this.planExecutor = planExecutor;
this.permissions = permissions;
}
QueryParameterMetadata getParameterMetadata() {
return parameterMetadata;
}
DAG getDag() {
return dag;
}
boolean isStreaming() {
return isStreaming;
}
SqlRowMetadata getRowMetadata() {
return rowMetadata;
}
@Override
public boolean isCacheable() {
return !objectKeys.contains(PlanObjectKey.NON_CACHEABLE_OBJECT_KEY);
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return context.isValid(objectKeys);
}
@Override
public void checkPermissions(SqlSecurityContext context) {
checkPermissions(context, dag);
permissions.forEach(context::checkPermission);
}
@Override
public boolean producesRows() {
return true;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
return planExecutor.execute(this, queryId, arguments, timeout);
}
}
static class DmlPlan extends JetPlan {
private final TableModify.Operation operation;
private final Set objectKeys;
private final QueryParameterMetadata parameterMetadata;
private final DAG dag;
private final JetPlanExecutor planExecutor;
private final List permissions;
DmlPlan(
TableModify.Operation operation,
PlanKey planKey,
QueryParameterMetadata parameterMetadata,
Set objectKeys,
DAG dag,
JetPlanExecutor planExecutor,
List permissions
) {
super(planKey);
this.operation = operation;
this.objectKeys = objectKeys;
this.parameterMetadata = parameterMetadata;
this.dag = dag;
this.planExecutor = planExecutor;
this.permissions = permissions;
}
Operation getOperation() {
return operation;
}
QueryParameterMetadata getParameterMetadata() {
return parameterMetadata;
}
DAG getDag() {
return dag;
}
@Override
public boolean isCacheable() {
return !objectKeys.contains(PlanObjectKey.NON_CACHEABLE_OBJECT_KEY);
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return context.isValid(objectKeys);
}
@Override
public void checkPermissions(SqlSecurityContext context) {
checkPermissions(context, dag);
permissions.forEach(context::checkPermission);
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
return planExecutor.execute(this, queryId, arguments, timeout);
}
}
static class IMapSelectPlan extends JetPlan {
private final Set objectKeys;
private final QueryParameterMetadata parameterMetadata;
private final String mapName;
private final Expression keyCondition;
private final KvRowProjector.Supplier rowProjectorSupplier;
private final SqlRowMetadata rowMetadata;
private final JetPlanExecutor planExecutor;
private final List permissions;
IMapSelectPlan(
PlanKey planKey,
PlanObjectKey objectKey,
QueryParameterMetadata parameterMetadata,
String mapName,
Expression keyCondition,
KvRowProjector.Supplier rowProjectorSupplier,
SqlRowMetadata rowMetadata,
JetPlanExecutor planExecutor,
List permissions
) {
super(planKey);
this.objectKeys = Collections.singleton(objectKey);
this.parameterMetadata = parameterMetadata;
this.mapName = mapName;
this.keyCondition = keyCondition;
this.rowProjectorSupplier = rowProjectorSupplier;
this.rowMetadata = rowMetadata;
this.planExecutor = planExecutor;
this.permissions = permissions;
}
QueryParameterMetadata parameterMetadata() {
return parameterMetadata;
}
String mapName() {
return mapName;
}
Expression keyCondition() {
return keyCondition;
}
KvRowProjector.Supplier rowProjectorSupplier() {
return rowProjectorSupplier;
}
SqlRowMetadata rowMetadata() {
return rowMetadata;
}
@Override
public boolean isCacheable() {
return true;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return context.isValid(objectKeys);
}
@Override
public void checkPermissions(SqlSecurityContext context) {
context.checkPermission(new MapPermission(mapName, ACTION_CREATE, ACTION_READ));
permissions.forEach(context::checkPermission);
}
@Override
public boolean producesRows() {
return true;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
return planExecutor.execute(this, queryId, arguments, timeout);
}
}
static class IMapInsertPlan extends JetPlan {
private final Set objectKeys;
private final QueryParameterMetadata parameterMetadata;
private final String mapName;
private final Function>> entriesFn;
private final JetPlanExecutor planExecutor;
private final List permissions;
IMapInsertPlan(
PlanKey planKey,
PlanObjectKey objectKey,
QueryParameterMetadata parameterMetadata,
String mapName,
Function>> entriesFn,
JetPlanExecutor planExecutor,
List permissions
) {
super(planKey);
this.objectKeys = Collections.singleton(objectKey);
this.parameterMetadata = parameterMetadata;
this.mapName = mapName;
this.entriesFn = entriesFn;
this.planExecutor = planExecutor;
this.permissions = permissions;
}
QueryParameterMetadata parameterMetadata() {
return parameterMetadata;
}
String mapName() {
return mapName;
}
Function>> entriesFn() {
return entriesFn;
}
@Override
public boolean isCacheable() {
return true;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return context.isValid(objectKeys);
}
@Override
public void checkPermissions(SqlSecurityContext context) {
context.checkPermission(new MapPermission(mapName, ACTION_CREATE, ACTION_PUT));
permissions.forEach(context::checkPermission);
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
return planExecutor.execute(this, arguments, timeout);
}
}
static class IMapSinkPlan extends JetPlan {
private final Set objectKeys;
private final QueryParameterMetadata parameterMetadata;
private final String mapName;
private final Function> entriesFn;
private final JetPlanExecutor planExecutor;
private final List permissions;
IMapSinkPlan(
PlanKey planKey,
PlanObjectKey objectKey,
QueryParameterMetadata parameterMetadata,
String mapName,
Function> entriesFn,
JetPlanExecutor planExecutor,
List permissions
) {
super(planKey);
this.objectKeys = Collections.singleton(objectKey);
this.parameterMetadata = parameterMetadata;
this.mapName = mapName;
this.entriesFn = entriesFn;
this.planExecutor = planExecutor;
this.permissions = permissions;
}
QueryParameterMetadata parameterMetadata() {
return parameterMetadata;
}
String mapName() {
return mapName;
}
Function> entriesFn() {
return entriesFn;
}
@Override
public boolean isCacheable() {
return true;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return context.isValid(objectKeys);
}
@Override
public void checkPermissions(SqlSecurityContext context) {
context.checkPermission(new MapPermission(mapName, ACTION_CREATE, ACTION_PUT, ACTION_REMOVE));
permissions.forEach(context::checkPermission);
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
return planExecutor.execute(this, arguments, timeout);
}
}
static class IMapUpdatePlan extends JetPlan {
private final Set objectKeys;
private final QueryParameterMetadata parameterMetadata;
private final String mapName;
private final Expression keyCondition;
private final UpdatingEntryProcessor.Supplier updaterSupplier;
private final JetPlanExecutor planExecutor;
private final List permissions;
IMapUpdatePlan(
PlanKey planKey,
PlanObjectKey objectKey,
QueryParameterMetadata parameterMetadata,
String mapName,
Expression keyCondition,
UpdatingEntryProcessor.Supplier updaterSupplier,
JetPlanExecutor planExecutor,
List permissions
) {
super(planKey);
this.objectKeys = Collections.singleton(objectKey);
this.parameterMetadata = parameterMetadata;
this.mapName = mapName;
this.keyCondition = keyCondition;
this.updaterSupplier = updaterSupplier;
this.planExecutor = planExecutor;
this.permissions = permissions;
}
QueryParameterMetadata parameterMetadata() {
return parameterMetadata;
}
String mapName() {
return mapName;
}
Expression keyCondition() {
return keyCondition;
}
UpdatingEntryProcessor.Supplier updaterSupplier() {
return updaterSupplier;
}
@Override
public boolean isCacheable() {
return true;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return context.isValid(objectKeys);
}
@Override
public void checkPermissions(SqlSecurityContext context) {
// We are checking ACTION_CREATE and ACTION_READ permissions to align with DmlPlan.
context.checkPermission(new MapPermission(mapName, ACTION_CREATE, ACTION_READ, ACTION_PUT, ACTION_REMOVE));
permissions.forEach(context::checkPermission);
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
return planExecutor.execute(this, arguments, timeout);
}
}
static class IMapDeletePlan extends JetPlan {
private final Set objectKeys;
private final QueryParameterMetadata parameterMetadata;
private final String mapName;
private final Expression keyCondition;
private final JetPlanExecutor planExecutor;
private final List permissions;
IMapDeletePlan(
PlanKey planKey,
PlanObjectKey objectKey,
QueryParameterMetadata parameterMetadata,
String mapName,
Expression keyCondition,
JetPlanExecutor planExecutor,
List permissions
) {
super(planKey);
this.objectKeys = Collections.singleton(objectKey);
this.parameterMetadata = parameterMetadata;
this.mapName = mapName;
this.keyCondition = keyCondition;
this.planExecutor = planExecutor;
this.permissions = permissions;
}
QueryParameterMetadata parameterMetadata() {
return parameterMetadata;
}
String mapName() {
return mapName;
}
Expression keyCondition() {
return keyCondition;
}
@Override
public boolean isCacheable() {
return true;
}
@Override
public boolean isPlanValid(PlanCheckContext context) {
return context.isValid(objectKeys);
}
@Override
public void checkPermissions(SqlSecurityContext context) {
// We are checking ACTION_CREATE and ACTION_READ permissions to align with DmlPlan.
context.checkPermission(new MapPermission(mapName, ACTION_CREATE, ACTION_READ, ACTION_PUT, ACTION_REMOVE));
permissions.forEach(context::checkPermission);
}
@Override
public boolean producesRows() {
return false;
}
@Override
public SqlResult execute(QueryId queryId, List arguments, long timeout) {
return planExecutor.execute(this, arguments, timeout);
}
}
private static void ensureNoArguments(String name, List arguments) {
if (!arguments.isEmpty()) {
throw QueryException.error(name + " does not support dynamic parameters");
}
}
private static void ensureNoTimeout(String name, long timeout) {
if (timeout > 0) {
throw QueryException.error(name + " does not support timeout");
}
}
}
