/supabase-csharp

A C# Client library for Supabase

Primary LanguageC#MIT LicenseMIT

Documentation can be found below, on the Supabase Developer Documentation and additionally in the Generated API Docs.

**CHANGELOG is available in the repository root. **

[NOTICE FOR v1.0.0]

  • The supabase-csharp Nuget package has been renamed to Supabase and a depreciation notice set to encourage adoption.
  • Almost all APIs stay the same when migrating from v0.16.x except the change in namespace from Postgrest to Supabase.Postgrest. Some minor refactoring will be required in the codebase.
  • The assembly name has been changed from supabase to Supabase.

Features

  • Integration with Supabase.Realtime
    • Realtime listeners for database changes
  • Integration with Postgrest
    • Access your database using a REST API generated from your schema & database functions
  • Integration with Gotrue
    • User authentication, including OAuth, email/password, and native sign-in
  • Integration with Supabase Storage
    • Store files in S3 with additional managed metadata
  • Integration with Supabase Edge Functions
    • Run serverless functions on the edge
  • Nuget Release

Quickstart

  1. To get started, create a new project in the Supabase Admin Panel.
  2. Grab your Supabase URL and Supabase Public Key from the Admin Panel (Settings -> API Keys).
  3. Initialize the client!

Reminder: supabase-csharp has some APIs that require the service_key rather than the public_key (for instance: the administration of users, bypassing database roles, etc.). If you are using the service_key be sure it is not exposed client side. Additionally, if you need to use both a service account and a public/user account, please do so using a separate client instance for each.

Documentation

Specific Features

Troubleshooting

Package made possible through the efforts of:

Join the ranks! See a problem? Help fix it!

Contributing

We are more than happy to have contributions! Please submit a PR.