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.

Sign up for GitHub

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

Update README.md to add the java type and OSON type mappings. #145

Merged
merged 1 commit into from
Jan 27, 2025
+21 −0
Merged

Update README.md to add the java type and OSON type mappings. #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions ojdbc-provider-jackson-oson/README.md
View file
Original file line number Diff line number Diff line change
@@ -14,6 +14,27 @@ in order to use the Oracle JDBC driver's JSON processing capabilities. It, there
- **Java Types Handling**: Support for various complex and basic Java types during serialization and deserialization.
- **Jackson Annotation support**: Support for Jackson Annotations. Note: When **@Format** annotation is used, the values are processed as Strings.

## Java type to Oson Mappings
When the **OSON Provider for Jackson** is used the Java types are stored as their corresponding OSON types. The type
mapping is given by the following table.

| **Java Type** | **Oson Type** |
|--------------------------------------------|--------------------|
| `LocalDateTime` | `OSON TIMESTAMP` |
| `OffsetDateTime` | `OSON TIMESTAMPTZ` |
| `Period` | `OSON INTERVALYM` |
| `Duration` | `OSON INTERVALDS` |
| `BigInteger` | `OSON NUMBER` |
| `Year` | `OSON NUMBER` |
| `byte[]` | `OSON byte[]` |
| `java.util.Date` | `OSON DATE` |
| `java.sql.Date` | `OSON DATE` |
| `Timestamp` | `OSON TIMESTAMP` |
| `LocalDate` | `OSON DATE` |
| `Boolean` | `OSON BOOLEAN` |
| `UUID` | `OSON UUID byte[]` |


## Installation

All providers in this module are distributed as single jar on the Maven Central