IMPORTANT

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

Annotations Reference

Complete reference for all NpgsqlRest comment annotations. For an introduction to how annotations work, see the Comment Annotations Guide.

How to Use This Reference

Each annotation has its own page with:

Recognized keywords
Syntax explanation
Working examples from the test suite
Related annotations

Annotation Categories

HTTP & Routing

HTTP - Expose function as HTTP endpoint
PATH - Set custom endpoint path
PROXY - Mark endpoint as reverse proxy
ENABLED - Enable endpoint for specific tags
DISABLED - Disable endpoint for specific tags
TAGS - Filter annotations by tags
HTTP CUSTOM TYPES - Define HTTP request on composite type for external API calls

Authorization

AUTHORIZE - Require authentication
ALLOW_ANONYMOUS - Allow unauthenticated access
LOGIN - Mark as sign-in endpoint
LOGOUT - Mark as sign-out endpoint

Basic Authentication

BASIC_AUTH - Enable HTTP Basic Authentication
BASIC_AUTH_REALM - Set authentication realm
BASIC_AUTH_COMMAND - Set validation function

Request Configuration

REQUEST_PARAM_TYPE - Query string vs body parameters
REQUEST_HEADERS_MODE - Control header passing
REQUEST_HEADERS_PARAMETER_NAME - Header parameter name
BODY_PARAMETER_NAME - Body parameter name
QUERY_STRING_NULL_HANDLING - NULL handling in query strings
VALIDATE - Parameter validation before database execution

Response Configuration

Response Headers - Set custom response headers
RESPONSE_NULL_HANDLING - NULL handling in responses
NESTED - Serialize composite type columns as nested JSON objects

Raw Output Mode

RAW - Return raw text instead of JSON
SEPARATOR - Column separator for raw output
NEW_LINE - Row separator for raw output
COLUMN_NAMES - Include column headers

Caching

CACHED - Enable response caching
CACHE_EXPIRES_IN - Set cache expiration

Performance

BUFFER_ROWS - Row buffering count
COMMAND_TIMEOUT - Query timeout
RETRY_STRATEGY - Retry behavior

Format References

Interval Format - Time/duration format for timeouts and cache expiration

Server-Sent Events

SSE - Enable Server-Sent Events
SSE_EVENTS_LEVEL - Notice level for SSE
SSE_EVENTS_SCOPE - SSE distribution scope

Upload

UPLOAD - File upload handling

Policies

ERROR_CODE_POLICY - Error handling policy
RATE_LIMITER_POLICY - Rate limiting policy

Context & Security

USER_CONTEXT - Enable user context
USER_PARAMETERS - Add user parameters
CONNECTION - Named database connection
SECURITY_SENSITIVE - Obfuscate logs

Parameter Annotations

PARAMETER_HASH - Hash one parameter using another

Custom

Custom Parameters - Custom key-value settings

Comments