10 minutes
Quickstart
Single-node cluster, first write, first read. Runs on a laptop with no configuration.
shardwright/docs
Improve this page
v4.2 · released 14 July
Updated continuously
Range-partitioned storage, documented properly.
Every page is versioned against the release it describes. Nothing here refers to an API that shipped two majors ago.
QuickstartBrowse the API
Start here
Four paths through the documentation, depending on why you arrived.
Core concept
Resharding guide
How ranges split and move while serving traffic, and what the client sees while it happens.
Production
Operations handbook
Backups, upgrades, and the four alerts worth paging someone about at 3am.
Upgrade path
Migration from v3
The two breaking changes, why they happened, and a codemod for the larger one.
Guides
Task-shaped, start to finish. Every code block is executed by our test suite on each release, so nothing here rots quietly.
API reference
Generated from the source, versioned against every release back to 2.0, with the deprecation date stated on anything on the way out.
Operations
Backups, upgrades, failure modes and the four alerts that are actually worth waking somebody for at three in the morning.
Most read
What everyone else is reading
- 01
Quickstart: single-node cluster
10 minutes · Most visited
- 02
How resharding works
Core concept · 14 minutes
- 03
Migrating from v3 to v4
Upgrade · 22 minutes
- 04
Backup and point-in-time restore
Operations · 12 minutes
- 05
Tuning the write path
Performance · 18 minutes
- 06
Client retry semantics
Reference · 9 minutes
312
Pages, all versioned
4.2
Current release
<200ms
Search response
100%
Examples run in CI
“Every code sample in these docs is executed by their test suite. I found out because one failed and they fixed the docs, not the sample.”
Kai Nakamura
Systems engineer
About this publication
Which version am I reading?
4.2, unless you switch it in the sidebar. Every page is versioned back to 2.0 and none of it silently describes a different release.
The example does not work.
That should not happen, because every code block runs in CI on each release. Open an issue with the page and we will fix the docs, not the sample.
Can I contribute?
Every page has an edit link. Documentation fixes are reviewed the same day, which is faster than we review code.
Is there an offline copy?
The whole site builds to a single PDF and a zipped HTML bundle, linked from the footer of every release.
Something unclear?
Every page has an edit link. Documentation fixes get reviewed the same day.
Improve this page