Skip to content

Document default type mapping #133

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

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

Document default type mapping #133

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6073ec
Document default type mapping
stIncMale Oct 16, 2025
e5ca8eb
Merge branch 'main' into documentDefaultTypeMapping
stIncMale Oct 23, 2025
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
82 changes: 81 additions & 1 deletion src/main/java/com/mongodb/hibernate/dialect/MongoDialect.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,14 @@
import com.mongodb.hibernate.internal.type.ObjectIdJavaType;
import com.mongodb.hibernate.internal.type.ObjectIdJdbcType;
import com.mongodb.hibernate.jdbc.MongoConnectionProvider;
import java.math.BigDecimal;
import java.time.Instant;
import java.util.Collection;
import org.bson.types.ObjectId;
import org.hibernate.annotations.Struct;
import org.hibernate.boot.model.FunctionContributions;
import org.hibernate.boot.model.TypeContributions;
import org.hibernate.cfg.AvailableSettings;
import org.hibernate.dialect.DatabaseVersion;
import org.hibernate.dialect.Dialect;
import org.hibernate.dialect.aggregate.AggregateSupport;
Expand All @@ -46,6 +52,7 @@
import org.hibernate.sql.model.ValuesAnalysis;
import org.hibernate.sql.model.internal.OptionalTableUpdate;
import org.hibernate.sql.model.jdbc.OptionalTableUpdateOperation;
import org.hibernate.type.WrapperArrayHandling;
import org.hibernate.type.descriptor.sql.internal.DdlTypeImpl;
import org.jspecify.annotations.Nullable;

Expand All @@ -58,6 +65,79 @@
* creating a JDBC adaptor on top of <a href="https://www.mongodb.com/docs/drivers/java/sync/current/">MongoDB Java
* Driver</a>.
*
* <table>
* <caption>Default type mapping</caption>
* <thead>
* <tr>
* <th>Java type</th>
* <th><a href="https://www.mongodb.com/docs/manual/reference/bson-types/">BSON type</a></th>
* </tr>
* </thead>
* <tbody>
* <tr>
* <td><a href="https://docs.oracle.com/javase/specs/jls/se17/html/jls-4.html#jls-4.1">null type</a></td>
* <td>BSON {@code Null}</td>
* </tr>
* <tr>
* <td>{@code byte[]}</td>
* <td>BSON {@code Binary data} with subtype 0</td>
* </tr>
* <tr>
* <td>{@code char}, {@link Character}, {@link String}, {@code char[]}</td>
* <td>BSON {@code String}</td>
* </tr>
* <tr>
* <td>{@code int}, {@link Integer}</td>
* <td>BSON {@code 32-bit integer}</td>
* </tr>
* <tr>
* <td>{@code long}, {@link Long}</td>
* <td>BSON {@code 64-bit integer}</td>
* </tr>
* <tr>
* <td>{@code double}, {@link Double}</td>
* <td>BSON {@code Double}</td>
* </tr>
* <tr>
* <td>{@code boolean}, {@link Boolean}</td>
* <td>BSON {@code Boolean}</td>
* </tr>
* <tr>
* <td>{@link BigDecimal}</td>
* <td>BSON {@code Decimal128}</td>
* </tr>
* <tr>
* <td>{@link ObjectId}</td>
* <td>BSON {@code ObjectId}</td>
* </tr>
* <tr>
* <td>{@link Instant}</td>
* <td>BSON {@code Date}</td>
* </tr>
* <tr>
* <td>{@link Struct} <a href="https://docs.hibernate.org/orm/6.6/userguide/html_single/#embeddable-mapping-aggregate">aggregate embeddable</a></td>
* <td>
* BSON {@code Object}
*
* <p>Field values are mapped as per this table.
* </td>
* </tr>
* <tr>
* <td>
* array, {@link Collection} (or a subtype supported by Hibernate ORM),
* except for {@code byte[]}, {@code char[]}
*
* <p>Note that {@link Character}{@code []} requires setting {@value AvailableSettings#WRAPPER_ARRAY_HANDLING} to {@link WrapperArrayHandling#ALLOW}.
* </td>
* <td>
* BSON {@code Array}
*
* <p>Array elements are mapped as per this table.
* </td>
* </tr>
* </tbody>
* </table>
*
* <p>For the documentation on the supported <a
* href="https://docs.jboss.org/hibernate/orm/6.6/userguide/html_single/Hibernate_User_Guide.html#hql-exp-functions">HQL
* functions</a> see {@link #initializeFunctionRegistry(FunctionContributions)}.
Expand Down Expand Up @@ -225,7 +305,7 @@ public boolean supportsStandardArrays() {
* </li>
* <li>
* The second argument must not be an HQL path expression.
* Also, it must be an array and not be a {@link java.util.Collection} when specified as
* Also, it must be an array and not be a {@link Collection} when specified as
* {@linkplain org.hibernate.query.SelectionQuery#setParameter(String, Object) query parameter}.
* </li>
* </ul>
Expand Down