Skip to content

request-headers-mode.md

Latest commit

 

History

History
105 lines (81 loc) · 2.5 KB

request-headers-mode.md

File metadata and controls

105 lines (81 loc) · 2.5 KB
Raw
outline
2
3
title REQUEST_HEADERS_MODE Annotation
titleTemplate NpgsqlRest
description Control how HTTP request headers are passed to PostgreSQL functions. Access headers via context or parameters.
head
meta
name content
keywords
npgsqlrest request headers, http headers postgresql, access request headers, headers to function, header mode
meta
property content
og:title
NpgsqlRest REQUEST_HEADERS_MODE Annotation
meta
property content
og:description
Control how HTTP request headers are passed to PostgreSQL functions.
meta
property content
og:type
article

REQUEST_HEADERS_MODE

::: info Also known as request_headers (with or without @ prefix) :::

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

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
begin atomic;
...;
end;

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

Equivalent as a SQL file endpoint (sql/with-headers.sql):

/*
HTTP POST
@request_headers_mode parameter
@param $1 data
@param $2 headers json
*/
select json_build_object('data', $1, 'headers', $2);

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

Related Annotations