documentation

Author: lovasoa

.github/workflows/release.yml

@@ -24,8 +24,10 @@ jobs:
           - os: windows-latest
             binary_extension: .exe
             target: x86_64-pc-windows-msvc
+            features: ""
           - os: macos-latest
             target: x86_64-apple-darwin
+            features: "odbc-static"
     steps:
       - uses: actions/checkout@v4
       - name: Install Rust toolchain
@@ -35,7 +37,7 @@ jobs:
       - name: Set up cargo cache
         uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6
       - name: Build
-        run: cargo build --profile superoptimized --locked --target ${{ matrix.target }}
+        run: cargo build --profile superoptimized --locked --target ${{ matrix.target }} --features "${{ matrix.features }}"
       - name: Upload unsigned Windows artifact
         if: matrix.os == 'windows-latest'
         id: upload_unsigned
@@ -90,7 +92,7 @@ jobs:
       - name: Set up cargo cache
         uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6
       - name: Build
-        run: cargo build --profile superoptimized --locked --target x86_64-unknown-linux-gnu --all-features
+        run: cargo build --profile superoptimized --locked --target x86_64-unknown-linux-gnu --features "odbc-static"
       - uses: actions/upload-artifact@v4
         with:
           name: sqlpage ubuntu-latest

README.md

@@ -190,7 +190,9 @@ You can skip this section if you want to use one of the built-in database driver
 
 SQLPage supports ODBC connections to connect to databases that don't have native drivers, such as Oracle, Snowflake, BigQuery, IBM DB2, and many others.
 
-On Linux, SQLPage supports both dynamic and static ODBC linking. The Docker image uses the system `unixODBC` (dynamic). Release binaries can be built with static ODBC linking by enabling the `odbc-static` feature. You still need to install or provide the database-specific ODBC driver for the database you want to connect to. SQLPage also searches for drivers in a `sqlpage/` directory placed next to the executable (rpath includes `$ORIGIN/sqlpage`).
+On Linux, SQLPage supports both dynamic and static ODBC linking. The Docker image uses the system `unixODBC` (dynamic).
+Linux and MacOS release binaries are built with a statically linked unixODBC.
+You still need to install or provide the database-specific ODBC driver for the database you want to connect to.
 
 #### Install ODBC
 
@@ -207,7 +209,9 @@ On Linux, SQLPage supports both dynamic and static ODBC linking. The Docker imag
 
 #### Connect to your database
 
- - Find your [connection string](https://www.connectionstrings.com/). It will look like this: `Driver={SnowflakeDSIIDriver};Server=xyz.snowflakecomputing.com;Database=MY_DB;Schema=PUBLIC;UID=my_user;PWD=my_password`
+ - Find your [connection string](https://www.connectionstrings.com/).
+   - It will look like this: `Driver=/opt/snowflake_odbc/lib/libSnowflake.so;Server=xyz.snowflakecomputing.com;Database=MY_DB;Schema=PUBLIC;UID=my_user;PWD=my_password`
+   - It must reference the path to the database driver you installed earlier, plus any connection parameter required by the driver itself. Follow the instructions from the driver's own documentation.
  - Use it in the [DATABASE_URL configuration option](./configuration.md)