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.

Configuration Reference

Complete reference documentation for all NpgsqlRest configuration options.

For an introduction to how configuration works (sources, precedence, environment variables, command-line arguments), see the Configuration Guide.

Latest Default Configuration

See the Latest Default Configuration for a complete reference of all default settings for version 3.2.2.

Reference Sections

Core Settings

Top-Level Settings - Application identity, URLs, and startup message
Config Section - Configuration file processing and environment variables
NpgsqlRest Options - Core API generation settings (URL prefixes, naming conventions, request handling)
Routine Options - PostgreSQL routine handling (language filtering, custom types)
Connection - Database connection strings and settings
Server - Kestrel web server and SSL/TLS configuration

Security

Authentication - Cookie, Bearer Token, and JWT authentication
External OAuth - Google, LinkedIn, GitHub, Microsoft, Facebook OAuth
Authentication Options - Per-endpoint authentication configuration
Claims Mapping - User context and parameters mapping
Basic Auth Config - HTTP Basic Authentication configuration
Validation - Parameter validation rules (NotNull, Required, Regex, etc.)
Antiforgery - CSRF protection settings
Data Protection - Key storage and encryption settings
CORS - Cross-Origin Resource Sharing configuration

Features

CRUD - Automatic CRUD endpoint generation for tables
Proxy - Reverse proxy support for forwarding requests to upstream services
OpenAPI - OpenAPI/Swagger documentation generation
HTTP Files - HTTP test file generation
Code Generation - Client code generation (TypeScript, etc.)
Uploads - File upload handling
HTTP Client - HTTP Types for external API calls from PostgreSQL functions

Performance

Response Compression - Gzip/Brotli compression settings
Cache Options - Response caching configuration
Rate Limiter - Rate limiting settings
Command Retry - Database command retry policies
Thread Pool - Thread pool configuration

Infrastructure

Logging - Log levels and output configuration
Static Files - Static file serving configuration
Error Handling - Error response configuration

Comments