pgdocker

Documentation

Overview

Package pgdocker creates one-off Postgres docker images to use so sqlgen can introspect the schema.

Index

• type Client
  • func Start(ctx context.Context, initScripts []string, l *zap.SugaredLogger) (client *Client, mErr error)
  • func (c *Client) ConnString() (string, error)
  • func (c *Client) GetContainerLogs() (logs string, mErr error)
  • func (c *Client) Stop(ctx context.Context) error

Types

type Client

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

Client is a client to control the running Postgres Docker container.

func Start

func Start(ctx context.Context, initScripts []string, l *zap.SugaredLogger) (client *Client, mErr error)

Start builds a Docker image and runs the image in a container.

func (*Client) ConnString

func (c *Client) ConnString() (string, error)

ConnString returns the connection string to connect to the started Postgres Docker container.

func (*Client) GetContainerLogs

func (c *Client) GetContainerLogs() (logs string, mErr error)

GetContainerLogs returns a string of all stderr and stdout logs for a container. Useful to enrich output when sqlgen fails to start the Docker container.

func (*Client) Stop

func (c *Client) Stop(ctx context.Context) error

Stop stops the running container, if any.