feat: add SurrealDB support (PSL, query compiler, schema engine)

Makefile

@@ -66,7 +66,7 @@ build-qc-wasm: build-qc-wasm-fast build-qc-wasm-small
 
 build-qc-gz-%: build-qc-wasm-%
 		@cd query-compiler/query-compiler-wasm/pkg && \
-    for provider in postgresql mysql sqlite sqlserver cockroachdb; do \
+    for provider in postgresql mysql sqlite sqlserver cockroachdb surrealdb; do \
         gzip -knc $$provider/query_compiler_$*_bg.wasm > $${provider}_$*.gz; \
     done;
 
@@ -436,7 +436,7 @@ measure-qc-wasm: measure-qc-wasm-fast measure-qc-wasm-small
 
 measure-qc-wasm-%: build-qc-gz-%
 	@cd query-compiler/query-compiler-wasm/pkg; \
-	for provider in postgresql mysql sqlite sqlserver cockroachdb; do \
+	for provider in postgresql mysql sqlite sqlserver cockroachdb surrealdb; do \
 		echo "$${provider}_$*_qc_size=$$(cat $$provider/query_compiler_$*_bg.wasm | wc -c | tr -d ' ')" >> $(ENGINE_SIZE_OUTPUT); \
 		echo "$${provider}_$*_qc_size_gz=$$(cat $${provider}_$*.gz | wc -c | tr -d ' ')" >> $(ENGINE_SIZE_OUTPUT); \
 	done;

psl/psl-core/Cargo.toml

@@ -10,6 +10,7 @@ mysql = []
 cockroachdb = ["postgresql"]
 mssql = []
 mongodb = []
+surrealdb = []
 
 [dependencies]
 diagnostics.workspace = true

psl/psl-core/src/builtin_connectors/mod.rs

@@ -25,6 +25,8 @@ mod native_type_definition;
 mod postgres_datamodel_connector;
 #[cfg(feature = "sqlite")]
 mod sqlite_datamodel_connector;
+#[cfg(feature = "surrealdb")]
+mod surrealdb_datamodel_connector;
 mod utils;
 pub use capabilities_support::{can_have_capability, can_support_relation_load_strategy, has_capability};
 
@@ -47,6 +49,9 @@ pub const MSSQL: &'static dyn crate::datamodel_connector::Connector =
     &mssql_datamodel_connector::MsSqlDatamodelConnector;
 #[cfg(feature = "mongodb")]
 pub const MONGODB: &'static dyn crate::datamodel_connector::Connector = &mongodb::MongoDbDatamodelConnector;
+#[cfg(feature = "surrealdb")]
+pub const SURREALDB: &'static dyn crate::datamodel_connector::Connector =
+    &surrealdb_datamodel_connector::SurrealDbDatamodelConnector;
 
 pub static BUILTIN_CONNECTORS: ConnectorRegistry<'static> = &[
     #[cfg(feature = "postgresql")]
@@ -61,4 +66,6 @@ pub static BUILTIN_CONNECTORS: ConnectorRegistry<'static> = &[
     COCKROACH,
     #[cfg(feature = "mongodb")]
     MONGODB,
+    #[cfg(feature = "surrealdb")]
+    SURREALDB,
 ];

psl/psl-core/src/builtin_connectors/surrealdb_datamodel_connector.rs

@@ -0,0 +1,128 @@
+use std::borrow::Cow;
+
+use crate::{
+    ValidatedSchema,
+    datamodel_connector::{
+        Connector, ConnectorCapabilities, ConnectorCapability, ConstraintScope, Flavour, NativeTypeConstructor,
+        NativeTypeInstance,
+    },
+    diagnostics::{DatamodelError, Diagnostics, Span},
+    parser_database::ReferentialAction,
+};
+use enumflags2::BitFlags;
+use parser_database::{ExtensionTypes, ScalarFieldType};
+
+const NATIVE_TYPE_CONSTRUCTORS: &[NativeTypeConstructor] = &[];
+const CONSTRAINT_SCOPES: &[ConstraintScope] = &[ConstraintScope::GlobalKeyIndex];
+
+pub const CAPABILITIES: ConnectorCapabilities = enumflags2::make_bitflags!(ConnectorCapability::{
+    AnyId |
+    CompoundIds |
+    RelationFieldsInArbitraryOrder |
+    UpdateableId |
+    DecimalType |
+    BackwardCompatibleQueryRaw |
+    NativeUpsert |
+    FilteredInlineChildNestedToOneDisconnect |
+    InsertReturning |
+    DeleteReturning |
+    UpdateReturning |
+    SupportsFiltersOnRelationsWithoutJoins |
+    CreateMany |
+    Json |
+    AdvancedJsonNullability
+});
+
+pub struct SurrealDbDatamodelConnector;
+
+impl Connector for SurrealDbDatamodelConnector {
+    fn provider_name(&self) -> &'static str {
+        "surrealdb"
+    }
+
+    fn name(&self) -> &str {
+        "SurrealDB"
+    }
+
+    fn capabilities(&self) -> ConnectorCapabilities {
+        CAPABILITIES
+    }
+
+    fn max_identifier_length(&self) -> usize {
+        // SurrealDB does not impose a specific identifier length limit
+        10000
+    }
+
+    fn foreign_key_referential_actions(&self) -> BitFlags<ReferentialAction> {
+        // SurrealDB does not support foreign key constraints natively
+        BitFlags::empty()
+    }
+
+    fn emulated_referential_actions(&self) -> BitFlags<ReferentialAction> {
+        use ReferentialAction::*;
+
+        Restrict | SetNull | Cascade
+    }
+
+    fn scalar_type_for_native_type(
+        &self,
+        _native_type: &NativeTypeInstance,
+        _extension_types: &dyn ExtensionTypes,
+    ) -> Option<ScalarFieldType> {
+        // Unreachable: parse_native_type() always returns None and
+        // available_native_type_constructors() is empty, so the validation
+        // pipeline in fields.rs never calls this method for SurrealDB.
+        unreachable!("No native types on SurrealDB");
+    }
+
+    fn default_native_type_for_scalar_type(
+        &self,
+        _scalar_type: &ScalarFieldType,
+        _schema: &ValidatedSchema,
+    ) -> Option<NativeTypeInstance> {
+        None
+    }
+
+    fn native_type_to_parts<'t>(&self, _native_type: &'t NativeTypeInstance) -> (&'t str, Cow<'t, [String]>) {
+        unreachable!()
+    }
+
+    fn constraint_violation_scopes(&self) -> &'static [ConstraintScope] {
+        CONSTRAINT_SCOPES
+    }
+
+    fn available_native_type_constructors(&self) -> &'static [NativeTypeConstructor] {
+        NATIVE_TYPE_CONSTRUCTORS
+    }
+
+    fn parse_native_type(
+        &self,
+        _name: &str,
+        _args: &[String],
+        span: Span,
+        diagnostics: &mut Diagnostics,
+    ) -> Option<NativeTypeInstance> {
+        diagnostics.push_error(DatamodelError::new_native_types_not_supported(
+            self.name().to_owned(),
+            span,
+        ));
+        None
+    }
+
+    fn validate_url(&self, url: &str) -> Result<(), String> {
+        // surrealdb:// is the canonical scheme; http(s):// accepted for direct HTTP API access.
+        if url.starts_with("surrealdb://") || url.starts_with("http://") || url.starts_with("https://") {
+            Ok(())
+        } else {
+            Err("must start with the protocol `surrealdb://`, `http://`, or `https://`.".to_string())
+        }
+    }
+
+    fn flavour(&self) -> Flavour {
+        Flavour::SurrealDb
+    }
+
+    fn can_assume_strict_equality_in_joins(&self) -> bool {
+        true
+    }
+}

psl/psl-core/src/datamodel_connector.rs

@@ -323,6 +323,7 @@ pub enum Flavour {
     Mysql,
     Postgres,
     Sqlite,
+    SurrealDb,
 }
 
 impl Flavour {

psl/psl/Cargo.toml

@@ -10,7 +10,8 @@ mysql = ["psl-core/mysql"]
 cockroachdb = ["psl-core/cockroachdb", "postgresql"]
 mssql = ["psl-core/mssql"]
 mongodb = ["psl-core/mongodb"]
-all = ["postgresql", "sqlite", "mysql", "cockroachdb", "mssql", "mongodb"]
+surrealdb = ["psl-core/surrealdb"]
+all = ["postgresql", "sqlite", "mysql", "cockroachdb", "mssql", "mongodb", "surrealdb"]
 
 [dependencies]
 psl-core.workspace = true

quaint/Cargo.toml

@@ -65,6 +65,8 @@ pooled = ["dep:mobc"]
 sqlite-native = ["sqlite", "rusqlite/bundled", "tokio/sync"]
 sqlite = []
 
+surrealdb = []
+
 fmt-sql = ["dep:sqlformat"]
 
 [dependencies]

quaint/src/connector/connection_info.rs

@@ -414,6 +414,8 @@ pub enum SqlFamily {
     Sqlite,
     #[cfg(feature = "mssql")]
     Mssql,
+    #[cfg(feature = "surrealdb")]
+    SurrealDb,
 }
 
 impl SqlFamily {
@@ -428,6 +430,8 @@ impl SqlFamily {
             SqlFamily::Sqlite => "sqlite",
             #[cfg(feature = "mssql")]
             SqlFamily::Mssql => "mssql",
+            #[cfg(feature = "surrealdb")]
+            SqlFamily::SurrealDb => "surrealdb",
         }
     }
 
@@ -440,6 +444,8 @@ impl SqlFamily {
             "postgres" | "postgresql" => Some(SqlFamily::Postgres),
             #[cfg(feature = "mysql")]
             "mysql" => Some(SqlFamily::Mysql),
+            #[cfg(feature = "surrealdb")]
+            "surrealdb" | "ws" | "wss" => Some(SqlFamily::SurrealDb),
             _ => None,
         }
     }
@@ -455,6 +461,8 @@ impl SqlFamily {
             SqlFamily::Sqlite => Some(999),
             #[cfg(feature = "mssql")]
             SqlFamily::Mssql => Some(1000),
+            #[cfg(feature = "surrealdb")]
+            SqlFamily::SurrealDb => None,
         }
     }
 
@@ -501,6 +509,10 @@ impl SqlFamily {
             SqlFamily::Sqlite => 999,
             #[cfg(feature = "mssql")]
             SqlFamily::Mssql => 2098,
+            // SurrealDB has no documented parameter limit; this is a conservative
+            // transport-based fallback (HTTP/WebSocket body size dependent).
+            #[cfg(feature = "surrealdb")]
+            SqlFamily::SurrealDb => 32766,
         }
     }
 
@@ -556,6 +568,18 @@ impl SqlFamily {
     pub fn is_mssql(&self) -> bool {
         false
     }
+
+    /// True, if family is SurrealDB.
+    #[cfg(feature = "surrealdb")]
+    pub fn is_surrealdb(&self) -> bool {
+        matches!(self, SqlFamily::SurrealDb)
+    }
+
+    /// True, if family is SurrealDB.
+    #[cfg(not(feature = "surrealdb"))]
+    pub fn is_surrealdb(&self) -> bool {
+        false
+    }
 }
 
 impl fmt::Display for SqlFamily {

quaint/src/connector/external.rs

@@ -60,6 +60,8 @@ pub enum AdapterProvider {
     #[cfg(feature = "mssql")]
     #[cfg_attr(target_arch = "wasm32", serde(rename = "sqlserver"))]
     SqlServer,
+    #[cfg(feature = "surrealdb")]
+    SurrealDb,
 }
 
 impl AdapterProvider {
@@ -73,6 +75,8 @@ impl AdapterProvider {
             Self::Sqlite => "sqlite",
             #[cfg(feature = "mssql")]
             Self::SqlServer => "mssql",
+            #[cfg(feature = "surrealdb")]
+            Self::SurrealDb => "surrealdb",
         }
     }
 }
@@ -90,6 +94,8 @@ impl FromStr for AdapterProvider {
             "sqlite" => Ok(Self::Sqlite),
             #[cfg(feature = "mssql")]
             "sqlserver" => Ok(Self::SqlServer),
+            #[cfg(feature = "surrealdb")]
+            "surrealdb" => Ok(Self::SurrealDb),
             _ => Err(format!("Unsupported adapter flavour: {s:?}")),
         }
     }
@@ -106,6 +112,8 @@ impl From<&AdapterProvider> for SqlFamily {
             AdapterProvider::Sqlite => SqlFamily::Sqlite,
             #[cfg(feature = "mssql")]
             AdapterProvider::SqlServer => SqlFamily::Mssql,
+            #[cfg(feature = "surrealdb")]
+            AdapterProvider::SurrealDb => SqlFamily::SurrealDb,
         }
     }
 }

quaint/src/lib.rs

@@ -107,8 +107,8 @@
 // TODO: remove once `quaint` is no longer a transitive dependency of `mongodb-schema-connector`.
 #![allow(dead_code)]
 
-#[cfg(not(any(feature = "sqlite", feature = "postgresql", feature = "mysql", feature = "mssql")))]
-compile_error!("one of 'sqlite', 'postgresql', 'mysql' or 'mssql' features must be enabled");
+#[cfg(not(any(feature = "sqlite", feature = "postgresql", feature = "mysql", feature = "mssql", feature = "surrealdb")))]
+compile_error!("one of 'sqlite', 'postgresql', 'mysql', 'mssql' or 'surrealdb' features must be enabled");
 
 #[macro_use]
 mod macros;

quaint/src/visitor.rs

@@ -14,6 +14,8 @@ mod mysql;
 mod postgres;
 #[cfg(feature = "sqlite")]
 mod sqlite;
+#[cfg(feature = "surrealdb")]
+mod surrealdb;
 
 // Generic query writer, used for all SQL flavors
 mod query_writer;
@@ -26,6 +28,8 @@ pub use self::mysql::Mysql;
 pub use self::postgres::Postgres;
 #[cfg(feature = "sqlite")]
 pub use self::sqlite::Sqlite;
+#[cfg(feature = "surrealdb")]
+pub use self::surrealdb::SurrealDb;
 
 use crate::ast::*;
 use query_template::QueryTemplate;