IMPORTANT

As you may notice, this page and pretty much the entire website were obviously created with the help of AI. I wonder how you could tell? Was it a big "Written With Claude" badge on every page? I moved it to the top now (with the help of AI of course) to make it even more obvious. There are a few blogposts that were written by me manually, the old-fashioned way, I hope there will be more in the future, and those have a similar "Human Written" badge. This project (not the website), on the other hand, is a very, very different story. It took me more than two years of painstaking and unpaid work in my own free time. A story that, hopefully, I will tell someday. But meanwhile, what would you like me to do? To create a complex documentation website with a bunch of highly technical articles with the help of AI and fake it, to give you an illusion that I also did that manually? Like the half of itnernet is doing at this point? How does that makes any sense? Is that even fair to you? Or maybe to create this website manually, the old-fashioned way, just for you? While working a paid job for a salary, most of you wouldn't even get up in the morning. Would you like me to sing you a song while we're at it? For your personal entertainment? Seriously, get a grip. Do you find this information less valuable because of the way this website was created? I give my best to fix it to keep the information as accurate as possible, and I think it is very accurate at this point. If you find some mistakes, inaccurancies or problems, there is a comment section at the bottom of every page, which I also made with the help of the AI. And I woould very much appreciate if you leave your feedback there. Look, I'm just a guy who likes SQL, that's all. If you don't approve of how this website was constructed and the use of AI tools, I suggest closing this page and never wever coming back. And good riddance. And I would ban your access if I could know how. Thank you for your attention to this matter.

REQUEST_HEADERS_MODE

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

sql

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

Pass as Context Variable

sql

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

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

Pass as Parameter

sql

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

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

REQUEST_HEADERS_PARAMETER_NAME - Set parameter name

Comments