Merge pull request #1029 from sqlpage/cursor/statically-link-unixodbc-and-update-configurations-df86

Statically link unixodbc and update configurations

Author: lovasoa

.cargo/config.toml

@@ -5,3 +5,6 @@
 # set by the user, and this is a good thing. If the user already set some
 # LIBSQLITE3_FLAGS, he probably knows what he is doing.
 LIBSQLITE3_FLAGS = "-DSQLITE_ENABLE_MATH_FUNCTIONS"
+
+[build]
+rustflags = []

.github/workflows/ci.yml

@@ -27,15 +27,11 @@ jobs:
       - uses: actions/checkout@v4
       - run: npm ci
       - run: npm test
-      - name: Install ODBC dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y unixodbc-dev freetds-dev
       - name: Set up cargo cache
         uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6
       - run: cargo fmt --all -- --check
       - run: cargo clippy --all-targets --all-features -- -D warnings
-      - run: cargo test
+      - run: cargo test --all-features
       - name: Upload Linux binary
         uses: actions/upload-artifact@v4
         with:
@@ -58,29 +54,23 @@ jobs:
             db_url: "mssql://root:[email protected]/sqlpage"
           - database: odbc
             container: postgres
-            db_url: "Driver={PostgreSQL Unicode};Server=127.0.0.1;Port=5432;Database=sqlpage;UID=root;PWD=Password123!"
+            db_url: "Driver=/usr/lib/x86_64-linux-gnu/odbc/psqlodbcw.so;Server=127.0.0.1;Port=5432;Database=sqlpage;UID=root;PWD=Password123!"
             setup_odbc: true
     steps:
       - uses: actions/checkout@v4
       - name: Set up cargo cache
         uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6
-      - name: Install ODBC dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y unixodbc-dev freetds-dev
-      - name: Setup ODBC for testing
+      - name: Install PostgreSQL ODBC driver
         if: matrix.setup_odbc
-        run: |
-          # Install PostgreSQL ODBC driver (automatically registers the driver)
-          sudo apt-get install -y odbc-postgresql
+        run: sudo apt-get install -y odbc-postgresql
       - name: Start database container
         run: docker compose up --wait ${{ matrix.container }}
       - name: Show container logs
         if: failure()
         run: docker compose logs ${{ matrix.container }}
       - name: Run tests against ${{ matrix.database }}
         timeout-minutes: 5
-        run: cargo test
+        run: cargo test --all-features
         env:
           DATABASE_URL: ${{ matrix.db_url }}
           RUST_BACKTRACE: 1

.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
@@ -83,18 +85,14 @@ jobs:
     container: quay.io/pypa/manylinux_2_28_x86_64
     steps:
       - uses: actions/checkout@v4
-      - name: Install ODBC dependencies
-        run: |
-          yum update -y
-          yum install -y unixODBC-devel freetds-devel
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
         with:
           targets: x86_64-unknown-linux-gnu
       - name: Set up cargo cache
         uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6
       - name: Build
-        run: cargo build --profile superoptimized --locked --target x86_64-unknown-linux-gnu
+        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

AGENTS.md

@@ -3,16 +3,17 @@ HTML streamed to client
 
 ## Validation
 
+### When working on rust code
 Mandatory formatting (rust): `cargo fmt --all`
-
 Mandatory linting: `cargo clippy --all-targets --all-features -- -D warnings`
 
+### When working on css or js
 Frontend formatting: `npm run format`
 
 More about testing: see [github actions](./.github/workflows/ci.yml).
 Project structure: see [contribution guide](./CONTRIBUTING.md)
 
-Don’t reformat unrelated files. Always run tests/lints/format before stopping when you changed code.
+NEVER reformat/lint/touch files unrelated to your task. Always run tests/lints/format before stopping when you changed code.
 
 ### Testing
 
@@ -32,33 +33,10 @@ DATABASE_URL='mssql://root:Password123!@localhost/sqlpage' cargo test # all dbms
 - Components: defined in `./sqlpage/templates/*.handlebars`
 - Functions: `src/webserver/database/sqlpage_functions/functions.rs` registered with `make_function!`.
 - Components and functions are documented in [official website](./examples/official-site/sqlpage/migrations/); one migration per component and per function.
-- ```sql
-   CREATE TABLE component(
-       name TEXT PRIMARY KEY,
-       description TEXT NOT NULL,
-       icon TEXT, -- icon name from tabler icon
-       introduced_in_version TEXT
-   );
-
-   CREATE TABLE parameter_type(name TEXT PRIMARY KEY);
-   INSERT INTO parameter_type(name) VALUES ('BOOLEAN'), ('COLOR'), ('HTML'), ('ICON'), ('INTEGER'), ('JSON'), ('REAL'), ('TEXT'), ('TIMESTAMP'), ('URL');
-
-   CREATE TABLE parameter(
-       top_level BOOLEAN DEFAULT FALSE,
-       name TEXT,
-       component TEXT REFERENCES component(name) ON DELETE CASCADE,
-       description TEXT,
-       description_md TEXT,
-       type TEXT REFERENCES parameter_type(name) ON DELETE CASCADE,
-       optional BOOLEAN DEFAULT FALSE,
-   );
-
-   CREATE TABLE example(
-       component TEXT REFERENCES component(name) ON DELETE CASCADE,
-       description TEXT,
-       properties JSON,
-   );
-  ```
+  - tables
+    - `component(name,description,icon,introduced_in_version)` -- icon name from tabler icon
+    - `parameter(top_level BOOLEAN, name, component REFERENCES component(name), description, description_md, type, optional BOOLEAN)` parameter types: BOOLEAN, COLOR, HTML, ICON, INTEGER, JSON, REAL, TEXT, TIMESTAMP, URL
+    - `example(component REFERENCES component(name), description, properties JSON)`
 - [Configuration](./configuration.md): see [AppConfig](./src/app_config.rs)
 - Routing: file-based in `src/webserver/routing.rs`; not found handled via `src/default_404.sql`.
 - Follow patterns from similar modules before introducing new abstractions.

CONTRIBUTING.md

@@ -37,12 +37,24 @@ cargo build --release
 
 The resulting executable will be in `target/release/sqlpage`.
 
+### ODBC build modes
+
+SQLPage can either be built with an integrated odbc driver manager (static linking),
+or depend on having one already installed on the system where it is running (dynamic linking).
+
+- Dynamic ODBC (default): `cargo build`
+- Static ODBC (Linux and MacOS only): `cargo build --features odbc-static`
+
+Windows comes with ODBC pre-installed; SQLPage cannot statically link to the unixODBC driver manager on windows.
+
 ## Code Style and Linting
 
 ### Rust
+
 - Use `cargo fmt` to format your Rust code
 - Run `cargo clippy` to catch common mistakes and improve code quality
 - All code must pass the following checks:
+
 ```bash
 cargo fmt --all -- --check
 cargo clippy
@@ -55,6 +67,7 @@ We use Biome for linting and formatting of the frontend code.
 ```bash
 npx @biomejs/biome check .
 ```
+
 This will check the entire codebase (html, css, js).
 
 ## Testing
@@ -80,6 +93,7 @@ cargo test
 ```
 
 ### End-to-End Tests
+
 We use Playwright for end-to-end testing of dynamic frontend features.
 Tests are located in [`tests/end-to-end/`](./tests/end-to-end/). Key areas covered include:
 
@@ -103,14 +117,15 @@ npm run test
 ## Documentation
 
 ### Component Documentation
+
 When adding new components, comprehensive documentation is required. Example from a component documentation:
 
 ```sql
 INSERT INTO component(name, icon, description, introduced_in_version) VALUES
     ('component_name', 'icon_name', 'Description of the component', 'version');
 
 -- Document all parameters
-INSERT INTO parameter(component, name, description, type, top_level, optional) 
+INSERT INTO parameter(component, name, description, type, top_level, optional)
 VALUES ('component_name', 'param_name', 'param_description', 'TEXT|BOOLEAN|NUMBER|JSON|ICON|COLOR', false, true);
 
 -- Include usage examples
@@ -127,6 +142,7 @@ If you are editing an existing component, edit the existing sql documentation fi
 If you are adding a new component, add a new sql file in the folder, and add the appropriate insert statements above.
 
 ### SQLPage Function Documentation
+
 When adding new SQLPage functions, document them using a SQL migrations. Example structure:
 
 ```sql
@@ -168,6 +184,7 @@ VALUES (
 ```
 
 Key elements to include in function documentation:
+
 - Clear description of the function's purpose
 - Version number where the function was introduced
 - Appropriate icon
@@ -179,11 +196,13 @@ Key elements to include in function documentation:
 ## Pull Request Process
 
 1. Create a new branch for your feature/fix:
+
 ```bash
 git checkout -b feature/your-feature-name
 ```
 
 2. Make your changes, ensuring:
+
 - All tests pass
 - Code is properly formatted
 - New features are documented
@@ -199,11 +218,10 @@ git checkout -b feature/your-feature-name
    - Run frontend linting with Biome
    - Test against multiple databases (PostgreSQL, MySQL, MSSQL)
 
-5. Wait for review and address any feedback
-
 ## Release Process
 
 Releases are automated when pushing tags that match the pattern `v*` (e.g., `v1.0.0`). The CI pipeline will:
+
 - Build and test the code
 - Create Docker images for multiple architectures
 - Push images to Docker Hub