Demo applications for popular languages and drivers #2018
Description
Motivation
Getting started with SPQR currently requires manual setup and a fair amount of implicit knowledge about configuration, routing and client behavior. This makes first-time adoption harder than it should be.
Instead of adding more commands or documentation-only explanations, we want to provide ready-to-run demo applications that demonstrate a correct sharded setup in practice.
Goals
Create demo applications for several popular languages and PostgreSQL drivers that:
- use publicly available Docker images
- work out of the box without manual configuration
- can be started with a single command (
make run) - immediately allow the user to run queries against a sharded setup
After running the demo, a user should be able to connect to SPQR and execute queries without additional steps.
What the demos should demonstrate
Each demo should include:
- a minimal but real application
- preconfigured SPQR router and shards
- sample schema
- example queries
- working sharding distribution
- connection through a real driver (not psql-only)
Best practices to showcase
The demos should implicitly teach recommended usage patterns:
- correct connection string usage
- transaction handling
- routing-aware queries
- safe schema initialization
- predictable key range behavior
Expected result
A new user should be able to clone the repository, run: