feat(mysql): add ability to set or unset the CLIENT_IGNORE_SPACE flag

sqlx-mysql/src/connection/stream.rs

@@ -33,7 +33,6 @@ pub(crate) enum Waiting {
 impl<S: Socket> MySqlStream<S> {
     pub(crate) fn with_socket(options: &MySqlConnectOptions, socket: S) -> Self {
         let mut capabilities = Capabilities::PROTOCOL_41
-            | Capabilities::IGNORE_SPACE
             | Capabilities::DEPRECATE_EOF
             | Capabilities::TRANSACTIONS
             | Capabilities::SECURE_CONNECTION
@@ -52,6 +51,10 @@ impl<S: Socket> MySqlStream<S> {
             capabilities |= Capabilities::FOUND_ROWS;
         }
 
+        if options.ignore_space {
+            capabilities |= Capabilities::IGNORE_SPACE;
+        }
+
         Self {
             waiting: VecDeque::new(),
             capabilities,

sqlx-mysql/src/options/mod.rs

@@ -82,6 +82,7 @@ pub struct MySqlConnectOptions {
     pub(crate) timezone: Option<String>,
     pub(crate) set_names: bool,
     pub(crate) found_rows: bool,
+    pub(crate) ignore_space: bool,
 }
 
 impl Default for MySqlConnectOptions {
@@ -126,6 +127,7 @@ impl MySqlConnectOptions {
             timezone: Some(String::from("+00:00")),
             set_names: true,
             found_rows: true,
+            ignore_space: true,
         }
     }
 
@@ -447,6 +449,20 @@ impl MySqlConnectOptions {
         self.found_rows = flag_val;
         self
     }
+
+    /// Sets the flag that enables or disables CLIENT_IGNORE_SPACE,
+    /// which makes the server add `IGNORE_SPACE` to the session's `sql_mode`.
+    ///
+    /// With `IGNORE_SPACE`, the server permits spaces between a built-in function name
+    /// and the following `(` character, and treats built-in function names as reserved words.
+    /// Disabling it matches the default of most other MySQL clients, which some proxies
+    /// (such as ProxySQL) require before they will share backend connections between clients.
+    ///
+    /// The default value is set to true.
+    pub fn ignore_space(mut self, flag_val: bool) -> Self {
+        self.ignore_space = flag_val;
+        self
+    }
 }
 
 impl MySqlConnectOptions {

tests/mysql/mysql.rs

@@ -779,3 +779,46 @@ async fn test_client_found_rows() -> anyhow::Result<()> {
 
     Ok(())
 }
+
+#[sqlx_macros::test]
+async fn test_client_ignore_space() -> anyhow::Result<()> {
+    setup_if_needed();
+
+    let url = url::Url::parse(&env::var("DATABASE_URL")?)?;
+    let ignore_space_mode = "SELECT FIND_IN_SET('IGNORE_SPACE', @@SESSION.sql_mode) > 0";
+    let spaced_call = "SELECT COUNT (*) FROM (SELECT 1) AS t";
+
+    // CLIENT_IGNORE_SPACE unspecified = true by default.
+    let mut conn = MySqlConnectOptions::from_url(&url)?.connect().await?;
+
+    let enabled: i64 = sqlx::query_scalar(ignore_space_mode)
+        .fetch_one(&mut conn)
+        .await?;
+    assert_eq!(enabled, 1);
+
+    let count: i64 = sqlx::query_scalar(spaced_call).fetch_one(&mut conn).await?;
+    assert_eq!(count, 1);
+
+    conn.close().await?;
+
+    // Explicitly unset CLIENT_IGNORE_SPACE.
+    let mut conn = MySqlConnectOptions::from_url(&url)?
+        .ignore_space(false)
+        .connect()
+        .await?;
+
+    let enabled: i64 = sqlx::query_scalar(ignore_space_mode)
+        .fetch_one(&mut conn)
+        .await?;
+    assert_eq!(enabled, 0);
+
+    // Without IGNORE_SPACE, a space after a built-in function name is a syntax error.
+    let result = sqlx::query_scalar::<_, i64>(spaced_call)
+        .fetch_one(&mut conn)
+        .await;
+    assert!(result.is_err());
+
+    conn.close().await?;
+
+    Ok(())
+}