NpgsqlRest

Appearance

Comments
Written with Claude
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.

Examples ​

This section provides hands-on examples demonstrating NpgsqlRest features. Each example builds on the previous one, progressively introducing more advanced concepts.

All examples are available in the examples repository on GitHub.

Prerequisites ​

Before running the examples, ensure you have:

  • PostgreSQL running locally (port 5432)
  • Bun runtime installed (bun.sh)
  • A database named example_db with default credentials (postgres/postgres)

Getting Started ​

  1. Clone the repository:
bash
bash
git clone https://github.com/NpgsqlRest/npgsqlrest-docs.git
cd npgsqlrest-docs/examples
  1. Install dependencies (downloads the NpgsqlRest binary and sets up required tools):
bash
bash
bun install
  1. Navigate to any example directory and run it:
bash
bash
cd 1_my_first_function

# Apply database migrations
bun run db:up

# Start the server (also rebuilds TypeScript and HTTP files)
bun run dev
  1. Visit http://127.0.0.1:8080 to see the result.

Available Examples ​

ExampleDescriptionRelated Blog Post
1_my_first_functionThe basics: creating a PostgreSQL function and exposing it as an HTTP endpoint with automatic TypeScript client generationEnd-to-End Type Checking
2_static_type_checkingHow NpgsqlRest's autogenerated client code provides static type safety, catching breaking changes at build timeEnd-to-End Type Checking
3_security_and_authDatabase-level security with cookie-based authentication and the principle of least privilegeDatabase-Level Security
4_passwords_tokens_rolesPassword verification, JWT/Bearer tokens, role-based access control (RBAC), and external OAuth providersMultiple Auth Schemes & RBAC
5_csv_basic_authCSV exports with HTTP Basic Auth, Excel integration, and type composition for BI use casesPostgreSQL BI Server
6_image_uploadsSecure image uploads with file system storage, PostgreSQL Large Objects, and progress trackingSecure Image Uploads
7_csv_excel_uploadsCSV and Excel file ingestion with row-by-row processing and automatic TypeScript clientsCSV & Excel Ingestion
8_simple_chat_clientReal-time chat application using Server-Sent Events (SSE) and PostgreSQL RAISE statementsReal-Time Chat with SSE
9_http_callsExternal API calls from PostgreSQL using HTTP custom types defined in type commentsExternal API Calls
10_proxy_ai_serviceReverse proxy with transform mode for caching AI responses and external service integrationReverse Proxy & AI Service
11_crud_auto_apiAuto-generate REST CRUD endpoints from PostgreSQL tables with whitelist patternsZero to CRUD API
13_passkeyWebAuthn passkey authentication with pure SQL: passwordless login using device biometricsPasskey SQL Auth
14_table_formatExcel export and stats endpoints with HTML table format output and cookie authenticationExcel Exports Done Right

Available Commands ​

Each example provides these scripts:

CommandDescription
bun run devStart NpgsqlRest server (rebuilds TypeScript and HTTP files)
bun run buildCompile TypeScript to JavaScript
bun run watchWatch mode for TypeScript changes
bun run db:upApply database migrations
bun run db:listList pending migrations

Next Steps ​

After completing these examples, explore:

Comments