supabase 3.0.0-dev.6

A dart client for Supabase. This client makes it simple for developers to build secure and scalable products.

supabase

Dart client library for Supabase, for use in non-Flutter Dart environments.

Guides · Reference Docs

Note

This is a Dart library for Supabase for use cases such as server-side Dart like Dart Edge, or non-Flutter Dart environments.

If you are developing a Flutter application, use supabase_flutter instead. supabase package is for non-Flutter Dart environments.

What is Supabase

Supabase is an open source Firebase alternative. We are a service to:

• listen to database changes
• query your tables, including filtering, pagination, and deeply nested relationships (like GraphQL)
• create, update, and delete rows
• manage your users and their permissions
• interact with your database using a simple UI

Docs

The docs can be found on the official Supabase website.

• Dart reference
• Supabase docs

Server-side usage

Create one SupabaseClient when the process starts and reuse it for as long as the process lives. The client keeps a pool of HTTP connections, and a request on a warm connection skips the TCP handshake and, over HTTPS, the TLS handshake, which on a server talking to a remote Supabase project take longer than the request itself. A client created per request throws that pool away every time.

To act on behalf of the user of an incoming request, keep the shared client and pass the access token of that request as the Authorization header of the call. The client only adds its own Authorization header when the request has none:

final todos = await supabase
    .from('todos')
    .select()
    .setHeader('Authorization', 'Bearer $userAccessToken');

Storage and functions calls accept a header the same way, through setHeader() on a bucket and the headers parameter of invoke().

The transport a SupabaseClient creates for itself closes a connection that has been unused for 60 seconds, which is below the point where the Supabase gateway closes it from its side. Open connections keep a Dart program alive until then, so call dispose() when the process shuts down.

If you do need more than one SupabaseClient, pass the same http.Client to each of them so they share one pool. Disposing a SupabaseClient leaves a client you passed in open, so close it yourself at shutdown. dart:io defaults to a 15 second idle timeout, so raise it:

import 'dart:io';

import 'package:http/io_client.dart';

final httpClient = IOClient(
  HttpClient()..idleTimeout = const Duration(seconds: 60),
);

License

This repo is licensed under MIT.

Credits

• https://github.com/supabase/supabase-js