Merge pull request #4325 from prkbuilds/pg_json_populate_record

Adding Support for `json_populate_record` and `jsonb_populate_record`
diesel-rs · Nov 17, 2024 · 27421b9 · 27421b9
2 parents e659b01 + bbf1ae2
commit 27421b9
Show file tree

Hide file tree

Showing 4 changed files with 155 additions and 7 deletions.
diff --git a/diesel/src/pg/expression/expression_methods.rs b/diesel/src/pg/expression/expression_methods.rs
@@ -1,11 +1,11 @@
 //! PostgreSQL specific expression methods
 
 pub(in crate::pg) use self::private::{
-    ArrayOrNullableArray, CombinedNullableValue, InetOrCidr, JsonIndex, JsonOrNullableJson,
-    JsonOrNullableJsonOrJsonbOrNullableJsonb, JsonRemoveIndex, JsonbOrNullableJsonb,
-    MaybeNullableValue, MultirangeOrNullableMultirange, MultirangeOrRangeMaybeNullable,
-    RangeOrMultirange, RangeOrNullableRange, RecordOrNullableRecord, TextArrayOrNullableTextArray,
-    TextOrNullableText,
+    ArrayOrNullableArray, CombinedAllNullableValue, CombinedNullableValue, InetOrCidr, JsonIndex,
+    JsonOrNullableJson, JsonOrNullableJsonOrJsonbOrNullableJsonb, JsonRemoveIndex,
+    JsonbOrNullableJsonb, MaybeNullableValue, MultirangeOrNullableMultirange,
+    MultirangeOrRangeMaybeNullable, RangeOrMultirange, RangeOrNullableRange,
+    RecordOrNullableRecord, TextArrayOrNullableTextArray, TextOrNullableText,
 };
 use super::date_and_time::{AtTimeZone, DateTimeLike};
 use super::operators::*;
@@ -3378,8 +3378,8 @@ where
 
 pub(in crate::pg) mod private {
     use crate::sql_types::{
-        Array, Binary, Cidr, Inet, Integer, Json, Jsonb, MaybeNullableType, Multirange, Nullable,
-        OneIsNullable, Range, Record, SingleValue, SqlType, Text,
+        AllAreNullable, Array, Binary, Cidr, Inet, Integer, Json, Jsonb, MaybeNullableType,
+        Multirange, Nullable, OneIsNullable, Range, Record, SingleValue, SqlType, Text,
     };
     use crate::{Expression, IntoSql};
 
@@ -3726,4 +3726,19 @@ pub(in crate::pg) mod private {
 
     impl<T> RecordOrNullableRecord for Record<T> {}
     impl<T> RecordOrNullableRecord for Nullable<Record<T>> {}
+
+    pub trait CombinedAllNullableValue<O, Out>: SingleValue {
+        type Out: SingleValue;
+    }
+
+    impl<T, O, Out> CombinedAllNullableValue<O, Out> for T
+    where
+        T: SingleValue,
+        O: SingleValue,
+        T::IsNull: AllAreNullable<O::IsNull>,
+        <T::IsNull as AllAreNullable<O::IsNull>>::Out: MaybeNullableType<Out>,
+        <<T::IsNull as AllAreNullable<O::IsNull>>::Out as MaybeNullableType<Out>>::Out: SingleValue,
+    {
+        type Out = <<T::IsNull as AllAreNullable<O::IsNull>>::Out as MaybeNullableType<Out>>::Out;
+    }
 }
diff --git a/diesel/src/pg/expression/functions.rs b/diesel/src/pg/expression/functions.rs
@@ -3,6 +3,7 @@
 use super::expression_methods::InetOrCidr;
 use crate::expression::functions::define_sql_function;
 use crate::pg::expression::expression_methods::ArrayOrNullableArray;
+use crate::pg::expression::expression_methods::CombinedAllNullableValue;
 use crate::pg::expression::expression_methods::CombinedNullableValue;
 use crate::pg::expression::expression_methods::JsonOrNullableJson;
 use crate::pg::expression::expression_methods::JsonbOrNullableJsonb;
@@ -2279,3 +2280,121 @@ define_sql_function! {
     #[sql_name = "row_to_json"]
     fn row_to_json<R: RecordOrNullableRecord + MaybeNullableValue<Json>>(record: R) -> R::Out;
 }
+
+#[cfg(feature = "postgres_backend")]
+define_sql_function! {
+    /// This function `json_populate_record` takes a Record base and Json as an input and converts it to top-level
+    /// JSON object to a row having the composite type of the base argument.
+    ///
+    /// # Example
+    ///
+    /// ```rust
+    /// # include!("../../doctest_setup.rs");
+    /// #
+    /// # fn main() {
+    /// #     #[cfg(feature = "serde_json")]
+    /// #     run_test().unwrap();
+    /// # }
+    /// #
+    /// # #[cfg(feature = "serde_json")]
+    /// # fn run_test() -> QueryResult<()> {
+    /// #     use diesel::dsl::json_populate_record;
+    /// #     use diesel::dsl::sql;
+    /// #     use diesel::sql_types::{Record, Text, Integer, Json};
+    /// #     use serde_json::Value;
+    /// #     let connection = &mut establish_connection();
+    ///
+    /// let expected: Value = serde_json::json!({
+    ///     "f1": "Alice",
+    ///     "f2": 16
+    /// });
+    /// let record: (String, i32) = diesel::select(json_populate_record::<Record<(Text, Integer)>, Json, _, _>(
+    ///         sql::<Record<(Text, Integer)>>("ROW('John', 30)"),
+    ///         expected
+    /// )).get_result(connection)?;
+    /// assert_eq!(record, ("Alice".to_string(), 16));
+    ///
+    /// let expected: Value = serde_json::json!({});
+    /// let record: (String, i32) = diesel::select(json_populate_record::<Record<(Text, Integer)>, Json, _, _>(
+    ///         sql::<Record<(Text, Integer)>>("ROW('John', 30)"),
+    ///         expected
+    /// )).get_result(connection)?;
+    /// assert_eq!(record, ("John".to_string(), 30));
+    ///
+    /// let expected: Value = serde_json::json!({
+    ///     "f1": "Alice"
+    /// });
+    /// let record: (String, i32) = diesel::select(json_populate_record::<Record<(Text, Integer)>, Json, _, _>(
+    ///         sql::<Record<(Text, Integer)>>("ROW('John', 30)"),
+    ///         expected
+    /// )).get_result(connection)?;
+    /// assert_eq!(record, ("Alice".to_string(), 30));
+    ///
+    /// #    Ok(())
+    /// # }
+    /// ```
+    #[sql_name = "json_populate_record"]
+    fn json_populate_record<
+        B: RecordOrNullableRecord + SingleValue,
+        J: JsonOrNullableJson + CombinedAllNullableValue<Json, B>
+    >(base: B, from_json: J) -> J::Out;
+}
+
+#[cfg(feature = "postgres_backend")]
+define_sql_function! {
+    /// This function `jsonb_populate_record` takes a Record base and Jsonb as an input and converts it to top-level
+    /// JSON object to a row having the composite type of the base argument.
+    ///
+    /// # Example
+    ///
+    /// ```rust
+    /// # include!("../../doctest_setup.rs");
+    /// #
+    /// # fn main() {
+    /// #     #[cfg(feature = "serde_json")]
+    /// #     run_test().unwrap();
+    /// # }
+    /// #
+    /// # #[cfg(feature = "serde_json")]
+    /// # fn run_test() -> QueryResult<()> {
+    /// #     use diesel::dsl::jsonb_populate_record;
+    /// #     use diesel::dsl::sql;
+    /// #     use diesel::sql_types::{Record, Text, Integer, Jsonb};
+    /// #     use serde_json::Value;
+    /// #     let connection = &mut establish_connection();
+    ///
+    /// let expected: Value = serde_json::json!({
+    ///     "f1": "Alice",
+    ///     "f2": 16
+    /// });
+    /// let record: (String, i32) = diesel::select(jsonb_populate_record::<Record<(Text, Integer)>, Jsonb, _, _>(
+    ///         sql::<Record<(Text, Integer)>>("ROW('John', 30)"),
+    ///         expected
+    /// )).get_result(connection)?;
+    /// assert_eq!(record, ("Alice".to_string(), 16));
+    ///
+    /// let expected: Value = serde_json::json!({});
+    /// let record: (String, i32) = diesel::select(jsonb_populate_record::<Record<(Text, Integer)>, Jsonb, _, _>(
+    ///         sql::<Record<(Text, Integer)>>("ROW('John', 30)"),
+    ///         expected
+    /// )).get_result(connection)?;
+    /// assert_eq!(record, ("John".to_string(), 30));
+    ///
+    /// let expected: Value = serde_json::json!({
+    ///     "f2": 42,
+    /// });
+    /// let record: (String, i32) = diesel::select(jsonb_populate_record::<Record<(Text, Integer)>, Jsonb, _, _>(
+    ///         sql::<Record<(Text, Integer)>>("ROW('John', 30)"),
+    ///         expected
+    /// )).get_result(connection)?;
+    /// assert_eq!(record, ("John".to_string(), 42));
+    ///
+    /// #    Ok(())
+    /// # }
+    /// ```
+    #[sql_name = "jsonb_populate_record"]
+    fn jsonb_populate_record<
+        B: RecordOrNullableRecord + SingleValue,
+        J: JsonbOrNullableJsonb + CombinedAllNullableValue<Jsonb, B>
+    >(base: B, from_json: J) -> J::Out;
+}
diff --git a/diesel/src/pg/expression/helper_types.rs b/diesel/src/pg/expression/helper_types.rs
@@ -556,3 +556,15 @@ pub type jsonb_object_with_keys_and_values<K, V> =
 #[allow(non_camel_case_types)]
 #[cfg(feature = "postgres_backend")]
 pub type row_to_json<R> = super::functions::row_to_json<SqlTypeOf<R>, R>;
+
+/// Return type of [`json_populate_record(base, json)`](super::functions::json_populate_record())
+#[allow(non_camel_case_types)]
+#[cfg(feature = "postgres_backend")]
+pub type json_populate_record<B, J> =
+    super::functions::json_populate_record<SqlTypeOf<B>, SqlTypeOf<J>, B, J>;
+
+/// Return type of [`jsonb_populate_record(base, json)`](super::functions::jsonb_populate_record())
+#[allow(non_camel_case_types)]
+#[cfg(feature = "postgres_backend")]
+pub type jsonb_populate_record<B, J> =
+    super::functions::jsonb_populate_record<SqlTypeOf<B>, SqlTypeOf<J>, B, J>;
diff --git a/diesel_derives/tests/auto_type.rs b/diesel_derives/tests/auto_type.rs
@@ -453,6 +453,8 @@ fn postgres_functions() -> _ {
         jsonb_object(pg_extras::text_array),
         jsonb_object_with_keys_and_values(pg_extras::text_array, pg_extras::text_array),
         row_to_json(pg_extras::record),
+        json_populate_record(pg_extras::record, pg_extras::json),
+        jsonb_populate_record(pg_extras::record, pg_extras::jsonb),
     )
 }