Skip to content

Improve console batch mode #1692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 19, 2024
Merged

Improve console batch mode #1692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f36a0ea
first step for bulk processing in console
gramian Aug 2, 2024
41c4b46
move from jansi to jni, add test for batch failing
robfrank Dec 16, 2024
a528c27
WIP
robfrank Dec 17, 2024
545573f
WIP
robfrank Dec 17, 2024
a1902b9
move batchMode and failAtAnd at memeber level
robfrank Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion console/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
</dependency>
<dependency>
<groupId>org.jline</groupId>
<artifactId>jline-terminal-jansi</artifactId>
<artifactId>jline-terminal-jni</artifactId>
<version>${jline.version}</version>
</dependency>
<dependency>
Expand Down
105 changes: 74 additions & 31 deletions console/src/main/java/com/arcadedb/console/Console.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,18 @@
import org.jline.terminal.Terminal;
import org.jline.terminal.TerminalBuilder;

import java.io.*;
import java.util.*;
import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;

public class Console {
private static final String PROMPT = "%n%s> ";
Expand All @@ -81,12 +91,20 @@ public class Console {
private long transactionBatchSize = 0L;
protected long currentOperationsInBatch = 0L;
private RemoteServer remoteServer;
private boolean batchMode = false;
private boolean failAtEnd = false;

public Console(final DatabaseInternal database) throws IOException {
this();
this.databaseProxy = database;
}

public Console(boolean batchMode, boolean failAtEnd) throws IOException {
this();
this.batchMode = batchMode;
this.failAtEnd = failAtEnd;
}

public Console() throws IOException {
IntegrationUtils.setRootPath(configuration);
databaseDirectory = configuration.getValueAsString(GlobalConfiguration.SERVER_DATABASE_DIRECTORY);
Expand All @@ -95,7 +113,7 @@ public Console() throws IOException {

GlobalConfiguration.PROFILE.setValue("low-cpu");

terminal = TerminalBuilder.builder().system(system).streams(System.in, System.out).jansi(true).build();
terminal = TerminalBuilder.builder().system(system).streams(System.in, System.out).jni(true).build();

output(3, "%s Console v.%s - %s (%s)", Constants.PRODUCT, Constants.getRawVersion(), Constants.COPYRIGHT, Constants.URL);
}
Expand Down Expand Up @@ -155,6 +173,7 @@ public static void main(final String[] args) throws IOException {
public static void execute(final String[] args) throws IOException {
final StringBuilder commands = new StringBuilder();
boolean batchMode = false;
boolean failAtEnd = false;
// PARSE ARGUMENT, EXTRACT SETTING AND BATCH MODE AND COMPILE THE LINES TO EXECUTE
for (int i = 0; i < args.length; i++) {
final String value = args[i].trim();
Expand All @@ -163,28 +182,28 @@ public static void execute(final String[] args) throws IOException {
final String[] parts = value.substring(2).split("=");
System.setProperty(parts[0], parts[1]);
setGlobalConfiguration(parts[0], parts[1], true);
} else if (value.equalsIgnoreCase("-b"))
} else if (value.equalsIgnoreCase("-b")) {
batchMode = true;
else {
} else if (value.equalsIgnoreCase("-fae")) {
failAtEnd = true;
} else {
commands.append(value);
if (!value.endsWith(";"))
commands.append(";");
}
}

final Console console = new Console();
final Console console = new Console(batchMode, failAtEnd);

try {
if (batchMode) {
// BATCH MODE
console.parse(commands.toString(), true);
console.parse("exit", true);
} else {
// INTERACTIVE MODE
if (console.parse(commands.toString(), true))
console.interactiveMode();
}

} finally {
// FORCE THE CLOSING
console.close();
Expand Down Expand Up @@ -287,10 +306,12 @@ private void executeSet(final String line) {
final String key = parts[0].trim();
final String value = parts[1].trim();

if ("limit".equalsIgnoreCase(key)) {
switch (key.toLowerCase()) {
case "limit" -> {
limit = Integer.parseInt(value);
outputLine(3, "Set new limit to %d", limit);
} else if ("asyncMode".equalsIgnoreCase(key)) {
}
case "asyncmode" -> {
asyncMode = Boolean.parseBoolean(value);
if (asyncMode) {
// ENABLE ASYNCHRONOUS PARALLEL MODE
Expand All @@ -303,39 +324,47 @@ private void executeSet(final String line) {
});
}
outputLine(3, "Set asyncMode to %s", asyncMode);
} else if ("transactionBatchSize".equalsIgnoreCase(key)) {
}
case "transactionbatchsize" -> {
transactionBatchSize = Integer.parseInt(value);
outputLine(3, "Set new transactionBatch to %d", transactionBatchSize);
} else if ("language".equalsIgnoreCase(key)) {
}
case "language" -> {
language = value;
outputLine(3, "Set language to %s", language);
} else if ("expandResultSet".equalsIgnoreCase(key)) {
}
case "expandresultset" -> {
expandResultSet = value.equalsIgnoreCase("true");
outputLine(3, "Set expanded result set to %s", expandResultSet);
} else if ("maxMultiValueEntries".equalsIgnoreCase(key)) {
}
case "maxmultivalueentries" -> {
maxMultiValueEntries = Integer.parseInt(value);
outputLine(3, "Set maximum multi value entries to %d", maxMultiValueEntries);
} else if ("verbose".equalsIgnoreCase(key)) {
}
case "verbose" -> {
verboseLevel = Integer.parseInt(value);
outputLine(3, "Set verbose level to %d", verboseLevel);
} else if ("maxWidth".equalsIgnoreCase(key)) {
}
case "maxwidth" -> {
maxWidth = Integer.parseInt(value);
outputLine(3, "Set maximum width to %d", maxWidth);
} else {
}
default -> {
if (!setGlobalConfiguration(key, value, false))
outputLine(3, "Setting '%s' is not supported by the console", key);
}
}

flushOutput();
}

private void executeTransactionStatus() {
checkDatabaseIsOpen();

if (databaseProxy instanceof DatabaseInternal) {
final TransactionContext tx = ((DatabaseInternal) databaseProxy).getTransaction();
if (databaseProxy instanceof DatabaseInternal db) {
final TransactionContext tx = db.getTransaction();
if (tx.isActive()) {
final ResultInternal row = new ResultInternal((Database) databaseProxy);
final ResultInternal row = new ResultInternal(db);
row.setPropertiesFromMap(tx.getStats());
printRecord(row);

Expand Down Expand Up @@ -550,15 +579,14 @@ else if (rec != null)

final List<TableFormatter.TableRow> resultSet = new ArrayList<>();

Object value;
for (final String fieldName : currentRecord.getPropertyNames()) {
value = currentRecord.getProperty(fieldName);
if (value instanceof byte[])
value = "byte[" + ((byte[]) value).length + "]";
else if (value instanceof Iterator<?>) {
Object value = currentRecord.getProperty(fieldName);
if (value instanceof byte[] bytes)
value = "byte[" + bytes.length + "]";
else if (value instanceof Iterator<?> iterator) {
final List<Object> coll = new ArrayList<>();
while (((Iterator<?>) value).hasNext())
coll.add(((Iterator<?>) value).next());
while (iterator.hasNext())
coll.add(iterator.next());
value = coll;
} else if (MultiValue.isMultiValue(value)) {
value = TableFormatter.getPrettyFieldMultiValue(MultiValue.getMultiValueIterator(value), maxMultiValueEntries);
Expand Down Expand Up @@ -597,13 +625,17 @@ public void onError(Exception exception) {
outputError(exception);
}
});
} else
} else {
try {
resultSet = databaseProxy.command(language, line);
} catch (Exception e) {
outputError(e);
if (batchMode && !failAtEnd)
throw e;
else
outputError(e);
return;
}
}

if (transactionBatchSize > 0) {
++currentOperationsInBatch;
Expand Down Expand Up @@ -739,8 +771,19 @@ public boolean parse(final String line, final boolean printCommand) throws IOExc
if (printCommand)
output(3, getPrompt() + w);

if (!execute(w))
return false;
if (batchMode) {
try {
if (!execute(w))
return false;
} catch (final Exception e) {
if (!failAtEnd)
throw e;
}
} else {
if (!execute(w))
return false;

}
}
return true;
}
Expand Down
41 changes: 39 additions & 2 deletions console/src/test/java/com/arcadedb/console/ConsoleBatchTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,18 @@
import com.arcadedb.GlobalConfiguration;
import com.arcadedb.database.Database;
import com.arcadedb.database.DatabaseFactory;
import com.arcadedb.exception.CommandSQLParsingException;
import com.arcadedb.server.TestServerHelper;
import com.arcadedb.utility.FileUtils;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import java.io.*;
import java.io.File;
import java.io.IOException;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

public class ConsoleBatchTest {
@Test
Expand All @@ -40,6 +43,39 @@ public void batchMode() throws IOException {
db.drop();
}

@Test
public void batchModeWithError() throws IOException {
// This should fail
assertThatThrownBy(() -> Console.execute(
new String[] { "-b", """
create database console;
create vertex table WRONG_STATEMENT;
create vertex type ConsoleOnlyVertex;
""" }))
.isInstanceOf(CommandSQLParsingException.class);

final Database db = new DatabaseFactory("./target/databases/console").open();
// the ConsoleOnlyVertex should not be created
assertThat(db.getSchema().existsType("ConsoleOnlyVertex")).isFalse();
db.drop();
}

@Test
public void batchModeWithFailAtEnd() throws IOException {
// Error is only printed out
Console.execute(
new String[] { "-b", "-fae", """
create database console;
create vertex table WRONG_STATEMENT;
create vertex type ConsoleOnlyVertex;
""" });

final Database db = new DatabaseFactory("./target/databases/console").open();
// the ConsoleOnlyVertex is created
assertThat(db.getSchema().existsType("ConsoleOnlyVertex")).isTrue();
db.drop();
}

@Test
public void interactiveMode() throws IOException {
Console.execute(new String[] { "create database console; create vertex type ConsoleOnlyVertex;exit" });
Expand All @@ -51,7 +87,8 @@ public void interactiveMode() throws IOException {
@Test
public void swallowSettings() throws IOException {
FileUtils.deleteRecursively(new File("./console"));
Console.execute(new String[] { "-Darcadedb.server.databaseDirectory=.", "create database console; create vertex type ConsoleOnlyVertex;exit;" });
Console.execute(new String[] { "-Darcadedb.server.databaseDirectory=.",
"create database console; create vertex type ConsoleOnlyVertex;exit;" });
final Database db = new DatabaseFactory("./console").open();
assertThat(db.getSchema().existsType("ConsoleOnlyVertex")).isTrue();
db.drop();
Expand Down
Loading