fix: deprecation warnings in sqlite::types::chrono, document `DATET…

…IME` behavior
launchbadge · Mar 12, 2024 · a2b89d7 · a2b89d7
1 parent 248d617
commit a2b89d7
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 11 deletions.
diff --git a/sqlx-sqlite/src/types/chrono.rs b/sqlx-sqlite/src/types/chrono.rs
@@ -156,7 +156,7 @@ fn decode_datetime_from_text(value: &str) -> Option<DateTime<FixedOffset>> {
 }
 
 fn decode_datetime_from_int(value: i64) -> Option<DateTime<FixedOffset>> {
-    NaiveDateTime::from_timestamp_opt(value, 0).map(|dt| Utc.fix().from_utc_datetime(&dt))
+    Utc.fix().timestamp_opt(value, 0).single()
 }
 
 fn decode_datetime_from_float(value: f64) -> Option<DateTime<FixedOffset>> {
@@ -166,7 +166,7 @@ fn decode_datetime_from_float(value: f64) -> Option<DateTime<FixedOffset>> {
     let seconds = timestamp as i64;
     let nanos = (timestamp.fract() * 1E9) as u32;
 
-    NaiveDateTime::from_timestamp_opt(seconds, nanos).map(|dt| Utc.fix().from_utc_datetime(&dt))
+    Utc.fix().timestamp_opt(seconds, nanos).single()
 }
 
 impl<'r> Decode<'r, Sqlite> for NaiveDateTime {

diff --git a/sqlx-sqlite/src/types/mod.rs b/sqlx-sqlite/src/types/mod.rs
@@ -37,22 +37,45 @@
 //!
 //! | Rust type                             | Sqlite type(s)                                       |
 //! |---------------------------------------|------------------------------------------------------|
-//! | `chrono::NaiveDateTime`               | DATETIME                                             |
-//! | `chrono::DateTime<Utc>`               | DATETIME                                             |
-//! | `chrono::DateTime<Local>`             | DATETIME                                             |
-//! | `chrono::NaiveDate`                   | DATE                                                 |
-//! | `chrono::NaiveTime`                   | TIME                                                 |
+//! | `chrono::NaiveDateTime`               | DATETIME (TEXT, INTEGER, REAL)                       |
+//! | `chrono::DateTime<Utc>`               | DATETIME (TEXT, INTEGER, REAL)                       |
+//! | `chrono::DateTime<Local>`             | DATETIME (TEXT, INTEGER, REAL)                       |
+//! | `chrono::DateTime<FixedOffset>`       | DATETIME (TEXT, INTEGER, REAL)                       |
+//! | `chrono::NaiveDate`                   | DATE (TEXT only)                                     |
+//! | `chrono::NaiveTime`                   | TIME (TEXT only)                                     |
+//!
+//! ##### NOTE: `DATETIME` conversions
+//! SQLite may represent `DATETIME` values as one of three types: `TEXT`, `REAL`, or `INTEGER`.
+//! Which one is used is entirely up to you and how you store timestamps in your database.
+//!
+//! The deserialization for `NaiveDateTime`, `DateTime<Utc>` and `DateTime<Local>` infer the date
+//! format from the type of the value they're being decoded from:
+//!
+//! * If `TEXT`, the format is assumed to be an ISO-8601 compatible datetime string.
+//!   A number of possible formats are tried; see `sqlx-sqlite/src/types/chrono.rs` for the current
+//!   set of formats.
+//! * If `INTEGER`, it is expected to be the number of seconds since January 1, 1970 00:00 UTC,
+//!   as if returned from the `unixtime()` function (without the `subsec` modifier).
+//! * If `REAL`, it is expected to be the (possibly fractional) number of days since the Julian epoch,
+//!   November 24, 4714 BCE 12:00 UTC, as if returned from the `julianday()` function.
+//!
+//! These types will always encode to a datetime string, either
+//! with (`DateTime<Tz>` for any `Tz: TimeZone`) or without (`NaiveDateTime`) a timezone offset.
 //!
 //! ### [`time`](https://crates.io/crates/time)
 //!
 //! Requires the `time` Cargo feature flag.
 //!
 //! | Rust type                             | Sqlite type(s)                                       |
 //! |---------------------------------------|------------------------------------------------------|
-//! | `time::PrimitiveDateTime`             | DATETIME                                             |
-//! | `time::OffsetDateTime`                | DATETIME                                             |
-//! | `time::Date`                          | DATE                                                 |
-//! | `time::Time`                          | TIME                                                 |
+//! | `time::PrimitiveDateTime`             | DATETIME (TEXT, INTEGER)                             |
+//! | `time::OffsetDateTime`                | DATETIME (TEXT, INTEGER)                             |
+//! | `time::Date`                          | DATE (TEXT only)                                     |
+//! | `time::Time`                          | TIME (TEXT only)                                     |
+//!
+//! ##### NOTE: `DATETIME` conversions
+//! The behavior here is identical to the corresponding `chrono` types, minus the support for `REAL`
+//! values as Julian days (it's just not implemented).
 //!
 //! ### [`uuid`](https://crates.io/crates/uuid)
 //!