feat: support MySQL database connections (#722)

Author: mattjohnsonpint

.trunk/configs/cspell.json

@@ -33,6 +33,7 @@
     "datasource",
     "dbname",
     "dbpool",
+    "dburl",
     "dcli",
     "Debugf",
     "dgraph",
@@ -87,6 +88,7 @@
     "jackc",
     "Jairus",
     "jensneuse",
+    "jmoiron",
     "joho",
     "jsonlogs",
     "jsonparser",

.vscode/launch.json

@@ -171,6 +171,10 @@
           "label": "HTTP Client Example",
           "value": "http"
         },
+        {
+          "label": "MySQL Client Example",
+          "value": "mysql"
+        },
         {
           "label": "Neo4j Client Example",
           "value": "neo4j"

CHANGELOG.md

@@ -13,6 +13,7 @@
   [#707](https://github.com/hypermodeinc/modus/pull/707)
 - feat: support type aliases and redefinitions
   [#721](https://github.com/hypermodeinc/modus/pull/721)
+- feat: support MySQL database connections [#722](https://github.com/hypermodeinc/modus/pull/722)
 
 ## 2025-01-09 - CLI 0.16.6
 

go.work

@@ -17,6 +17,7 @@ use (
 	./sdk/go/examples/embedding
 	./sdk/go/examples/graphql
 	./sdk/go/examples/http
+	./sdk/go/examples/mysql
 	./sdk/go/examples/neo4j
 	./sdk/go/examples/postgresql
 	./sdk/go/examples/simple

lib/manifest/manifest.go

@@ -172,6 +172,13 @@ func parseManifestJson(data []byte, manifest *Manifest) error {
 			}
 			info.Name = name
 			manifest.Connections[name] = info
+		case ConnectionTypeMysql:
+			var info MysqlConnectionInfo
+			if err := json.Unmarshal(rawCon, &info); err != nil {
+				return fmt.Errorf("failed to parse mysql connection [%s]: %w", name, err)
+			}
+			info.Name = name
+			manifest.Connections[name] = info
 		case ConnectionTypeDgraph:
 			var info DgraphConnectionInfo
 			if err := json.Unmarshal(rawCon, &info); err != nil {

lib/manifest/modus_schema.json

@@ -219,6 +219,24 @@
                 "required": ["type", "connString"],
                 "additionalProperties": false
               },
+              {
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "const": "mysql",
+                    "description": "Type of the connection."
+                  },
+                  "connString": {
+                    "type": "string",
+                    "minLength": 1,
+                    "pattern": "^mysql:\\/\\/(.*?@)?([0-9a-zA-Z.-]*?)(:\\d+)?(\\/[0-9a-zA-Z.-]+)?(\\?.+)?$",
+                    "description": "The MySQL connection string in URI format.",
+                    "markdownDescription": "The MySQL connection string in URI format.\n\nReference: https://docs.hypermode.com/modus/app-manifest#mysql-connection"
+                  }
+                },
+                "required": ["type", "connString"],
+                "additionalProperties": false
+              },
               {
                 "properties": {
                   "type": {

lib/manifest/mysql.go

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2025 Hypermode Inc.
+ * Licensed under the terms of the Apache License, Version 2.0
+ * See the LICENSE file that accompanied this code for further details.
+ *
+ * SPDX-FileCopyrightText: 2025 Hypermode Inc. <hello@hypermode.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package manifest
+
+const ConnectionTypeMysql ConnectionType = "mysql"
+
+type MysqlConnectionInfo struct {
+	Name    string         `json:"-"`
+	Type    ConnectionType `json:"type"`
+	ConnStr string         `json:"connString"`
+}
+
+func (info MysqlConnectionInfo) ConnectionName() string {
+	return info.Name
+}
+
+func (info MysqlConnectionInfo) ConnectionType() ConnectionType {
+	return info.Type
+}
+
+func (info MysqlConnectionInfo) Hash() string {
+	return computeHash(info.Name, info.Type, info.ConnStr)
+}
+
+func (info MysqlConnectionInfo) Variables() []string {
+	return extractVariables(info.ConnStr)
+}

lib/manifest/test/manifest_test.go

@@ -97,6 +97,11 @@ func TestReadManifest(t *testing.T) {
 				Type:    manifest.ConnectionTypePostgresql,
 				ConnStr: "postgresql://{{POSTGRESQL_USERNAME}}:{{POSTGRESQL_PASSWORD}}@1.2.3.4:5432/data?sslmode=disable",
 			},
+			"my-mysql": manifest.MysqlConnectionInfo{
+				Name:    "my-mysql",
+				Type:    manifest.ConnectionTypeMysql,
+				ConnStr: "mysql://{{MYSQL_USERNAME}}:{{MYSQL_PASSWORD}}@1.2.3.4:3306/mydb?sslmode=disable",
+			},
 			"my-dgraph-cloud": manifest.DgraphConnectionInfo{
 				Name:       "my-dgraph-cloud",
 				Type:       manifest.ConnectionTypeDgraph,
@@ -207,6 +212,20 @@ func TestPostgresConnectionInfo_Hash(t *testing.T) {
 	}
 }
 
+func TestMysqlConnectionInfo_Hash(t *testing.T) {
+	connection := manifest.MysqlConnectionInfo{
+		Name:    "my-database",
+		ConnStr: "mysql://{{MYSQL_USERNAME}}:{{MYSQL_PASSWORD}}@1.2.3.4:3306/mydb?sslmode=disable",
+	}
+
+	expectedHash := "3b96055cec5bd4195901e1442c856fe5b5493b0af0dde8f64f1d14a4795f5272"
+
+	actualHash := connection.Hash()
+	if actualHash != expectedHash {
+		t.Errorf("Expected hash: %s, but got: %s", expectedHash, actualHash)
+	}
+}
+
 func TestDgraphCloudConnectionInfo_Hash(t *testing.T) {
 	connection := manifest.DgraphConnectionInfo{
 		Name:       "my-dgraph-cloud",
@@ -259,6 +278,7 @@ func TestGetVariablesFromManifest(t *testing.T) {
 		"my-rest-api":              {"API_TOKEN"},
 		"another-rest-api":         {"USERNAME", "PASSWORD"},
 		"neon":                     {"POSTGRESQL_USERNAME", "POSTGRESQL_PASSWORD"},
+		"my-mysql":                 {"MYSQL_USERNAME", "MYSQL_PASSWORD"},
 		"my-dgraph-cloud":          {"DGRAPH_KEY"},
 		"my-neo4j":                 {"NEO4J_USERNAME", "NEO4J_PASSWORD"},
 	}

lib/manifest/test/valid_modus.json

@@ -64,6 +64,10 @@
       "type": "postgresql",
       "connString": "postgresql://{{POSTGRESQL_USERNAME}}:{{POSTGRESQL_PASSWORD}}@1.2.3.4:5432/data?sslmode=disable"
     },
+    "my-mysql": {
+      "type": "mysql",
+      "connString": "mysql://{{MYSQL_USERNAME}}:{{MYSQL_PASSWORD}}@1.2.3.4:3306/mydb?sslmode=disable"
+    },
     "my-dgraph-cloud": {
       "type": "dgraph",
       "grpcTarget": "frozen-mango.grpc.eu-central-1.aws.cloud.dgraph.io:443",

runtime/go.mod

@@ -24,6 +24,7 @@ require (
 	github.com/docker/go-connections v0.5.0
 	github.com/fatih/color v1.18.0
 	github.com/getsentry/sentry-go v0.31.1
+	github.com/go-sql-driver/mysql v1.8.1
 	github.com/go-viper/mapstructure/v2 v2.2.1
 	github.com/goccy/go-json v0.10.4
 	github.com/gofrs/flock v0.12.1
@@ -46,15 +47,18 @@ require (
 	github.com/tetratelabs/wazero v1.8.2
 	github.com/tidwall/gjson v1.18.0
 	github.com/tidwall/sjson v1.2.5
+	github.com/twpayne/go-geom v1.6.0
 	github.com/viterin/vek v0.4.2
 	github.com/wundergraph/graphql-go-tools/execution v1.2.0
 	github.com/wundergraph/graphql-go-tools/v2 v2.0.0-rc.142
+	github.com/xo/dburl v0.23.2
 	golang.org/x/exp v0.0.0-20250106191152-7588d65b2ba8
 	golang.org/x/sys v0.29.0
 	google.golang.org/grpc v1.69.4
 )
 
 require (
+	filippo.io/edwards25519 v1.1.0 // indirect
 	github.com/Microsoft/go-winio v0.6.2 // indirect
 	github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.6.7 // indirect
 	github.com/aws/aws-sdk-go-v2/credentials v1.17.54 // indirect