Skip to content

[pull] main from liveblocks:main #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pull merged 1 commit into from
Mar 10, 2026
Merged

[pull] main from liveblocks:main #213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 12 additions & 42 deletions guides/pages/about-the-new-storage-engine.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
meta:
title: "The new realtime data storage engine and its benefits"
description:
"Learn about our improved v2 realtime data storage engine and how to enable
it"
"Learn about our improved v2 realtime data storage engine and its benefits"
---

Since v3.14, rooms can be powered by our new v2 realtime data storage engine—a
Expand All @@ -15,8 +14,8 @@ support—[Liveblocks Storage](/docs/ready-made-features/multiplayer/sync-engine
and [Yjs](/docs/ready-made-features/multiplayer/sync-engine/liveblocks-yjs) all
work the same way.

You can now opt in to v2 to try it out and give us feedback. Soon it will become
the default for everyone.
Since March 10, 2026, the v2 engine is the default for all newly created rooms.
Existing rooms remain on v1 for now.

## What are the benefits?

Expand Down Expand Up @@ -48,47 +47,18 @@ raised significantly for rooms on the v2 engine:
| `LiveMap` value | 128 kB | 2 MB |
| `LiveList` value | 128 kB | 2 MB |

## How to enable it
## How it works

The engine is assigned at room creation time and cannot be changed afterward.
The engine version is assigned at room creation time and cannot be changed
afterward. Since March 10, 2026, all newly created rooms automatically use the
v2 engine. No opt-in or code changes are required.

1. Upgrade to v3.14+: `npx liveblocks@latest upgrade`
2. Opt-in to v2 (see options below)

### Per-room opt-in

Specify the `engine` option when entering a room. This only affects new rooms—if
the room already exists, the room stays on its original engine version.

With `RoomProvider`:

```tsx
<RoomProvider id="my-new-room" engine={2}>
{children}
</RoomProvider>
```

With vanilla client:

```tsx
const { room, leave } = client.enterRoom("my-new-room", { engine: 2 });
```

### Dashboard opt-in

Alternatively, you can opt-in without code changes directly from your
[Liveblocks dashboard](https://liveblocks.io/dashboard):

1. Click Settings
2. Toggle "Enable v2 Storage engine for new rooms"

This is equivalent to setting `engine={2}` on all new rooms going forward.
**Note: this toggle affects all projects in your account.**
If you're on an older SDK version, we recommend upgrading to v3.14+ to take full
advantage of the v2 engine: `npx liveblocks@latest upgrade`

### Migrating existing rooms

Existing rooms that were created before this change remain on the v1 engine.
Eventually, we will transparently migrate all existing room data from the v1 to
the v2 Storage engine, and the explicit opt-in `engine` option will no longer
have an effect, but we will announce this ahead of time. This process will be a
seamless and uninterrupted continuation for rooms, and require no action on your
part.
the v2 engine. This process will be seamless and require no action on your part.
We will announce this ahead of time.
Loading