roleutil

package

v0.348.0 Latest Latest Go to latest Published: Oct 21, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/planetscale/cli

Links

Open Source Insights

Documentation ¶

Index ¶

type Options
type Role
- func New(ctx context.Context, client *ps.Client, opts Options) (*Role, error)
- func (r *Role) Cleanup(ctx context.Context, successor string) error
- func (r *Role) WaitUntilReady(ctx context.Context) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	Organization   string
	Database       string
	Branch         string
	Name           string
	TTL            time.Duration
	InheritedRoles []string
}

Options represents the options to create a new Postgres role

type Role ¶

type Role struct {
	Role *ps.PostgresRole
	// contains filtered or unexported fields
}

Role represents a Postgres role with cleanup capabilities

func New ¶

func New(ctx context.Context, client *ps.Client, opts Options) (*Role, error)

New creates a new temporary Postgres role

func (*Role) Cleanup ¶

func (r *Role) Cleanup(ctx context.Context, successor string) error

Cleanup deletes the temporary role with an optional successor

func (*Role) WaitUntilReady ¶ added in v0.332.0

func (r *Role) WaitUntilReady(ctx context.Context) error

WaitUntilReady waits until a temporary role can accept connections. The create response contains the only copy of the password, so this method keeps the original role and only updates its readiness state.

Source Files ¶

View all Source files

roleutil.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL