Add 'Fail' mode when no shard selected #234
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This implements a "Fail" mode when no shard is selected, equivalent to pgcat's MR #859. When enabled, applications must explicitly select a shard for every connection, preventing data compromise in multi-tenant scenarios.
Problem
In multi-tenant applications using shards as tenants, it's critical that every query explicitly selects the correct shard. Without this requirement, queries may inadvertently access data from all shards, leading to potential data compromise and cross-tenant data leakage.
Solution
Added a new configuration option
require_shard_selection
that enforces explicit shard selection:When enabled, queries without explicit shard selection will fail with a
ShardSelectionRequired
error.Valid shard selection methods
/* pgdog_shard: 1 */ SELECT * FROM users
SET pgdog.shard TO 1; SELECT * FROM users
/* pgdog_sharding_key: user_123 */ SELECT * FROM users
Implementation details
require_shard_selection: bool
configuration option to[general]
sectionShardSelectionRequired
error variant to the parser error enumfalse
)Example
With this configuration:
SELECT * FROM users
→ fails withShardSelectionRequired
/* pgdog_shard: 1 */ SELECT * FROM users
→ routes to shard 1SET pgdog.shard TO 0; SELECT * FROM users
→ routes to shard 0Testing
All existing tests pass and new tests verify the functionality works correctly with various query types and shard selection methods.
Fixes #221.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.