Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-903: add dependencies and POJO tip; backport type-name #1297

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

oliverhowell
Copy link
Contributor

Closes SUP-455 and DOCS-903

@oliverhowell oliverhowell added backport to 5.3 Backport commits from main to v/5.3 backport to 5.4 backport to 5.5 Backport commits from main to v/5.5 labels Sep 17, 2024
Copy link

netlify bot commented Sep 17, 2024

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
🔨 Latest commit 543beb0
🔍 Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/66eab7ff13dded0008f6fc82
😎 Deploy Preview https://deploy-preview-1297--hardcore-allen-f5257d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@oliverhowell oliverhowell marked this pull request as ready for review September 17, 2024 14:31

When you configure a map with the generic MapLoader, Hazelcast creates a xref:sql:mapping-to-jdbc.adoc[SQL mapping with the JDBC connector]. The name of the mapping is the same name as your map prefixed with `__map-store.`. This mapping is used to read data from the external system, and it is removed whenever the configured map is removed. You can also configure this SQL mapping, using <<data-connection-ref, configuration properties>>.

== Configuration Properties for the Generic MapLoader
== Configuration properties for the generic MapLoader
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
== Configuration properties for the generic MapLoader
== Configuration properties for the Generic MapLoader

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And is generic mapStore correct then?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, IMHO should have the same case. This case is used also in the title btw.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've looked at the other sources and I think we should refer to "generic MapLoader" in normal text. I know in code it is "Generic.MapLoader" and we use that when specifically including or referring to code (if we always used code names then our docs and marketing content would be all over the place). Check latest commit for proposed version.

== Quickstart Configuration
== Add dependencies

If you are using a Hazelcast JAR file, you need to ensure you have added the following dependencies to your pom.xml:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better wording would be that they need to be on the classpath. E.g. if you use the full docker image they are. If you use the slim image the hazelcast-mapstore is missing.

Also the section Supported backends below also mentions that you need jdbc driver or in case of using MongoDB you need the hazelcast-jet-mongodb jar. Maybe this could be unified into single place.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like this?

Suggested change
If you are using a Hazelcast JAR file, you need to ensure you have added the following dependencies to your pom.xml:
If you are using a Hazelcast JAR file, you need to ensure the following is added to your classpath:
NOTE: If you are using the slim distribution, you need to add `hazelcast-mapstore`. If you are using MongoDb, you also need to add `hazelcast-jet-mongodb`.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport to 5.3 Backport commits from main to v/5.3 backport to 5.4 backport to 5.5 Backport commits from main to v/5.5
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants