com.arcadedb.query.sql.SQLScriptQueryEngine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arcadedb-engine Show documentation
There is a newer version: 24.11.1
/*
 * Copyright © 2021-present Arcade Data Ltd ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-FileCopyrightText: 2021-present Arcade Data Ltd ([email protected])
 * SPDX-License-Identifier: Apache-2.0
 */
package com.arcadedb.query.sql;

import com.arcadedb.ContextConfiguration;
import com.arcadedb.database.DatabaseInternal;
import com.arcadedb.exception.CommandExecutionException;
import com.arcadedb.exception.CommandSQLParsingException;
import com.arcadedb.query.QueryEngine;
import com.arcadedb.query.sql.executor.BasicCommandContext;
import com.arcadedb.query.sql.executor.CommandContext;
import com.arcadedb.query.sql.executor.InternalExecutionPlan;
import com.arcadedb.query.sql.executor.ResultSet;
import com.arcadedb.query.sql.executor.RetryExecutionPlan;
import com.arcadedb.query.sql.executor.RetryStep;
import com.arcadedb.query.sql.executor.ScriptExecutionPlan;
import com.arcadedb.query.sql.parser.BeginStatement;
import com.arcadedb.query.sql.parser.CommitStatement;
import com.arcadedb.query.sql.parser.LetStatement;
import com.arcadedb.query.sql.parser.Limit;
import com.arcadedb.query.sql.parser.LocalResultSet;
import com.arcadedb.query.sql.parser.ParseException;
import com.arcadedb.query.sql.parser.SqlParser;
import com.arcadedb.query.sql.parser.Statement;

import java.util.*;

import static com.arcadedb.query.sql.parser.SqlParserTreeConstants.JJTLIMIT;

public class SQLScriptQueryEngine extends SQLQueryEngine {
  public static final String ENGINE_NAME = "sqlscript";

  public static class SQLScriptQueryEngineFactory implements QueryEngineFactory {
    @Override
    public String getLanguage() {
      return ENGINE_NAME;
    }

    @Override
    public QueryEngine getInstance(final DatabaseInternal database) {
      return new SQLScriptQueryEngine(database);
    }
  }

  protected SQLScriptQueryEngine(final DatabaseInternal database) {
    super(database);
  }

  @Override
  public String getLanguage() {
    return ENGINE_NAME;
  }

  @Override
  public ResultSet query(final String query, ContextConfiguration configuration, final Map parameters) {
    final List statements = parseScript(query, database);
    statements.stream().map((statement) -> {
      if (statement.isIdempotent())
        throw new IllegalArgumentException("Query '" + query + "' is not idempotent");
      return null;
    });

    final BasicCommandContext context = new BasicCommandContext();
    context.setDatabase(database.getWrappedDatabaseInstance());
    context.setInputParameters(parameters);
    return executeInternal(statements, context);
  }

  @Override
  public ResultSet query(final String query, ContextConfiguration configuration, final Object... parameters) {
    final List statements = parseScript(query, database);
    statements.stream().map((statement) -> {
      if (statement.isIdempotent())
        throw new IllegalArgumentException("Query '" + query + "' is not idempotent");
      return null;
    });

    final BasicCommandContext context = new BasicCommandContext();
    context.setDatabase(database.getWrappedDatabaseInstance());
    context.setInputParameters(parameters);
    return executeInternal(statements, context);
  }

  @Override
  public ResultSet command(final String query, ContextConfiguration configuration, final Map parameters) {
    final List statements = parseScript(query, database.getWrappedDatabaseInstance());

    final BasicCommandContext context = new BasicCommandContext();
    context.setConfiguration(configuration);
    context.setDatabase(database.getWrappedDatabaseInstance());
    context.setInputParameters(parameters);
    return executeInternal(statements, context);
  }

  @Override
  public ResultSet command(final String query, ContextConfiguration configuration, final Object... parameters) {
    final List statements = parseScript(query, database.getWrappedDatabaseInstance());

    final BasicCommandContext context = new BasicCommandContext();
    context.setConfiguration(configuration);
    context.setDatabase(database.getWrappedDatabaseInstance());
    context.setInputParameters(parameters);
    return executeInternal(statements, context);
  }

  @Override
  public AnalyzedQuery analyze(final String query) {
    final List statements = parseScript(query, database);
    return new AnalyzedQuery() {
      @Override
      public boolean isIdempotent() {
        for (Statement s : statements)
          if (!s.isIdempotent())
            return false;
        return true;
      }

      @Override
      public boolean isDDL() {
        for (Statement s : statements)
          if (s.isDDL())
            return true;
        return false;
      }
    };
  }

  public static List parseScript(final String script, final DatabaseInternal database) {
    try {
      final SqlParser parser = new SqlParser(database, addSemicolon(script));
      return parser.ParseScript();
    } catch (final ParseException e) {
      throw new CommandSQLParsingException(e).setCommand(script);
    }
  }

  private static String addSemicolon(final String parserText) {
    if (!parserText.endsWith(";"))
      return parserText + ";";
    return parserText;
  }

  @Override
  public boolean isExecutedByTheLeader() {
    // REPLICATE THE SCRIPT TO THE LEADER
    return true;
  }

  private ResultSet executeInternal(final List statements, final CommandContext scriptContext) {
    final ScriptExecutionPlan plan = new ScriptExecutionPlan(scriptContext);

    plan.setStatements(statements);

    List lastRetryBlock = new ArrayList<>();
    int nestedTxLevel = 0;

    for (final Statement stm : statements) {
      stm.setOriginalStatement(stm);
      stm.setLimit(new Limit(JJTLIMIT).setValue((int) database.getResultSetLimit()));

      if (stm instanceof BeginStatement)
        nestedTxLevel++;

      if (nestedTxLevel <= 0) {
        final InternalExecutionPlan sub = stm.createExecutionPlan(scriptContext);
        plan.chain(sub, false);
      } else
        lastRetryBlock.add(stm);

      if (stm instanceof CommitStatement) {
        if (nestedTxLevel > 0) {
          nestedTxLevel--;
          if (nestedTxLevel == 0) {

            if (((CommitStatement) stm).getRetry() != null) {
              int nRetries = ((CommitStatement) stm).getRetry().getValue().intValue();
              if (nRetries <= 0)
                throw new CommandExecutionException("Invalid retry number " + nRetries);

              final RetryStep step = new RetryStep(lastRetryBlock, nRetries, ((CommitStatement) stm).getElseStatements(), ((CommitStatement) stm).getElseFail(),
                  scriptContext, false);
              final RetryExecutionPlan retryPlan = new RetryExecutionPlan(scriptContext);
              retryPlan.chain(step);
              plan.chain(retryPlan, false);
              lastRetryBlock = new ArrayList<>();
            } else {
              for (final Statement statement : lastRetryBlock) {
                final InternalExecutionPlan sub = statement.createExecutionPlan(scriptContext);
                plan.chain(sub, false);
              }
            }
          }
        } else
          throw new CommandSQLParsingException("Found COMMIT statement without a BEGIN");
      }

      if (stm instanceof LetStatement)
        scriptContext.declareScriptVariable(((LetStatement) stm).getName().getStringValue());
    }

    return new LocalResultSet(plan);
  }
}