AMashenkov commented on code in PR #6533: URL: https://github.com/apache/ignite-3/pull/6533#discussion_r2332710713
########## modules/cli/src/main/java/org/apache/ignite/internal/cli/commands/sql/SqlExecReplCommand.java: ########## @@ -0,0 +1,243 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.ignite.internal.cli.commands.sql; + +import static org.apache.ignite.internal.cli.commands.Options.Constants.JDBC_URL_KEY; +import static org.apache.ignite.internal.cli.commands.Options.Constants.JDBC_URL_OPTION; +import static org.apache.ignite.internal.cli.commands.Options.Constants.JDBC_URL_OPTION_DESC; +import static org.apache.ignite.internal.cli.commands.Options.Constants.PLAIN_OPTION; +import static org.apache.ignite.internal.cli.commands.Options.Constants.PLAIN_OPTION_DESC; +import static org.apache.ignite.internal.cli.commands.Options.Constants.SCRIPT_FILE_OPTION; +import static org.apache.ignite.internal.cli.commands.Options.Constants.SCRIPT_FILE_OPTION_DESC; +import static org.apache.ignite.internal.cli.core.style.AnsiStringSupport.ansi; +import static org.apache.ignite.internal.cli.core.style.AnsiStringSupport.fg; + +import jakarta.inject.Inject; +import java.io.File; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.sql.SQLException; +import java.util.regex.Pattern; +import org.apache.ignite.internal.cli.call.sql.SqlQueryCall; +import org.apache.ignite.internal.cli.commands.BaseCommand; +import org.apache.ignite.internal.cli.commands.sql.help.IgniteSqlCommandCompleter; +import org.apache.ignite.internal.cli.commands.treesitter.highlighter.SqlAttributedStringHighlighter; +import org.apache.ignite.internal.cli.config.CliConfigKeys; +import org.apache.ignite.internal.cli.config.ConfigManagerProvider; +import org.apache.ignite.internal.cli.core.CallExecutionPipelineProvider; +import org.apache.ignite.internal.cli.core.call.CallExecutionPipeline; +import org.apache.ignite.internal.cli.core.call.StringCallInput; +import org.apache.ignite.internal.cli.core.exception.ExceptionHandlers; +import org.apache.ignite.internal.cli.core.exception.ExceptionWriter; +import org.apache.ignite.internal.cli.core.exception.IgniteCliApiException; +import org.apache.ignite.internal.cli.core.exception.IgniteCliException; +import org.apache.ignite.internal.cli.core.exception.handler.ClusterNotInitializedExceptionHandler; +import org.apache.ignite.internal.cli.core.exception.handler.SqlExceptionHandler; +import org.apache.ignite.internal.cli.core.repl.Repl; +import org.apache.ignite.internal.cli.core.repl.Session; +import org.apache.ignite.internal.cli.core.repl.executor.RegistryCommandExecutor; +import org.apache.ignite.internal.cli.core.repl.executor.ReplExecutorProvider; +import org.apache.ignite.internal.cli.core.rest.ApiClientFactory; +import org.apache.ignite.internal.cli.core.style.AnsiStringSupport.Color; +import org.apache.ignite.internal.cli.decorators.SqlQueryResultDecorator; +import org.apache.ignite.internal.cli.sql.SqlManager; +import org.apache.ignite.internal.cli.sql.SqlSchemaProvider; +import org.apache.ignite.internal.util.StringUtils; +import org.apache.ignite.rest.client.api.ClusterManagementApi; +import org.apache.ignite.rest.client.invoker.ApiException; +import org.jline.reader.EOFError; +import org.jline.reader.Highlighter; +import org.jline.reader.LineReader; +import org.jline.reader.ParsedLine; +import org.jline.reader.Parser; +import org.jline.reader.SyntaxError; +import org.jline.reader.impl.DefaultHighlighter; +import org.jline.reader.impl.DefaultParser; +import org.jline.reader.impl.completer.AggregateCompleter; +import org.jline.utils.AttributedString; +import picocli.CommandLine.ArgGroup; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; +import picocli.CommandLine.Parameters; + +/** + * Command for sql execution in REPL mode. + */ +@Command(name = "exec", description = "Executes SQL query") +public class SqlExecReplCommand extends BaseCommand implements Runnable { + @Option(names = JDBC_URL_OPTION, required = true, descriptionKey = JDBC_URL_KEY, description = JDBC_URL_OPTION_DESC) + private String jdbc; + + @Option(names = PLAIN_OPTION, description = PLAIN_OPTION_DESC) + private boolean plain; + + @ArgGroup + private ExecOptions execOptions; + + private static class ExecOptions { + @Parameters(index = "0", description = "SQL query to execute", defaultValue = Option.NULL_VALUE) + private String command; + + @Option(names = SCRIPT_FILE_OPTION, description = SCRIPT_FILE_OPTION_DESC, defaultValue = Option.NULL_VALUE) + private File file; + } + + @Inject + private ReplExecutorProvider replExecutorProvider; + + @Inject + private ConfigManagerProvider configManagerProvider; + + @Inject + private Session session; + + @Inject + private ApiClientFactory clientFactory; + + private static String extract(File file) { + try { + return String.join("\n", Files.readAllLines(file.toPath(), StandardCharsets.UTF_8)); + } catch (IOException e) { + throw new IgniteCliException("File [" + file.getAbsolutePath() + "] not found"); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void run() { + try (SqlManager sqlManager = new SqlManager(jdbc)) { + // When passing white space to this command, picocli will treat it as a positional argument + if (execOptions == null || (StringUtils.nullOrBlank(execOptions.command) && execOptions.file == null)) { + SqlSchemaProvider schemaProvider = new SqlSchemaProvider(sqlManager::getMetadata); + schemaProvider.initStateAsync(); + + SqlCompleter sqlCompleter = new SqlCompleter(schemaProvider); + IgniteSqlCommandCompleter sqlCommandCompleter = new IgniteSqlCommandCompleter(); + + replExecutorProvider.get().execute(Repl.builder() + .withPromptProvider(() -> ansi(fg(Color.GREEN).mark("sql-cli> "))) + .withCompleter(new AggregateCompleter(sqlCommandCompleter, sqlCompleter)) + .withCommandClass(SqlReplTopLevelCliCommand.class) + .withCallExecutionPipelineProvider(provider(sqlManager)) + .withHistoryFileName("sqlhistory") + .withAutosuggestionsWidgets() + .withHighlighter(highlightingEnabled() ? new HighlighterImpl() : new DefaultHighlighter()) + .withParser(multilineSupported() ? new MultilineParser() : new DefaultParser()) + .build()); + } else { + String executeCommand = execOptions.file != null ? extract(execOptions.file) : execOptions.command; + createSqlExecPipeline(sqlManager, executeCommand).runPipeline(); + } + } catch (SQLException e) { + String url = session.info() == null ? null : session.info().nodeUrl(); + + ExceptionWriter exceptionWriter = ExceptionWriter.fromPrintWriter(spec.commandLine().getErr()); + try { + if (url != null) { + new ClusterManagementApi(clientFactory.getClient(url)).clusterState(); + } + + SqlExceptionHandler.INSTANCE.handle(exceptionWriter, e); + } catch (ApiException apiE) { + new ClusterNotInitializedExceptionHandler("Failed to start sql repl mode", "cluster init") + .handle(exceptionWriter, new IgniteCliApiException(apiE, url)); + } + } + } + + private boolean multilineSupported() { + return Boolean.parseBoolean(configManagerProvider.get().getCurrentProperty(CliConfigKeys.SQL_MULTILINE.value())); + } + + private boolean highlightingEnabled() { + return Boolean.parseBoolean(configManagerProvider.get().getCurrentProperty(CliConfigKeys.SYNTAX_HIGHLIGHTING.value())); + } + + /** + * Multiline parser, expects ";" at the end of the line. + */ + private static final class MultilineParser implements Parser { + + private static final Parser DEFAULT_PARSER = new DefaultParser(); + + @Override + public ParsedLine parse(String line, int cursor, ParseContext context) throws SyntaxError { + if ((ParseContext.UNSPECIFIED == context || ParseContext.ACCEPT_LINE == context) + && !line.trim().endsWith(";")) { + throw new EOFError(-1, cursor, "Missing semicolon (;)"); + } + + return DEFAULT_PARSER.parse(line, cursor, context); + } + } + + private static class HighlighterImpl implements Highlighter { + + @Override + public AttributedString highlight(LineReader lineReader, String s) { + return SqlAttributedStringHighlighter.highlight(s); + } + + @Override + public void setErrorPattern(Pattern pattern) { + } + + @Override + public void setErrorIndex(int i) { + } + } + + private CallExecutionPipelineProvider provider(SqlManager sqlManager) { + return (executor, exceptionHandlers, line) -> executor.hasCommand(dropSemicolon(line)) + ? createInternalCommandPipeline(executor, exceptionHandlers, line) + : createSqlExecPipeline(sqlManager, line); + } + + private CallExecutionPipeline<?, ?> createSqlExecPipeline(SqlManager sqlManager, String line) { + return CallExecutionPipeline.builder(new SqlQueryCall(sqlManager)) + .inputProvider(() -> new StringCallInput(line)) + .output(spec.commandLine().getOut()) + .errOutput(spec.commandLine().getErr()) + .decorator(new SqlQueryResultDecorator(plain)) + .verbose(verbose) + .exceptionHandler(SqlExceptionHandler.INSTANCE) + .build(); + } + + private CallExecutionPipeline<?, ?> createInternalCommandPipeline(RegistryCommandExecutor call, + ExceptionHandlers exceptionHandlers, + String line) { + return CallExecutionPipeline.builder(call) + .inputProvider(() -> new StringCallInput(dropSemicolon(line))) + .output(spec.commandLine().getOut()) + .errOutput(spec.commandLine().getErr()) + .exceptionHandlers(exceptionHandlers) + .verbose(verbose) + .build(); + } + + private static String dropSemicolon(String line) { + if (line.trim().endsWith(";")) { + line = line.substring(0, line.length() - 1); Review Comment: This is not related to the current ticket, I've just rename the SqlReplCommand -> SqlExecReplCommand ########## modules/cli/src/main/java/org/apache/ignite/internal/cli/commands/sql/SqlExecReplCommand.java: ########## @@ -0,0 +1,243 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.ignite.internal.cli.commands.sql; + +import static org.apache.ignite.internal.cli.commands.Options.Constants.JDBC_URL_KEY; +import static org.apache.ignite.internal.cli.commands.Options.Constants.JDBC_URL_OPTION; +import static org.apache.ignite.internal.cli.commands.Options.Constants.JDBC_URL_OPTION_DESC; +import static org.apache.ignite.internal.cli.commands.Options.Constants.PLAIN_OPTION; +import static org.apache.ignite.internal.cli.commands.Options.Constants.PLAIN_OPTION_DESC; +import static org.apache.ignite.internal.cli.commands.Options.Constants.SCRIPT_FILE_OPTION; +import static org.apache.ignite.internal.cli.commands.Options.Constants.SCRIPT_FILE_OPTION_DESC; +import static org.apache.ignite.internal.cli.core.style.AnsiStringSupport.ansi; +import static org.apache.ignite.internal.cli.core.style.AnsiStringSupport.fg; + +import jakarta.inject.Inject; +import java.io.File; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.sql.SQLException; +import java.util.regex.Pattern; +import org.apache.ignite.internal.cli.call.sql.SqlQueryCall; +import org.apache.ignite.internal.cli.commands.BaseCommand; +import org.apache.ignite.internal.cli.commands.sql.help.IgniteSqlCommandCompleter; +import org.apache.ignite.internal.cli.commands.treesitter.highlighter.SqlAttributedStringHighlighter; +import org.apache.ignite.internal.cli.config.CliConfigKeys; +import org.apache.ignite.internal.cli.config.ConfigManagerProvider; +import org.apache.ignite.internal.cli.core.CallExecutionPipelineProvider; +import org.apache.ignite.internal.cli.core.call.CallExecutionPipeline; +import org.apache.ignite.internal.cli.core.call.StringCallInput; +import org.apache.ignite.internal.cli.core.exception.ExceptionHandlers; +import org.apache.ignite.internal.cli.core.exception.ExceptionWriter; +import org.apache.ignite.internal.cli.core.exception.IgniteCliApiException; +import org.apache.ignite.internal.cli.core.exception.IgniteCliException; +import org.apache.ignite.internal.cli.core.exception.handler.ClusterNotInitializedExceptionHandler; +import org.apache.ignite.internal.cli.core.exception.handler.SqlExceptionHandler; +import org.apache.ignite.internal.cli.core.repl.Repl; +import org.apache.ignite.internal.cli.core.repl.Session; +import org.apache.ignite.internal.cli.core.repl.executor.RegistryCommandExecutor; +import org.apache.ignite.internal.cli.core.repl.executor.ReplExecutorProvider; +import org.apache.ignite.internal.cli.core.rest.ApiClientFactory; +import org.apache.ignite.internal.cli.core.style.AnsiStringSupport.Color; +import org.apache.ignite.internal.cli.decorators.SqlQueryResultDecorator; +import org.apache.ignite.internal.cli.sql.SqlManager; +import org.apache.ignite.internal.cli.sql.SqlSchemaProvider; +import org.apache.ignite.internal.util.StringUtils; +import org.apache.ignite.rest.client.api.ClusterManagementApi; +import org.apache.ignite.rest.client.invoker.ApiException; +import org.jline.reader.EOFError; +import org.jline.reader.Highlighter; +import org.jline.reader.LineReader; +import org.jline.reader.ParsedLine; +import org.jline.reader.Parser; +import org.jline.reader.SyntaxError; +import org.jline.reader.impl.DefaultHighlighter; +import org.jline.reader.impl.DefaultParser; +import org.jline.reader.impl.completer.AggregateCompleter; +import org.jline.utils.AttributedString; +import picocli.CommandLine.ArgGroup; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; +import picocli.CommandLine.Parameters; + +/** + * Command for sql execution in REPL mode. + */ +@Command(name = "exec", description = "Executes SQL query") +public class SqlExecReplCommand extends BaseCommand implements Runnable { + @Option(names = JDBC_URL_OPTION, required = true, descriptionKey = JDBC_URL_KEY, description = JDBC_URL_OPTION_DESC) + private String jdbc; + + @Option(names = PLAIN_OPTION, description = PLAIN_OPTION_DESC) + private boolean plain; + + @ArgGroup + private ExecOptions execOptions; + + private static class ExecOptions { + @Parameters(index = "0", description = "SQL query to execute", defaultValue = Option.NULL_VALUE) + private String command; + + @Option(names = SCRIPT_FILE_OPTION, description = SCRIPT_FILE_OPTION_DESC, defaultValue = Option.NULL_VALUE) + private File file; + } + + @Inject + private ReplExecutorProvider replExecutorProvider; + + @Inject + private ConfigManagerProvider configManagerProvider; + + @Inject + private Session session; + + @Inject + private ApiClientFactory clientFactory; + + private static String extract(File file) { + try { + return String.join("\n", Files.readAllLines(file.toPath(), StandardCharsets.UTF_8)); + } catch (IOException e) { + throw new IgniteCliException("File [" + file.getAbsolutePath() + "] not found"); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void run() { + try (SqlManager sqlManager = new SqlManager(jdbc)) { + // When passing white space to this command, picocli will treat it as a positional argument + if (execOptions == null || (StringUtils.nullOrBlank(execOptions.command) && execOptions.file == null)) { + SqlSchemaProvider schemaProvider = new SqlSchemaProvider(sqlManager::getMetadata); + schemaProvider.initStateAsync(); + + SqlCompleter sqlCompleter = new SqlCompleter(schemaProvider); + IgniteSqlCommandCompleter sqlCommandCompleter = new IgniteSqlCommandCompleter(); + + replExecutorProvider.get().execute(Repl.builder() + .withPromptProvider(() -> ansi(fg(Color.GREEN).mark("sql-cli> "))) + .withCompleter(new AggregateCompleter(sqlCommandCompleter, sqlCompleter)) + .withCommandClass(SqlReplTopLevelCliCommand.class) + .withCallExecutionPipelineProvider(provider(sqlManager)) + .withHistoryFileName("sqlhistory") + .withAutosuggestionsWidgets() + .withHighlighter(highlightingEnabled() ? new HighlighterImpl() : new DefaultHighlighter()) + .withParser(multilineSupported() ? new MultilineParser() : new DefaultParser()) + .build()); + } else { + String executeCommand = execOptions.file != null ? extract(execOptions.file) : execOptions.command; + createSqlExecPipeline(sqlManager, executeCommand).runPipeline(); + } + } catch (SQLException e) { + String url = session.info() == null ? null : session.info().nodeUrl(); + + ExceptionWriter exceptionWriter = ExceptionWriter.fromPrintWriter(spec.commandLine().getErr()); + try { + if (url != null) { + new ClusterManagementApi(clientFactory.getClient(url)).clusterState(); + } + + SqlExceptionHandler.INSTANCE.handle(exceptionWriter, e); + } catch (ApiException apiE) { + new ClusterNotInitializedExceptionHandler("Failed to start sql repl mode", "cluster init") + .handle(exceptionWriter, new IgniteCliApiException(apiE, url)); + } + } + } + + private boolean multilineSupported() { + return Boolean.parseBoolean(configManagerProvider.get().getCurrentProperty(CliConfigKeys.SQL_MULTILINE.value())); + } + + private boolean highlightingEnabled() { + return Boolean.parseBoolean(configManagerProvider.get().getCurrentProperty(CliConfigKeys.SYNTAX_HIGHLIGHTING.value())); + } + + /** + * Multiline parser, expects ";" at the end of the line. + */ + private static final class MultilineParser implements Parser { + + private static final Parser DEFAULT_PARSER = new DefaultParser(); + + @Override + public ParsedLine parse(String line, int cursor, ParseContext context) throws SyntaxError { + if ((ParseContext.UNSPECIFIED == context || ParseContext.ACCEPT_LINE == context) + && !line.trim().endsWith(";")) { + throw new EOFError(-1, cursor, "Missing semicolon (;)"); + } + + return DEFAULT_PARSER.parse(line, cursor, context); + } + } + + private static class HighlighterImpl implements Highlighter { + + @Override + public AttributedString highlight(LineReader lineReader, String s) { + return SqlAttributedStringHighlighter.highlight(s); + } + + @Override + public void setErrorPattern(Pattern pattern) { + } + + @Override + public void setErrorIndex(int i) { + } + } + + private CallExecutionPipelineProvider provider(SqlManager sqlManager) { + return (executor, exceptionHandlers, line) -> executor.hasCommand(dropSemicolon(line)) + ? createInternalCommandPipeline(executor, exceptionHandlers, line) + : createSqlExecPipeline(sqlManager, line); + } + + private CallExecutionPipeline<?, ?> createSqlExecPipeline(SqlManager sqlManager, String line) { + return CallExecutionPipeline.builder(new SqlQueryCall(sqlManager)) + .inputProvider(() -> new StringCallInput(line)) + .output(spec.commandLine().getOut()) + .errOutput(spec.commandLine().getErr()) + .decorator(new SqlQueryResultDecorator(plain)) + .verbose(verbose) + .exceptionHandler(SqlExceptionHandler.INSTANCE) + .build(); + } + + private CallExecutionPipeline<?, ?> createInternalCommandPipeline(RegistryCommandExecutor call, + ExceptionHandlers exceptionHandlers, + String line) { + return CallExecutionPipeline.builder(call) + .inputProvider(() -> new StringCallInput(dropSemicolon(line))) + .output(spec.commandLine().getOut()) + .errOutput(spec.commandLine().getErr()) + .exceptionHandlers(exceptionHandlers) + .verbose(verbose) + .build(); + } + + private static String dropSemicolon(String line) { + if (line.trim().endsWith(";")) { + line = line.substring(0, line.length() - 1); Review Comment: This is not related to the current ticket, I've just renamed ```SqlReplCommand -> SqlExecReplCommand```` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
