Skip to content

Commit

Permalink
Add note about enabling Panama for vector collections (#1177)
Browse files Browse the repository at this point in the history
Co-authored-by: Oliver Howell <[email protected]>
  • Loading branch information
k-jamroz and oliverhowell authored Jul 18, 2024
1 parent e5ddbc6 commit ee1996b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/modules/data-structures/pages/vector-collections.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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=<your_license_key> \
-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.
Expand Down

0 comments on commit ee1996b

Please sign in to comment.