new function: sqlpage.headers()

closes #810

Author: lovasoa

CHANGELOG.md

@@ -35,6 +35,7 @@
     - Control decimal places with `number_format_digits` property.
 - Add a new `description_md` row-level property to the form component to allow displaying markdown in a form field description.
 - Improve the error message when a header component (e.g. status_code, json, cookie) is used in the wrong place (after data has already been sent to the client).
+- New function: [`sqlpage.headers`](https://sql-page.com/functions.sql?function=headers).
 
 ## 0.32.1 (2025-01-03)
 

examples/official-site/sqlpage/migrations/08_functions.sql

@@ -86,6 +86,8 @@ Log the [`User-Agent`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
 ```sql
 INSERT INTO user_agent_log (user_agent) VALUES (sqlpage.header(''user-agent''));
 ```
+
+If you need access to all headers at once, use [`sqlpage.headers()`](?function=headers) instead.
     '
     );
 INSERT INTO sqlpage_function_parameters (

examples/official-site/sqlpage/migrations/56_headers.sql

@@ -0,0 +1,39 @@
+INSERT INTO sqlpage_functions (
+        "name",
+        "introduced_in_version",
+        "icon",
+        "description_md"
+    )
+VALUES (
+        'headers',
+        '0.33.0',
+        'circle-dotted-letter-h',
+        'Returns all HTTP request headers as a JSON object.
+
+### Example
+
+The following displays all HTTP request headers in a list,
+using SQLite''s `json_each()` function.
+
+```sql
+select ''list'' as component;
+
+select key as title, value as description
+from json_each(sqlpage.headers()); -- json_each() is SQLite only
+```
+
+If not on SQLite, use your [database''s JSON function](/blog.sql?post=JSON%20in%20SQL%3A%20A%20Comprehensive%20Guide).
+
+### Details
+
+The function returns a JSON object where:
+- Keys are lowercase header names
+- Values are the corresponding header values
+- If no headers are present, returns an empty JSON object `{}`
+
+This is useful when you need to:
+- Debug HTTP requests
+- Access multiple headers at once
+
+If you only need access to a single known header, use [`sqlpage.header(name)`](?function=header) instead.
+');

src/webserver/database/sqlpage_functions/functions.rs

@@ -26,6 +26,7 @@ super::function_definition_macro::sqlpage_functions! {
 
     hash_password(password: Option<String>);
     header((&RequestInfo), name: Cow<str>);
+    headers((&RequestInfo));
 
     link(file: Cow<str>, parameters: Option<Cow<str>>, hash: Option<Cow<str>>);
 
@@ -629,3 +630,7 @@ async fn request_body_base64(request: &RequestInfo) -> Option<String> {
     );
     Some(base64_string)
 }
+
+async fn headers(request: &RequestInfo) -> String {
+    serde_json::to_string(&request.headers).unwrap_or_default()
+}

tests/sql_test_files/it_works_headers.sql

@@ -0,0 +1,4 @@
+select 'text' as component,
+    case when sqlpage.headers() LIKE '%"cookie":"test_cook=123"%' then 'It works !'
+        else 'error: ' || sqlpage.headers()
+    end AS contents;