bookmarks

Documentation

Index

• func Path(overrideDir string) string
• func ReadAll(path string) (map[string]Bookmark, error)
• type Bookmark
  • func GetBookmark(bookmarkPath string, bookmarkName string) (Bookmark, error)
  • func (b Bookmark) ConvertToOptions() command.Options
  • func (b Bookmark) SSHInfoIsEmpty() bool

Functions

func Path

func Path(overrideDir string) string

Path returns bookmarks storage path

func ReadAll

func ReadAll(path string) (map[string]Bookmark, error)

ReadAll returns all available bookmarks

Types

type Bookmark

type Bookmark struct {
	URL      string          `json:"url"`      // Postgres connection URL
	Host     string          `json:"host"`     // Server hostname
	Port     int             `json:"port"`     // Server port
	User     string          `json:"user"`     // Database user
	Password string          `json:"password"` // User password
	Database string          `json:"database"` // Database name
	SSLMode  string          `json:"ssl"`      // Connection SSL mode
	SSH      *shared.SSHInfo `json:"ssh"`      // SSH tunnel config
}

Bookmark contains information about bookmarked database connection

func GetBookmark

func GetBookmark(bookmarkPath string, bookmarkName string) (Bookmark, error)

GetBookmark reads an existing bookmark

func (Bookmark) ConvertToOptions

func (b Bookmark) ConvertToOptions() command.Options

ConvertToOptions returns an options struct from connection details

func (Bookmark) SSHInfoIsEmpty

func (b Bookmark) SSHInfoIsEmpty() bool

SSHInfoIsEmpty returns true if ssh configuration is not provided