{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
41 lines (39 loc) · 106 KB
/
Copy pathindex.html
File metadata and controls
41 lines (39 loc) · 106 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Annotations Reference | NpgsqlRest</title>
<meta name="description" content="Complete reference for all NpgsqlRest comment annotations. HTTP methods, authorization, caching, rate limiting, and more for PostgreSQL REST APIs.">
<meta name="generator" content="VitePress v1.6.4">
<link rel="preload stylesheet" href="/assets/style.DkoEojDh.css" as="style">
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
<script type="module" src="/assets/app.BUrFvZj7.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.C8ZywH72.js">
<link rel="modulepreload" href="/assets/chunks/framework.CgT1UzWm.js">
<link rel="modulepreload" href="/assets/annotations_index.md.D20z3eDV.lean.js">
<link rel="icon" type="image/x-icon" href="/favicon.ico">
<link rel="shortcut icon" href="/favicon.ico">
<link rel="apple-touch-icon" sizes="180x180" href="/favicon.ico">
<link rel="alternate" type="application/rss+xml" title="NpgsqlRest Blog" href="/feed.xml">
<script defer data-id="101498393" src="//static.getclicky.com/js"></script>
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
<meta name="keywords" content="npgsqlrest annotations, postgresql comment annotations, rest api annotations, http endpoint configuration, sql api annotations">
<meta property="og:title" content="NpgsqlRest Annotations Reference">
<meta property="og:description" content="Complete reference for all NpgsqlRest comment annotations for PostgreSQL REST APIs.">
<meta property="og:type" content="article">
<link rel="canonical" href="https://npgsqlrest.github.io/annotations/">
<meta property="og:url" content="https://npgsqlrest.github.io/annotations/">
<meta property="og:image" content="https://npgsqlrest.github.io/og-image.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="NpgsqlRest Annotations Reference">
<meta name="twitter:description" content="Complete reference for all NpgsqlRest comment annotations for PostgreSQL REST APIs.">
<meta name="twitter:image" content="https://npgsqlrest.github.io/og-image.png">
</head>
<body>
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0b0ada53></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0b0ada53>Skip to content</a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar" data-v-ae24b3ad data-v-6aa21345><div class="wrapper" data-v-6aa21345><div class="container" data-v-6aa21345><div class="title" data-v-6aa21345><div class="VPNavBarTitle has-sidebar" data-v-6aa21345 data-v-1168a8e4><a class="title" href="/" data-v-1168a8e4><!--[--><!--]--><!--[--><img class="VPImage logo" src="/favicon.ico" alt data-v-8426fc1a><!--]--><span data-v-1168a8e4>NpgsqlRest</span><!--[--><!--]--></a></div></div><div class="content" data-v-6aa21345><div class="content-body" data-v-6aa21345><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6aa21345><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-6aa21345 data-v-dc692963><span id="main-nav-aria-label" class="visually-hidden" data-v-dc692963> Main Navigation </span><!--[--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-dc692963 data-v-cf11d7a2><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-cf11d7a2><span class="text" data-v-cf11d7a2><!----><span data-v-cf11d7a2>Guide</span><span class="vpi-chevron-down text-icon" data-v-cf11d7a2></span></span></button><div class="menu" data-v-cf11d7a2><div class="VPMenu" data-v-cf11d7a2 data-v-b98bc113><div class="items" data-v-b98bc113><!--[--><!--[--><div class="VPMenuGroup" data-v-b98bc113 data-v-69e747b5><p class="title" data-v-69e747b5>Getting Started</p><!--[--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/" data-v-35975db6><!--[--><span data-v-35975db6>Overview</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/installation.html" data-v-35975db6><!--[--><span data-v-35975db6>Installation</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/quick-start.html" data-v-35975db6><!--[--><span data-v-35975db6>Quick Start</span><!--]--></a></div><!--]--><!--]--></div><!--]--><!--[--><div class="VPMenuGroup" data-v-b98bc113 data-v-69e747b5><p class="title" data-v-69e747b5>Topics</p><!--[--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/sql-files.html" data-v-35975db6><!--[--><span data-v-35975db6>SQL File Endpoints</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/configuration.html" data-v-35975db6><!--[--><span data-v-35975db6>Configuration Guide</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/annotations.html" data-v-35975db6><!--[--><span data-v-35975db6>Comment Annotations Guide</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/connections.html" data-v-35975db6><!--[--><span data-v-35975db6>Connection Management</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/authentication.html" data-v-35975db6><!--[--><span data-v-35975db6>Authentication</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/sse.html" data-v-35975db6><!--[--><span data-v-35975db6>Server-Sent Events</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/http-types.html" data-v-35975db6><!--[--><span data-v-35975db6>HTTP Custom Types</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/proxy.html" data-v-35975db6><!--[--><span data-v-35975db6>Proxy Endpoints</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/testing.html" data-v-35975db6><!--[--><span data-v-35975db6>Testing</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/logging.html" data-v-35975db6><!--[--><span data-v-35975db6>Logging</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/claude-code-skill.html" data-v-35975db6><!--[--><span data-v-35975db6>Claude Code Skill</span><!--]--></a></div><!--]--><!--]--></div><!--]--><!--[--><div class="VPMenuGroup" data-v-b98bc113 data-v-69e747b5><p class="title" data-v-69e747b5>Reference</p><!--[--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/faq.html" data-v-35975db6><!--[--><span data-v-35975db6>FAQ & Troubleshooting</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-69e747b5 data-v-35975db6><a class="VPLink link" href="/guide/changelog/" data-v-35975db6><!--[--><span data-v-35975db6>Changelog</span><!--]--></a></div><!--]--><!--]--></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/examples/" tabindex="0" data-v-dc692963 data-v-e56f3d57><!--[--><span data-v-e56f3d57>Examples</span><!--]--></a><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup active" data-v-dc692963 data-v-cf11d7a2><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-cf11d7a2><span class="text" data-v-cf11d7a2><!----><span data-v-cf11d7a2>Reference</span><span class="vpi-chevron-down text-icon" data-v-cf11d7a2></span></span></button><div class="menu" data-v-cf11d7a2><div class="VPMenu" data-v-cf11d7a2 data-v-b98bc113><div class="items" data-v-b98bc113><!--[--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-35975db6><a class="VPLink link active" href="/annotations/" data-v-35975db6><!--[--><span data-v-35975db6>Annotations</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-35975db6><a class="VPLink link" href="/config/" data-v-35975db6><!--[--><span data-v-35975db6>Configuration</span><!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/blog/" tabindex="0" data-v-dc692963 data-v-e56f3d57><!--[--><span data-v-e56f3d57>Blog</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/support.html" tabindex="0" data-v-dc692963 data-v-e56f3d57><!--[--><span data-v-e56f3d57>❤️ Sponsor</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-6aa21345 data-v-6c893767><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-6c893767 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-6aa21345 data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://github.com/NpgsqlRest/NpgsqlRest" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" href="https://github.com/sponsors/NpgsqlRest" aria-label="Sponsor NpgsqlRest on GitHub" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" fill="currentColor"><path d="M7.655 14.916v-.001h-.002l-.006-.003-.018-.01a22.066 22.066 0 0 1-3.744-2.584C2.045 10.731 0 8.35 0 5.5 0 2.836 2.086 1 4.25 1 5.797 1 7.153 1.802 8 3.02 8.847 1.802 10.203 1 11.75 1 13.914 1 16 2.836 16 5.5c0 2.85-2.045 5.231-3.885 6.818a22.066 22.066 0 0 1-3.744 2.584l-.018.01-.006.003h-.002a.75.75 0 0 1-.69 0Z"/></svg></a><a class="VPSocialLink no-icon" href="https://patreon.com/vbconsulting" aria-label="Patreon" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M22.957 7.21c-.004-3.064-2.391-5.576-5.191-6.482-3.478-1.125-8.064-.962-11.384.604C2.357 3.231 1.093 7.391 1.046 11.54c-.039 3.411.302 7.463 3.097 9.746 2.602 2.124 6.19 2.078 9.402 1.836 1.883-.142 3.939-.358 5.477-1.528 1.564-1.19 1.873-3.298 1.972-5.151.134-2.51.187-5.016-.037-7.233zm-2.55 7.703c-.078 1.593-.383 3.473-1.795 4.334-1.351.824-3.151.973-4.686 1.083-2.891.207-6.063.276-8.514-1.399C3.106 17.39 2.924 14.34 2.95 11.67c.03-3.206.678-6.721 3.654-8.375 2.756-1.531 6.556-1.727 9.544-.872 2.339.669 4.351 2.678 4.355 5.217.007 2.583-.016 5.168-.095 7.273z"/><path d="M16.088 5.19c-1.008-.542-2.607-.48-3.441.388-.568.591-.773 1.389-.8 2.172-.034.993.068 2.013.361 2.953.307.985 1.034 1.848 2.077 2.012.878.138 1.83-.088 2.458-.732.7-.718.88-1.81.877-2.779-.003-.989-.084-1.99-.423-2.91-.268-.726-.654-1.328-1.109-1.104zm-.294 5.482c-.182.462-.581.771-1.091.696-.532-.078-.859-.533-1.04-1.005-.248-.647-.327-1.375-.312-2.06.01-.46.095-.939.371-1.313.345-.467.993-.447 1.426-.115.41.315.607.835.74 1.32.18.66.211 1.675-.094 2.477zM8.4 10.394c.233 1.084.755 2.299 1.907 2.579.934.227 1.993-.165 2.434-1.048.455-.91.346-1.995.166-2.972-.165-.893-.46-1.885-1.207-2.445-.745-.559-1.832-.457-2.479.192-.84.843-.958 2.138-.955 3.277.001.147.119.364.134.417zm1.363-2.808c.302-.321.805-.336 1.14-.054.445.375.618 1.015.75 1.558.131.54.212 1.156.082 1.703-.1.423-.378.821-.84.882-.469.062-.886-.306-1.088-.704-.326-.644-.401-1.426-.381-2.148.013-.465.104-.993.337-1.237z"/></svg></a><a class="VPSocialLink no-icon" href="https://buymeacoffee.com/vbilopavu" aria-label="Buy Me a Coffee" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M20.216 6.415l-.132-.666c-.119-.598-.388-1.163-1.001-1.379-.197-.069-.42-.098-.57-.241-.152-.143-.196-.366-.231-.572-.065-.378-.125-.756-.192-1.133-.057-.325-.102-.69-.25-.987-.195-.4-.597-.634-.996-.788a5.723 5.723 0 00-.626-.194c-1-.263-2.05-.36-3.077-.416a25.834 25.834 0 00-3.7.062c-.915.083-1.88.184-2.75.5-.318.116-.646.256-.888.501-.297.302-.393.77-.177 1.146.154.267.415.456.692.58.36.162.737.284 1.123.366 1.075.238 2.189.331 3.287.37 1.218.05 2.437.01 3.65-.118.299-.033.598-.073.896-.119.352-.054.578-.513.474-.834-.124-.383-.457-.531-.834-.473-.466.074-.96.108-1.382.146-1.177.08-2.358.082-3.536.006a22.228 22.228 0 01-1.157-.107c-.086-.01-.18-.025-.258-.036-.243-.036-.484-.08-.724-.13-.111-.027-.111-.185 0-.212h.005c.277-.06.557-.108.838-.147h.002c.131-.009.263-.032.394-.048a25.076 25.076 0 013.426-.12c.674.019 1.347.067 2.017.144l.228.031c.267.04.533.088.798.145.392.085.895.113 1.07.542.055.137.08.288.111.431l.319 1.484a.237.237 0 01-.199.284h-.003c-.037.006-.075.01-.112.015a36.704 36.704 0 01-4.743.295 37.059 37.059 0 01-4.699-.304c-.14-.017-.293-.042-.417-.06-.326-.048-.649-.108-.973-.161-.393-.065-.768-.032-1.123.161-.29.16-.527.404-.675.701-.154.316-.199.66-.267 1-.069.34-.176.707-.135 1.056.087.753.613 1.365 1.37 1.502a39.69 39.69 0 0011.343.376.483.483 0 01.535.53l-.071.697-1.018 9.907c-.041.41-.047.832-.125 1.237-.122.637-.553 1.028-1.182 1.171-.577.131-1.165.2-1.756.205-.656.004-1.31-.025-1.966-.022-.699.004-1.556-.06-2.095-.58-.475-.458-.54-1.174-.605-1.793l-.731-7.013-.322-3.094c-.037-.351-.286-.695-.678-.678-.336.015-.718.3-.678.679l.228 2.185.949 9.112c.147 1.344 1.174 2.068 2.446 2.272.742.12 1.503.144 2.257.156.966.016 1.942.053 2.892-.122 1.408-.258 2.465-1.198 2.616-2.657.34-3.332.683-6.663 1.024-9.995l.215-2.087a.484.484 0 01.39-.426c.402-.078.787-.212 1.074-.518.455-.488.546-1.124.385-1.766zm-1.478.772c-.145.137-.363.201-.578.233-2.416.359-4.866.54-7.308.46-1.748-.06-3.477-.254-5.207-.498-.17-.024-.353-.055-.47-.18-.22-.236-.111-.71-.054-.995.052-.26.152-.609.463-.646.484-.057 1.046.148 1.526.22.577.088 1.156.159 1.737.212 2.48.226 5.002.19 7.472-.14.45-.06.899-.13 1.345-.21.399-.072.84-.206 1.08.206.166.281.188.657.162.974a.544.544 0 01-.169.364z"/></svg></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-6aa21345 data-v-bb2aa2f0 data-v-cf11d7a2><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-cf11d7a2><span class="vpi-more-horizontal icon" data-v-cf11d7a2></span></button><div class="menu" data-v-cf11d7a2><div class="VPMenu" data-v-cf11d7a2 data-v-b98bc113><!----><!--[--><!--[--><!----><div class="group" data-v-bb2aa2f0><div class="item appearance" data-v-bb2aa2f0><p class="label" data-v-bb2aa2f0>Appearance</p><div class="appearance-action" data-v-bb2aa2f0><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-bb2aa2f0 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span><!--]--></span></span></button></div></div></div><div class="group" data-v-bb2aa2f0><div class="item social-links" data-v-bb2aa2f0><div class="VPSocialLinks social-links-list" data-v-bb2aa2f0 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://github.com/NpgsqlRest/NpgsqlRest" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" href="https://github.com/sponsors/NpgsqlRest" aria-label="Sponsor NpgsqlRest on GitHub" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" fill="currentColor"><path d="M7.655 14.916v-.001h-.002l-.006-.003-.018-.01a22.066 22.066 0 0 1-3.744-2.584C2.045 10.731 0 8.35 0 5.5 0 2.836 2.086 1 4.25 1 5.797 1 7.153 1.802 8 3.02 8.847 1.802 10.203 1 11.75 1 13.914 1 16 2.836 16 5.5c0 2.85-2.045 5.231-3.885 6.818a22.066 22.066 0 0 1-3.744 2.584l-.018.01-.006.003h-.002a.75.75 0 0 1-.69 0Z"/></svg></a><a class="VPSocialLink no-icon" href="https://patreon.com/vbconsulting" aria-label="Patreon" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M22.957 7.21c-.004-3.064-2.391-5.576-5.191-6.482-3.478-1.125-8.064-.962-11.384.604C2.357 3.231 1.093 7.391 1.046 11.54c-.039 3.411.302 7.463 3.097 9.746 2.602 2.124 6.19 2.078 9.402 1.836 1.883-.142 3.939-.358 5.477-1.528 1.564-1.19 1.873-3.298 1.972-5.151.134-2.51.187-5.016-.037-7.233zm-2.55 7.703c-.078 1.593-.383 3.473-1.795 4.334-1.351.824-3.151.973-4.686 1.083-2.891.207-6.063.276-8.514-1.399C3.106 17.39 2.924 14.34 2.95 11.67c.03-3.206.678-6.721 3.654-8.375 2.756-1.531 6.556-1.727 9.544-.872 2.339.669 4.351 2.678 4.355 5.217.007 2.583-.016 5.168-.095 7.273z"/><path d="M16.088 5.19c-1.008-.542-2.607-.48-3.441.388-.568.591-.773 1.389-.8 2.172-.034.993.068 2.013.361 2.953.307.985 1.034 1.848 2.077 2.012.878.138 1.83-.088 2.458-.732.7-.718.88-1.81.877-2.779-.003-.989-.084-1.99-.423-2.91-.268-.726-.654-1.328-1.109-1.104zm-.294 5.482c-.182.462-.581.771-1.091.696-.532-.078-.859-.533-1.04-1.005-.248-.647-.327-1.375-.312-2.06.01-.46.095-.939.371-1.313.345-.467.993-.447 1.426-.115.41.315.607.835.74 1.32.18.66.211 1.675-.094 2.477zM8.4 10.394c.233 1.084.755 2.299 1.907 2.579.934.227 1.993-.165 2.434-1.048.455-.91.346-1.995.166-2.972-.165-.893-.46-1.885-1.207-2.445-.745-.559-1.832-.457-2.479.192-.84.843-.958 2.138-.955 3.277.001.147.119.364.134.417zm1.363-2.808c.302-.321.805-.336 1.14-.054.445.375.618 1.015.75 1.558.131.54.212 1.156.082 1.703-.1.423-.378.821-.84.882-.469.062-.886-.306-1.088-.704-.326-.644-.401-1.426-.381-2.148.013-.465.104-.993.337-1.237z"/></svg></a><a class="VPSocialLink no-icon" href="https://buymeacoffee.com/vbilopavu" aria-label="Buy Me a Coffee" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M20.216 6.415l-.132-.666c-.119-.598-.388-1.163-1.001-1.379-.197-.069-.42-.098-.57-.241-.152-.143-.196-.366-.231-.572-.065-.378-.125-.756-.192-1.133-.057-.325-.102-.69-.25-.987-.195-.4-.597-.634-.996-.788a5.723 5.723 0 00-.626-.194c-1-.263-2.05-.36-3.077-.416a25.834 25.834 0 00-3.7.062c-.915.083-1.88.184-2.75.5-.318.116-.646.256-.888.501-.297.302-.393.77-.177 1.146.154.267.415.456.692.58.36.162.737.284 1.123.366 1.075.238 2.189.331 3.287.37 1.218.05 2.437.01 3.65-.118.299-.033.598-.073.896-.119.352-.054.578-.513.474-.834-.124-.383-.457-.531-.834-.473-.466.074-.96.108-1.382.146-1.177.08-2.358.082-3.536.006a22.228 22.228 0 01-1.157-.107c-.086-.01-.18-.025-.258-.036-.243-.036-.484-.08-.724-.13-.111-.027-.111-.185 0-.212h.005c.277-.06.557-.108.838-.147h.002c.131-.009.263-.032.394-.048a25.076 25.076 0 013.426-.12c.674.019 1.347.067 2.017.144l.228.031c.267.04.533.088.798.145.392.085.895.113 1.07.542.055.137.08.288.111.431l.319 1.484a.237.237 0 01-.199.284h-.003c-.037.006-.075.01-.112.015a36.704 36.704 0 01-4.743.295 37.059 37.059 0 01-4.699-.304c-.14-.017-.293-.042-.417-.06-.326-.048-.649-.108-.973-.161-.393-.065-.768-.032-1.123.161-.29.16-.527.404-.675.701-.154.316-.199.66-.267 1-.069.34-.176.707-.135 1.056.087.753.613 1.365 1.37 1.502a39.69 39.69 0 0011.343.376.483.483 0 01.535.53l-.071.697-1.018 9.907c-.041.41-.047.832-.125 1.237-.122.637-.553 1.028-1.182 1.171-.577.131-1.165.2-1.756.205-.656.004-1.31-.025-1.966-.022-.699.004-1.556-.06-2.095-.58-.475-.458-.54-1.174-.605-1.793l-.731-7.013-.322-3.094c-.037-.351-.286-.695-.678-.678-.336.015-.718.3-.678.679l.228 2.185.949 9.112c.147 1.344 1.174 2.068 2.446 2.272.742.12 1.503.144 2.257.156.966.016 1.942.053 2.892-.122 1.408-.258 2.465-1.198 2.616-2.657.34-3.332.683-6.663 1.024-9.995l.215-2.087a.484.484 0 01.39-.426c.402-.078.787-.212 1.074-.518.455-.488.546-1.124.385-1.766zm-1.478.772c-.145.137-.363.201-.578.233-2.416.359-4.866.54-7.308.46-1.748-.06-3.477-.254-5.207-.498-.17-.024-.353-.055-.47-.18-.22-.236-.111-.71-.054-.995.052-.26.152-.609.463-.646.484-.057 1.046.148 1.526.22.577.088 1.156.159 1.737.212 2.48.226 5.002.19 7.472-.14.45-.06.899-.13 1.345-.21.399-.072.84-.206 1.08.206.166.281.188.657.162.974a.544.544 0 01-.169.364z"/></svg></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-6aa21345 data-v-e5dd9c1c><span class="container" data-v-e5dd9c1c><span class="top" data-v-e5dd9c1c></span><span class="middle" data-v-e5dd9c1c></span><span class="bottom" data-v-e5dd9c1c></span></span></button></div></div></div></div><div class="divider" data-v-6aa21345><div class="divider-line" data-v-6aa21345></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-5d98c3a5 data-v-a6f0e41e><div class="container" data-v-a6f0e41e><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-a6f0e41e><span class="vpi-align-left menu-icon" data-v-a6f0e41e></span><span class="menu-text" data-v-a6f0e41e>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-a6f0e41e data-v-8a42e2b4><button data-v-8a42e2b4>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-5d98c3a5 data-v-319d5ca6><div class="curtain" data-v-319d5ca6></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-319d5ca6><span class="visually-hidden" id="sidebar-aria-label" data-v-319d5ca6> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 has-active" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>HTTP & Routing</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/http.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>HTTP</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/path.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>PATH</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/proxy.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>PROXY</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/proxy-out.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>PROXY_OUT</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/internal.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>INTERNAL</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/enabled.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>ENABLED</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/disabled.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>DISABLED</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/tags.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>TAGS</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/openapi.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>OPENAPI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/mcp.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>MCP</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/http-type.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>HTTP CUSTOM TYPES</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Authorization</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/authorize.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>AUTHORIZE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/allow-anonymous.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>ALLOW_ANONYMOUS</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/login.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>LOGIN</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/logout.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>LOGOUT</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/basic-auth.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>BASIC_AUTH</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/basic-auth-realm.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>BASIC_AUTH_REALM</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/basic-auth-command.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>BASIC_AUTH_COMMAND</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Request Configuration</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/request-param-type.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>REQUEST_PARAM_TYPE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/request-headers-mode.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>REQUEST_HEADERS_MODE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/request-headers-parameter-name.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>REQUEST_HEADERS_PARAMETER_NAME</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/body-parameter-name.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>BODY_PARAMETER_NAME</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/query-string-null-handling.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>QUERY_STRING_NULL_HANDLING</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/validate.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>VALIDATE</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Response Configuration</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/response-headers.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Response Headers</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/response-null-handling.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>RESPONSE_NULL_HANDLING</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/nested.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>NESTED</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/single.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>SINGLE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/void.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>VOID</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/raw.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>RAW</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/separator.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>SEPARATOR</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/new-line.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>NEW_LINE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/column-names.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>COLUMN_NAMES</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Caching & Performance</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/cached.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>CACHED</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/cache-expires-in.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>CACHE_EXPIRES_IN</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/cache-profile.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>CACHE_PROFILE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/buffer-rows.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>BUFFER_ROWS</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/command-timeout.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>COMMAND_TIMEOUT</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/retry-strategy.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>RETRY_STRATEGY</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/interval-format.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Interval Format</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Server-Sent Events</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/sse.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>SSE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/sse-events-level.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>SSE_EVENTS_LEVEL</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/sse-events-scope.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>SSE_EVENTS_SCOPE</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Upload & Policies</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/upload.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>UPLOAD</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/error-code-policy.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>ERROR_CODE_POLICY</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/rate-limiter-policy.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>RATE_LIMITER_POLICY</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Output & Code Generation</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/table-format.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>TABLE_FORMAT</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/tsclient.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>TSCLIENT</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/dartclient.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>DARTCLIENT</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Parameters</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/param.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>PARAM</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/parameter-hash.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>PARAMETER_HASH</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/encrypt-decrypt.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>ENCRYPT / DECRYPT</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/parameter-substitution.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Parameter Value Substitution</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/resolved-parameters.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Resolved Parameters</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>SQL File Annotations</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/define-param.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>DEFINE_PARAM</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/result-name.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>RESULT_NAME</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/skip.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>SKIP</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/returns.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>RETURNS</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Test Files (--test)</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/test-setup.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>TEST @setup</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/test-teardown.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>TEST @teardown</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/test-connection.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>TEST @connection</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/test-tag.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>TEST @tag</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/test-claim.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>TEST @claim</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/test-response.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>TEST @response</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Context & Security</h2><!----></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/user-context.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>USER_CONTEXT</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/user-parameters.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>USER_PARAMETERS</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/connection.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>CONNECTION</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/security-sensitive.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>SECURITY_SENSITIVE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/annotations/custom-parameters.html" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Custom Parameters</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible" data-v-c40bc020 data-v-b3fd67f8><div class="item" role="button" tabindex="0" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><h2 class="text" data-v-b3fd67f8>Other Links</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b3fd67f8><span class="vpi-chevron-right caret-icon" data-v-b3fd67f8></span></div></div><div class="items" data-v-b3fd67f8><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/guide/" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Guide</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/config/" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Configuration Reference</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b3fd67f8 data-v-b3fd67f8><div class="item" data-v-b3fd67f8><div class="indicator" data-v-b3fd67f8></div><a class="VPLink link link" href="/guide/changelog/" data-v-b3fd67f8><!--[--><p class="text" data-v-b3fd67f8>Changelog</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-5d98c3a5 data-v-1428d186><div class="VPDoc has-sidebar has-aside" data-v-1428d186 data-v-39a288b8><!--[--><!--]--><div class="container" data-v-39a288b8><div class="aside" data-v-39a288b8><div class="aside-curtain" data-v-39a288b8></div><div class="aside-container" data-v-39a288b8><div class="aside-content" data-v-39a288b8><div class="VPDocAside" data-v-39a288b8 data-v-3f215769><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-3f215769 data-v-a5bbad30><div class="content" data-v-a5bbad30><div class="outline-marker" data-v-a5bbad30></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-a5bbad30>On this page</div><ul class="VPDocOutlineItem root" data-v-a5bbad30 data-v-b933a997><!--[--><!--]--></ul></div></nav><!--[--><!--[--><!--[--><!--[--><div class="comments-outline-link" data-v-6357a5e2><a href="#comments" class="outline-link" data-v-6357a5e2>Comments</a></div><!--]--><!--]--><!--]--><!--]--><div class="spacer" data-v-3f215769></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-39a288b8><div class="content-container" data-v-39a288b8><!--[--><!--]--><main class="main" data-v-39a288b8><div style="position:relative;" class="vp-doc _annotations_" data-v-39a288b8><div><h1 id="annotations-reference" tabindex="-1">Annotations Reference <a class="header-anchor" href="#annotations-reference" aria-label="Permalink to "Annotations Reference""></a></h1><p>Complete reference for all NpgsqlRest comment annotations. For an introduction to how annotations work, see the <a href="./../guide/annotations.html">Comment Annotations Guide</a>.</p><div class="info custom-block"><p class="custom-block-title">INFO</p><p>All annotations work in both PostgreSQL function/procedure comments (<code>COMMENT ON FUNCTION ...</code>) and <a href="./../guide/sql-files.html">SQL file endpoints</a> (<code>--</code> and <code>/* */</code> comments in <code>.sql</code> files). The "SQL File Annotations" section below lists annotations that are specific to SQL files.</p></div><h2 id="how-to-use-this-reference" tabindex="-1">How to Use This Reference <a class="header-anchor" href="#how-to-use-this-reference" aria-label="Permalink to "How to Use This Reference""></a></h2><p>Each annotation has its own page with:</p><ul><li>Recognized keywords</li><li>Syntax explanation</li><li>Working examples from the test suite</li><li>Related annotations</li></ul><h2 id="annotation-categories" tabindex="-1">Annotation Categories <a class="header-anchor" href="#annotation-categories" aria-label="Permalink to "Annotation Categories""></a></h2><h3 id="http-routing" tabindex="-1">HTTP & Routing <a class="header-anchor" href="#http-routing" aria-label="Permalink to "HTTP & Routing""></a></h3><ul><li><a href="./http.html">HTTP</a> - Expose function as HTTP endpoint</li><li><a href="./path.html">PATH</a> - Set custom endpoint path</li><li><a href="./proxy.html">PROXY</a> - Mark endpoint as reverse proxy</li><li><a href="./proxy-out.html">PROXY_OUT</a> - Execute function first, then forward result to upstream</li><li><a href="./enabled.html">ENABLED</a> - Re-enable an endpoint after <code>@disabled</code>, optionally only for specific tags</li><li><a href="./disabled.html">DISABLED</a> - Disable endpoint, optionally only for specific tags</li><li><a href="./tags.html">TAGS</a> - Filter annotations by tags</li><li><a href="./openapi.html">OPENAPI</a> - Hide from the OpenAPI document or override the section tag</li><li><a href="./mcp.html">MCP</a> - Expose a routine as a Model Context Protocol (MCP) tool for AI agents</li><li><a href="./http-type.html">HTTP CUSTOM TYPES</a> - Define HTTP request on composite type for external API calls</li><li><a href="./internal.html">INTERNAL</a> - Mark endpoint as internal-only (accessible via proxy/HTTP client types, not public HTTP)</li></ul><h3 id="authorization" tabindex="-1">Authorization <a class="header-anchor" href="#authorization" aria-label="Permalink to "Authorization""></a></h3><ul><li><a href="./authorize.html">AUTHORIZE</a> - Require authentication</li><li><a href="./allow-anonymous.html">ALLOW_ANONYMOUS</a> - Allow unauthenticated access</li><li><a href="./login.html">LOGIN</a> - Mark as sign-in endpoint</li><li><a href="./logout.html">LOGOUT</a> - Mark as sign-out endpoint</li></ul><h3 id="basic-authentication" tabindex="-1">Basic Authentication <a class="header-anchor" href="#basic-authentication" aria-label="Permalink to "Basic Authentication""></a></h3><ul><li><a href="./basic-auth.html">BASIC_AUTH</a> - Enable HTTP Basic Authentication</li><li><a href="./basic-auth-realm.html">BASIC_AUTH_REALM</a> - Set authentication realm</li><li><a href="./basic-auth-command.html">BASIC_AUTH_COMMAND</a> - Set validation function</li></ul><h3 id="request-configuration" tabindex="-1">Request Configuration <a class="header-anchor" href="#request-configuration" aria-label="Permalink to "Request Configuration""></a></h3><ul><li><a href="./request-param-type.html">REQUEST_PARAM_TYPE</a> - Query string vs body parameters</li><li><a href="./request-headers-mode.html">REQUEST_HEADERS_MODE</a> - Control header passing</li><li><a href="./request-headers-parameter-name.html">REQUEST_HEADERS_PARAMETER_NAME</a> - Header parameter name</li><li><a href="./body-parameter-name.html">BODY_PARAMETER_NAME</a> - Body parameter name</li><li><a href="./query-string-null-handling.html">QUERY_STRING_NULL_HANDLING</a> - NULL handling in query strings</li><li><a href="./validate.html">VALIDATE</a> - Parameter validation before database execution</li></ul><h3 id="response-configuration" tabindex="-1">Response Configuration <a class="header-anchor" href="#response-configuration" aria-label="Permalink to "Response Configuration""></a></h3><ul><li><a href="./response-headers.html">Response Headers</a> - Set custom response headers</li><li><a href="./response-null-handling.html">RESPONSE_NULL_HANDLING</a> - NULL handling in responses</li><li><a href="./nested.html">NESTED</a> - Serialize composite type columns as nested JSON objects</li><li><a href="./single.html">SINGLE</a> - Return a single record as a JSON object instead of an array</li><li><a href="./void.html">VOID</a> - Force endpoint to return 204 No Content</li></ul><h3 id="table-format-output" tabindex="-1">Table Format Output <a class="header-anchor" href="#table-format-output" aria-label="Permalink to "Table Format Output""></a></h3><ul><li><a href="./table-format.html">TABLE_FORMAT</a> - <code>table_format</code>, <code>excel_file_name</code>, <code>excel_sheet</code> for HTML table and Excel rendering</li></ul><h3 id="client-code-generation" tabindex="-1">Client Code Generation <a class="header-anchor" href="#client-code-generation" aria-label="Permalink to "Client Code Generation""></a></h3><ul><li><a href="./tsclient.html">TSCLIENT</a> - Control TypeScript client generation per endpoint (disable, module names, URL exports, TanStack Query hooks opt-out)</li><li><a href="./dartclient.html">DARTCLIENT</a> - Control Dart (Flutter) client generation per endpoint (disable, module names, URL exports, response options)</li></ul><h3 id="raw-output-mode" tabindex="-1">Raw Output Mode <a class="header-anchor" href="#raw-output-mode" aria-label="Permalink to "Raw Output Mode""></a></h3><ul><li><a href="./raw.html">RAW</a> - Return raw text instead of JSON</li><li><a href="./separator.html">SEPARATOR</a> - Column separator for raw output</li><li><a href="./new-line.html">NEW_LINE</a> - Row separator for raw output</li><li><a href="./column-names.html">COLUMN_NAMES</a> - Include column headers</li></ul><h3 id="caching" tabindex="-1">Caching <a class="header-anchor" href="#caching" aria-label="Permalink to "Caching""></a></h3><ul><li><a href="./cached.html">CACHED</a> - Enable response caching</li><li><a href="./cache-expires-in.html">CACHE_EXPIRES_IN</a> - Set cache expiration</li><li><a href="./cache-profile.html">CACHE_PROFILE</a> - Select a named cache profile (multiple backends, dynamic TTL, skip-on-condition rules)</li></ul><h3 id="performance" tabindex="-1">Performance <a class="header-anchor" href="#performance" aria-label="Permalink to "Performance""></a></h3><ul><li><a href="./buffer-rows.html">BUFFER_ROWS</a> - Row buffering count</li><li><a href="./command-timeout.html">COMMAND_TIMEOUT</a> - Query timeout</li><li><a href="./retry-strategy.html">RETRY_STRATEGY</a> - Retry behavior</li></ul><h3 id="format-references" tabindex="-1">Format References <a class="header-anchor" href="#format-references" aria-label="Permalink to "Format References""></a></h3><ul><li><a href="./interval-format.html">Interval Format</a> - Time/duration format for timeouts and cache expiration</li></ul><h3 id="server-sent-events" tabindex="-1">Server-Sent Events <a class="header-anchor" href="#server-sent-events" aria-label="Permalink to "Server-Sent Events""></a></h3><ul><li><a href="./sse.html">SSE</a> - Enable Server-Sent Events</li><li><a href="./sse-events-level.html">SSE_EVENTS_LEVEL</a> - Notice level for SSE</li><li><a href="./sse-events-scope.html">SSE_EVENTS_SCOPE</a> - SSE distribution scope</li></ul><h3 id="upload" tabindex="-1">Upload <a class="header-anchor" href="#upload" aria-label="Permalink to "Upload""></a></h3><ul><li><a href="./upload.html">UPLOAD</a> - File upload handling</li></ul><h3 id="policies" tabindex="-1">Policies <a class="header-anchor" href="#policies" aria-label="Permalink to "Policies""></a></h3><ul><li><a href="./error-code-policy.html">ERROR_CODE_POLICY</a> - Error handling policy</li><li><a href="./rate-limiter-policy.html">RATE_LIMITER_POLICY</a> - Rate limiting policy</li></ul><h3 id="context-security" tabindex="-1">Context & Security <a class="header-anchor" href="#context-security" aria-label="Permalink to "Context & Security""></a></h3><ul><li><a href="./user-context.html">USER_CONTEXT</a> - Enable user context</li><li><a href="./user-parameters.html">USER_PARAMETERS</a> - Add user parameters</li><li><a href="./connection.html">CONNECTION</a> - Named database connection</li><li><a href="./security-sensitive.html">SECURITY_SENSITIVE</a> - Obfuscate logs</li></ul><h3 id="parameter-annotations" tabindex="-1">Parameter Annotations <a class="header-anchor" href="#parameter-annotations" aria-label="Permalink to "Parameter Annotations""></a></h3><ul><li><a href="./param.html">PARAM</a> - Rename, retype, set defaults, and configure parameters</li><li><a href="./parameter-hash.html">PARAMETER_HASH</a> - Hash one parameter using another</li><li><a href="./encrypt-decrypt.html">ENCRYPT</a> - Encrypt parameter values before sending to PostgreSQL</li><li><a href="./encrypt-decrypt.html">DECRYPT</a> - Decrypt result column values before returning to client</li><li><a href="./parameter-substitution.html">Parameter Value Substitution</a> - <code>{name}</code> placeholders in annotation values</li><li><a href="./resolved-parameters.html">Resolved Parameters</a> - Compute a parameter value server-side from a SQL expression</li></ul><h3 id="sql-file-annotations" tabindex="-1">SQL File Annotations <a class="header-anchor" href="#sql-file-annotations" aria-label="Permalink to "SQL File Annotations""></a></h3><ul><li><a href="./define-param.html">DEFINE_PARAM</a> - Define virtual HTTP parameters not bound to SQL</li><li><a href="./result-name.html">RESULT_NAME</a> - Rename result keys in multi-command SQL file endpoints</li><li><a href="./skip.html">SKIP</a> - Exclude commands from multi-command results</li><li><a href="./returns.html">RETURNS</a> - Skip Describe step and resolve return columns from a composite type (for runtime-created temp tables)</li></ul><h3 id="test-file-annotations" tabindex="-1">Test File Annotations <a class="header-anchor" href="#test-file-annotations" aria-label="Permalink to "Test File Annotations""></a></h3><p>These apply <strong>only to test files</strong> run by the <a href="./../guide/testing.html">SQL test runner</a> (<code>npgsqlrest --test</code>) — not to endpoint SQL files or routine comments:</p><ul><li><a href="./test-setup.html">TEST @setup</a> - Run named steps before an individual test file</li><li><a href="./test-teardown.html">TEST @teardown</a> - Run named steps after an individual test file, always</li><li><a href="./test-connection.html">TEST @connection</a> - Run a test file on a different named connection</li><li><a href="./test-tag.html">TEST @tag</a> - Tag a test file for Tag/ExcludeTag filtering</li><li><a href="./test-claim.html">TEST @claim</a> - Set the acting principal for an in-process endpoint call (HTTP block directive)</li><li><a href="./test-response.html">TEST @response</a> - Name the captured response temp table (HTTP block directive)</li></ul><h3 id="custom" tabindex="-1">Custom <a class="header-anchor" href="#custom" aria-label="Permalink to "Custom""></a></h3><ul><li><a href="./custom-parameters.html">Custom Parameters</a> - Custom key-value settings</li></ul></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><!--[--><!--]--><div class="edit-info" data-v-e257564d><div class="edit-link" data-v-e257564d><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/NpgsqlRest/npgsqlrest-docs/edit/main/docs/annotations/index.md" target="_blank" rel="noreferrer" data-v-e257564d><!--[--><span class="vpi-square-pen edit-link-icon" data-v-e257564d></span> Edit this page on GitHub<!--]--></a></div><div class="last-updated" data-v-e257564d><p class="VPLastUpdated" data-v-e257564d data-v-e98dd255>Last updated: <time datetime="2026-06-26T13:23:03.000Z" data-v-e98dd255></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-e257564d><span class="visually-hidden" id="doc-footer-aria-label" data-v-e257564d>Pager</span><div class="pager" data-v-e257564d><!----></div><div class="pager" data-v-e257564d><a class="VPLink link pager-link next" href="/annotations/http.html" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Next page</span><span class="title" data-v-e257564d>HTTP</span><!--]--></a></div></nav></footer><!--[--><!--[--><!--[--><div id="comments" class="giscus-wrapper" data-v-5337483f><h2 class="comments-heading" data-v-5337483f>Comments</h2><!----></div><div class="sponsor-footer" data-v-8f879b82><div class="sponsor-footer-content" data-v-8f879b82><span class="sponsor-heart" data-v-8f879b82>❤️</span><a href="/support" class="sponsor-text" data-v-8f879b82>Support this project</a><span class="sponsor-text" data-v-8f879b82>:</span><a href="https://github.com/sponsors/NpgsqlRest" target="_blank" class="sponsor-link" data-v-8f879b82><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" fill="currentColor" data-v-8f879b82><path d="M7.655 14.916v-.001h-.002l-.006-.003-.018-.01a22.066 22.066 0 0 1-3.744-2.584C2.045 10.731 0 8.35 0 5.5 0 2.836 2.086 1 4.25 1 5.797 1 7.153 1.802 8 3.02 8.847 1.802 10.203 1 11.75 1 13.914 1 16 2.836 16 5.5c0 2.85-2.045 5.231-3.885 6.818a22.066 22.066 0 0 1-3.744 2.584l-.018.01-.006.003h-.002a.75.75 0 0 1-.69 0Z" data-v-8f879b82></path></svg> GitHub Sponsors </a><span class="sponsor-separator" data-v-8f879b82>·</span><a href="https://patreon.com/vbconsulting" target="_blank" class="sponsor-link" data-v-8f879b82><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" data-v-8f879b82><path d="M22.957 7.21c-.004-3.064-2.391-5.576-5.191-6.482-3.478-1.125-8.064-.962-11.384.604C2.357 3.231 1.093 7.391 1.046 11.54c-.039 3.411.302 7.463 3.097 9.746 2.602 2.124 6.19 2.078 9.402 1.836 1.883-.142 3.939-.358 5.477-1.528 1.564-1.19 1.873-3.298 1.972-5.151.134-2.51.187-5.016-.037-7.233zm-2.55 7.703c-.078 1.593-.383 3.473-1.795 4.334-1.351.824-3.151.973-4.686 1.083-2.891.207-6.063.276-8.514-1.399C3.106 17.39 2.924 14.34 2.95 11.67c.03-3.206.678-6.721 3.654-8.375 2.756-1.531 6.556-1.727 9.544-.872 2.339.669 4.351 2.678 4.355 5.217.007 2.583-.016 5.168-.095 7.273z" data-v-8f879b82></path><path d="M16.088 5.19c-1.008-.542-2.607-.48-3.441.388-.568.591-.773 1.389-.8 2.172-.034.993.068 2.013.361 2.953.307.985 1.034 1.848 2.077 2.012.878.138 1.83-.088 2.458-.732.7-.718.88-1.81.877-2.779-.003-.989-.084-1.99-.423-2.91-.268-.726-.654-1.328-1.109-1.104zm-.294 5.482c-.182.462-.581.771-1.091.696-.532-.078-.859-.533-1.04-1.005-.248-.647-.327-1.375-.312-2.06.01-.46.095-.939.371-1.313.345-.467.993-.447 1.426-.115.41.315.607.835.74 1.32.18.66.211 1.675-.094 2.477zM8.4 10.394c.233 1.084.755 2.299 1.907 2.579.934.227 1.993-.165 2.434-1.048.455-.91.346-1.995.166-2.972-.165-.893-.46-1.885-1.207-2.445-.745-.559-1.832-.457-2.479.192-.84.843-.958 2.138-.955 3.277.001.147.119.364.134.417zm1.363-2.808c.302-.321.805-.336 1.14-.054.445.375.618 1.015.75 1.558.131.54.212 1.156.082 1.703-.1.423-.378.821-.84.882-.469.062-.886-.306-1.088-.704-.326-.644-.401-1.426-.381-2.148.013-.465.104-.993.337-1.237z" data-v-8f879b82></path></svg> Patreon </a><span class="sponsor-separator" data-v-8f879b82>·</span><a href="https://buymeacoffee.com/vbilopavu" target="_blank" class="sponsor-link" data-v-8f879b82><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" data-v-8f879b82><path d="M20.216 6.415l-.132-.666c-.119-.598-.388-1.163-1.001-1.379-.197-.069-.42-.098-.57-.241-.152-.143-.196-.366-.231-.572-.065-.378-.125-.756-.192-1.133-.057-.325-.102-.69-.25-.987-.195-.4-.597-.634-.996-.788a5.723 5.723 0 00-.626-.194c-1-.263-2.05-.36-3.077-.416a25.834 25.834 0 00-3.7.062c-.915.083-1.88.184-2.75.5-.318.116-.646.256-.888.501-.297.302-.393.77-.177 1.146.154.267.415.456.692.58.36.162.737.284 1.123.366 1.075.238 2.189.331 3.287.37 1.218.05 2.437.01 3.65-.118.299-.033.598-.073.896-.119.352-.054.578-.513.474-.834-.124-.383-.457-.531-.834-.473-.466.074-.96.108-1.382.146-1.177.08-2.358.082-3.536.006a22.228 22.228 0 01-1.157-.107c-.086-.01-.18-.025-.258-.036-.243-.036-.484-.08-.724-.13-.111-.027-.111-.185 0-.212h.005c.277-.06.557-.108.838-.147h.002c.131-.009.263-.032.394-.048a25.076 25.076 0 013.426-.12c.674.019 1.347.067 2.017.144l.228.031c.267.04.533.088.798.145.392.085.895.113 1.07.542.055.137.08.288.111.431l.319 1.484a.237.237 0 01-.199.284h-.003c-.037.006-.075.01-.112.015a36.704 36.704 0 01-4.743.295 37.059 37.059 0 01-4.699-.304c-.14-.017-.293-.042-.417-.06-.326-.048-.649-.108-.973-.161-.393-.065-.768-.032-1.123.161-.29.16-.527.404-.675.701-.154.316-.199.66-.267 1-.069.34-.176.707-.135 1.056.087.753.613 1.365 1.37 1.502a39.69 39.69 0 0011.343.376.483.483 0 01.535.53l-.071.697-1.018 9.907c-.041.41-.047.832-.125 1.237-.122.637-.553 1.028-1.182 1.171-.577.131-1.165.2-1.756.205-.656.004-1.31-.025-1.966-.022-.699.004-1.556-.06-2.095-.58-.475-.458-.54-1.174-.605-1.793l-.731-7.013-.322-3.094c-.037-.351-.286-.695-.678-.678-.336.015-.718.3-.678.679l.228 2.185.949 9.112c.147 1.344 1.174 2.068 2.446 2.272.742.12 1.503.144 2.257.156.966.016 1.942.053 2.892-.122 1.408-.258 2.465-1.198 2.616-2.657.34-3.332.683-6.663 1.024-9.995l.215-2.087a.484.484 0 01.39-.426c.402-.078.787-.212 1.074-.518.455-.488.546-1.124.385-1.766zm-1.478.772c-.145.137-.363.201-.578.233-2.416.359-4.866.54-7.308.46-1.748-.06-3.477-.254-5.207-.498-.17-.024-.353-.055-.47-.18-.22-.236-.111-.71-.054-.995.052-.26.152-.609.463-.646.484-.057 1.046.148 1.526.22.577.088 1.156.159 1.737.212 2.48.226 5.002.19 7.472-.14.45-.06.899-.13 1.345-.21.399-.072.84-.206 1.08.206.166.281.188.657.162.974a.544.544 0 01-.169.364z" data-v-8f879b82></path></svg> Buy Me a Coffee </a></div><div class="footer-license" data-v-8f879b82>Released under the MIT License.</div><div class="footer-copyright" data-v-8f879b82>Copyright © 2024-2026 VB Consulting</div></div><!--]--><!--]--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"about.md\":\"J23IMV0f\",\"annotations_allow-anonymous.md\":\"DuA7Gki2\",\"annotations_authorize.md\":\"RF33Q4Ug\",\"annotations_basic-auth-command.md\":\"CaUP2YuS\",\"annotations_basic-auth-realm.md\":\"IAC7Y6jP\",\"annotations_basic-auth.md\":\"BVGyLYSQ\",\"annotations_body-parameter-name.md\":\"h5JsTgb9\",\"annotations_buffer-rows.md\":\"B2Uhx6FH\",\"annotations_cache-expires-in.md\":\"3a-_LTW5\",\"annotations_cache-profile.md\":\"zOPCTblV\",\"annotations_cached.md\":\"jWOtZDQX\",\"annotations_column-names.md\":\"CxKyq7P_\",\"annotations_command-timeout.md\":\"CgZTUr4G\",\"annotations_connection.md\":\"ZPv8emfL\",\"annotations_custom-parameters.md\":\"CZ5UmNvg\",\"annotations_dartclient.md\":\"DZ7hEaM_\",\"annotations_define-param.md\":\"DeJiK5tc\",\"annotations_disabled.md\":\"CJUqT1JV\",\"annotations_enabled.md\":\"Be8ICGkW\",\"annotations_encrypt-decrypt.md\":\"BmfP2y7i\",\"annotations_error-code-policy.md\":\"BQvygm8k\",\"annotations_http-type.md\":\"Dm9v_5yb\",\"annotations_http.md\":\"BDBFWX1o\",\"annotations_index.md\":\"D20z3eDV\",\"annotations_internal.md\":\"CWfOTavq\",\"annotations_interval-format.md\":\"B0DW7EkT\",\"annotations_login.md\":\"BIXm8NLh\",\"annotations_logout.md\":\"C-TORz3p\",\"annotations_mcp.md\":\"CmleKmhL\",\"annotations_nested.md\":\"CwCRudLy\",\"annotations_new-line.md\":\"DTd4qKPS\",\"annotations_openapi.md\":\"C6j-A4kO\",\"annotations_param.md\":\"BVstITMK\",\"annotations_parameter-hash.md\":\"6zChHskJ\",\"annotations_parameter-substitution.md\":\"BbRKYbca\",\"annotations_path.md\":\"Dt9Jozh1\",\"annotations_proxy-out.md\":\"BVx4B3qg\",\"annotations_proxy.md\":\"BOl4Ws_2\",\"annotations_query-string-null-handling.md\":\"DiC8ZxD3\",\"annotations_rate-limiter-policy.md\":\"BkXimPnm\",\"annotations_raw.md\":\"DRcpaotI\",\"annotations_request-headers-mode.md\":\"DSHe3zrO\",\"annotations_request-headers-parameter-name.md\":\"7LRRHW-f\",\"annotations_request-param-type.md\":\"eMyD1QvU\",\"annotations_resolved-parameters.md\":\"CHMqqJhT\",\"annotations_response-headers.md\":\"mybLD6bH\",\"annotations_response-null-handling.md\":\"7thMxWdj\",\"annotations_result-name.md\":\"DB3oXoD0\",\"annotations_retry-strategy.md\":\"5CGNaGQ5\",\"annotations_returns.md\":\"bd1ZhoQ6\",\"annotations_security-sensitive.md\":\"Cg0rAH4W\",\"annotations_separator.md\":\"L15NfpUb\",\"annotations_single.md\":\"U24YTOKJ\",\"annotations_skip.md\":\"BlI2X0Xl\",\"annotations_sse-events-level.md\":\"BFJVkc6r\",\"annotations_sse-events-scope.md\":\"BqYzMeMx\",\"annotations_sse.md\":\"BZb8EMk_\",\"annotations_table-format.md\":\"BdFiUzh3\",\"annotations_tags.md\":\"Bzn31aYH\",\"annotations_test-claim.md\":\"BYETxCjT\",\"annotations_test-connection.md\":\"CFBpPqqB\",\"annotations_test-response.md\":\"CFvGAu3V\",\"annotations_test-setup.md\":\"D1p9ke7u\",\"annotations_test-tag.md\":\"Bqnpw4cJ\",\"annotations_test-teardown.md\":\"BGclbLIJ\",\"annotations_tsclient.md\":\"RSe89Vnr\",\"annotations_upload.md\":\"CyUy8w6C\",\"annotations_user-context.md\":\"Dn0XZRwZ\",\"annotations_user-parameters.md\":\"C1oSKF_D\",\"annotations_validate.md\":\"JEpbmp-o\",\"annotations_void.md\":\"D__a_A0k\",\"blog_benchmarks-2026-07_actix.md\":\"CiIzp7zD\",\"blog_benchmarks-2026-07_analysis.md\":\"BBzncBUd\",\"blog_benchmarks-2026-07_axum.md\":\"CGhZyGBp\",\"blog_benchmarks-2026-07_bun.md\":\"BBkb0-73\",\"blog_benchmarks-2026-07_deno.md\":\"BoBiHOyY\",\"blog_benchmarks-2026-07_django.md\":\"M8aEbQkS\",\"blog_benchmarks-2026-07_dotnet.md\":\"O_Fbuog0\",\"blog_benchmarks-2026-07_express.md\":\"497ParpB\",\"blog_benchmarks-2026-07_fastapi.md\":\"CZZBxCcl\",\"blog_benchmarks-2026-07_fastify.md\":\"PWqXxmlp\",\"blog_benchmarks-2026-07_go.md\":\"BOQonSYv\",\"blog_benchmarks-2026-07_index.md\":\"DPFGNxkW\",\"blog_benchmarks-2026-07_npgsqlrest.md\":\"DiEV6r5o\",\"blog_benchmarks-2026-07_postgrest.md\":\"CmgANg9B\",\"blog_benchmarks-2026-07_results.md\":\"NsOzfD4_\",\"blog_benchmarks-2026-07_spring-boot.md\":\"CYiO3u9L\",\"blog_benchmarks-2026-07_swoole.md\":\"DsgjpYXI\",\"blog_case-study-zero-backend-code.md\":\"CZ2ZfNjn\",\"blog_csv-excel-ingestion-postgresql-npgsqlrest.md\":\"DpB_igfL\",\"blog_custom-types-multiset-rest-api.md\":\"1nTEKA0y\",\"blog_database-level-security-postgresql-authentication.md\":\"CzwJqEt9\",\"blog_draft-anniversary-vietnam-of-computer-science.md\":\"pTlNkO-9\",\"blog_draft-npgsqlrest-vs-sqlpage.md\":\"DKspC7lv\",\"blog_end-to-end-static-type-checking-postgresql-typescript.md\":\"CwlGkDfC\",\"blog_excel-export-table-format-postgresql-npgsqlrest.md\":\"gcFn-k8P\",\"blog_external-api-calls-postgresql-http-types.md\":\"DqIQg-CH\",\"blog_index.md\":\"B6M7Wd9n\",\"blog_mcp-server-postgresql-ai-tools-npgsqlrest.md\":\"Cb5gf3AU\",\"blog_multiple-auth-schemes-rbac-external-providers.md\":\"DD247qSg\",\"blog_npgsqlrest-3.13-production-patterns.md\":\"Cev1Eu_9\",\"blog_npgsqlrest-3.19-sql-test-runner-watch-mode.md\":\"B5qBTjYk\",\"blog_npgsqlrest-3.20-dart-client-react-query-tool-schemas.md\":\"CgYPMZGZ\",\"blog_npgsqlrest-vs-postgrest-supabase-comparison.md\":\"BlGU2Q-h\",\"blog_passkey-sql-auth.md\":\"DYAcjqTp\",\"blog_performance-scalability-high-availability-npgsqlrest.md\":\"n9xqkwpr\",\"blog_postgresql-bi-server-excel-csv-basic-auth.md\":\"BZNH9x6X\",\"blog_postgresql-rest-api-benchmark-2024.md\":\"BPscbHNl\",\"blog_postgresql-rest-api-benchmark-2025.md\":\"DCw_ftky\",\"blog_postgresql-rest-api-benchmark-2026.md\":\"Cw7Sqsdc\",\"blog_real-time-chat-postgresql-sse-npgsqlrest.md\":\"CHMp4_vS\",\"blog_reverse-proxy-postgresql-ai-service-npgsqlrest.md\":\"WGyLFIks\",\"blog_secure-image-uploads-postgresql-typescript.md\":\"ClAn1ZfM\",\"blog_sql-file-source-rest-api-from-plain-sql.md\":\"CAWXKWH_\",\"blog_sql-rest-api.md\":\"Cqihgf_7\",\"blog_the-backend-that-writes-itself-presentation.md\":\"llJuqh0H\",\"blog_the-power-of-simplicity.md\":\"mnp14wGy\",\"blog_typescript-codegen-walkthrough.md\":\"C9zYTCfh\",\"blog_web-scraping-postgresql-http-types-xml.md\":\"C1k5-l0F\",\"blog_what-have-stored-procedures-ever-done-for-us.md\":\"CJpre9aq\",\"config_antiforgery.md\":\"YCAIVeMN\",\"config_auth.md\":\"BWratilS\",\"config_authentication-options.md\":\"C_gcgTpB\",\"config_basic-auth-config.md\":\"B9V8eZiH\",\"config_cache-options.md\":\"1XEksGqv\",\"config_claims-mapping.md\":\"BPHRWDuQ\",\"config_codegen.md\":\"I7URQUMR\",\"config_command-retry.md\":\"DHjxdKTb\",\"config_config-section.md\":\"BzQaruE6\",\"config_connection.md\":\"A3gVBu8O\",\"config_cors.md\":\"pKUpmUU9\",\"config_dart-codegen.md\":\"CeHet-Dn\",\"config_data-protection.md\":\"B6ooKT4i\",\"config_error-handling.md\":\"CZc_Wgfg\",\"config_external-auth.md\":\"CSNsyI3-\",\"config_forwarded-headers.md\":\"BruA3aLK\",\"config_health-checks.md\":\"ft7l_18J\",\"config_http-client.md\":\"DnI2TzfY\",\"config_http-files.md\":\"DowIH6sE\",\"config_index.md\":\"CKT5aKyr\",\"config_latest.md\":\"BvNksD1J\",\"config_logging.md\":\"DwQET8FK\",\"config_mcp.md\":\"BGMaemKR\",\"config_npgsqlrest.md\":\"tjOS-a1h\",\"config_openapi.md\":\"CAi4-R6b\",\"config_passkey-auth.md\":\"BYcf3UoZ\",\"config_proxy.md\":\"C2xVs9Nx\",\"config_rate-limiter.md\":\"CmrakYr8\",\"config_react-query.md\":\"3XeuHtUO\",\"config_response-compression.md\":\"ClG0Ba7j\",\"config_routine-options.md\":\"C0agj466\",\"config_security-headers.md\":\"Dz12HXHk\",\"config_server.md\":\"C2Bzytns\",\"config_sql-file-source.md\":\"CQcsuY9j\",\"config_static-files.md\":\"k8UPorQE\",\"config_stats.md\":\"B6W4DshA\",\"config_table-format.md\":\"Bw5f3eH1\",\"config_test-runner.md\":\"Bc0Y52H5\",\"config_thread-pool.md\":\"KM_ARuU7\",\"config_top-level.md\":\"Mz_WCMKC\",\"config_uploads.md\":\"nAmFHgiy\",\"config_validation.md\":\"CegAPC9t\",\"config_watch.md\":\"luF5Tzrn\",\"examples_index.md\":\"B2OqnfeD\",\"guide_annotations.md\":\"DU-zqEAN\",\"guide_authentication.md\":\"CHA6EyKG\",\"guide_changelog_index.md\":\"CM87qpnt\",\"guide_changelog_v3.0.0.md\":\"CaZXLafq\",\"guide_changelog_v3.0.1.md\":\"BUYpSTnZ\",\"guide_changelog_v3.1.0.md\":\"aytjCXmr\",\"guide_changelog_v3.1.1.md\":\"Dvcm06o2\",\"guide_changelog_v3.1.2.md\":\"MAJKDuvx\",\"guide_changelog_v3.1.3.md\":\"BLHr8miN\",\"guide_changelog_v3.10.0.md\":\"BBqeIqaD\",\"guide_changelog_v3.11.0.md\":\"FEmK3VbG\",\"guide_changelog_v3.11.1.md\":\"DG3mgHsB\",\"guide_changelog_v3.12.0.md\":\"Cy_M8DOe\",\"guide_changelog_v3.13.0.md\":\"CPebg6z6\",\"guide_changelog_v3.14.0.md\":\"BLKRi2JX\",\"guide_changelog_v3.15.0.md\":\"AJVURNae\",\"guide_changelog_v3.15.1.md\":\"UQBvinqv\",\"guide_changelog_v3.15.2.md\":\"C8IH8CLl\",\"guide_changelog_v3.16.0.md\":\"D819FiNR\",\"guide_changelog_v3.16.1.md\":\"ChX8KTBv\",\"guide_changelog_v3.16.2.md\":\"Z7spYv6Z\",\"guide_changelog_v3.16.3.md\":\"aUoK00fi\",\"guide_changelog_v3.17.0.md\":\"BySTo0-8\",\"guide_changelog_v3.18.0.md\":\"gV3TOhK4\",\"guide_changelog_v3.18.1.md\":\"C7u4RMmj\",\"guide_changelog_v3.18.2.md\":\"Vb2DHaXa\",\"guide_changelog_v3.19.0.md\":\"B_4hNd5U\",\"guide_changelog_v3.2.0.md\":\"zcVMXaf-\",\"guide_changelog_v3.2.1.md\":\"DkDT8Q3X\",\"guide_changelog_v3.2.2.md\":\"BeWN-qfj\",\"guide_changelog_v3.2.3.md\":\"-3BgswP_\",\"guide_changelog_v3.2.4.md\":\"DN3GJkoo\",\"guide_changelog_v3.2.6.md\":\"BUuqzHR4\",\"guide_changelog_v3.2.7.md\":\"D3tB-UNb\",\"guide_changelog_v3.20.0.md\":\"vT1tEdX8\",\"guide_changelog_v3.21.0.md\":\"tSTSO7E8\",\"guide_changelog_v3.3.0.md\":\"5yAhQXRx\",\"guide_changelog_v3.3.1.md\":\"C-8W07JV\",\"guide_changelog_v3.4.0.md\":\"DERpdk1l\",\"guide_changelog_v3.4.1.md\":\"CSRBLkzp\",\"guide_changelog_v3.4.2.md\":\"J3JJ4YD-\",\"guide_changelog_v3.4.3.md\":\"BvjGtoaj\",\"guide_changelog_v3.4.4.md\":\"GRvyJorR\",\"guide_changelog_v3.4.5.md\":\"CUgqjnVj\",\"guide_changelog_v3.4.6.md\":\"F4AoQ81N\",\"guide_changelog_v3.4.7.md\":\"8Nx1qS9j\",\"guide_changelog_v3.4.8.md\":\"CqfdHAHp\",\"guide_changelog_v3.5.0.md\":\"ClDhJ7kR\",\"guide_changelog_v3.6.0.md\":\"DPrK2ILz\",\"guide_changelog_v3.6.1.md\":\"1YPburzT\",\"guide_changelog_v3.6.2.md\":\"SfdLAc-b\",\"guide_changelog_v3.6.3.md\":\"DzranNaa\",\"guide_changelog_v3.7.0.md\":\"b4O8pTS_\",\"guide_changelog_v3.8.0.md\":\"Blbaz3gu\",\"guide_changelog_v3.9.0.md\":\"DnL6T-zZ\",\"guide_claude-code-skill.md\":\"DXrk9EyA\",\"guide_configuration.md\":\"BC7pRWZE\",\"guide_connections.md\":\"C5XWWxpF\",\"guide_faq.md\":\"Bq-QvD4q\",\"guide_http-types.md\":\"i3tZ3Kjj\",\"guide_index.md\":\"37GH1xBM\",\"guide_installation.md\":\"HAGc2Y1r\",\"guide_logging.md\":\"BfBypoVM\",\"guide_proxy.md\":\"DkBI2Z0D\",\"guide_quick-start.md\":\"BGl8BrzS\",\"guide_sql-files.md\":\"BcvSVvcJ\",\"guide_sse.md\":\"D3LDO5OR\",\"guide_testing.md\":\"koQI43RN\",\"index.md\":\"B8Ic8T-o\",\"support.md\":\"CQVY7pS_\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"NpgsqlRest - Automatic PostgreSQL Web Server\",\"titleTemplate\":\"NpgsqlRest\",\"description\":\"Automatic PostgreSQL Web Server - Create REST APIs for PostgreSQL databases in minutes.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/favicon.ico\",\"siteTitle\":\"NpgsqlRest\",\"nav\":[{\"text\":\"Guide\",\"items\":[{\"text\":\"Getting Started\",\"items\":[{\"text\":\"Overview\",\"link\":\"/guide/\"},{\"text\":\"Installation\",\"link\":\"/guide/installation\"},{\"text\":\"Quick Start\",\"link\":\"/guide/quick-start\"}]},{\"text\":\"Topics\",\"items\":[{\"text\":\"SQL File Endpoints\",\"link\":\"/guide/sql-files\"},{\"text\":\"Configuration Guide\",\"link\":\"/guide/configuration\"},{\"text\":\"Comment Annotations Guide\",\"link\":\"/guide/annotations\"},{\"text\":\"Connection Management\",\"link\":\"/guide/connections\"},{\"text\":\"Authentication\",\"link\":\"/guide/authentication\"},{\"text\":\"Server-Sent Events\",\"link\":\"/guide/sse\"},{\"text\":\"HTTP Custom Types\",\"link\":\"/guide/http-types\"},{\"text\":\"Proxy Endpoints\",\"link\":\"/guide/proxy\"},{\"text\":\"Testing\",\"link\":\"/guide/testing\"},{\"text\":\"Logging\",\"link\":\"/guide/logging\"},{\"text\":\"Claude Code Skill\",\"link\":\"/guide/claude-code-skill\"}]},{\"text\":\"Reference\",\"items\":[{\"text\":\"FAQ & Troubleshooting\",\"link\":\"/guide/faq\"},{\"text\":\"Changelog\",\"link\":\"/guide/changelog/\"}]}]},{\"text\":\"Examples\",\"link\":\"/examples/\"},{\"text\":\"Reference\",\"items\":[{\"text\":\"Annotations\",\"link\":\"/annotations/\"},{\"text\":\"Configuration\",\"link\":\"/config/\"}]},{\"text\":\"Blog\",\"link\":\"/blog/\"},{\"text\":\"❤️ Sponsor\",\"link\":\"/support\"}],\"sidebar\":{\"/blog/benchmarks-2026-07/\":[{\"text\":\"Benchmark 2026-07\",\"collapsed\":false,\"items\":[{\"text\":\"Introduction\",\"link\":\"/blog/benchmarks-2026-07/\"},{\"text\":\"Overall Analysis\",\"link\":\"/blog/benchmarks-2026-07/analysis\"},{\"text\":\"NpgsqlRest Deep Dive\",\"link\":\"/blog/benchmarks-2026-07/npgsqlrest\"},{\"text\":\"Raw Results\",\"link\":\"/blog/benchmarks-2026-07/results\"}]},{\"text\":\"Frameworks\",\"collapsed\":false,\"items\":[{\"text\":\"Go (net/http)\",\"link\":\"/blog/benchmarks-2026-07/go\"},{\"text\":\"Swoole PHP\",\"link\":\"/blog/benchmarks-2026-07/swoole\"},{\"text\":\"FastAPI\",\"link\":\"/blog/benchmarks-2026-07/fastapi\"},{\"text\":\"Django\",\"link\":\"/blog/benchmarks-2026-07/django\"},{\"text\":\"Fastify\",\"link\":\"/blog/benchmarks-2026-07/fastify\"},{\"text\":\"Express\",\"link\":\"/blog/benchmarks-2026-07/express\"},{\"text\":\"Bun\",\"link\":\"/blog/benchmarks-2026-07/bun\"},{\"text\":\"Deno\",\"link\":\"/blog/benchmarks-2026-07/deno\"},{\"text\":\"Actix-web\",\"link\":\"/blog/benchmarks-2026-07/actix\"},{\"text\":\"Axum\",\"link\":\"/blog/benchmarks-2026-07/axum\"},{\"text\":\"Spring Boot\",\"link\":\"/blog/benchmarks-2026-07/spring-boot\"},{\"text\":\".NET 10 (EF & Dapper)\",\"link\":\"/blog/benchmarks-2026-07/dotnet\"},{\"text\":\"PostgREST\",\"link\":\"/blog/benchmarks-2026-07/postgrest\"}]},{\"text\":\"Source & Data (GitHub)\",\"collapsed\":false,\"items\":[{\"text\":\"Benchmark code (branch)\",\"link\":\"https://github.com/NpgsqlRest/pg_function_load_tests/tree/202607131327\"},{\"text\":\"Raw dataset (results.csv)\",\"link\":\"https://github.com/NpgsqlRest/pg_function_load_tests/blob/202607131327/src/_k6/results/202607131327/results.csv\"},{\"text\":\"All blog posts\",\"link\":\"/blog/\"}]}],\"/blog/\":[{\"text\":\"Tutorials\",\"collapsed\":false,\"items\":[{\"text\":\"NpgsqlRest 3.20.0: Dart, Hooks & Tool Schemas\",\"link\":\"/blog/npgsqlrest-3.20-dart-client-react-query-tool-schemas\"},{\"text\":\"Tests Are SQL Files Too\",\"link\":\"/blog/npgsqlrest-3.19-sql-test-runner-watch-mode\"},{\"text\":\"PostgreSQL as MCP Tools for AI Agents\",\"link\":\"/blog/mcp-server-postgresql-ai-tools-npgsqlrest\"},{\"text\":\"Case Study: 74 Endpoints, Zero Backend Code\",\"link\":\"/blog/case-study-zero-backend-code\"},{\"text\":\"TypeScript Code Generation Walkthrough\",\"link\":\"/blog/typescript-codegen-walkthrough\"},{\"text\":\"NpgsqlRest 3.13.0: Production Patterns\",\"link\":\"/blog/npgsqlrest-3.13-production-patterns\"},{\"text\":\"SQL REST API\",\"link\":\"/blog/sql-rest-api\"},{\"text\":\"SQL File Source\",\"link\":\"/blog/sql-file-source-rest-api-from-plain-sql\"},{\"text\":\"Database-Level Security\",\"link\":\"/blog/database-level-security-postgresql-authentication\"},{\"text\":\"Multiple Auth Schemes & RBAC\",\"link\":\"/blog/multiple-auth-schemes-rbac-external-providers\"},{\"text\":\"Passkey SQL Auth\",\"link\":\"/blog/passkey-sql-auth\"},{\"text\":\"End-to-End Type Checking\",\"link\":\"/blog/end-to-end-static-type-checking-postgresql-typescript\"},{\"text\":\"Real-Time Chat with SSE\",\"link\":\"/blog/real-time-chat-postgresql-sse-npgsqlrest\"},{\"text\":\"External API Calls\",\"link\":\"/blog/external-api-calls-postgresql-http-types\"},{\"text\":\"Web Scraping with HTTP Types\",\"link\":\"/blog/web-scraping-postgresql-http-types-xml\"},{\"text\":\"Reverse Proxy & AI Service\",\"link\":\"/blog/reverse-proxy-postgresql-ai-service-npgsqlrest\"},{\"text\":\"Secure Image Uploads\",\"link\":\"/blog/secure-image-uploads-postgresql-typescript\"},{\"text\":\"CSV & Excel Ingestion\",\"link\":\"/blog/csv-excel-ingestion-postgresql-npgsqlrest\"},{\"text\":\"PostgreSQL BI Server\",\"link\":\"/blog/postgresql-bi-server-excel-csv-basic-auth\"}]},{\"text\":\"Feature Deep Dives\",\"collapsed\":false,\"items\":[{\"text\":\"Excel Exports Done Right\",\"link\":\"/blog/excel-export-table-format-postgresql-npgsqlrest\"},{\"text\":\"Custom Types & Multiset\",\"link\":\"/blog/custom-types-multiset-rest-api\"},{\"text\":\"Performance & High Availability\",\"link\":\"/blog/performance-scalability-high-availability-npgsqlrest\"},{\"text\":\"What Have Stored Procedures Done for Us?\",\"link\":\"/blog/what-have-stored-procedures-ever-done-for-us\"},{\"text\":\"The Power of Simplicity\",\"link\":\"/blog/the-power-of-simplicity\"}]},{\"text\":\"Benchmarks & Comparisons\",\"collapsed\":false,\"items\":[{\"text\":\"Benchmark 2026-07 (Series)\",\"link\":\"/blog/benchmarks-2026-07/\"},{\"text\":\"Benchmark 2026 (January)\",\"link\":\"/blog/postgresql-rest-api-benchmark-2026\"},{\"text\":\"NpgsqlRest vs PostgREST vs Supabase\",\"link\":\"/blog/npgsqlrest-vs-postgrest-supabase-comparison\"}]},{\"text\":\"Other Links\",\"collapsed\":false,\"items\":[{\"text\":\"Guide\",\"link\":\"/guide/\"},{\"text\":\"Annotations Reference\",\"link\":\"/annotations/\"},{\"text\":\"Configuration Reference\",\"link\":\"/config/\"}]}],\"/guide/changelog/\":[{\"text\":\"Changelog\",\"items\":[{\"text\":\"Overview\",\"link\":\"/guide/changelog/\"},{\"text\":\"v3.21.0 (Latest)\",\"link\":\"/guide/changelog/v3.21.0\"},{\"text\":\"v3.20.0\",\"link\":\"/guide/changelog/v3.20.0\"},{\"text\":\"v3.19.0\",\"link\":\"/guide/changelog/v3.19.0\"},{\"text\":\"v3.18.2\",\"link\":\"/guide/changelog/v3.18.2\"},{\"text\":\"v3.18.1\",\"link\":\"/guide/changelog/v3.18.1\"},{\"text\":\"v3.18.0\",\"link\":\"/guide/changelog/v3.18.0\"},{\"text\":\"v3.17.0\",\"link\":\"/guide/changelog/v3.17.0\"},{\"text\":\"v3.16.3\",\"link\":\"/guide/changelog/v3.16.3\"},{\"text\":\"v3.16.2\",\"link\":\"/guide/changelog/v3.16.2\"},{\"text\":\"v3.16.1\",\"link\":\"/guide/changelog/v3.16.1\"},{\"text\":\"v3.16.0\",\"link\":\"/guide/changelog/v3.16.0\"},{\"text\":\"v3.15.2\",\"link\":\"/guide/changelog/v3.15.2\"},{\"text\":\"v3.15.1\",\"link\":\"/guide/changelog/v3.15.1\"},{\"text\":\"v3.15.0\",\"link\":\"/guide/changelog/v3.15.0\"},{\"text\":\"v3.14.0\",\"link\":\"/guide/changelog/v3.14.0\"},{\"text\":\"v3.13.0\",\"link\":\"/guide/changelog/v3.13.0\"},{\"text\":\"v3.12.0\",\"link\":\"/guide/changelog/v3.12.0\"},{\"text\":\"v3.11.1\",\"link\":\"/guide/changelog/v3.11.1\"},{\"text\":\"v3.11.0\",\"link\":\"/guide/changelog/v3.11.0\"},{\"text\":\"v3.10.0\",\"link\":\"/guide/changelog/v3.10.0\"},{\"text\":\"v3.9.0\",\"link\":\"/guide/changelog/v3.9.0\"},{\"text\":\"v3.8.0\",\"link\":\"/guide/changelog/v3.8.0\"},{\"text\":\"v3.7.0\",\"link\":\"/guide/changelog/v3.7.0\"},{\"text\":\"v3.6.3\",\"link\":\"/guide/changelog/v3.6.3\"},{\"text\":\"v3.6.2\",\"link\":\"/guide/changelog/v3.6.2\"},{\"text\":\"v3.6.1\",\"link\":\"/guide/changelog/v3.6.1\"},{\"text\":\"v3.6.0\",\"link\":\"/guide/changelog/v3.6.0\"},{\"text\":\"v3.5.0\",\"link\":\"/guide/changelog/v3.5.0\"},{\"text\":\"v3.4.8\",\"link\":\"/guide/changelog/v3.4.8\"},{\"text\":\"v3.4.7\",\"link\":\"/guide/changelog/v3.4.7\"},{\"text\":\"v3.4.6\",\"link\":\"/guide/changelog/v3.4.6\"},{\"text\":\"v3.4.5\",\"link\":\"/guide/changelog/v3.4.5\"},{\"text\":\"v3.4.4\",\"link\":\"/guide/changelog/v3.4.4\"},{\"text\":\"v3.4.3\",\"link\":\"/guide/changelog/v3.4.3\"},{\"text\":\"v3.4.2\",\"link\":\"/guide/changelog/v3.4.2\"},{\"text\":\"v3.4.1\",\"link\":\"/guide/changelog/v3.4.1\"},{\"text\":\"v3.4.0\",\"link\":\"/guide/changelog/v3.4.0\"},{\"text\":\"v3.3.1\",\"link\":\"/guide/changelog/v3.3.1\"},{\"text\":\"v3.3.0\",\"link\":\"/guide/changelog/v3.3.0\"},{\"text\":\"v3.2.7\",\"link\":\"/guide/changelog/v3.2.7\"},{\"text\":\"v3.2.6\",\"link\":\"/guide/changelog/v3.2.6\"},{\"text\":\"v3.2.4\",\"link\":\"/guide/changelog/v3.2.4\"},{\"text\":\"v3.2.3\",\"link\":\"/guide/changelog/v3.2.3\"},{\"text\":\"v3.2.2\",\"link\":\"/guide/changelog/v3.2.2\"},{\"text\":\"v3.2.1\",\"link\":\"/guide/changelog/v3.2.1\"},{\"text\":\"v3.2.0\",\"link\":\"/guide/changelog/v3.2.0\"},{\"text\":\"v3.1.3\",\"link\":\"/guide/changelog/v3.1.3\"},{\"text\":\"v3.1.2\",\"link\":\"/guide/changelog/v3.1.2\"},{\"text\":\"v3.1.1\",\"link\":\"/guide/changelog/v3.1.1\"},{\"text\":\"v3.1.0\",\"link\":\"/guide/changelog/v3.1.0\"},{\"text\":\"v3.0.1\",\"link\":\"/guide/changelog/v3.0.1\"},{\"text\":\"v3.0.0\",\"link\":\"/guide/changelog/v3.0.0\"}]},{\"text\":\"Other Links\",\"collapsed\":false,\"items\":[{\"text\":\"Guide\",\"link\":\"/guide/\"},{\"text\":\"Annotations Reference\",\"link\":\"/annotations/\"},{\"text\":\"Configuration Reference\",\"link\":\"/config/\"}]}],\"/examples/\":[{\"text\":\"Examples\",\"items\":[{\"text\":\"Overview\",\"link\":\"/examples/\"}]},{\"text\":\"Reference\",\"items\":[{\"text\":\"Guide\",\"link\":\"/guide/\"},{\"text\":\"Annotations Reference\",\"link\":\"/annotations/\"},{\"text\":\"Configuration Reference\",\"link\":\"/config/\"},{\"text\":\"Changelog\",\"link\":\"/guide/changelog/\"}]}],\"/guide/\":[{\"text\":\"Getting Started\",\"items\":[{\"text\":\"Overview\",\"link\":\"/guide/\"},{\"text\":\"Installation\",\"link\":\"/guide/installation\"},{\"text\":\"Quick Start\",\"link\":\"/guide/quick-start\"}]},{\"text\":\"Topics\",\"items\":[{\"text\":\"SQL File Endpoints\",\"link\":\"/guide/sql-files\"},{\"text\":\"Configuration Guide\",\"link\":\"/guide/configuration\"},{\"text\":\"Comment Annotations Guide\",\"link\":\"/guide/annotations\"},{\"text\":\"Connection Management\",\"link\":\"/guide/connections\"},{\"text\":\"Authentication\",\"link\":\"/guide/authentication\"},{\"text\":\"Server-Sent Events\",\"link\":\"/guide/sse\"},{\"text\":\"HTTP Custom Types\",\"link\":\"/guide/http-types\"},{\"text\":\"Proxy Endpoints\",\"link\":\"/guide/proxy\"},{\"text\":\"Testing\",\"link\":\"/guide/testing\"},{\"text\":\"Logging\",\"link\":\"/guide/logging\"},{\"text\":\"Claude Code Skill\",\"link\":\"/guide/claude-code-skill\"}]},{\"text\":\"Reference\",\"items\":[{\"text\":\"FAQ & Troubleshooting\",\"link\":\"/guide/faq\"},{\"text\":\"Changelog\",\"link\":\"/guide/changelog/\"},{\"text\":\"Examples\",\"link\":\"/examples/\"},{\"text\":\"Annotations Reference\",\"link\":\"/annotations/\"},{\"text\":\"Configuration Reference\",\"link\":\"/config/\"}]}],\"/annotations/\":[{\"text\":\"HTTP & Routing\",\"items\":[{\"text\":\"Overview\",\"link\":\"/annotations/\"},{\"text\":\"HTTP\",\"link\":\"/annotations/http\"},{\"text\":\"PATH\",\"link\":\"/annotations/path\"},{\"text\":\"PROXY\",\"link\":\"/annotations/proxy\"},{\"text\":\"PROXY_OUT\",\"link\":\"/annotations/proxy-out\"},{\"text\":\"INTERNAL\",\"link\":\"/annotations/internal\"},{\"text\":\"ENABLED\",\"link\":\"/annotations/enabled\"},{\"text\":\"DISABLED\",\"link\":\"/annotations/disabled\"},{\"text\":\"TAGS\",\"link\":\"/annotations/tags\"},{\"text\":\"OPENAPI\",\"link\":\"/annotations/openapi\"},{\"text\":\"MCP\",\"link\":\"/annotations/mcp\"},{\"text\":\"HTTP CUSTOM TYPES\",\"link\":\"/annotations/http-type\"}]},{\"text\":\"Authorization\",\"items\":[{\"text\":\"AUTHORIZE\",\"link\":\"/annotations/authorize\"},{\"text\":\"ALLOW_ANONYMOUS\",\"link\":\"/annotations/allow-anonymous\"},{\"text\":\"LOGIN\",\"link\":\"/annotations/login\"},{\"text\":\"LOGOUT\",\"link\":\"/annotations/logout\"},{\"text\":\"BASIC_AUTH\",\"link\":\"/annotations/basic-auth\"},{\"text\":\"BASIC_AUTH_REALM\",\"link\":\"/annotations/basic-auth-realm\"},{\"text\":\"BASIC_AUTH_COMMAND\",\"link\":\"/annotations/basic-auth-command\"}]},{\"text\":\"Request Configuration\",\"items\":[{\"text\":\"REQUEST_PARAM_TYPE\",\"link\":\"/annotations/request-param-type\"},{\"text\":\"REQUEST_HEADERS_MODE\",\"link\":\"/annotations/request-headers-mode\"},{\"text\":\"REQUEST_HEADERS_PARAMETER_NAME\",\"link\":\"/annotations/request-headers-parameter-name\"},{\"text\":\"BODY_PARAMETER_NAME\",\"link\":\"/annotations/body-parameter-name\"},{\"text\":\"QUERY_STRING_NULL_HANDLING\",\"link\":\"/annotations/query-string-null-handling\"},{\"text\":\"VALIDATE\",\"link\":\"/annotations/validate\"}]},{\"text\":\"Response Configuration\",\"items\":[{\"text\":\"Response Headers\",\"link\":\"/annotations/response-headers\"},{\"text\":\"RESPONSE_NULL_HANDLING\",\"link\":\"/annotations/response-null-handling\"},{\"text\":\"NESTED\",\"link\":\"/annotations/nested\"},{\"text\":\"SINGLE\",\"link\":\"/annotations/single\"},{\"text\":\"VOID\",\"link\":\"/annotations/void\"},{\"text\":\"RAW\",\"link\":\"/annotations/raw\"},{\"text\":\"SEPARATOR\",\"link\":\"/annotations/separator\"},{\"text\":\"NEW_LINE\",\"link\":\"/annotations/new-line\"},{\"text\":\"COLUMN_NAMES\",\"link\":\"/annotations/column-names\"}]},{\"text\":\"Caching & Performance\",\"items\":[{\"text\":\"CACHED\",\"link\":\"/annotations/cached\"},{\"text\":\"CACHE_EXPIRES_IN\",\"link\":\"/annotations/cache-expires-in\"},{\"text\":\"CACHE_PROFILE\",\"link\":\"/annotations/cache-profile\"},{\"text\":\"BUFFER_ROWS\",\"link\":\"/annotations/buffer-rows\"},{\"text\":\"COMMAND_TIMEOUT\",\"link\":\"/annotations/command-timeout\"},{\"text\":\"RETRY_STRATEGY\",\"link\":\"/annotations/retry-strategy\"},{\"text\":\"Interval Format\",\"link\":\"/annotations/interval-format\"}]},{\"text\":\"Server-Sent Events\",\"items\":[{\"text\":\"SSE\",\"link\":\"/annotations/sse\"},{\"text\":\"SSE_EVENTS_LEVEL\",\"link\":\"/annotations/sse-events-level\"},{\"text\":\"SSE_EVENTS_SCOPE\",\"link\":\"/annotations/sse-events-scope\"}]},{\"text\":\"Upload & Policies\",\"items\":[{\"text\":\"UPLOAD\",\"link\":\"/annotations/upload\"},{\"text\":\"ERROR_CODE_POLICY\",\"link\":\"/annotations/error-code-policy\"},{\"text\":\"RATE_LIMITER_POLICY\",\"link\":\"/annotations/rate-limiter-policy\"}]},{\"text\":\"Output & Code Generation\",\"items\":[{\"text\":\"TABLE_FORMAT\",\"link\":\"/annotations/table-format\"},{\"text\":\"TSCLIENT\",\"link\":\"/annotations/tsclient\"},{\"text\":\"DARTCLIENT\",\"link\":\"/annotations/dartclient\"}]},{\"text\":\"Parameters\",\"items\":[{\"text\":\"PARAM\",\"link\":\"/annotations/param\"},{\"text\":\"PARAMETER_HASH\",\"link\":\"/annotations/parameter-hash\"},{\"text\":\"ENCRYPT / DECRYPT\",\"link\":\"/annotations/encrypt-decrypt\"},{\"text\":\"Parameter Value Substitution\",\"link\":\"/annotations/parameter-substitution\"},{\"text\":\"Resolved Parameters\",\"link\":\"/annotations/resolved-parameters\"}]},{\"text\":\"SQL File Annotations\",\"items\":[{\"text\":\"DEFINE_PARAM\",\"link\":\"/annotations/define-param\"},{\"text\":\"RESULT_NAME\",\"link\":\"/annotations/result-name\"},{\"text\":\"SKIP\",\"link\":\"/annotations/skip\"},{\"text\":\"RETURNS\",\"link\":\"/annotations/returns\"}]},{\"text\":\"Test Files (--test)\",\"items\":[{\"text\":\"TEST @setup\",\"link\":\"/annotations/test-setup\"},{\"text\":\"TEST @teardown\",\"link\":\"/annotations/test-teardown\"},{\"text\":\"TEST @connection\",\"link\":\"/annotations/test-connection\"},{\"text\":\"TEST @tag\",\"link\":\"/annotations/test-tag\"},{\"text\":\"TEST @claim\",\"link\":\"/annotations/test-claim\"},{\"text\":\"TEST @response\",\"link\":\"/annotations/test-response\"}]},{\"text\":\"Context & Security\",\"items\":[{\"text\":\"USER_CONTEXT\",\"link\":\"/annotations/user-context\"},{\"text\":\"USER_PARAMETERS\",\"link\":\"/annotations/user-parameters\"},{\"text\":\"CONNECTION\",\"link\":\"/annotations/connection\"},{\"text\":\"SECURITY_SENSITIVE\",\"link\":\"/annotations/security-sensitive\"},{\"text\":\"Custom Parameters\",\"link\":\"/annotations/custom-parameters\"}]},{\"text\":\"Other Links\",\"collapsed\":false,\"items\":[{\"text\":\"Guide\",\"link\":\"/guide/\"},{\"text\":\"Configuration Reference\",\"link\":\"/config/\"},{\"text\":\"Changelog\",\"link\":\"/guide/changelog/\"}]}],\"/config/\":[{\"text\":\"Core Settings\",\"items\":[{\"text\":\"Overview\",\"link\":\"/config/\"},{\"text\":\"Latest Default Configuration\",\"link\":\"/config/latest\"},{\"text\":\"Top-Level Settings\",\"link\":\"/config/top-level\"},{\"text\":\"Config Section\",\"link\":\"/config/config-section\"},{\"text\":\"NpgsqlRest Options\",\"link\":\"/config/npgsqlrest\"},{\"text\":\"Routine Options\",\"link\":\"/config/routine-options\"},{\"text\":\"Connection Settings\",\"link\":\"/config/connection\"},{\"text\":\"Server & SSL\",\"link\":\"/config/server\"}]},{\"text\":\"Security\",\"items\":[{\"text\":\"Authentication\",\"link\":\"/config/auth\"},{\"text\":\"External OAuth\",\"link\":\"/config/external-auth\"},{\"text\":\"Passkey Authentication\",\"link\":\"/config/passkey-auth\"},{\"text\":\"Authentication Options\",\"link\":\"/config/authentication-options\"},{\"text\":\"Claims Mapping\",\"link\":\"/config/claims-mapping\"},{\"text\":\"Basic Auth Config\",\"link\":\"/config/basic-auth-config\"},{\"text\":\"Validation\",\"link\":\"/config/validation\"},{\"text\":\"Antiforgery\",\"link\":\"/config/antiforgery\"},{\"text\":\"Data Protection\",\"link\":\"/config/data-protection\"},{\"text\":\"CORS\",\"link\":\"/config/cors\"},{\"text\":\"Security Headers\",\"link\":\"/config/security-headers\"},{\"text\":\"Forwarded Headers\",\"link\":\"/config/forwarded-headers\"}]},{\"text\":\"Features\",\"items\":[{\"text\":\"SQL File Source\",\"link\":\"/config/sql-file-source\"},{\"text\":\"Test Runner\",\"link\":\"/config/test-runner\"},{\"text\":\"Watch Mode\",\"link\":\"/config/watch\"},{\"text\":\"Proxy\",\"link\":\"/config/proxy\"},{\"text\":\"OpenAPI\",\"link\":\"/config/openapi\"},{\"text\":\"MCP\",\"link\":\"/config/mcp\"},{\"text\":\"HTTP Files\",\"link\":\"/config/http-files\"},{\"text\":\"Code Generation\",\"link\":\"/config/codegen\"},{\"text\":\"React Query Hooks\",\"link\":\"/config/react-query\"},{\"text\":\"Dart Code Generation\",\"link\":\"/config/dart-codegen\"},{\"text\":\"Upload Options\",\"link\":\"/config/uploads\"},{\"text\":\"Table Format\",\"link\":\"/config/table-format\"},{\"text\":\"HTTP Client\",\"link\":\"/config/http-client\"}]},{\"text\":\"Performance\",\"items\":[{\"text\":\"Response Compression\",\"link\":\"/config/response-compression\"},{\"text\":\"Cache Options\",\"link\":\"/config/cache-options\"},{\"text\":\"Rate Limiter\",\"link\":\"/config/rate-limiter\"},{\"text\":\"Command Retry\",\"link\":\"/config/command-retry\"},{\"text\":\"Thread Pool\",\"link\":\"/config/thread-pool\"}]},{\"text\":\"Infrastructure\",\"items\":[{\"text\":\"Logging\",\"link\":\"/config/logging\"},{\"text\":\"Static Files\",\"link\":\"/config/static-files\"},{\"text\":\"Error Handling\",\"link\":\"/config/error-handling\"},{\"text\":\"Health Checks\",\"link\":\"/config/health-checks\"},{\"text\":\"Stats\",\"link\":\"/config/stats\"}]},{\"text\":\"Other Links\",\"collapsed\":false,\"items\":[{\"text\":\"Guide\",\"link\":\"/guide/\"},{\"text\":\"Annotations Reference\",\"link\":\"/annotations/\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/NpgsqlRest/NpgsqlRest\"},{\"icon\":{\"svg\":\"<svg xmlns=\\\"http://www.w3.org/2000/svg\\\" viewBox=\\\"0 0 16 16\\\" fill=\\\"currentColor\\\"><path d=\\\"M7.655 14.916v-.001h-.002l-.006-.003-.018-.01a22.066 22.066 0 0 1-3.744-2.584C2.045 10.731 0 8.35 0 5.5 0 2.836 2.086 1 4.25 1 5.797 1 7.153 1.802 8 3.02 8.847 1.802 10.203 1 11.75 1 13.914 1 16 2.836 16 5.5c0 2.85-2.045 5.231-3.885 6.818a22.066 22.066 0 0 1-3.744 2.584l-.018.01-.006.003h-.002a.75.75 0 0 1-.69 0Z\\\"/></svg>\"},\"link\":\"https://github.com/sponsors/NpgsqlRest\",\"ariaLabel\":\"Sponsor NpgsqlRest on GitHub\"},{\"icon\":{\"svg\":\"<svg xmlns=\\\"http://www.w3.org/2000/svg\\\" viewBox=\\\"0 0 24 24\\\" fill=\\\"currentColor\\\"><path d=\\\"M22.957 7.21c-.004-3.064-2.391-5.576-5.191-6.482-3.478-1.125-8.064-.962-11.384.604C2.357 3.231 1.093 7.391 1.046 11.54c-.039 3.411.302 7.463 3.097 9.746 2.602 2.124 6.19 2.078 9.402 1.836 1.883-.142 3.939-.358 5.477-1.528 1.564-1.19 1.873-3.298 1.972-5.151.134-2.51.187-5.016-.037-7.233zm-2.55 7.703c-.078 1.593-.383 3.473-1.795 4.334-1.351.824-3.151.973-4.686 1.083-2.891.207-6.063.276-8.514-1.399C3.106 17.39 2.924 14.34 2.95 11.67c.03-3.206.678-6.721 3.654-8.375 2.756-1.531 6.556-1.727 9.544-.872 2.339.669 4.351 2.678 4.355 5.217.007 2.583-.016 5.168-.095 7.273z\\\"/><path d=\\\"M16.088 5.19c-1.008-.542-2.607-.48-3.441.388-.568.591-.773 1.389-.8 2.172-.034.993.068 2.013.361 2.953.307.985 1.034 1.848 2.077 2.012.878.138 1.83-.088 2.458-.732.7-.718.88-1.81.877-2.779-.003-.989-.084-1.99-.423-2.91-.268-.726-.654-1.328-1.109-1.104zm-.294 5.482c-.182.462-.581.771-1.091.696-.532-.078-.859-.533-1.04-1.005-.248-.647-.327-1.375-.312-2.06.01-.46.095-.939.371-1.313.345-.467.993-.447 1.426-.115.41.315.607.835.74 1.32.18.66.211 1.675-.094 2.477zM8.4 10.394c.233 1.084.755 2.299 1.907 2.579.934.227 1.993-.165 2.434-1.048.455-.91.346-1.995.166-2.972-.165-.893-.46-1.885-1.207-2.445-.745-.559-1.832-.457-2.479.192-.84.843-.958 2.138-.955 3.277.001.147.119.364.134.417zm1.363-2.808c.302-.321.805-.336 1.14-.054.445.375.618 1.015.75 1.558.131.54.212 1.156.082 1.703-.1.423-.378.821-.84.882-.469.062-.886-.306-1.088-.704-.326-.644-.401-1.426-.381-2.148.013-.465.104-.993.337-1.237z\\\"/></svg>\"},\"link\":\"https://patreon.com/vbconsulting\",\"ariaLabel\":\"Patreon\"},{\"icon\":{\"svg\":\"<svg xmlns=\\\"http://www.w3.org/2000/svg\\\" viewBox=\\\"0 0 24 24\\\" fill=\\\"currentColor\\\"><path d=\\\"M20.216 6.415l-.132-.666c-.119-.598-.388-1.163-1.001-1.379-.197-.069-.42-.098-.57-.241-.152-.143-.196-.366-.231-.572-.065-.378-.125-.756-.192-1.133-.057-.325-.102-.69-.25-.987-.195-.4-.597-.634-.996-.788a5.723 5.723 0 00-.626-.194c-1-.263-2.05-.36-3.077-.416a25.834 25.834 0 00-3.7.062c-.915.083-1.88.184-2.75.5-.318.116-.646.256-.888.501-.297.302-.393.77-.177 1.146.154.267.415.456.692.58.36.162.737.284 1.123.366 1.075.238 2.189.331 3.287.37 1.218.05 2.437.01 3.65-.118.299-.033.598-.073.896-.119.352-.054.578-.513.474-.834-.124-.383-.457-.531-.834-.473-.466.074-.96.108-1.382.146-1.177.08-2.358.082-3.536.006a22.228 22.228 0 01-1.157-.107c-.086-.01-.18-.025-.258-.036-.243-.036-.484-.08-.724-.13-.111-.027-.111-.185 0-.212h.005c.277-.06.557-.108.838-.147h.002c.131-.009.263-.032.394-.048a25.076 25.076 0 013.426-.12c.674.019 1.347.067 2.017.144l.228.031c.267.04.533.088.798.145.392.085.895.113 1.07.542.055.137.08.288.111.431l.319 1.484a.237.237 0 01-.199.284h-.003c-.037.006-.075.01-.112.015a36.704 36.704 0 01-4.743.295 37.059 37.059 0 01-4.699-.304c-.14-.017-.293-.042-.417-.06-.326-.048-.649-.108-.973-.161-.393-.065-.768-.032-1.123.161-.29.16-.527.404-.675.701-.154.316-.199.66-.267 1-.069.34-.176.707-.135 1.056.087.753.613 1.365 1.37 1.502a39.69 39.69 0 0011.343.376.483.483 0 01.535.53l-.071.697-1.018 9.907c-.041.41-.047.832-.125 1.237-.122.637-.553 1.028-1.182 1.171-.577.131-1.165.2-1.756.205-.656.004-1.31-.025-1.966-.022-.699.004-1.556-.06-2.095-.58-.475-.458-.54-1.174-.605-1.793l-.731-7.013-.322-3.094c-.037-.351-.286-.695-.678-.678-.336.015-.718.3-.678.679l.228 2.185.949 9.112c.147 1.344 1.174 2.068 2.446 2.272.742.12 1.503.144 2.257.156.966.016 1.942.053 2.892-.122 1.408-.258 2.465-1.198 2.616-2.657.34-3.332.683-6.663 1.024-9.995l.215-2.087a.484.484 0 01.39-.426c.402-.078.787-.212 1.074-.518.455-.488.546-1.124.385-1.766zm-1.478.772c-.145.137-.363.201-.578.233-2.416.359-4.866.54-7.308.46-1.748-.06-3.477-.254-5.207-.498-.17-.024-.353-.055-.47-.18-.22-.236-.111-.71-.054-.995.052-.26.152-.609.463-.646.484-.057 1.046.148 1.526.22.577.088 1.156.159 1.737.212 2.48.226 5.002.19 7.472-.14.45-.06.899-.13 1.345-.21.399-.072.84-.206 1.08.206.166.281.188.657.162.974a.544.544 0 01-.169.364z\\\"/></svg>\"},\"link\":\"https://buymeacoffee.com/vbilopavu\",\"ariaLabel\":\"Buy Me a Coffee\"}],\"editLink\":{\"pattern\":\"https://github.com/NpgsqlRest/npgsqlrest-docs/edit/main/docs/:path\",\"text\":\"Edit this page on GitHub\"},\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
</body>
</html>
You can’t perform that action at this time.