Skip to content

IGNITE-24619 Describe regexPattern in cache list help #13530

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

Open
ignitetcbot wants to merge 2 commits into
base: master
Choose a base branch
from
Open

IGNITE-24619 Describe regexPattern in cache list help #13530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8dfbf26
IGNITE-24619 Describe regexPattern in cache list help
dspavlov Aug 27, 2026
10d98dd
IGNITE-24619 Fix regex help example
dspavlov Aug 27, 2026
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
19 changes: 19 additions & 0 deletions ...ility/src/test/java/org/apache/ignite/internal/commandline/CommandHandlerParsingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import java.util.UUID;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import org.apache.ignite.IgniteCheckedException;
import org.apache.ignite.IgniteException;
Expand Down Expand Up @@ -93,6 +94,8 @@
import org.apache.ignite.internal.util.typedef.T2;
import org.apache.ignite.internal.util.typedef.internal.U;
import org.apache.ignite.testframework.GridTestUtils;
import org.apache.ignite.testframework.ListeningTestLogger;
import org.apache.ignite.testframework.LogListener;
import org.apache.ignite.testframework.junits.SystemPropertiesRule;
import org.apache.ignite.testframework.junits.WithSystemProperty;
import org.jetbrains.annotations.Nullable;
Expand All @@ -110,6 +113,7 @@
import static org.apache.ignite.internal.commandline.ArgumentParser.CMD_VERBOSE;
import static org.apache.ignite.internal.commandline.CommandHandler.DFLT_HOST;
import static org.apache.ignite.internal.commandline.CommandHandler.DFLT_PORT;
import static org.apache.ignite.internal.commandline.CommandHandler.EXIT_CODE_OK;
import static org.apache.ignite.internal.management.api.CommandUtils.cmdText;
import static org.apache.ignite.internal.management.api.CommandUtils.executable;
import static org.apache.ignite.internal.management.api.CommandUtils.visitCommandParams;
Expand All @@ -130,6 +134,21 @@
*/
@WithSystemProperty(key = IGNITE_ENABLE_EXPERIMENTAL_COMMAND, value = "true")
public class CommandHandlerParsingTest {
/** */
@Test
public void testCacheListHelpDescribesRegexPattern() {
ListeningTestLogger testLog = new ListeningTestLogger();
LogListener regexDescription = LogListener.matches(Pattern.compile(
"regexPattern\\s+- Java regular expression for filtering cache, group, or sequence names.*" +
"'\\^account-\\.\\*' matches names starting with 'account-'"
)).build();

testLog.registerListener(regexDescription);

assertEquals(EXIT_CODE_OK, new CommandHandler(testLog).execute(asList("--cache", "help")));
assertTrue(regexDescription.check());
}

/** */
@ClassRule public static final TestRule classRule = new SystemPropertiesRule();

Expand Down
3 changes: 2 additions & 1 deletion ...s/core/src/main/java/org/apache/ignite/internal/management/cache/CacheListCommandArg.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ public class CacheListCommandArg extends IgniteDataTransferObject {
/** */
@Order(0)
@Positional
@Argument(example = "regexPattern")
@Argument(description = "Java regular expression for filtering cache, group, or sequence names. " +
"Examples: '.' matches all names, '^account-.*' matches names starting with 'account-'", example = "regexPattern")
String regex;

/** */
Expand Down
1 change: 1 addition & 0 deletions ...t/resources/org.apache.ignite.util/GridCommandHandlerClusterByClassTest_cache_help.output
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Arguments: --cache help --yes
control.(sh|bat) --cache list regexPattern [nodeId] [--config] [--output-format multi-line] [--groups|--seq]

Parameters:
regexPattern - Java regular expression for filtering cache, group, or sequence names. Examples: '.' matches all names, '^account-.*' matches names starting with 'account-'.
--config - print all configuration parameters for each cache.
--output-format multi-line - print configuration parameters per line. This option has effect only when used with --config and without [--groups|--seq].
--groups - print information about groups.
Expand Down
1 change: 1 addition & 0 deletions ...rces/org.apache.ignite.util/GridCommandHandlerClusterByClassWithSSLTest_cache_help.output
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Arguments: --cache help --yes
control.(sh|bat) --cache list regexPattern [nodeId] [--config] [--output-format multi-line] [--groups|--seq]

Parameters:
regexPattern - Java regular expression for filtering cache, group, or sequence names. Examples: '.' matches all names, '^account-.*' matches names starting with 'account-'.
--config - print all configuration parameters for each cache.
--output-format multi-line - print configuration parameters per line. This option has effect only when used with --config and without [--groups|--seq].
--groups - print information about groups.
Expand Down