use a dedicated type for native queries column info

hasura · Mar 13, 2024 · b61cb10 · b61cb10
1 parent eb6867a
commit b61cb10
Show file tree

Hide file tree

Showing 6 changed files with 140 additions and 18 deletions.
diff --git a/crates/configuration/src/version3/mod.rs b/crates/configuration/src/version3/mod.rs
@@ -179,15 +179,23 @@ pub fn occurring_scalar_types(
     tables: &metadata::TablesInfo,
     native_queries: &metadata::NativeQueries,
 ) -> BTreeSet<metadata::ScalarType> {
-    let tables_column_types = tables.0.values().flat_map(|v| v.columns.values());
-    let native_queries_column_types = native_queries.0.values().flat_map(|v| v.columns.values());
-    let native_queries_arguments_types =
-        native_queries.0.values().flat_map(|v| v.arguments.values());
+    let tables_column_types = tables
+        .0
+        .values()
+        .flat_map(|v| v.columns.values().map(|c| &c.r#type));
+    let native_queries_column_types = native_queries
+        .0
+        .values()
+        .flat_map(|v| v.columns.values().map(|c| &c.r#type));
+    let native_queries_arguments_types = native_queries
+        .0
+        .values()
+        .flat_map(|v| v.arguments.values().map(|c| &c.r#type));
 
     tables_column_types
         .chain(native_queries_column_types)
         .chain(native_queries_arguments_types)
-        .filter_map(|c| match c.r#type {
+        .filter_map(|t| match t {
             metadata::Type::ScalarType(ref t) => Some(t.clone()), // only keep scalar types
             metadata::Type::ArrayType(_) | metadata::Type::CompositeType(_) => None,
         })

diff --git a/crates/connectors/ndc-postgres/src/schema.rs b/crates/connectors/ndc-postgres/src/schema.rs
@@ -163,12 +163,12 @@ pub async fn get_schema(
             arguments: info
                 .arguments
                 .iter()
-                .map(|(name, column_info)| {
+                .map(|(name, readonly_column_info)| {
                     (
                         name.clone(),
                         models::ArgumentInfo {
-                            description: column_info.description.clone(),
-                            argument_type: column_to_type(column_info),
+                            description: readonly_column_info.description.clone(),
+                            argument_type: readonly_column_to_type(readonly_column_info),
                         },
                     )
                 })
@@ -208,7 +208,7 @@ pub async fn get_schema(
                         column.name.clone(),
                         models::ObjectField {
                             description: column.description.clone(),
-                            r#type: column_to_type(column),
+                            r#type: readonly_column_to_type(column),
                         },
                     )
                 })),
@@ -253,7 +253,7 @@ pub async fn get_schema(
                         name.clone(),
                         models::ArgumentInfo {
                             description: column_info.description.clone(),
-                            argument_type: column_to_type(column_info),
+                            argument_type: readonly_column_to_type(column_info),
                         },
                     )
                 })
@@ -286,6 +286,7 @@ pub async fn get_schema(
     })
 }
 
+/// Extract the models::Type representation of a column.
 fn column_to_type(column: &metadata::ColumnInfo) -> models::Type {
     match &column.nullable {
         metadata::Nullable::NonNullable => type_to_type(&column.r#type),
@@ -295,6 +296,16 @@ fn column_to_type(column: &metadata::ColumnInfo) -> models::Type {
     }
 }
 
+/// Extract the models::Type representation of a readonly column.
+fn readonly_column_to_type(column: &metadata::ReadOnlyColumnInfo) -> models::Type {
+    match &column.nullable {
+        metadata::Nullable::NonNullable => type_to_type(&column.r#type),
+        metadata::Nullable::Nullable => models::Type::Nullable {
+            underlying_type: Box::new(type_to_type(&column.r#type)),
+        },
+    }
+}
+
 fn type_to_type(typ: &metadata::Type) -> models::Type {
     match &typ {
         metadata::Type::ArrayType(typ) => models::Type::Array {

diff --git a/crates/query-engine/metadata/src/metadata/native_queries.rs b/crates/query-engine/metadata/src/metadata/native_queries.rs
@@ -22,10 +22,10 @@ pub struct NativeQueryInfo {
     /// such as `SELECT * FROM authors WHERE name = {{author_name}}`
     pub sql: NativeQuerySql,
     /// Columns returned by the Native Query
-    pub columns: BTreeMap<String, ColumnInfo>,
+    pub columns: BTreeMap<String, ReadOnlyColumnInfo>,
     #[serde(default)]
     /// Names and types of arguments that can be passed to this Native Query
-    pub arguments: BTreeMap<String, ColumnInfo>,
+    pub arguments: BTreeMap<String, ReadOnlyColumnInfo>,
     #[serde(default)]
     pub description: Option<String>,
     /// True if this native query mutates the database
@@ -34,6 +34,18 @@ pub struct NativeQueryInfo {
     pub is_procedure: bool,
 }
 
+/// Information about a native query column.
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
+pub struct ReadOnlyColumnInfo {
+    pub name: String,
+    pub r#type: Type,
+    #[serde(default)]
+    pub nullable: Nullable,
+    #[serde(default)]
+    pub description: Option<String>,
+}
+
 /// A part of a Native Query text, either raw text or a parameter.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub enum NativeQueryPart {

diff --git a/...s/snapshots/databases_tests__postgres__configuration_tests__get_configuration_schema.snap b/...s/snapshots/databases_tests__postgres__configuration_tests__get_configuration_schema.snap
@@ -807,15 +807,15 @@ expression: schema
           "description": "Columns returned by the Native Query",
           "type": "object",
           "additionalProperties": {
-            "$ref": "#/definitions/ColumnInfo"
+            "$ref": "#/definitions/ReadOnlyColumnInfo"
           }
         },
         "arguments": {
           "description": "Names and types of arguments that can be passed to this Native Query",
           "default": {},
           "type": "object",
           "additionalProperties": {
-            "$ref": "#/definitions/ColumnInfo"
+            "$ref": "#/definitions/ReadOnlyColumnInfo"
           }
         },
         "description": {
@@ -834,6 +834,37 @@ expression: schema
     "Native_query_sql": {
       "type": "string"
     },
+    "ReadOnlyColumnInfo": {
+      "description": "Information about a native query column.",
+      "type": "object",
+      "required": [
+        "name",
+        "type"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "$ref": "#/definitions/Type"
+        },
+        "nullable": {
+          "default": "nullable",
+          "allOf": [
+            {
+              "$ref": "#/definitions/Nullable"
+            }
+          ]
+        },
+        "description": {
+          "default": null,
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    },
     "AggregateFunctions": {
       "description": "All supported aggregate functions, grouped by type.",
       "type": "object",

diff --git a/...shots/databases_tests__postgres__configuration_tests__get_rawconfiguration_v3_schema.snap b/...shots/databases_tests__postgres__configuration_tests__get_rawconfiguration_v3_schema.snap
@@ -795,15 +795,15 @@ expression: schema
           "description": "Columns returned by the Native Query",
           "type": "object",
           "additionalProperties": {
-            "$ref": "#/definitions/ColumnInfo"
+            "$ref": "#/definitions/ReadOnlyColumnInfo"
           }
         },
         "arguments": {
           "description": "Names and types of arguments that can be passed to this Native Query",
           "default": {},
           "type": "object",
           "additionalProperties": {
-            "$ref": "#/definitions/ColumnInfo"
+            "$ref": "#/definitions/ReadOnlyColumnInfo"
           }
         },
         "description": {
@@ -822,6 +822,37 @@ expression: schema
     "Native_query_sql": {
       "type": "string"
     },
+    "ReadOnlyColumnInfo": {
+      "description": "Information about a native query column.",
+      "type": "object",
+      "required": [
+        "name",
+        "type"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "$ref": "#/definitions/Type"
+        },
+        "nullable": {
+          "default": "nullable",
+          "allOf": [
+            {
+              "$ref": "#/definitions/Nullable"
+            }
+          ]
+        },
+        "description": {
+          "default": null,
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    },
     "AggregateFunctions": {
       "description": "All supported aggregate functions, grouped by type.",
       "type": "object",

diff --git a/...shots/databases_tests__postgres__openapi_tests__openapi__up_to_date_generated_schema.snap b/...shots/databases_tests__postgres__openapi_tests__openapi__up_to_date_generated_schema.snap
@@ -789,15 +789,15 @@ expression: generated_schema_json
           "description": "Columns returned by the Native Query",
           "type": "object",
           "additionalProperties": {
-            "$ref": "#/components/schemas/ColumnInfo"
+            "$ref": "#/components/schemas/ReadOnlyColumnInfo"
           }
         },
         "arguments": {
           "description": "Names and types of arguments that can be passed to this Native Query",
           "default": {},
           "type": "object",
           "additionalProperties": {
-            "$ref": "#/components/schemas/ColumnInfo"
+            "$ref": "#/components/schemas/ReadOnlyColumnInfo"
           }
         },
         "description": {
@@ -814,6 +814,35 @@ expression: generated_schema_json
     "Native_query_sql": {
       "type": "string"
     },
+    "ReadOnlyColumnInfo": {
+      "description": "Information about a native query column.",
+      "type": "object",
+      "required": [
+        "name",
+        "type"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "$ref": "#/components/schemas/Type"
+        },
+        "nullable": {
+          "default": "nullable",
+          "allOf": [
+            {
+              "$ref": "#/components/schemas/Nullable"
+            }
+          ]
+        },
+        "description": {
+          "default": null,
+          "type": "string",
+          "nullable": true
+        }
+      }
+    },
     "AggregateFunctions": {
       "description": "All supported aggregate functions, grouped by type.",
       "type": "object",