diff --git a/docs/modules/ROOT/pages/clc-cpmap.adoc b/docs/modules/ROOT/pages/clc-cpmap.adoc new file mode 100644 index 0000000..18ef1c4 --- /dev/null +++ b/docs/modules/ROOT/pages/clc-cpmap.adoc @@ -0,0 +1,369 @@ += clc cpmap + +CPMap commands are a group of CPMap operations. + +Usage: + +[source,bash] +---- +clc cpmap [command] [flags] +---- + +== Commands + +* <> +* <> +* <> +* <> +* <> +* <> +* <> + +== clc cpmap compare-and-set + +Sets the value for the given key if it has the expected value. + +Usage: + +[source,bash] +---- +clc cpmap compare-and-set [key] [expected-value] [new-value] [flags] +---- + +Parameters: + +[cols="1m,1a,2a,1a"] +|=== +|Parameter|Required|Description|Default + +|`--name`, `-n` +|Optional +|Name of the map. +|`default` + +|`key` +|Required +|Key of the map entry. +|N/A + +|`expected-value`, +|Required +|Value to set for the key. +|N/A + +|`new-value`, +|Required +|Value to set for the key. +|N/A + +|`--key-type`, `-k` +|Optional +|Data type of the key. One of: `string`, `bool`, `json`, `i8`, `i16`, `i32`, `i64`, `f32`, `f64` +|string + +|`--value-type`, `-v` +|Optional +|Data type of the value. One of: `string`, `bool`, `json`, `i8`, `i16`, `i32`, `i64`, `f32`, `f64` +|string + +|=== + +.Global parameters +[%collapsible] +==== +include::partial$global-parameters.adoc[] +==== + +== clc cpmap get + +Gets a value from the given CPMap. + +Usage: + +[source,bash] +---- +clc cpmap get [key] [flags] +---- + +Parameters: + +[cols="1m,1a,2a,1a"] +|=== +|Parameter|Required|Description|Default + +|`--name`, `-n` +|Optional +|Name of the CPMap. +|`default` + +|`key` +|Required +|Key of the CPMap entry. +|N/A + +|`--key-type`, `-k` +|Optional +|Data type of the key. One of: `string`, `bool`, `json`, `i8`, `i16`, `i32`, `i64`, `f32`, `f64`. +|string + +|=== + +.Global parameters +[%collapsible] +==== +include::partial$global-parameters.adoc[] +==== + +Example: + +[source,bash] +---- +clc cpmap get -n yearbook -k i16 2012 +---- + +== clc cpmap set + +Sets a value in the given CPMap. + +Usage: + +[source,bash] +---- +clc cpmap set [key] [value] [flags] +---- + +Parameters: + +[cols="1m,1a,2a,1a"] +|=== +|Parameter|Required|Description|Default + +|`--name`, `-n` +|Optional +|Name of the CPMap. +|`default` + +|`key` +|Required +|Key of the CPMap entry. +|N/A + +|`value`, +|Required +|Value to set for the key. +|N/A + +|`--key-type`, `-k` +|Optional +|Data type of the key. One of: `string`, `bool`, `json`, `i8`, `i16`, `i32`, `i64`, `f32`, `f64` +|string + +|`--value-type`, `-v` +|Optional +|Data type of the value. One of: `string`, `bool`, `json`, `i8`, `i16`, `i32`, `i64`, `f32`, `f64` +|string + +|=== + +.Global parameters +[%collapsible] +==== +include::partial$global-parameters.adoc[] +==== + +Example: + +[source,bash] +---- +clc cpmap -n my-cpmap set -k string hello -v f32 19.94 +---- + + +== clc cpmap put + +Puts the given value in the given CPMap and returns the old value. + +Usage: + +[source,bash] +---- +clc cpmap put [key] [value] [flags] +---- + +Parameters: + +[cols="1m,1a,2a,1a"] +|=== +|Parameter|Required|Description|Default + +|`--name`, `-n` +|Optional +|Name of the CPMap. +|`default` + +|`key` +|Required +|Key of the CPMap entry. +|N/A + +|`value`, +|Required +|Value to set for the key. +|N/A + +|`--key-type`, `-k` +|Optional +|Data type of the key. One of: `string`, `bool`, `json`, `i8`, `i16`, `i32`, `i64`, `f32`, `f64` +|string + +|`--value-type`, `-v` +|Optional +|Data type of the value. One of: `string`, `bool`, `json`, `i8`, `i16`, `i32`, `i64`, `f32`, `f64` +|string + +|=== + +.Global parameters +[%collapsible] +==== +include::partial$global-parameters.adoc[] +==== + +Example: + +[source,bash] +---- +clc cpmap -n my-cpmap put -k string hello -v f32 19.94 +---- + +== clc cpmap remove + +Removes the value of a given key in a CPMap and returns the old value. + +Usage: + +[source,bash] +---- +clc cpmap remove [flags] [key] +---- + +Parameters: + +[cols="1m,1a,2a,1a"] +|=== +|Parameter|Required|Description|Default + +|`--name`, `-n` +|Optional +|Name of the map. +|`default` + +|`key` +|Required +|Key of the map entry. +|N/A + +|`--key-type`, `-k` +|Optional +|Data type of the key. One of: `string`, `bool`, `json`, `i8`, `i16`, `i32`, `i64`, `f32`, `f64` +|string + +|=== + +.Global parameters +[%collapsible] +==== +include::partial$global-parameters.adoc[] +==== + +Example: + +[source,bash] +---- +clc cpmap remove --name my-cpmap --key-type string k1 +k1 +---- + + +== clc cpmap delete + +Deletes the value of a given key in a CPMap. + +Usage: + +[source,bash] +---- +clc cpmap delete [flags] [key] +---- + +Parameters: + +[cols="1m,1a,2a,1a"] +|=== +|Parameter|Required|Description|Default + +|`--name`, `-n` +|Optional +|Name of the map. +|`default` + +|`key` +|Required +|Key of the map entry. +|N/A + +|`--key-type`, `-k` +|Optional +|Data type of the key. One of: `string`, `bool`, `json`, `i8`, `i16`, `i32`, `i64`, `f32`, `f64` +|string + +|=== + +.Global parameters +[%collapsible] +==== +include::partial$global-parameters.adoc[] +==== + +Example: + +[source,bash] +---- +clc cpmap delete --name my-cpmap --key-type string k1 +k1 +---- + +== clc cpmap destroy + +Deletes the CPMap and all the data in it. + +Usage: + +[source,bash] +---- +clc cpmap destroy [flags] +---- + +Parameters: + +[cols="1m,1a,2a,1a"] +|=== +|Parameter|Required|Description|Default + +|`--name`, `-n` +|Optional +|Name of the map. +|`default` + +|`--yes` +|Optional +|Skip confirming the destroy operation. +|`false` + +|=== + +.Global parameters +[%collapsible] +==== +include::partial$global-parameters.adoc[] +==== \ No newline at end of file diff --git a/docs/modules/ROOT/pages/clc-job.adoc b/docs/modules/ROOT/pages/clc-job.adoc index 4539459..a42e75e 100644 --- a/docs/modules/ROOT/pages/clc-job.adoc +++ b/docs/modules/ROOT/pages/clc-job.adoc @@ -23,13 +23,10 @@ clc job [command] [options] == clc job submit -Creates a Jet job using the provided JAR file or YAML job definition. +Creates a Jet job using the provided JAR file. This command requires a Hazelcast {hazelcast-cloud} or Hazelcast Platform cluster of version 5.3.0 or above. -TIP: For further information about codeless job definition, see the xref:yaml-job-definition.adoc[YAML Job Definition] topic. - - Usage: [source,bash] diff --git a/docs/modules/ROOT/pages/clc-script.adoc b/docs/modules/ROOT/pages/clc-script.adoc index 744d787..46a58a5 100644 --- a/docs/modules/ROOT/pages/clc-script.adoc +++ b/docs/modules/ROOT/pages/clc-script.adoc @@ -1,5 +1,5 @@ = clc script run -:description: Runs the script in the given local or HTTP location. Advanced script currently only supports local files. +:description: Runs the script in the given location. {description} @@ -10,10 +10,9 @@ Two kinds of scripts are supported: * Shell scripts: CLC commands or SQL * Advanced scripts: a Python-like language -The scripts may be in the following locations: +The scripts may be in the following location: * Filesystem path: The path may optionally have the file:// prefix. -* HTTP resource: The path should have the http:// or https:// prefix. == Shell Script @@ -155,6 +154,27 @@ The following functions are available for advanced scripts: |`VALUES_LIST = map_values(name=MAP_NAME)` |Returns the values in the Map as a list. +|`BOOL = cpmap_compare_and_set(KEY, EXPECTED_VALUE, NEW_VALUE, name=CPMAP_NAME)` +|Sets the value for the given key if it has the expected value. + +|`cpmap_delete(KEY, name=CPMAP_NAME)` +|Deletes the value of a given key in a CPMap. + +|`cpmap_destroy(name=CPMAP_NAME)` +|Deletes the CPMap and all the data in it. + +|`cpmap_get(KEY, name=CPMAP_NAME)` +|Gets a value from the given CPMap. + +|`OLD_VALUE = cpmap_put(KEY, VALUE, name=CPMAP_NAME)` +|Puts the given value in the given CPMap and returns the old value. + +|`VALUE = cpmap_remove(KEY, name=CPMAP_NAME)` +|Removes the value of a given key in a CPMap and returns the old value. + +|`cpmap_set(KEY, VALUE, name=CPMAP_NAME)` +|Sets a value in the given CPMap. + |`TIME = now()` |Returns the current time in nanoseconds. diff --git a/docs/modules/ROOT/pages/release-notes-5.4.0.adoc b/docs/modules/ROOT/pages/release-notes-5.4.0.adoc new file mode 100644 index 0000000..806562d --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes-5.4.0.adoc @@ -0,0 +1,33 @@ += 5.4.0 Release Notes + +== New Features + +=== CPMap + +Hazelcast CPMap is a distributed implementation of a minimal key-value interface. +This release adds support for the CPMap data structures. +Note that CPMap is an Hazelcast Enterprise feature. + +Added the following `cpmap` commands: + +* `compare-and-set` +* `delete` +* `destroy` +* `get` +* `put` +* `remove` +* `set` + +Added the following advanced script functions for the CPMap: + +* `cpmap_compare_and_set` +* `cpmap_delete` +* `cpmap_destroy` +* `cpmap_get` +* `cpmap_put` +* `cpmap_remove` +* `cpmap_set` + +== Changes + +* Removed the ability to run scripts over HTTP. diff --git a/docs/modules/ROOT/pages/yaml-job-definition.adoc b/docs/modules/ROOT/pages/yaml-job-definition.adoc.dontgenerate similarity index 100% rename from docs/modules/ROOT/pages/yaml-job-definition.adoc rename to docs/modules/ROOT/pages/yaml-job-definition.adoc.dontgenerate