Releases: hazelcast/hazelcast-commandline-client
v5.2.0
Release Notes
This is the first GA release of Hazelcast CLC.
Be sure to check the README and participate in our survey.
The new features and changes since v5.2.0-beta3 are below.
New Features
- CLC can read data serialized using Compact serialization and portable automatically.
- if the user doesn't provide a configuration in the shell mode, they can select one from a configuration list or import a Viridian configuration.
- Added
--quite(shorthand-q) flag which suppresses unnecessary output. - Added
CLC_CLIENT_NAMEenvironment variable which allows overriding the default client name. - Added
CLC_CLIENT_LABElSenvironment variable which allows overriding the default client labels with a comma separated list of labels.
Changes
- CLC outputs more messages about what's going on, such as success messages. To suppress this behavior, such as script usage, just pass
--quiteor-q.
Fixes
- 186 Map name parameter gets stuck to a value in the shell mode
- 198 CLC failure in Docker - "panic: maxWidth should be positive if header is nil"
Known Issues
- Powershell autocompletion does not work.
- Ctrl+(left/right) key combinations don't work as expected in the interactive mode. You can set the
CLC_EXPERIMENTAL_READLINEenvironment variable tonyto use an alternative readline implementation. - Navigating shell history with arrow keys doesn't work on Windows. You can enable the alternative
nyreadline implementation to workaround that. - Windows binaries are currently not code signed and running them will show warnings. We are going to release code signed binaries soon.
- There are some compact field types that are not decoded. We will add the missing field types in the next version.
quiteshould bequiet. This will be fixed in the next release.
v5.2.0-BETA-3
Release Notes
This is the third beta release of Hazelcast CLC.
Be sure to check the README and participate in our survey.
New Features
- Hazelcast Viridian Serverless is supported out of the box.
- These new commands were added:
object list: Lists the distributed data structures in the cluster.completion: Generate completion for one of Bash, Fish, Powershell and Zsh. Check out--helpfor more information.config add: Adds CLC configuration.config import: Import CLC configuration from various sources. Currently only Viridian Serverless Go Client sample is supported.config list: List known configurations.home: Outputs the CLC home directory.
- The following output formats are supported using the
--formatflag:- CSV.
- Delimited. Outputs with tab characters between fields. Default mode for the non-interactive mode.
- JSON
- Table. Default mode for the interactive mode.
- SQL shortcuts in the shell:
\dm: list mappings\dm MAPPING: display information about a mapping\dm+ MAPPING: describe a mapping
--show-typeflag formapcommands which outputs the type of key and value, even if they can't be decoded.
Changes
- Removed SQL browser.
- The interactive mode defaults to running SQL queries. CLC commands should be prefixed with a backslash
\. - The configuration format was simplified.
- Map commands were changed to not use a flag for the key and value. They are passed as positional arguments:
$ map set -n my-map my-key my-value - Map name is optional and defaults to
default. - Removed
map get-all,map putandmap put-allcommands. - Added
map setcommand. - Auto-completion is disabled in the interactive mode.
- Viridian Serverless is the default cloud platform.
- The shell connects to the cluster on demand.
Known Issues
- Powershell autocompletion does not work.
- Ctrl+(left/right) key combinations don't work as expected in the interactive mode. You can set the
CLC_EXPERIMENTAL_READLINEenvironment variable tonyto use an alternative readline implementation.*
v5.2.0-BETA-3 PREVIEW
Release Notes
This is a preview release of Hazelcast CLC v5.2.0 Beta3.
Be sure to check the README and participate in our survey.
New Features
- Hazelcast Viridian Serverless is supported out of the box.
- Auto-complete support for Powershell and Fish.
- These new commands were added:
object list: Lists the distributed data structures in the cluster.completion: Generate completion for one of Bash, Fish, Powershell and Zsh. Check out--helpfor more information.config import: Import CLC configuration from various sources. Currently only Viridian Serverless Go Client sample is supported.config list: List known configurations.home: Outputs the CLC home directory.shell: Starts the CLC shell. This is the default mode of operation
- The following output formats are supported using the
--formatflag:- CSV.
- Delimited. Outputs with tab characters between fields. Default mode for the non-interactive mode.
- JSON
- Table. Default mode for the interactive mode.
- SQL shortcuts in the shell:
\dm: list mappings\dm MAPPING: display information about a mapping\dm+ MAPPING: describe a mapping
--show-typeflag formapcommands which outputs the type of key and value, even if they can't be decoded.- Support for portable and initial support for compact serialization. Note that reading keys/values encoded with these serialization methods require writing a schema file. This restriction will be lifted in later releases.
Changes
- Removed SQL browser.
- The interactive mode defaults to running SQL queries. CLC commands should be prefixed with a backslash
\. - The configuration format was simplified.
- Map commands were changed to not use a flag for the key and value. They are passed as positional arguments:
$ map put -n my-map my-key my-value - Map name is optional and defaults to
default. - Removed
get-allandput-allcommands. - Auto-completion is disabled in the interactive mode.
v5.2.0-BETA-2
With this release, Hazelcast Command-Line Client can be used on Windows!
New features
Windows support:
Windows amd64 executable and a Windows installer are available on assets.
Version command:
Users can troubleshoot easier with the CLC version, Hazelcast Go Client version, go version, and the latest git commit hash. See the command documentation
SQL Browser and Interactive mode improvements
- A few bugs that cause the CLC to stuck are addressed and visual improvements are made.
- A new UI widget is added to indicate that a query is running.
- Color themes and the ability to override colors on SQL Browser are provided. See the documentation for related flags.
Known Issues
- Currently, Hazelcast Command-Line Client does not work properly in interactive mode on the following platforms: Powershell 7 and higher, Windows Terminal.
v1.0.0-BETA-1
This is the first internal release of Hazelcast Command-Line Client.
The first beta release of the Hazelcast CLC has the following features:
New features
Basic map operations:
- clear
- get
- get-all
- put
- put-all
- clear
- remove
Serialization support for basic types:
- int(8,16,32,64)
- float(32,64)
- boolean
- string
- JSON
Basic cluster operations:
- getting/setting cluster state
- getting cluster version
- shutting down a cluster
2 ways of installation:
- Brew package
- Installation script
3 modes of operation:
- Non-Interactive (with auto-completion support)
- Interactive (a prompt with auto-completion suggestions)
- SQL Browser (a TUI for executing SQL statements and navigating results)
Known Issues
- Windows is not officially supported as a host in this release.
- Client statistics are not shown in the Hazelcast Management Center and Hazelcast Cloud Cluster Metrics Panel.
- "--key-type" and "--value-type" flags do not support autocompletion of options in the interactive mode.
- The "help" message has redundant lines in interactive mode.
- Logs interfere with the interactive prompt display.
- Interactive mode prints garbage characters on some key combinations.