Use TLS backend feature names

Author: lovasoa

.github/workflows/publish.yml

@@ -29,4 +29,4 @@ jobs:
            --workspace \
            --token ${{ secrets.CRATES_TOKEN }} \
            --no-default-features \
-           --features runtime-actix-rustls
+           --features rustls

.github/workflows/sqlx.yml

@@ -30,20 +30,20 @@ jobs:
         run: |
           cargo clippy --manifest-path sqlx-core/Cargo.toml \
             --no-default-features \
-            --features offline,all-databases,all-types,migrate,runtime-tokio-${{ matrix.tls }} \
+            --features offline,all-databases,all-types,migrate,${{ matrix.tls }} \
             -- -D warnings
       - name: Run clippy for root with all features
         run: |
           cargo clippy \
             --no-default-features \
-            --features offline,all-databases,all-types,migrate,runtime-tokio-${{ matrix.tls }},macros \
+            --features offline,all-databases,all-types,migrate,${{ matrix.tls }},macros \
             -- -D warnings
       - name: Run clippy for all targets
         run: |
           cargo clippy \
             --no-default-features \
             --all-targets \
-            --features offline,all-databases,all-types,migrate,runtime-tokio-${{ matrix.tls }} \
+            --features offline,all-databases,all-types,migrate,${{ matrix.tls }} \
             -- -D warnings
 
   test:
@@ -62,7 +62,7 @@ jobs:
         if: ${{ matrix.os == 'ubuntu-latest' }}
       - run: cargo test
           --manifest-path sqlx-core/Cargo.toml
-          --features offline,all-databases,all-types,runtime-tokio-rustls
+          --features offline,all-databases,all-types,rustls
 
   cli:
     name: CLI Binaries
@@ -119,11 +119,11 @@ jobs:
         run: |
           cargo clippy \
             --no-default-features \
-            --features sqlite,all-types,runtime-tokio-${{ matrix.tls }},macros,migrate \
+            --features sqlite,all-types,${{ matrix.tls }},macros,migrate \
             -- -D warnings
       - run: cargo test
           --no-default-features
-          --features any,macros,migrate,sqlite,all-types,runtime-tokio-${{ matrix.tls }}
+          --features any,macros,migrate,sqlite,all-types,${{ matrix.tls }}
         env:
           DATABASE_URL: sqlite://tests/sqlite/sqlite.db
           RUSTFLAGS: --cfg sqlite_ipaddr
@@ -147,7 +147,7 @@ jobs:
           save-if: ${{ github.ref == 'refs/heads/main' && matrix.postgres == '14' }}
 
       - run: |
-          cargo build --features postgres,all-types,runtime-tokio-${{ matrix.tls }}
+          cargo build --features postgres,all-types,${{ matrix.tls }}
         env:
           # FIXME: needed to disable `ltree` tests in Postgres 9.6
           # but `PgLTree` should just fall back to text format
@@ -157,7 +157,7 @@ jobs:
         run: |
           cargo clippy \
             --no-default-features \
-            --features postgres,all-types,runtime-tokio-${{ matrix.tls }},macros,migrate \
+            --features postgres,all-types,${{ matrix.tls }},macros,migrate \
             -- -D warnings
         env:
           RUSTFLAGS: --cfg postgres_${{ matrix.postgres }}
@@ -167,15 +167,15 @@ jobs:
           docker exec postgres_${{ matrix.postgres }} bash -c "until pg_isready; do sleep 1; done"
 
       - run: |
-          cargo test --no-default-features --features any,postgres,macros,all-types,runtime-tokio-${{ matrix.tls }}
+          cargo test --no-default-features --features any,postgres,macros,all-types,${{ matrix.tls }}
         env:
           DATABASE_URL: postgres://postgres:password@localhost:5432/sqlx
           # FIXME: needed to disable `ltree` tests in Postgres 9.6
           # but `PgLTree` should just fall back to text format
           RUSTFLAGS: --cfg postgres_${{ matrix.postgres }}
 
       - run: |
-          cargo test --no-default-features --features any,postgres,macros,migrate,all-types,runtime-tokio-${{ matrix.tls }}
+          cargo test --no-default-features --features any,postgres,macros,migrate,all-types,${{ matrix.tls }}
         env:
           DATABASE_URL: postgres://postgres:password@localhost:5432/sqlx?sslmode=verify-ca&sslrootcert=./tests/certs/ca.crt
           # FIXME: needed to disable `ltree` tests in Postgres 9.6
@@ -191,11 +191,11 @@ jobs:
       - uses: Swatinem/rust-cache@65012b490220f477f20ab979e35ae732e6de4e68
         with:
           prefix-key: v1-sqlx
-          shared-key: postgres-tokio-rustls
+          shared-key: postgres-rustls
           save-if: ${{ false }}
       - run: docker compose up --wait postgres_16
         working-directory: tests
-      - run: cargo test --no-default-features --features any,postgres,macros,all-types,runtime-tokio-rustls
+      - run: cargo test --no-default-features --features any,postgres,macros,all-types,rustls
         env:
           DATABASE_URL: postgres://postgres@localhost:5432/sqlx?sslmode=verify-ca&sslrootcert=./tests/certs/ca.crt&sslcert=./tests/certs/client.crt&sslkey=./tests/keys/client.key
 
@@ -217,26 +217,26 @@ jobs:
           save-if: ${{ github.ref == 'refs/heads/main' && matrix.mysql == '8' }}
 
       - run: |
-          cargo build --features mysql,all-types,runtime-tokio-${{ matrix.tls }}
+          cargo build --features mysql,all-types,${{ matrix.tls }}
 
       - name: Run clippy for mysql
         run: |
           cargo clippy \
             --no-default-features \
-            --features mysql,all-types,runtime-tokio-${{ matrix.tls }},macros,migrate \
+            --features mysql,all-types,${{ matrix.tls }},macros,migrate \
             -- -D warnings
 
       - run: docker compose -f tests/docker-compose.yml run -d -p 3306:3306 mysql_${{ matrix.mysql }}
       - run: sleep 60
 
       - run: |
-          cargo test --no-default-features --features any,mysql,macros,migrate,all-types,runtime-tokio-${{ matrix.tls }}
+          cargo test --no-default-features --features any,mysql,macros,migrate,all-types,${{ matrix.tls }}
         env:
           DATABASE_URL: mysql://root:password@localhost:3306/sqlx?ssl-mode=disabled
 
       # MySQL 5.7 supports TLS but not TLSv1.3 as required by RusTLS.
       - run: |
-          cargo test --no-default-features --features any,mysql,macros,migrate,all-types,runtime-tokio-${{ matrix.tls }}
+          cargo test --no-default-features --features any,mysql,macros,migrate,all-types,${{ matrix.tls }}
         if: ${{ !(matrix.mysql == '5_7' && matrix.tls == 'rustls') }}
         env:
           DATABASE_URL: mysql://root:password@localhost:3306/sqlx
@@ -259,20 +259,20 @@ jobs:
           save-if: ${{ github.ref == 'refs/heads/main' && matrix.mariadb == '10_6' }}
 
       - run: |
-          cargo build --features mysql,runtime-tokio-${{ matrix.tls }}
+          cargo build --features mysql,${{ matrix.tls }}
 
       - name: Run clippy for mariadb
         run: |
           cargo clippy \
             --no-default-features \
-            --features mysql,runtime-tokio-${{ matrix.tls }},macros,migrate \
+            --features mysql,${{ matrix.tls }},macros,migrate \
             -- -D warnings
 
       - run: docker compose -f tests/docker-compose.yml run -d -p 3306:3306 mariadb_${{ matrix.mariadb }}
       - run: sleep 30
 
       - run: |
-          cargo test --no-default-features --features any,mysql,macros,migrate,runtime-tokio-${{ matrix.tls }}
+          cargo test --no-default-features --features any,mysql,macros,migrate,${{ matrix.tls }}
         env:
           DATABASE_URL: mysql://root:password@localhost:3306/sqlx
 
@@ -294,20 +294,20 @@ jobs:
           save-if: ${{ github.ref == 'refs/heads/main' && matrix.mssql == '2022' }}
 
       - run: |
-          cargo build --features mssql,all-types,runtime-tokio-${{ matrix.tls }}
+          cargo build --features mssql,all-types,${{ matrix.tls }}
 
       - name: Run clippy for mssql
         run: |
           cargo clippy \
             --no-default-features \
-            --features mssql,all-types,runtime-tokio-${{ matrix.tls }},macros,migrate \
+            --features mssql,all-types,${{ matrix.tls }},macros,migrate \
             -- -D warnings
 
       - run: docker compose -f tests/docker-compose.yml run -d -p 1433:1433 mssql_${{ matrix.mssql }}
       - run: sleep 80 # MSSQL takes a "bit" to startup
 
       - run: |
-          cargo test --no-default-features --features any,mssql,macros,migrate,all-types,runtime-tokio-${{ matrix.tls }}
+          cargo test --no-default-features --features any,mssql,macros,migrate,all-types,${{ matrix.tls }}
         env:
           DATABASE_URL: mssql://sa:Password123!@localhost/sqlx
 
@@ -338,10 +338,10 @@ jobs:
           odbcinst -q -s || true
           echo "select 1;" | isql -v SQLX_PG_5432 || true
       - name: Run ODBC tests (PostgreSQL DSN)
-        run: cargo test --no-default-features --features any,odbc,macros,all-types,runtime-tokio-rustls
+        run: cargo test --no-default-features --features any,odbc,macros,all-types,rustls
         env:
           DATABASE_URL: DSN=SQLX_PG_5432;UID=postgres;PWD=password
       - name: Run ODBC tests (SQLite driver)
-        run: cargo test --no-default-features --features any,odbc,macros,all-types,runtime-tokio-rustls
+        run: cargo test --no-default-features --features any,odbc,macros,all-types,rustls
         env:
           DATABASE_URL: Driver={SQLite3};Database=./tests/odbc/sqlite.db

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
  - remove discontinued async-std runtime support and async-std-only runtime/TLS dependencies
  - remove unmaintained paste dependency from test and Any helper macros
  - replace rustls-pemfile with rustls pki-types PEM parsing
+ - add TLS-oriented feature names (`native-tls`, `rustls`, `rustls-nocrypto`) while keeping legacy runtime feature names as aliases
 
 ## 0.6.54
  - odbc: improve prepared statement metadata handling and keep execution working when drivers defer result column metadata until bind/execute

Cargo.toml

@@ -43,7 +43,7 @@ authors = [
 ]
 
 [package.metadata.docs.rs]
-features = ["all", "runtime-tokio-native-tls"]
+features = ["all", "native-tls"]
 rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
@@ -75,42 +75,35 @@ all-types = [
     "git2",
 ]
 
-# previous runtimes, available as features for error messages better than just
-# "feature doesn't exist"
-runtime-actix = []
-runtime-tokio = []
-
-# actual runtimes
-runtime-actix-native-tls = ["runtime-tokio-native-tls"]
-runtime-tokio-native-tls = [
-    "sqlx-core/runtime-tokio-native-tls",
-    "sqlx-macros/runtime-tokio-native-tls",
-    "_rt-tokio",
+# TLS backends. Tokio is the supported async runtime.
+native-tls = [
+    "sqlx-core/native-tls",
+    "sqlx-macros/native-tls",
 ]
 
-runtime-actix-rustls = ["runtime-tokio-rustls"]
-runtime-tokio-rustls = [
-    "sqlx-core/runtime-tokio-rustls",
-    "sqlx-macros/runtime-tokio-rustls",
-    "sqlx-rt/runtime-tokio-rustls",
+rustls = [
+    "sqlx-core/rustls",
+    "sqlx-macros/rustls",
+    "sqlx-rt/rustls",
     "aws_lc_rs",
     "tls12",
-    "_rt-tokio",
 ]
-runtime-tokio-rustls-nocrypto = [
-    "sqlx-core/runtime-tokio-rustls",
-    "sqlx-macros/runtime-tokio-rustls",
-    "sqlx-rt/runtime-tokio-rustls",
-    "_rt-tokio",
+rustls-nocrypto = [
+    "sqlx-core/rustls",
+    "sqlx-macros/rustls",
+    "sqlx-rt/rustls",
 ]
 
+# Backward-compatible aliases for legacy runtime feature names.
+runtime-actix-native-tls = ["native-tls"]
+runtime-tokio-native-tls = ["native-tls"]
+runtime-actix-rustls = ["rustls"]
+runtime-tokio-rustls = ["rustls"]
+runtime-tokio-rustls-nocrypto = ["rustls-nocrypto"]
+
 aws_lc_rs = ["sqlx-core/aws_lc_rs"]
 tls12 = ["sqlx-core/tls12"]
 
-# for conditional compilation
-_rt-tokio = []
-_rt-actix = []
-
 # database
 any = ["sqlx-core/any"]
 postgres = ["sqlx-core/postgres", "sqlx-macros/postgres"]

README.md

@@ -82,7 +82,7 @@ SQLx is an async, pure Rust<sub>†</sub> SQL crate featuring compile-time check
 
 -   **Pure Rust**. The Postgres and MySQL/MariaDB drivers are written in pure Rust using **zero** unsafe<sub>††</sub> code.
 
--   **Runtime Agnostic**. Works on different runtimes ([`tokio`] / [`actix`]) and TLS backends ([`native-tls`], [`rustls`]).
+-   **Tokio-based**. Uses [`tokio`] for async IO and supports multiple TLS backends ([`native-tls`], [`rustls`]).
 
 <small><small>
 
@@ -124,31 +124,26 @@ with C, those interactions are `unsafe`.
 
 ## Install
 
-SQLx is compatible with the [`tokio`] and [`actix`] runtimes; and, the [`native-tls`] and [`rustls`] TLS backends. When adding the dependency, you must chose a runtime feature that is `runtime` + `tls`.
+SQLx uses [`tokio`] for async IO and supports the [`native-tls`] and [`rustls`] TLS backends. When adding the dependency, choose one TLS backend feature.
 
 [`tokio`]: https://github.com/tokio-rs/tokio
-[`actix`]: https://github.com/actix/actix-net
 [`native-tls`]: https://crates.io/crates/native-tls
 [`rustls`]: https://crates.io/crates/rustls
 
 ```toml
 # Cargo.toml
 [dependencies]
-# tokio + rustls
-sqlx-oldapi = { version = "0.6", features = [ "runtime-tokio-rustls" ] }
+# rustls
+sqlx-oldapi = { version = "0.6", features = [ "rustls" ] }
 ```
 
-<small><small>The runtime and TLS backend not being separate feature sets to select is a workaround for a [Cargo issue](https://github.com/rust-lang/cargo/issues/3494).</small></small>
-
 #### Cargo Feature Flags
 
--   `runtime-tokio-native-tls`: Use the `tokio` runtime and `native-tls` TLS backend.
-
--   `runtime-tokio-rustls`: Use the `tokio` runtime and `rustls` TLS backend.
+-   `native-tls`: Use the `native-tls` TLS backend.
 
--   `runtime-actix-native-tls`: Use the `actix` runtime and `native-tls` TLS backend.
+-   `rustls`: Use the `rustls` TLS backend with the default crypto provider.
 
--   `runtime-actix-rustls`: Use the `actix` runtime and `rustls` TLS backend.
+-   `rustls-nocrypto`: Use the `rustls` TLS backend without selecting a crypto provider.
 
 -   `postgres`: Add support for the Postgres database server.
 
@@ -217,14 +212,8 @@ See the `examples/` folder for more in-depth usage.
 
 ```toml
 [dependencies]
-# PICK ONE:
-# Tokio:
-sqlx-oldapi = { version = "0.6", features = [ "runtime-tokio-native-tls" , "postgres" ] }
+sqlx-oldapi = { version = "0.6", features = [ "native-tls" , "postgres" ] }
 tokio = { version = "1", features = ["full"] }
-
-# Actix-web:
-sqlx-oldapi = { version = "0.6", features = [ "runtime-actix-native-tls" , "postgres" ] }
-actix-web = "4"
 ```
 
 ```rust

contrib/ide/vscode/settings.json

@@ -6,7 +6,7 @@
         "macros",
         "migrate",
         "all-types",
-        "runtime-actix-rustls"
+        "rustls"
     ],
     "rust-analyzer.linkedProjects": [
         "./Cargo.toml",

examples/mysql/todos/Cargo.toml

@@ -8,6 +8,6 @@ workspace = "../../../"
 [dependencies]
 anyhow = "1.0"
 futures = "0.3"
-sqlx = { package = "sqlx-oldapi",  path = "../../../", features = [ "mysql", "runtime-tokio-native-tls" ] }
+sqlx = { package = "sqlx-oldapi",  path = "../../../", features = [ "mysql", "native-tls" ] }
 clap = { version = "4.5", features = ["derive"] }
 tokio = { version = "1.20.0", features = ["macros"]}

examples/postgres/axum-social-with-tests/Cargo.toml

@@ -9,7 +9,7 @@ publish = false
 [dependencies]
 # Primary crates
 axum = { version = "0.8", features = ["macros"] }
-sqlx = { package = "sqlx-oldapi",  version = "0.6.55", path = "../../../", features = ["runtime-tokio-rustls", "postgres", "time", "uuid"] }
+sqlx = { package = "sqlx-oldapi",  version = "0.6.55", path = "../../../", features = ["rustls", "postgres", "time", "uuid"] }
 tokio = { version = "1.20.1", features = ["rt-multi-thread", "macros", "net"] }
 
 # Important secondary crates

examples/postgres/files/Cargo.toml

@@ -8,6 +8,6 @@ publish = false
 
 [dependencies]
 anyhow = "1.0"
-sqlx = { package = "sqlx-oldapi",  path = "../../../", features = ["postgres", "offline", "runtime-tokio-native-tls"] }
+sqlx = { package = "sqlx-oldapi",  path = "../../../", features = ["postgres", "offline", "native-tls"] }
 tokio = { version = "1.20.0", features = ["macros"]}
 dotenvy = "0.15.0"

examples/postgres/listen/Cargo.toml

@@ -6,6 +6,6 @@ publish = false
 workspace = "../../../"
 
 [dependencies]
-sqlx = { package = "sqlx-oldapi",  path = "../../../", features = [ "postgres", "tls", "runtime-tokio-native-tls" ] }
+sqlx = { package = "sqlx-oldapi",  path = "../../../", features = [ "postgres", "tls", "native-tls" ] }
 futures = "0.3.1"
 tokio = { version = "1.20.0", features = ["macros", "rt-multi-thread", "time"]}