What is the best practice for preserving regional time zone offsets in Realm Java/Kotlin?

Answer

Use a dual‑field approach: store the event time as a native java.util.Date (UTC) and keep a separate String that holds the IANA ZoneId (e.g., America/New_York). This preserves query performance while enabling accurate local‑time reconstruction.

Why This Works

• Realm’s Date type is indexed and supports range queries, sorting, and other date operators.
• The IANA zone ID contains all DST rules and historical changes, so ZonedDateTime can compute the correct offset for any instant.
• An integer offset would be static; it can’t adapt to future DST transitions or changes in regional legislation.

Implementation Steps (Java/Kotlin)

1. Define the model. Example in Kotlin:

   open class Event : RealmObject() {
       var timestamp: Date? = null   // UTC instant
       var zoneId: String? = null    // IANA zone ID
   }
   

2. Persist data. Convert a ZonedDateTime to UTC before storing:

   val now = ZonedDateTime.now(ZoneId.of("America/New_York"))
   val event = realm.createObject(Event::class.java)
   event.timestamp = Date.from(now.toInstant())
   event.zoneId = now.zone.id
   

3. Retrieve and reconstruct local time. At read time:

   val instant = event.timestamp.toInstant()
   val zone = ZoneId.of(event.zoneId)
   val local = ZonedDateTime.ofInstant(instant, zone)
   

4. Query by absolute time. Use Realm’s date operators on timestamp for range, sorting, etc., without touching zoneId.

Considerations & Verification

• Ensure the device’s IANA time‑zone database is up to date; otherwise future DST changes may be mis‑calculated.
• Run a quick test: create an event, save it, query by a date range, and confirm the reconstructed local time matches expectations.
• Do not store the full ISO‑8601 string; that would disable Realm’s native indexing.

Missing Diagnostic Detail

Does your application need to handle future changes to regional time‑zone rules (e.g., a country adopting a new DST policy)? If so, the IANA ZoneId approach is mandatory; an integer offset would become invalid over time.