Add DB_URL support (#240)

* Add DB_URL support

* refactor

* tests for db_url

* fix tsts

* docs

* fmt

Author: JasonShin

book/docs/connect/README.md

@@ -20,7 +20,35 @@ based config and specify connection details for those databases. [Please check h
 
 ### 2. CLI options
 
-Run the following command for more details
+You can provide database connection details via CLI options. This includes individual connection parameters or a complete database URL.
+
+#### Using individual connection parameters
+
+```bash
+$ sqlx-ts <path> \
+  --db-type postgres \
+  --db-host 127.0.0.1 \
+  --db-port 5432 \
+  --db-user postgres \
+  --db-pass postgres \
+  --db-name mydb
+```
+
+#### Using database URL
+
+Alternatively, you can use `--db-url` to specify the complete connection string:
+
+```bash
+# PostgreSQL
+$ sqlx-ts <path> --db-type postgres --db-url postgres://user:pass@localhost:5432/mydb
+
+# MySQL
+$ sqlx-ts <path> --db-type mysql --db-url mysql://user:pass@localhost:3306/mydb
+```
+
+**Note:** When `--db-url` is provided, it takes precedence over individual connection parameters (`--db-host`, `--db-port`, `--db-user`, `--db-pass`, `--db-name`).
+
+Run the following command for more details:
 
 ```bash
 $ sqlx-ts --help

book/docs/connect/config-file.md

@@ -46,6 +46,26 @@ Example `.sqlxrc.json`
 }
 ```
 
+Alternatively, you can use `DB_URL` to specify the connection string directly:
+
+```json
+{
+  "generate_types": {
+    "enabled": true
+  },
+  "connections": {
+    "default": {
+      "DB_TYPE": "postgres",
+      "DB_URL": "postgres://postgres:[email protected]:5432/mydb"
+    },
+    "mysql_db": {
+      "DB_TYPE": "mysql",
+      "DB_URL": "mysql://root:[email protected]:3306/mydatabase"
+    }
+  }
+}
+```
+
 ## Configuration options
 
 ### connections (required)
@@ -71,6 +91,7 @@ const postgresSQL = sql`
 ```
 
 Supported fields of each connection include
+- `DB_URL`: Database connection URL (e.g. `postgres://user:pass@host:port/dbname` or `mysql://user:pass@host:port/dbname`). If provided, this overrides individual connection parameters (`DB_HOST`, `DB_PORT`, `DB_USER`, `DB_PASS`, `DB_NAME`)
 - `DB_TYPE`: type of database connection (mysql | postgres)
 - `DB_USER`: database user name
 - `DB_PASS`: database password

book/docs/connect/environment-variables.md

@@ -3,6 +3,7 @@
 
 | Environment variables | Description                                                                                |
 | --------------------- | ------------------------------------------------------------------------------------------ |
+| DB_URL                | Primary database connection URL (e.g. `postgres://user:pass@host:port/dbname` or `mysql://user:pass@host:port/dbname`). If provided, this overrides individual connection parameters |
 | DB_HOST               | Primary DB host                                                                            |
 | DB_PASS               | Primary DB password                                                                        |
 | DB_PORT               | Primary DB port number                                                                     |
@@ -11,3 +12,38 @@
 | DB_NAME               | Primary DB name                                                                            |
 | PG_SEARCH_PATH        | PostgreSQL schema search path (default is "$user,public") [https://www.postgresql.org/docs/current/ddl-schemas.html#DDL-SCHEMAS-PATH](https://www.postgresql.org/docs/current/ddl-schemas.html#DDL-SCHEMAS-PATH)                                                                                           |
 
+## Examples
+
+### Using individual connection parameters
+
+```bash
+export DB_TYPE=postgres
+export DB_HOST=127.0.0.1
+export DB_PORT=5432
+export DB_USER=postgres
+export DB_PASS=postgres
+export DB_NAME=mydb
+
+sqlx-ts <path>
+```
+
+### Using database URL
+
+Alternatively, you can use `DB_URL` to specify the complete connection string:
+
+```bash
+# PostgreSQL
+export DB_TYPE=postgres
+export DB_URL=postgres://postgres:postgres@localhost:5432/mydb
+
+sqlx-ts <path>
+
+# MySQL
+export DB_TYPE=mysql
+export DB_URL=mysql://root:password@localhost:3306/mydatabase
+
+sqlx-ts <path>
+```
+
+**Note:** When `DB_URL` is set, it takes precedence over individual connection parameters (`DB_HOST`, `DB_PORT`, `DB_USER`, `DB_PASS`, `DB_NAME`).
+

src/common/cli.rs

@@ -52,6 +52,10 @@ pub struct Cli {
   #[clap(long)]
   pub db_name: Option<String>,
 
+  /// Custom database connection URL (overrides individual connection parameters if provided)
+  #[clap(long)]
+  pub db_url: Option<String>,
+
   /// PostgreSQL schema search path (default is "$user,public") https://www.postgresql.org/docs/current/ddl-schemas.html#DDL-SCHEMAS-PATH
   #[clap(long)]
   pub pg_search_path: Option<String>,

src/common/config.rs

@@ -40,16 +40,18 @@ pub struct GenerateTypesConfig {
 pub struct DbConnectionConfig {
   #[serde(rename = "DB_TYPE")]
   pub db_type: DatabaseType,
-  #[serde(rename = "DB_HOST")]
+  #[serde(rename = "DB_HOST", default)]
   pub db_host: String,
-  #[serde(rename = "DB_PORT")]
+  #[serde(rename = "DB_PORT", default)]
   pub db_port: u16,
-  #[serde(rename = "DB_USER")]
+  #[serde(rename = "DB_USER", default)]
   pub db_user: String,
   #[serde(rename = "DB_PASS")]
   pub db_pass: Option<String>,
   #[serde(rename = "DB_NAME")]
   pub db_name: Option<String>,
+  #[serde(rename = "DB_URL")]
+  pub db_url: Option<String>,
   #[serde(rename = "PG_SEARCH_PATH")]
   pub pg_search_path: Option<String>,
   #[serde(rename = "POOL_SIZE", default = "default_pool_size")]
@@ -218,43 +220,73 @@ impl Config {
         panic!("")
       });
 
-    let db_host = &CLI_ARGS
-      .db_host
+    let db_url = &CLI_ARGS
+      .db_url
       .clone()
-      .or_else(|| dotenv.db_host.clone())
-      .or_else(|| default_config.map(|x| x.db_host.clone()))
-      .expect(
+      .or_else(|| dotenv.db_url.clone())
+      .or_else(|| default_config.map(|x| x.db_url.clone()).flatten());
+
+    let db_host_chain = || {
+      CLI_ARGS
+        .db_host
+        .clone()
+        .or_else(|| dotenv.db_host.clone())
+        .or_else(|| default_config.map(|x| x.db_host.clone()))
+    };
+
+    let db_host = match (db_url.is_some(), db_host_chain()) {
+      (true, Some(v)) => v,
+      (true, None) => String::new(),
+      (false, Some(v)) => v,
+      (false, None) => panic!(
         r"
-             Failed to fetch DB host.
-             Please provide it at least through a CLI arg or an environment variable or through
-             file based configuration
-             ",
-      );
-
-    let db_port = &CLI_ARGS
-      .db_port
-      .or(dotenv.db_port)
-      .or_else(|| default_config.map(|x| x.db_port))
-      .expect(
+       Failed to fetch DB host.
+       Please provide it at least through a CLI arg or an environment variable or through
+       file based configuration, or provide a custom DB_URL
+       "
+      ),
+    };
+
+    let db_port_chain = || {
+      CLI_ARGS
+        .db_port
+        .or(dotenv.db_port)
+        .or_else(|| default_config.map(|x| x.db_port))
+    };
+
+    let db_port = match (db_url.is_some(), db_port_chain()) {
+      (true, Some(v)) => v,
+      (true, None) => 0,
+      (false, Some(v)) => v,
+      (false, None) => panic!(
         r"
-             Failed to fetch DB port.
-             Please provide it at least through a CLI arg or an environment variable or through
-             file based configuration
-             ",
-      );
-
-    let db_user = &CLI_ARGS
-      .db_user
-      .clone()
-      .or_else(|| dotenv.db_user.clone())
-      .or_else(|| default_config.map(|x| x.db_user.clone()))
-      .expect(
+       Failed to fetch DB port.
+       Please provide it at least through a CLI arg or an environment variable or through
+       file based configuration, or provide a custom DB_URL
+       "
+      ),
+    };
+
+    let db_user_chain = || {
+      CLI_ARGS
+        .db_user
+        .clone()
+        .or_else(|| dotenv.db_user.clone())
+        .or_else(|| default_config.map(|x| x.db_user.clone()))
+    };
+
+    let db_user = match (db_url.is_some(), db_user_chain()) {
+      (true, Some(v)) => v,
+      (true, None) => String::new(),
+      (false, Some(v)) => v,
+      (false, None) => panic!(
         r"
-             Failed to fetch DB user.
-             Please provide it at least through a CLI arg or an environment variable or through
-             file based configuration
-             ",
-      );
+       Failed to fetch DB user.
+       Please provide it at least through a CLI arg or an environment variable or through
+       file based configuration, or provide a custom DB_URL
+       "
+      ),
+    };
 
     let db_pass = &CLI_ARGS
       .db_pass
@@ -286,11 +318,12 @@ impl Config {
 
     DbConnectionConfig {
       db_type: db_type.to_owned(),
-      db_host: db_host.to_owned(),
-      db_port: db_port.to_owned(),
-      db_user: db_user.to_owned(),
+      db_host,
+      db_port,
+      db_user,
       db_pass: db_pass.to_owned(),
       db_name: db_name.to_owned(),
+      db_url: db_url.to_owned(),
       pg_search_path: pg_search_path.to_owned(),
       pool_size,
       connection_timeout,
@@ -332,6 +365,11 @@ impl Config {
   /// This is to follow the spec of connection string for MySQL
   /// https://dev.mysql.com/doc/connector-j/8.1/en/connector-j-reference-jdbc-url-format.html
   pub fn get_mysql_cred_str(&self, conn: &DbConnectionConfig) -> String {
+    // If custom DB_URL is provided, use it directly
+    if let Some(db_url) = &conn.db_url {
+      return db_url.to_owned();
+    }
+
     format!(
       "mysql://{user}:{pass}@{host}:{port}/{db_name}",
       user = &conn.db_user,
@@ -344,6 +382,11 @@ impl Config {
   }
 
   pub fn get_postgres_cred(&self, conn: &DbConnectionConfig) -> String {
+    // If custom DB_URL is provided, use it directly
+    if let Some(db_url) = &conn.db_url {
+      return db_url.to_owned();
+    }
+
     format!(
       "postgresql://{user}:{pass}@{host}:{port}/{db_name}",
       user = &conn.db_user,

src/common/dotenv.rs

@@ -9,6 +9,7 @@ pub struct Dotenv {
   pub db_port: Option<u16>,
   pub db_pass: Option<String>,
   pub db_name: Option<String>,
+  pub db_url: Option<String>,
   pub pg_search_path: Option<String>,
 }
 
@@ -44,6 +45,7 @@ impl Dotenv {
       db_port: Self::get_var("DB_PORT").map(|val| val.parse::<u16>().expect("DB_PORT is not a valid integer")),
       db_pass: Self::get_var("DB_PASS"),
       db_name: Self::get_var("DB_NAME"),
+      db_url: Self::get_var("DB_URL"),
       pg_search_path: Self::get_var("PG_SEARCH_PATH"),
     }
   }