From ee1996b506b629fe665a7891c57fdddd6c89b37b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Jamr=C3=B3z?= <79092062+k-jamroz@users.noreply.github.com> Date: Thu, 18 Jul 2024 17:24:04 +0200 Subject: [PATCH] Add note about enabling Panama for vector collections (#1177) Co-authored-by: Oliver Howell --- .../data-structures/pages/vector-collections.adoc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/modules/data-structures/pages/vector-collections.adoc b/docs/modules/data-structures/pages/vector-collections.adoc index bc37579eb..be9b5bcf4 100644 --- a/docs/modules/data-structures/pages/vector-collections.adoc +++ b/docs/modules/data-structures/pages/vector-collections.adoc @@ -14,6 +14,19 @@ Conceptually, a vector collection resembles a key-value store. Here, the key is Users can store any value they require as metadata. This could be additional characteristics of the source data or even the source data itself. +== JVM configuration + +Vector collection indexing and search are computationally very intensive and can utilize SIMD instructions. +For best performance using vector collections, use Java 21 and enable Vector API from Project Panama by adding `--add-modules jdk.incubator.vector` to xref:configuration:jvm-parameters.adoc[JVM parameters]. + +If you use Docker, you can use the following example command: + +```sh +docker run -p 5701:5701 -e HZ_LICENSEKEY= \ + -e "JAVA_OPTS=--add-modules jdk.incubator.vector -Dhazelcast.partition.count=16" \ + hazelcast/hazelcast-enterprise:latest-snapshot-slim-jdk21 +``` + == Configuration Collection configuration can be set dynamically during vector collection creation or statically during cluster configuration. Unlike other data structures, the configuration must be set up before the collection can be used. There is no default configuration for the vector collection. If no matching configuration is found for the specified vector collection, the system raises an error.