REQUEST_HEADERS_MODE

Control how HTTP request headers are passed to the PostgreSQL function.

Keywords

request_headers_mode, request_headers

Syntax

request_headers_mode <mode>
request_headers <mode>

Values

Value	Description
ignore	Don't pass request headers to the function
context	Set headers as PostgreSQL context variable via set_config()
parameter	Pass headers to a function parameter as JSON

Examples

Ignore Headers

comment on function simple_func() is
'HTTP GET
request_headers_mode ignore';

Pass as Context Variable

comment on function context_aware_func() is
'HTTP GET
request_headers_mode context';

Headers accessible via: current_setting('request.headers', true)

Pass as Parameter

create function with_headers(_data text, _headers json default null)
returns json
language sql
as $$...$$;

comment on function with_headers(text, json) is
'HTTP POST
request_headers_mode parameter';

Behavior

• Default mode is configured in NpgsqlRest.RequestHeadersMode
• context mode uses the key from RequestHeadersContextKey setting
• parameter mode uses the parameter name from RequestHeadersParameterName setting

Related

• NpgsqlRest Options configuration - Configure default request headers mode
• Comment Annotations Guide - How annotations work
• Configuration Guide - How configuration works

Related Annotations

• REQUEST_HEADERS_PARAMETER_NAME - Set parameter name