The full migration guide is in references/migration-v2-v3.md. Its section headings name the symbol that changed, so search it for the symbol in a compiler error or in the code you are changing. Every "Before" and "After" snippet there is authoritative. This file is the order to apply it in and the checks that make the migration complete.
Rules
- Follow the steps in order. Do not skip the Supabase CLI check.
- Never write the table definitions by hand. They come from
supabase gen types --lang dart, and the generated file is never edited. - Every query ends up on the typed
table()API unless it matches one of the exceptions in step 8. Report every exception to the user. - Keep the behavior of the app. Where v3 changed a default, pin the v2 behavior explicitly unless the user asks for the new one.
- Do not suppress analyzer errors or warnings to get a clean run. Fix them.
- Ask the user before a choice that changes runtime behavior and is not covered here.
1. Preflight
- Read
pubspec.yaml. Note which of these are dependencies and their versions:supabase_flutter,supabase,gotrue,postgrest,realtime_client,storage_client,functions_client. - Run
git status. If the tree is dirty, ask the user to commit or stash first so the migration is one reviewable diff. - Run
dart analyzeand save the output. Issues that exist before the migration are the baseline, and step 9 is measured against it. - Check for a
supabase/folder withconfig.tomlandmigrations/. It decides the source of the generated types in step 4.
2. Supabase CLI 3.0.0 or newer
Dart generation requires Supabase CLI 3.0.0 or newer.
supabase --version
If the project runs the CLI through npm (a supabase entry in
package.json), check npx supabase --version instead.
If the command is missing or prints a version below 3.0.0, stop and give
the user the command for their platform, then wait until the version check
passes:
| Install method | Upgrade command |
|---|---|
| Homebrew (macOS, Linux) | brew upgrade supabase/tap/supabase |
| npm | npm install --save-dev supabase@latest |
| Scoop (Windows) | scoop update supabase |
| Not installed | https://supabase.com/docs/guides/local-development/cli/getting-started |
Do not continue on an older CLI and do not fall back to hand-written types.
3. Pin the changed order() defaults while still on v2
v3 changed two defaults of order() without a compile error. Both pins
below already mean the same thing on v2, so add them before upgrading:
grep -rnE '\.order\(' lib test bin
- A call without
ascending:sorted descending on v2 and sorts ascending on v3. Addascending: false. - A query that sorts descending (including the ones you just changed) put
NULLs last on v2 and puts them first on v3. When the column is nullable, addnullsFirst: false. This does not apply tostream().order(), which takes no null placement.
The direction pin applies to stream().order() too. The result is that every
order() call states its direction and, on a descending query of a nullable
column, its null placement.
4. Dependencies and the typed schema
Once supabase_typegen is added, its supabase-typegen-generate skill has
the details of the generator, its options and its errors.
-
Update the dependencies. Use the newest 3.x version of each package;
dart pub outdatedlists it, prereleases included.-
supabaseto 3.x. -
Replace any direct dependency on a renamed package, and its imports:
v2 v3 gotruesupabase_authrealtime_clientsupabase_realtimestorage_clientsupabase_storagefunctions_clientsupabase_functionsA direct dependency that only duplicates what
supabasealready re-exports can be removed instead.
-
-
Add the generator:
dart pub add dev:supabase_typegen. -
Run
dart pub get. -
Generate the schema. Pick the source:
- A
supabase/folder with migrations: runsupabase start(needs Docker), thensupabase gen types --lang dart. - A project linked with
supabase link:--remote. - Otherwise ask the user for the project ref and use
--remote=<ref>.
Ask which schemas the app queries. Pass
--schemafor each schema other thanpublicthat the app uses. Write tolib/supabase_schema.g.dartunless the project already has a generated-code convention:supabase gen types --lang dart > lib/supabase_schema.g.dart - A
-
Run
dart analyze lib/supabase_schema.g.dart. It must be clean. If it is not, report the error to the user rather than editing the file.
5. Mechanical renames
Apply these across the project before reading compiler errors, since they remove most of them. The tables are in the reference:
- "The client packages are renamed": imports and the
GoTrue*type names, such asGoTrueClienttoAuthClient. - "Abbreviations in the public API are spelled out": for example
queryParams:toqueryParameters:andopts:tooptions:. - "Plural enum names singularized" and "One shared
SortDirectionfor every sort direction". - "Every deprecated API is gone": for example
User.confirmedAttoUser.emailConfirmedAtandAuthUsertoUser.
6. Compiler-driven pass
- Run
dart analyze. - For each new error, search the reference for the symbol it names and apply the "After" form of that section.
- Repeat until the only issues left are the baseline from step 1.
The sections that most often apply:
- "Sign-in methods that always issue a session return the
Session":signInWithPassword()and others return theSessiondirectly. - "
AuthStateis a sealed class" and "User.appMetadatais anAppMetadataanduserMetadatais never null". - "Realtime listener callbacks are now streams":
onPostgresChanges,onBroadcastand the connection callbacks. - "The auth client persists the session itself":
localStorage:andLocalStoragesubclasses become anAuthAsyncStorage. - "Service exceptions share one base" and "
FunctionsExceptionis sealed". - "Every client takes one
SupabaseRetryOptions". - "Timestamps are
DateTimeinstead ofStringorint". - "
rpcis a getter", "insert()andupsert()no longer take filters" and "The rest client and its builders are stateless".
7. Changes the compiler will not catch
Go through every item. For each one, search with the given pattern, read every match, and fix or confirm it. Keep a list of the sites you could not decide for the summary in step 9.
| Change (reference section) | Search | Action |
|---|---|---|
order() defaults |
\.order\( |
Confirm step 3 covered every call. |
RealtimeClient.connectionState is now typed |
connectionState |
Compare against SocketState.open and friends, not strings. Prefer isConnected. |
HttpMethod is one shared enum |
HttpMethod\.[a-z]+\.index |
Persist name instead of index. |
Confirming an email or phone change emits userUpdated |
AuthChangeEvent\.signedIn |
Handle userUpdated where an email or phone change confirmation should be seen. |
AuthChangeEvent.initialSession is emitted to every subscriber |
onAuthStateChange |
Listeners that act on signedIn at subscription time must also act on initialSession. |
A client without an asyncStorage keeps pkce verifiers in memory |
SupabaseClient\( |
A directly constructed client whose pkce flow completes in another process, such as from an email link, passes a persistent AuthClientOptions(asyncStorage: …). |
| The retry backoff defaults are the same in every client | retryOptions|SupabaseRetryOptions |
Ask whether the old PostgREST curve matters. If it does, pass the options shown in the reference. |
| The rest client and its builders are stateless | =\s*await .*\.(insert|upsert|update|delete)\( |
A write without select() resolves to void. Drop the assignment or add .select(). |
userMetadata is never null |
userMetadata\s*(\?|==|!=) |
Remove the dead null checks. |
PostgresChangePayload.errors is a List<String> |
errors\s*[!=]=\s*null |
Replace != null with errors.isNotEmpty and == null with errors.isEmpty. |
SupabaseClient builds its own default HTTP client |
runWithClient |
Pass the client as httpClient: instead. |
The Supabase URL must use https |
SupabaseClient\(|Supabase\.initialize |
Trace the URL of each call, including one from String.fromEnvironment. Use https unless the host is loopback, or pass allowInsecureHttp. |
| A request that gets no response throws a transport exception | on ClientException|on TimeoutException |
Catch SupabaseTransportException around Supabase calls. |
A failing accessToken callback throws AccessTokenException |
accessToken: and transport exception catches |
Catch AccessTokenException where token failures were handled. |
| The request timeout bounds idle time | requestTimeout |
Add .timeout(…) on the builder where a total deadline was intended. |
| Realtime throws exceptions instead of strings | on String|toString\(\)\.contains near subscribe, httpSend, track, send |
Catch StateError, RealtimeApiException or RealtimeTransportException. |
| Signing out removes every channel | \.subscribe\( |
Subscribe a channel that must outlive a sign-out, such as a public one, again after AuthSignedOut. |
| Cross-tab session sync is opt-in for standalone clients | AuthClientOptions\( |
On web, pass persistSession: true where the session must be shared and persisted. |
Search lib, test, bin and any other source folders with
grep -rnE '<pattern>'.
8. Move every query to the typed table() API
Follow the reference section "Moving from from() to the typed table API".
Convert one table at a time and re-run dart analyze after each.
Naming in the generated file: table books in public is Books,
BooksRow, BooksInsert and BooksUpdate. A table in another schema
carries the schema as a prefix, inventory.books is InventoryBooks, and
supabase.schema('inventory').from('books') becomes
supabase.table(InventoryBooks.table). Columns are camelCase constants on the
table class, Books.authorId.
| Untyped | Typed |
|---|---|
.from('books').select() |
.table(Books.table).select() |
.select('id, title') |
.selectOnly([Books.id, Books.title]), read with row.title |
.select('title, authors(name)') |
.selectOnly([Books.title, Books.authors(Authors.name)]) |
.eq('author_id', 2) |
.where(Books.authorId.eq(2)) |
.or('price.lt.10,in_print.eq.false') |
.where(Books.price.lt(10) | Books.inPrint.isFalse()) |
.order('created_at', ascending: false) |
.order(Books.createdAt.desc()) |
.order('price', ascending: false, nullsFirst: false) |
.order(Books.price.desc().nullsLast()) |
.limit(3, referencedTable: 'books') |
.embedded(Authors.books, (books) => books.limit(3)) |
.eq('books.title', 'Dune') |
.embedded(Authors.books, (books) => books.where(Books.title.eq('Dune'))) |
.select('name, books!inner(title)') |
.selectOnly([...]).requiring(Authors.books) |
.isFilter('books', null) |
.where(Authors.books.isNull()) |
.insert({...}) |
.insert(BooksInsert(...)) |
.insert([{...}, {...}]) |
.insertAll([BooksInsert(...), ...]) |
.update({...}).eq('id', 1) |
.update(BooksUpdate(...)).where(Books.id.eq(1)) |
.update({'price': null}) |
.update(BooksUpdate(price: null)) |
.delete().eq('id', 1) |
.delete().where(Books.id.eq(1)) |
.delete() with no filter |
.delete().all() |
.upsert({...}, onConflict: 'name') |
.upsert(AuthorsInsert(...), onConflict: [Authors.name]) |
.stream(primaryKey: ['id']).eq('author_id', 2) |
.stream(primaryKey: [Books.id]).filter(Books.authorId.eq(2)) |
.rpc('search_books', params: {'query': q}) |
.rpc.searchBooks(query: q) |
Rules for the conversion:
- Carry the direction pinned in step 3 over:
ascending: falsebecomes.desc(), andnullsFirst: falsebecomes.nullsLast(). Anorder()with neither stays a plain column, which is ascending. A typedstream()takes the same orderings, but throws anArgumentErroron.nullsFirst()or.nullsLast(), since it always placesNULLs last ascending and first descending. - A typed
update()ordelete()sends nothing until it has.where(…)or.all(). A bareawaitof one compiles and silently does nothing, and the analyzer reports it as anunused_resultwarning. Fix every one of them. - A parameter of an
InsertorUpdatetype that is left out leaves the column out, and passingnullwrites SQLNULL, the same as a key that is missing from the map or set tonull. insertAll()andupsertAll()give a column left out of only some rows its database default, where the untyped listinsert()wroteNULL, and take nodefaultToNull. Where the code relied onNULL, passnullfor the column in those rows.- Replace
row['title'] as Stringwithrow.titlewherever the rows are consumed. A model class that only mirrors a table is replaced by the generated row type. A model that adds behavior is built from the row getters, not fromtoJson(). - An operator with no typed method uses
Books.title.raw('eq.Dune'). A filter on a JSON path usesBooks.metadata.jsonText('edition').eq('first').
from() and the untyped rpc('fn', params: …) remain only for:
- a table, view or function missing from the generated file because its schema was not generated or is not exposed through the Data API,
- a table name computed at runtime,
- a function the generator gives no method, which it explains in a comment in the generated file.
9. Verify and report
dart analyzeshows nothing beyond the baseline from step 1.- Run
dart formaton every file you changed. Do not formatlib/supabase_schema.g.dart, which is already formatted. - Run
dart test. Fix failures the migration caused and report the rest. - Give the user a short summary:
- the dependency changes and the generated schema file and command,
- every site from step 7 that needs a human decision,
- every remaining
from()or untypedrpc()call and its reason, - that the schema must be regenerated with the same command after every
change to the database schema, whether from a migration or the
dashboard, and after upgrading
supabase_typegenor the Supabase CLI.