electric-sql / electric-sql/electric

[Electric 2.0] Rewrite Shapes Guide

Open
#3,533 1 comment 11 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
10.4k
Forks
375
Avg merge
3d 1h
Merged PRs (30d)
18

Description

## Goal
Remove single-table limitations, document subqueries, ordering, limits

## Scope
- Position shapes as "real-time subscriptions to Postgres subsets"
- Document subquery support with cross-table filtering examples
- Show ordering, limits, pagination patterns
- Remove all "limitations" language about single-table
- Auth patterns using subqueries (multi-tenant auth use case)

## Current File
`/website/docs/guides/shapes.md` (276 lines)

## Dependencies
Subquery feature must be shipped/merged

## Acceptance Criteria
- User can understand shapes as real-time Postgres subscriptions
- Subquery examples are clear and practical
- Multi-tenant authorization pattern is documented
- Ordering, limits, and pagination patterns are explained

## Context
Part of Electric 2.0 launch. This is a critical doc update that shows the full power of query-driven sync.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.