neonapi

package

v0.2.1 Latest Latest Go to latest Published: May 14, 2026 License: MIT Imports: 12 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Branch struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	Parent  string `json:"parent_id"`
	Primary bool   `json:"primary"`
}

type Client struct {
	// contains filtered or unexported fields
}

Client is a small Neon API client used by the vango CLI.

All methods treat connection URIs as secret material. Callers must never print returned DSNs to stdout/stderr.

func New(cfg Config) (*Client, error)

func (c *Client) ConnectionURI(ctx context.Context, projectID, branchID, databaseName, roleName string, pooled bool) (string, error)

ConnectionURI retrieves a credential-bearing Postgres connection URI.

The returned string must be treated as secret material.

func (c *Client) CreateBranch(ctx context.Context, projectID, name, parentBranchID string) (Branch, error)

func (c *Client) DeleteBranch(ctx context.Context, projectID, branchID string) error

func (c *Client) ListBranches(ctx context.Context, projectID string) ([]Branch, error)

type Config struct {
	APIKey     string
	BaseURL    string
	HTTPClient *http.Client
}