From 6b2870605e8c32f670046322e8c284b6e778739a Mon Sep 17 00:00:00 2001 From: Vincent Driessen Date: Tue, 10 Mar 2026 16:41:22 +0100 Subject: [PATCH] Update storage engine guide to reflect v2 is now the default (#3168) --- guides/pages/about-the-new-storage-engine.mdx | 54 +++++-------------- 1 file changed, 12 insertions(+), 42 deletions(-) diff --git a/guides/pages/about-the-new-storage-engine.mdx b/guides/pages/about-the-new-storage-engine.mdx index 0e6d8bd007..f7fba303c1 100644 --- a/guides/pages/about-the-new-storage-engine.mdx +++ b/guides/pages/about-the-new-storage-engine.mdx @@ -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 @@ -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? @@ -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 - - {children} - -``` - -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.