postgres

Documentation

Overview

Package postgres opens direct Postgres connections to a Supabase project's database. The Database tab uses this for browsing tables, running SQL, and editing rows.

In v0.1 this is a stub — the connection helper signature is defined but the Database tab implementation is deferred to v0.1.x.

Index

• type Client
  • func Connect(ctx context.Context, connString string) (*Client, error)
  • func (c *Client) Close()

Types

type Client

type Client struct {
	Pool *pgxpool.Pool
}

Client wraps a pgx connection pool for one Supabase project's database.

func Connect

func Connect(ctx context.Context, connString string) (*Client, error)

Connect opens a pgx pool against the supplied connection string.

In v0.1.x this will be wired up to fetch the connection string from the Supabase Management API given a project ref.

func (*Client) Close

func (c *Client) Close()

Close releases the connection pool.