feat: create sqlx.toml format

Author: abonander

Cargo.lock

@@ -50,16 +50,21 @@ authors.workspace = true
 repository.workspace = true
 
 [package.metadata.docs.rs]
-features = ["all-databases", "_unstable-all-types"]
+features = ["all-databases", "_unstable-all-types", "_unstable-doc"]
 rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
-default = ["any", "macros", "migrate", "json"]
+default = ["any", "macros", "migrate", "json", "config-all"]
 
 derive = ["sqlx-macros/derive"]
 macros = ["derive", "sqlx-macros/macros"]
 migrate = ["sqlx-core/migrate", "sqlx-macros?/migrate", "sqlx-mysql?/migrate", "sqlx-postgres?/migrate", "sqlx-sqlite?/migrate"]
 
+# Enable parsing of `sqlx.toml` for configuring macros, migrations, or both.
+config-macros = ["sqlx-macros?/config-macros"]
+config-migrate = ["sqlx-macros?/config-migrate"]
+config-all = ["config-macros", "config-migrate"]
+
 # intended mainly for CI and docs
 all-databases = ["mysql", "sqlite", "postgres", "any"]
 _unstable-all-types = [
@@ -73,6 +78,8 @@ _unstable-all-types = [
     "uuid",
     "bit-vec",
 ]
+# Render documentation that wouldn't otherwise be shown (e.g. `sqlx_core::config`).
+_unstable-doc = ["config-all", "sqlx-core/_unstable-doc"]
 
 # Base runtime features without TLS
 runtime-async-std = ["_rt-async-std", "sqlx-core/_rt-async-std", "sqlx-macros?/_rt-async-std"]

Cargo.toml

@@ -12,7 +12,7 @@ features = ["offline"]
 
 [features]
 default = []
-migrate = ["sha2", "crc"]
+migrate = ["sha2", "crc", "config-migrate"]
 
 any = []
 
@@ -30,6 +30,12 @@ _tls-none = []
 # support offline/decoupled building (enables serialization of `Describe`)
 offline = ["serde", "either/serde"]
 
+config = ["serde", "toml/parse"]
+config-macros = ["config"]
+config-migrate = ["config"]
+
+_unstable-doc = ["config-macros", "config-migrate"]
+
 [dependencies]
 # Runtimes
 async-std = { workspace = true, optional = true }
@@ -77,6 +83,7 @@ percent-encoding = "2.1.0"
 regex = { version = "1.5.5", optional = true }
 serde = { version = "1.0.132", features = ["derive", "rc"], optional = true }
 serde_json = { version = "1.0.73", features = ["raw_value"], optional = true }
+toml = { version = "0.8.16", optional = true }
 sha1 = { version = "0.10.1", default-features = false, optional = true }
 sha2 = { version = "0.10.0", default-features = false, optional = true }
 sqlformat = "0.2.0"

sqlx-core/Cargo.toml

@@ -0,0 +1,38 @@
+/// Configuration shared by multiple components.
+#[derive(Debug, Default, serde::Deserialize)]
+pub struct Config {
+    /// Override the database URL environment variable.
+    ///
+    /// This is used by both the macros and `sqlx-cli`.
+    ///
+    /// Case-sensitive. Defaults to `DATABASE_URL`.
+    ///
+    /// Example: Multi-Database Project
+    /// -------
+    /// You can use multiple databases in the same project by breaking it up into multiple crates,
+    /// then using a different environment variable for each.
+    ///
+    /// For example, with two crates in the workspace named `foo` and `bar`:
+    ///
+    /// #### `foo/sqlx.toml`
+    /// ```toml
+    /// [macros]
+    /// database_url_var = "FOO_DATABASE_URL"
+    /// ```
+    ///
+    /// #### `bar/sqlx.toml`
+    /// ```toml
+    /// [macros]
+    /// database_url_var = "BAR_DATABASE_URL"
+    /// ```
+    ///
+    /// #### `.env`
+    /// ```text
+    /// FOO_DATABASE_URL=postgres://postgres@localhost:5432/foo
+    /// BAR_DATABASE_URL=postgres://postgres@localhost:5432/bar
+    /// ```
+    ///
+    /// The query macros used in `foo` will use `FOO_DATABASE_URL`,
+    /// and the ones used in `bar` will use `BAR_DATABASE_URL`.
+    pub database_url_var: Option<String>,
+}