Skip to content

Commit

Permalink
docs: update documentation explaning more about serialization to colu…
Browse files Browse the repository at this point in the history
…mn annotation at keyvalue

Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
  • Loading branch information
otaviojava committed Feb 16, 2024
1 parent 0fd4d1a commit 76df537
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions spec/src/main/asciidoc/chapters/api/annotations.adoc
Expand Up @@ -335,3 +335,7 @@ Here's a generated JSON sample of this structure:
----

This JSON structure represents a serialized `Person` entity with `nickname`, `name`, and `phones` attributes. The `nickname`, `name`, and `phones` fields are mapped to corresponding database columns.

When using the `@Column` annotation, it's important to remember that Key-Value databases usually only require the `@Id` annotation to identify unique entities. The Jakarta NoSQL provider will determine how to serialize the object for storage, which can be combined with other annotations, such as Jakarta JSON Binding, to customize the serialization process. This flexibility allows developers to adapt the serialization process to the specific requirements of their database.

If you use NoSQL databases that serialize information to JSON, you can integrate them with Jakarta JSON Binding. The Jakarta NoSQL provider will define the integration process, ensuring a smooth and efficient serialization of data to the JSON format.

0 comments on commit 76df537

Please sign in to comment.