bson-codecs-jsr310

bson-codecs-jsr310 copied to clipboard

BSON codecs for Java 8 Date and Time API (JSR-310)

The library provides codecs for the following JSR-310 classes:

• java.time.DayOfWeek
• java.time.Duration
• java.time.Instant
• java.time.LocalDate
• java.time.LocalDateTime
• java.time.LocalTime
• java.time.Month
• java.time.MonthDay
• java.time.OffsetDateTime
• java.time.OffsetTime
• java.time.Period
• java.time.Year
• java.time.YearMonth
• java.time.ZonedDateTime
• java.time.ZoneId
• java.time.ZoneOffset

Usage

In order to utilize the codecs one can use CodecRegistries helper, for example in case of Mongo synchronous client:

MongoClient mongoClient = MongoClients.create();

CodecRegistry codecRegistry = CodecRegistries.fromRegistries(
        MongoClientSettings.getDefaultCodecRegistry(),
        CodecRegistries.fromCodecs(new DurationAsDecimal128Codec())
);

MongoDatabase database = client
        .getDatabase(...)
        .withCodecRegistry(codecRegistry);

Note that depending on a context a different set of codecs might be necessary. There are three main factors to consider when choosing codecs:

• queryability - how much stored values are capable of being searched;
• sortability - how much stored values are capable of being ordered;
• readability - how much stored values are readable for human.

The table below presents the recommendations for all the factors. The more + signs a cell contains the better a row codec is in terms of a column factor: