Dmoverton/schemaless capability

PR-URL: hasura/graphql-engine-mono#9667 GitOrigin-RevId: 41b3928e976703633437ef14624ec00fb0a8498d
hasura · Jun 27, 2023 · 37560dd · 37560dd
1 parent b11203f
commit 37560dd
Show file tree

Hide file tree

Showing 13 changed files with 46 additions and 17 deletions.
diff --git a/dc-agents/dc-api-types/package.json b/dc-agents/dc-api-types/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@hasura/dc-api-types",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "description": "Hasura GraphQL Engine Data Connector Agent API types",
   "author": "Hasura (https://github.com/hasura/graphql-engine)",
   "license": "Apache-2.0",

diff --git a/dc-agents/dc-api-types/src/agent.openapi.json b/dc-agents/dc-api-types/src/agent.openapi.json
@@ -558,6 +558,11 @@
             "default": false,
             "description": "Whether tables can have primary keys",
             "type": "boolean"
+          },
+          "supports_schemaless_tables": {
+            "default": false,
+            "description": "Whether the database supports tables with no defined schema",
+            "type": "boolean"
           }
         },
         "type": "object"

diff --git a/dc-agents/dc-api-types/src/models/DataSchemaCapabilities.ts b/dc-agents/dc-api-types/src/models/DataSchemaCapabilities.ts
@@ -14,5 +14,9 @@ export type DataSchemaCapabilities = {
    * Whether tables can have primary keys
    */
   supports_primary_keys?: boolean;
+  /**
+   * Whether the database supports tables with no defined schema
+   */
+  supports_schemaless_tables?: boolean;
 };
 
diff --git a/dc-agents/package-lock.json b/dc-agents/package-lock.json
diff --git a/dc-agents/reference/package-lock.json b/dc-agents/reference/package-lock.json
diff --git a/dc-agents/reference/package.json b/dc-agents/reference/package.json
@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "@fastify/cors": "^8.1.0",
-    "@hasura/dc-api-types": "0.33.0",
+    "@hasura/dc-api-types": "0.34.0",
     "fastify": "^4.13.0",
     "mathjs": "^11.0.0",
     "pino-pretty": "^8.0.0",

diff --git a/dc-agents/sqlite/package-lock.json b/dc-agents/sqlite/package-lock.json
diff --git a/dc-agents/sqlite/package.json b/dc-agents/sqlite/package.json
@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "@fastify/cors": "^8.1.0",
-    "@hasura/dc-api-types": "0.33.0",
+    "@hasura/dc-api-types": "0.34.0",
     "fastify-metrics": "^9.2.1",
     "fastify": "^4.13.0",
     "nanoid": "^3.3.4",

diff --git a/server/lib/dc-api/src/Hasura/Backends/DataConnector/API/V0/Capabilities.hs b/server/lib/dc-api/src/Hasura/Backends/DataConnector/API/V0/Capabilities.hs
@@ -27,6 +27,7 @@ module Hasura.Backends.DataConnector.API.V0.Capabilities
     dscSupportsPrimaryKeys,
     dscSupportsForeignKeys,
     dscColumnNullability,
+    dscSupportsSchemalessTables,
     defaultDataSchemaCapabilities,
     ColumnNullability (..),
     QueryCapabilities (..),
@@ -136,15 +137,16 @@ instance HasCodec Capabilities where
 data DataSchemaCapabilities = DataSchemaCapabilities
   { _dscSupportsPrimaryKeys :: Bool,
     _dscSupportsForeignKeys :: Bool,
-    _dscColumnNullability :: ColumnNullability
+    _dscColumnNullability :: ColumnNullability,
+    _dscSupportsSchemalessTables :: Bool
   }
   deriving stock (Eq, Ord, Show, Generic, Data)
   deriving anyclass (NFData, Hashable)
   deriving (FromJSON, ToJSON, ToSchema) via Autodocodec DataSchemaCapabilities
 
 defaultDataSchemaCapabilities :: DataSchemaCapabilities
 defaultDataSchemaCapabilities =
-  DataSchemaCapabilities False False NullableAndNonNullableColumns
+  DataSchemaCapabilities False False NullableAndNonNullableColumns False
 
 instance HasCodec DataSchemaCapabilities where
   codec =
@@ -153,6 +155,7 @@ instance HasCodec DataSchemaCapabilities where
         <$> optionalFieldWithOmittedDefault "supports_primary_keys" (_dscSupportsPrimaryKeys defaultDataSchemaCapabilities) "Whether tables can have primary keys" .= _dscSupportsPrimaryKeys
         <*> optionalFieldWithOmittedDefault "supports_foreign_keys" (_dscSupportsForeignKeys defaultDataSchemaCapabilities) "Whether tables can have foreign keys" .= _dscSupportsForeignKeys
         <*> optionalFieldWithOmittedDefault "column_nullability" (_dscColumnNullability defaultDataSchemaCapabilities) "The sort of column nullability that is supported" .= _dscColumnNullability
+        <*> optionalFieldWithOmittedDefault "supports_schemaless_tables" (_dscSupportsSchemalessTables defaultDataSchemaCapabilities) "Whether the database supports tables with no defined schema" .= _dscSupportsSchemalessTables
 
 data ColumnNullability
   = OnlyNullableColumns

diff --git a/server/src-lib/Hasura/Backends/DataConnector/Adapter/Backend.hs b/server/src-lib/Hasura/Backends/DataConnector/Adapter/Backend.hs
@@ -8,6 +8,7 @@ module Hasura.Backends.DataConnector.Adapter.Backend
   )
 where
 
+import Control.Lens (view)
 import Data.Aeson qualified as J
 import Data.Aeson.Extended (ToJSONKeyValue (..))
 import Data.Aeson.Key (fromText)
@@ -167,6 +168,9 @@ instance Backend 'DataConnector where
 
   backendSupportsNestedObjects = pure ()
 
+  sourceSupportsSchemalessTables =
+    view $ DC.scCapabilities . API.cDataSchema . API.dscSupportsSchemalessTables
+
 instance HasSourceConfiguration 'DataConnector where
   type SourceConfig 'DataConnector = DC.SourceConfig
   type SourceConnConfiguration 'DataConnector = DC.ConnSourceConfig

diff --git a/server/src-lib/Hasura/RQL/Types/Backend.hs b/server/src-lib/Hasura/RQL/Types/Backend.hs
@@ -425,5 +425,8 @@ class
   default backendSupportsNestedObjects :: (XNestedObjects b ~ XDisable) => Either QErr (XNestedObjects b)
   backendSupportsNestedObjects = throw400 InvalidConfiguration "Nested objects not supported"
 
+  sourceSupportsSchemalessTables :: SourceConfig b -> Bool
+  sourceSupportsSchemalessTables = const False
+
 -- Prisms
 $(makePrisms ''ComputedFieldReturnType)
diff --git a/server/src-lib/Hasura/Table/API.hs b/server/src-lib/Hasura/Table/API.hs
@@ -728,7 +728,7 @@ buildTableCache = Inc.cache proc (source, sourceConfig, dbTablesMeta, tableBuild
                           -<
                             err400 NotExists $ "no such table/view exists in source: " <>> _tbiName table
                       Just metadataTable ->
-                        buildRawTableInfo -< (table, metadataTable, sourceConfig, reloadMetadataInvalidationKey, logicalModels)
+                        buildRawTableInfo -< (source, table, metadataTable, sourceConfig, reloadMetadataInvalidationKey, logicalModels)
                 )
             |)
               (mkTableMetadataObject source tableName)
@@ -761,14 +761,15 @@ buildTableCache = Inc.cache proc (source, sourceConfig, dbTablesMeta, tableBuild
       ErrorA
         QErr
         arr
-        ( TableBuildInput b,
+        ( SourceName,
+          TableBuildInput b,
           DBTableMetadata b,
           SourceConfig b,
           Inc.Dependency Inc.InvalidationKey,
           LogicalModels b
         )
         (TableCoreInfoG b (RawColumnInfo b) (Column b))
-    buildRawTableInfo = Inc.cache proc (tableBuildInput, metadataTable, sourceConfig, reloadMetadataInvalidationKey, logicalModels) -> do
+    buildRawTableInfo = Inc.cache proc (sourceName, tableBuildInput, metadataTable, sourceConfig, reloadMetadataInvalidationKey, logicalModels) -> do
       let TableBuildInput name isEnum config apolloFedConfig mLogicalModelName = tableBuildInput
       columns <-
         liftEitherA
@@ -778,6 +779,14 @@ buildTableCache = Inc.cache proc (source, sourceConfig, dbTablesMeta, tableBuild
               pure $ _ptmiColumns metadataTable
             Just logicalModelName -> do
               -- A logical model was specified: use columns from the logical model
+              --
+              -- If the source does not support schemaless tables then we throw an error.
+              -- This is not strictly necessary - the logical model could be used even with sources
+              -- that always provide a table schema.  For now, we want to limit this functionality to
+              -- databases such as MongoDB that don't always provide a schema. In future we may want
+              -- to relax this.
+              unless (sourceSupportsSchemalessTables @b sourceConfig)
+                $ throw400 InvalidConfiguration ("The source " <> sourceName <<> " does not support schemaless tables")
               logicalModel <-
                 InsOrdHashMap.lookup logicalModelName logicalModels
                   `onNothing` throw400 InvalidConfiguration ("The logical mode " <> logicalModelName <<> " could not be found")

diff --git a/server/src-test/Hasura/Backends/DataConnector/API/V0/CapabilitiesSpec.hs b/server/src-test/Hasura/Backends/DataConnector/API/V0/CapabilitiesSpec.hs
@@ -62,6 +62,7 @@ genDataSchemaCapabilities =
     <$> Gen.bool
     <*> Gen.bool
     <*> genColumnNullability
+    <*> Gen.bool
 
 genColumnNullability :: (MonadGen m) => m ColumnNullability
 genColumnNullability =