Skip to content

Commit

Permalink
DOCS-330 Release Notes (#178)
Browse files Browse the repository at this point in the history
  • Loading branch information
angelasimms authored Dec 8, 2022
1 parent 57351a8 commit 2b01ce4
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@
* xref:keyboard-shortcuts.adoc[]
.Release Notes
* xref:release-notes.adoc[0.1]
* xref:release-notes.adoc[0.3]
45 changes: 42 additions & 3 deletions docs/modules/ROOT/pages/release-notes.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,46 @@
= Release Notes Hazelcast CLC {page-component-version}

== Features
== New Features

== Fixes
* Added support for link:https://hazelcast.com/products/viridian/[Hazelcast {hazelcast-cloud} Serverless].

== Known issues
* Added the following commands:

** `object list`: Lists the distributed data structures in the cluster.
** `completion`: Generates the autocompletion script for the specified shell, either Bash, Fish, Powershell or Zsh. Use `--help` for more information.
** `config add`: Adds configuration to the Hazelcast CLC. For example, to connect to a specific cluster.
** `config import`: Imports configuration into the Hazelcast CLC from various sources. Currently only the {hazelcast-cloud} Serverless Go Client sample is supported.
** `config list`: Lists known configurations.
** `home`: Outputs the Hazelcast CLC home directory, which stores all configuration, logs and other files.

* Added support for the following output formats, using the `--format` flag:

** CSV
** Delimited. Outputs with tab characters between fields. This is the default format when working in non-interactive mode.
** JSON
** Table. This is the default format when working in interactive mode.

* Added SQL shortcuts to the Hazelcast CLC shell:
** `\dm`: Lists mappings.
** `\dm MAPPING`: Displays information about a mapping.
** `\dm+ MAPPING`: Describes a mapping.

* Added the `--show-type` flag for map commands, which outputs the type of key and value even if they can't be decoded.

== Changes

* Removed the SQL browser.
* The interactive mode defaults to running SQL queries. Prefix CLC commands with a backslash `\`.
* Simplified the configuration format.
* Map commands no longer use a flag for the key and value. They are passed as positional arguments: `$ map set -n my-map my-key my-value`.
* The Map name is optional and defaults to `default`.
* Removed `map get-all`, `map put` and `map put-all` commands.
* Added the `map set` command.
* Auto-completion is disabled in interactive mode.
* {hazelcast-cloud} 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_READLINE` environment variable to ny to use an alternative readline implementation.

0 comments on commit 2b01ce4

Please sign in to comment.