serde-sqlx 0.0.1

Allows deserializing Postgres rows into Rust types using serde
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
use deserializers::PgRowDeserializer;
use serde::de::Error;
use serde::de::{value::Error as DeError, Deserialize};

use sqlx::postgres::{PgRow, PgValueRef};

/// Convenience function: deserialize a PgRow into any T that implements Deserialize
pub fn from_pg_row<T>(row: PgRow) -> Result<T, DeError>
where
    T: for<'de> Deserialize<'de>,
{
    let deserializer = PgRowDeserializer::new(&row);
    T::deserialize(deserializer)
}

fn decode_raw_pg<'a, T>(raw_value: PgValueRef<'a>) -> Result<T, DeError>
where
    T: sqlx::Decode<'a, sqlx::Postgres>,
{
    T::decode(raw_value).map_err(|err| {
        DeError::custom(format!(
            "Failed to decode {} value: {:?}",
            std::any::type_name::<T>(),
            err,
        ))
    })
}

mod seq_access {
    use std::fmt::Debug;

    use serde::de::{value::Error as DeError, DeserializeSeed, SeqAccess, Visitor};
    use serde::ser::Error as _;
    use serde::{de, forward_to_deserialize_any};
    use sqlx::{postgres::PgValueRef, Row};

    use crate::{
        decode_raw_pg,
        deserializers::{PgRowDeserializer, PgValueDeserializer},
    };

    /// A SeqAccess implementation that iterates over the row’s columns
    pub(crate) struct PgRowSeqAccess<'a> {
        pub(crate) deserializer: PgRowDeserializer<'a>,
        pub(crate) num_cols: usize,
    }

    impl<'de, 'a> SeqAccess<'de> for PgRowSeqAccess<'a> {
        type Error = DeError;

        fn next_element_seed<T>(&mut self, seed: T) -> Result<Option<T::Value>, Self::Error>
        where
            T: DeserializeSeed<'de>,
        {
            if self.deserializer.index < self.num_cols {
                let value = self
                    .deserializer
                    .row
                    .try_get_raw(self.deserializer.index)
                    .map_err(DeError::custom)?;

                // Create a PgValueDeserializer for the current column.
                let pg_value_deserializer = PgValueDeserializer { value };

                self.deserializer.index += 1;

                // Deserialize the value and return it wrapped in Some.
                seed.deserialize(pg_value_deserializer).map(Some)
            } else {
                Ok(None)
            }
        }
    }

    use serde::de::IntoDeserializer;

    /// SeqAccess implementation for Postgres arrays
    /// It decodes a raw Postgres array, such as TEXT[] into a `Vec<Option<T>>` and
    /// then yields each element during deserialization
    pub struct PgArraySeqAccess<T> {
        iter: std::vec::IntoIter<Option<T>>,
    }

    impl<'de, 'a, T> PgArraySeqAccess<T>
    where
        T: sqlx::Decode<'a, sqlx::Postgres> + Debug,
    {
        pub fn new(value: PgValueRef<'a>) -> Result<Self, DeError>
        where
            Vec<Option<T>>: sqlx::Decode<'a, sqlx::Postgres> + Debug,
        {
            let vec: Vec<Option<T>> = decode_raw_pg(value)?;

            Ok(PgArraySeqAccess {
                iter: vec.into_iter(),
            })
        }
    }

    impl<'de, T> SeqAccess<'de> for PgArraySeqAccess<T>
    where
        T: IntoDeserializer<'de, DeError>,
    {
        type Error = DeError;

        fn next_element_seed<U>(&mut self, seed: U) -> Result<Option<U::Value>, Self::Error>
        where
            U: DeserializeSeed<'de>,
        {
            let Some(value) = self.iter.next() else {
                return Ok(None);
            };

            seed.deserialize(PgArrayElementDeserializer { value })
                .map(Some)
        }
    }

    /// Yet another deserializer, this time to handles Options
    struct PgArrayElementDeserializer<T> {
        pub value: Option<T>,
    }

    impl<'de, T> de::Deserializer<'de> for PgArrayElementDeserializer<T>
    where
        T: IntoDeserializer<'de, DeError>,
    {
        type Error = DeError;

        fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            match self.value {
                Some(v) => visitor.visit_some(v.into_deserializer()),
                None => visitor.visit_none(),
            }
        }

        fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            match self.value {
                Some(v) => v.into_deserializer().deserialize_any(visitor),
                None => Err(DeError::custom(
                    "unexpected null in non-optional array element",
                )),
            }
        }

        forward_to_deserialize_any! {
            bool i8 i16 i32 i64 i128 u8 u16 u32 u64 u128 f32 f64 char str string
            bytes byte_buf unit unit_struct newtype_struct seq tuple tuple_struct
            map struct enum identifier ignored_any
        }
    }
}

mod map_access {
    use serde::de::{self, value::Error as DeError, IntoDeserializer, MapAccess};
    use serde::ser::Error as _;

    use sqlx::{Column, Row};

    use crate::deserializers::{PgRowDeserializer, PgValueDeserializer};

    pub(crate) struct PgRowMapAccess<'a> {
        pub(crate) deserializer: PgRowDeserializer<'a>,
        pub(crate) num_cols: usize,
    }

    impl<'de, 'a> MapAccess<'de> for PgRowMapAccess<'a> {
        type Error = DeError;

        fn next_key_seed<K>(&mut self, seed: K) -> Result<Option<K::Value>, Self::Error>
        where
            K: de::DeserializeSeed<'de>,
        {
            if self.deserializer.index < self.num_cols {
                let col_name = self.deserializer.row.columns()[self.deserializer.index].name();
                // Use the column name as the key
                seed.deserialize(col_name.into_deserializer()).map(Some)
            } else {
                Ok(None)
            }
        }

        fn next_value_seed<V>(&mut self, seed: V) -> Result<V::Value, Self::Error>
        where
            V: de::DeserializeSeed<'de>,
        {
            let value = self
                .deserializer
                .row
                .try_get_raw(self.deserializer.index)
                .map_err(DeError::custom)?;
            let pg_type_deserializer = PgValueDeserializer { value };

            self.deserializer.index += 1;

            seed.deserialize(pg_type_deserializer)
        }
    }
}

mod deserializers {
    use crate::decode_raw_pg;
    use crate::json::PgJson;
    use crate::map_access::PgRowMapAccess;
    use crate::seq_access::{PgArraySeqAccess, PgRowSeqAccess};
    use serde::de::{value::Error as DeError, Deserializer, Visitor};
    use serde::de::{Error as _, IntoDeserializer};
    use serde::forward_to_deserialize_any;
    use sqlx::postgres::{PgRow, PgValueRef};
    use sqlx::{Row, TypeInfo, ValueRef};

    #[derive(Clone, Copy)]
    pub struct PgRowDeserializer<'a> {
        pub(crate) row: &'a PgRow,
        pub(crate) index: usize,
    }

    impl<'a> PgRowDeserializer<'a> {
        pub fn new(row: &'a PgRow) -> Self {
            PgRowDeserializer { row, index: 0 }
        }

        #[allow(unused)]
        pub fn is_json(&self) -> bool {
            self.row.try_get_raw(0).map_or(false, |value| {
                matches!(value.type_info().name(), "JSON" | "JSONB")
            })
        }
    }

    impl<'de, 'a> Deserializer<'de> for PgRowDeserializer<'a> {
        type Error = DeError;

        fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            let raw_value = self.row.try_get_raw(0).map_err(DeError::custom)?;

            if raw_value.is_null() {
                visitor.visit_none()
            } else {
                visitor.visit_some(self)
            }
        }

        fn deserialize_newtype_struct<V>(
            self,
            _name: &'static str,
            visitor: V,
        ) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            visitor.visit_newtype_struct(self)
        }

        fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            match self.row.columns().len() {
                0 => return visitor.visit_unit(),
                1 => {}
                _n => {
                    return self.deserialize_seq(visitor);
                }
            };

            let raw_value = self.row.try_get_raw(self.index).map_err(DeError::custom)?;
            let type_info = raw_value.type_info();
            let type_name = type_info.name();

            if raw_value.is_null() {
                return visitor.visit_none();
            }

            // If this is a BOOL[], TEXT[], etc
            if type_name.ends_with("[]") {
                return self.deserialize_seq(visitor);
            }

            // Direct all "basic" types down to `PgValueDeserializer`
            let deserializer = PgValueDeserializer { value: raw_value };

            deserializer.deserialize_any(visitor)
        }

        /// We treat the row as a map (each column is a key/value pair)
        fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            visitor.visit_map(PgRowMapAccess {
                deserializer: self,
                num_cols: self.row.columns().len(),
            })
        }

        fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            let raw_value = self.row.try_get_raw(self.index).map_err(DeError::custom)?;
            let type_info = raw_value.type_info();
            let type_name = type_info.name();

            match type_name {
                "TEXT[]" | "VARCHAR[]" => {
                    let seq_access = PgArraySeqAccess::<String>::new(raw_value)?;
                    visitor.visit_seq(seq_access)
                }
                "INT4[]" => {
                    let seq_access = PgArraySeqAccess::<i32>::new(raw_value)?;
                    visitor.visit_seq(seq_access)
                }
                "JSON[]" | "JSONB[]" => {
                    let seq_access = PgArraySeqAccess::<PgJson>::new(raw_value)?;
                    visitor.visit_seq(seq_access)
                }
                "BOOL[]" => {
                    let seq_access = PgArraySeqAccess::<bool>::new(raw_value)?;
                    visitor.visit_seq(seq_access)
                }
                _ => {
                    let seq_access = PgRowSeqAccess {
                        deserializer: self,
                        num_cols: self.row.columns().len(),
                    };

                    visitor.visit_seq(seq_access)
                }
            }
        }

        fn deserialize_tuple<V>(self, _len: usize, visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            self.deserialize_seq(visitor)
        }

        fn deserialize_struct<V>(
            self,
            _name: &'static str,
            fields: &'static [&'static str],
            visitor: V,
        ) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            let raw_value = self.row.try_get_raw(self.index).map_err(DeError::custom)?;
            let type_info = raw_value.type_info();
            let type_name = type_info.name();

            if type_name == "JSON" || type_name == "JSONB" {
                let value = decode_raw_pg::<PgJson>(raw_value).map_err(|err| {
                    DeError::custom(format!("Failed to decode JSON/JSONB: {err}"))
                })?;

                if let serde_json::Value::Object(ref obj) = value.0 {
                    if fields.len() == 1 {
                        // If there's only one expected field, check if the object already contains it.
                        if obj.contains_key(fields[0]) {
                            // If so, we can deserialize directly.
                            return value.into_deserializer().deserialize_any(visitor);
                        } else {
                            // Otherwise, wrap the object in a new map keyed by that field name.
                            let mut map = serde_json::Map::new();
                            map.insert(fields[0].to_owned(), value.0);
                            return map
                                .into_deserializer()
                                .deserialize_any(visitor)
                                .map_err(DeError::custom);
                        }
                    } else {
                        // For multiple expected fields, ensure the JSON object already contains all of them.
                        if fields.iter().all(|&field| obj.contains_key(field)) {
                            return value.into_deserializer().deserialize_any(visitor);
                        } else {
                            return Err(DeError::custom(format!(
                                "JSON object missing expected keys: expected {:?}, found keys {:?}",
                                fields,
                                obj.keys().collect::<Vec<_>>()
                            )));
                        }
                    }
                } else {
                    // For non-object JSON values, delegate directly.
                    return value.into_deserializer().deserialize_any(visitor);
                }
            }

            // Fallback for non-JSON types.
            self.deserialize_map(visitor)
        }

        // For other types, forward to deserialize_any.
        forward_to_deserialize_any! {
            bool i8 i16 i32 i64 u8 u16 u32 u64 f32 f64 char str string
            bytes byte_buf unit unit_struct
            tuple_struct enum identifier ignored_any
        }
    }

    /// An "inner" deserializer
    #[derive(Clone)]
    pub(crate) struct PgValueDeserializer<'a> {
        pub(crate) value: PgValueRef<'a>,
    }

    impl<'de, 'a> Deserializer<'de> for PgValueDeserializer<'a> {
        type Error = DeError;

        fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            if self.value.is_null() {
                visitor.visit_none()
            } else {
                visitor.visit_some(self)
            }
        }

        fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            if self.value.is_null() {
                return visitor.visit_none();
            }
            let type_info = self.value.type_info();

            let type_name = type_info.name();

            match type_name {
                "FLOAT4" => {
                    let v = decode_raw_pg::<f32>(self.value)?;
                    visitor.visit_f32(v)
                }
                "FLOAT8" => {
                    let v = decode_raw_pg::<f64>(self.value)?;
                    visitor.visit_f64(v)
                }
                "NUMERIC" => {
                    let numeric = decode_raw_pg::<rust_decimal::Decimal>(self.value)?;

                    let num: f64 = numeric
                        .try_into()
                        .map_err(|_| DeError::custom("Failed to parse Decimal as f64"))?;

                    visitor.visit_f64(num)
                }
                "INT8" => {
                    let v = decode_raw_pg::<i64>(self.value)?;
                    visitor.visit_i64(v)
                }
                "INT4" => {
                    let v = decode_raw_pg::<i32>(self.value)?;
                    visitor.visit_i32(v)
                }
                "INT2" => {
                    let v = decode_raw_pg::<i16>(self.value)?;
                    visitor.visit_i16(v)
                }
                "BOOL" => {
                    let v = decode_raw_pg::<bool>(self.value)?;
                    visitor.visit_bool(v)
                }
                "DATE" => {
                    let date = decode_raw_pg::<chrono::NaiveDate>(self.value)?;
                    visitor.visit_string(date.to_string())
                }
                "TIME" | "TIMETZ" => {
                    let time = decode_raw_pg::<chrono::NaiveTime>(self.value)?;
                    visitor.visit_string(time.to_string())
                }
                "TIMESTAMP" | "TIMESTAMPTZ" => {
                    let ts = decode_raw_pg::<chrono::DateTime<chrono::FixedOffset>>(self.value)?;
                    visitor.visit_string(ts.to_rfc3339())
                }
                "UUID" => {
                    let uuid = decode_raw_pg::<uuid::Uuid>(self.value)?;
                    visitor.visit_string(uuid.to_string())
                }
                "BYTEA" => {
                    let bytes = decode_raw_pg::<&[u8]>(self.value)?;
                    visitor.visit_bytes(bytes)
                }
                "INTERVAL" => {
                    let pg_interval =
                        decode_raw_pg::<sqlx::postgres::types::PgInterval>(self.value)?;
                    let secs = pg_interval.microseconds / 1_000_000;
                    let nanos = (pg_interval.microseconds % 1_000_000) * 1000;
                    let days_duration = chrono::Duration::days(pg_interval.days as i64);
                    let duration = chrono::Duration::seconds(secs)
                        + chrono::Duration::nanoseconds(nanos)
                        + days_duration;
                    visitor.visit_string(duration.to_string())
                }
                "CHAR" | "TEXT" => {
                    let s = decode_raw_pg::<String>(self.value)?;
                    visitor.visit_string(s)
                }
                "JSON" | "JSONB" => {
                    let value = decode_raw_pg::<PgJson>(self.value)?;

                    value.into_deserializer().deserialize_any(visitor)
                }
                _other => {
                    let as_string = decode_raw_pg::<String>(self.value.clone())?;
                    visitor.visit_string(as_string)
                }
            }
        }

        // For other types, forward to deserialize_any.
        forward_to_deserialize_any! {
            bool i8 i16 i32 i64 u8 u16 u32 u64 f32 f64 char str string
            bytes byte_buf unit unit_struct newtype_struct struct
            tuple_struct enum identifier ignored_any tuple seq map
        }
    }
}

mod json {
    use serde::{
        de::{self, value::Error as DeError, Deserializer, Error, IntoDeserializer},
        forward_to_deserialize_any,
    };
    use serde_json::Value;
    use sqlx::{
        postgres::{PgTypeInfo, PgValueRef},
        Postgres, TypeInfo, ValueRef,
    };

    /// Decodes Postgres' JSON or JSONB into serde_json::Value
    #[derive(Debug)]
    pub(crate) struct PgJson(pub(crate) serde_json::Value);

    impl<'a> sqlx::Decode<'a, sqlx::Postgres> for PgJson {
        fn decode(value: PgValueRef<'a>) -> Result<Self, sqlx::error::BoxDynError> {
            let is_jsonb = match value.type_info().name() {
                "JSON" => false,
                "JSONB" => true,
                other => unreachable!("Got {other} in PgJson"),
            };

            let mut bytes = value.as_bytes()?;

            // For JSONB, the first byte is a version (should be 1)
            if is_jsonb {
                if bytes.is_empty() || bytes[0] != 1 {
                    return Err("invalid JSONB header".into());
                }

                // Skip the version byte
                bytes = &bytes[1..]
            };

            let value = serde_json::from_slice(bytes)?;

            Ok(PgJson(value))
        }
    }

    impl sqlx::Type<Postgres> for PgJson {
        fn type_info() -> PgTypeInfo {
            PgTypeInfo::with_name("JSON")
        }
    }

    pub struct PgJsonDeserializer {
        value: Value,
    }

    impl<'de> Deserializer<'de> for PgJsonDeserializer {
        type Error = DeError;

        fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
        where
            V: de::Visitor<'de>,
        {
            // Delegate to serde_json::Value's own Deserializer
            self.value.deserialize_any(visitor).map_err(DeError::custom)
        }

        forward_to_deserialize_any! {
            bool i8 i16 i32 i64 u8 u16 u32 u64 f32 f64 char str string
            bytes byte_buf option unit unit_struct newtype_struct seq tuple
            tuple_struct map struct enum identifier ignored_any
        }
    }

    impl<'de> IntoDeserializer<'de> for PgJson {
        type Deserializer = PgJsonDeserializer;

        fn into_deserializer(self) -> Self::Deserializer {
            PgJsonDeserializer { value: self.0 }
        }
    }
}