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

MongoDB documentation improvements #8515

Merged
merged 1 commit into from
Apr 10, 2020

Conversation

loicmathieu
Copy link
Contributor

Some improvements to the MongoDB documentation:

  • Clarify multi-tenancy (see discussions Provides multi-tenancy capabilities for MongoDB with Panache #7431 (comment))
  • Add a note on the cryptic Can't find a codec for class error that should be fixed via @RegisterForReflection. Maybe this note needs to be on MongoDB with Panache as it was reported with the usage of MongoDB with Panache (all now normally fixed).
  • Add some debugging tips

@loicmathieu
Copy link
Contributor Author

/cc @geoand

Copy link
Contributor

@geoand geoand left a comment

Choose a reason for hiding this comment

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

Added some small suggestions

docs/src/main/asciidoc/mongodb-panache.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/mongodb.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/mongodb.adoc Outdated Show resolved Hide resolved
====
If you encounter the following error when running your application in native mode: +
`Failed to encode 'MyObject'. Encoding 'myVariable' errored with: Can't find a codec for class org.acme.MyVariable.` +
This means that the `org.acme.MyVariable` class is not known to GraalVM, to fix this you can add the `@RegisterForReflection` annotation to your `MyVariable` class.
Copy link
Contributor

Choose a reason for hiding this comment

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

the remedy is to add the @RegisterForReflection annotation to your MyVariable class.

@loicmathieu loicmathieu force-pushed the improve-mongodb-docs branch from 88323ff to 2ab610c Compare April 10, 2020 08:47
@loicmathieu
Copy link
Contributor Author

@geoand I applied your suggestions

@geoand
Copy link
Contributor

geoand commented Apr 10, 2020

And I hadn't made any mistakes of my own 😆 ?

@geoand geoand merged commit 52dfc5e into quarkusio:master Apr 10, 2020
@geoand
Copy link
Contributor

geoand commented Apr 10, 2020

Thanks for this, these are very good clarifications!

@loicmathieu loicmathieu deleted the improve-mongodb-docs branch April 13, 2020 09:11
@gsmet gsmet added this to the 1.4.0.CR1 milestone Apr 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants