mirror of
https://github.com/foomo/posh-providers.git
synced 2025-10-16 12:35:41 +00:00
feat(postgres/postgres): add postgres
This commit is contained in:
Kevin Franklin Kim
parent
6d5a5e31b3
commit
bd24931ab5
37
postgres/README.md
Normal file
37
postgres/README.md
Normal file
@ -0,0 +1,37 @@
|
||||
# POSH gotsrpc provider
|
||||
|
||||
## Usage
|
||||
|
||||
### Plugin
|
||||
|
||||
```go
|
||||
package plugin
|
||||
|
||||
type Plugin struct {
|
||||
l log.Logger
|
||||
commands command.Commands
|
||||
}
|
||||
|
||||
func New(l log.Logger) (plugin.Plugin, error) {
|
||||
inst := &Plugin{
|
||||
l: l,
|
||||
commands: command.Commands{},
|
||||
}
|
||||
|
||||
// ...
|
||||
|
||||
inst.commands.Add(postgres.NewCommand(l))
|
||||
|
||||
// ...
|
||||
|
||||
return inst, nil
|
||||
}
|
||||
```
|
||||
|
||||
### Dependencies
|
||||
|
||||
This requires you to have:
|
||||
|
||||
- psql
|
||||
- pg_dump
|
||||
- pg_restore
|
||||
271
postgres/command.go
Normal file
271
postgres/command.go
Normal file
@ -0,0 +1,271 @@
|
||||
package postgres
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
"time"
|
||||
|
||||
"github.com/foomo/posh-providers/arbitrary/zip"
|
||||
"github.com/foomo/posh/pkg/command/tree"
|
||||
"github.com/foomo/posh/pkg/log"
|
||||
"github.com/foomo/posh/pkg/prompt/goprompt"
|
||||
"github.com/foomo/posh/pkg/readline"
|
||||
"github.com/foomo/posh/pkg/shell"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
type (
|
||||
Command struct {
|
||||
l log.Logger
|
||||
zip *zip.Zip
|
||||
commandTree tree.Root
|
||||
}
|
||||
CommandOption func(*Command)
|
||||
)
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ~ Options
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
|
||||
func CommandWithZip(v *zip.Zip) CommandOption {
|
||||
return func(o *Command) {
|
||||
o.zip = v
|
||||
}
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ~ Constructor
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
|
||||
func NewCommand(l log.Logger, opts ...CommandOption) *Command {
|
||||
inst := &Command{
|
||||
l: l.Named("postgres"),
|
||||
}
|
||||
|
||||
for _, opt := range opts {
|
||||
if opt != nil {
|
||||
opt(inst)
|
||||
}
|
||||
}
|
||||
|
||||
connectionFlags := func(fs *readline.FlagSets) {
|
||||
fs.Default().String("port", "", "database server port number")
|
||||
fs.Default().String("host", "", "database server host or socket directory")
|
||||
fs.Default().String("dbname", "", "database to dump")
|
||||
fs.Default().String("username", "", "connect as specified database user")
|
||||
}
|
||||
|
||||
inst.commandTree = tree.New(&tree.Node{
|
||||
Name: "postgres",
|
||||
Description: "Postgres utilities",
|
||||
Flags: func(ctx context.Context, r *readline.Readline, fs *readline.FlagSets) error {
|
||||
connectionFlags(fs)
|
||||
return nil
|
||||
},
|
||||
Execute: inst.execute,
|
||||
Nodes: tree.Nodes{
|
||||
{
|
||||
Name: "dump",
|
||||
Description: "Create a database dump",
|
||||
Flags: func(ctx context.Context, r *readline.Readline, fs *readline.FlagSets) error {
|
||||
fs.Default().Bool("verbose", false, "verbose mode")
|
||||
// Options controlling the output content:
|
||||
fs.Default().Bool("data-only", false, "dump only the data, not the schema")
|
||||
fs.Default().Bool("schema-only", false, "dump only the schema, no data")
|
||||
fs.Default().Bool("no-owner", false, "skip restoration of object ownership")
|
||||
fs.Default().String("format", "", "output file format ")
|
||||
// connection
|
||||
connectionFlags(fs)
|
||||
fs.Internal().Bool("zip", false, "create a zip file")
|
||||
fs.Internal().Bool("dump", false, "use dump format")
|
||||
fs.Internal().String("zip-cred", "", "configured zip credential name")
|
||||
if err := fs.Internal().SetValues("zip-cred", inst.zip.Config().CredentialNames()...); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
Args: tree.Args{
|
||||
{
|
||||
Name: "database",
|
||||
Description: "Database name to dump",
|
||||
},
|
||||
{
|
||||
Name: "dirname",
|
||||
Description: "Path to the dump file",
|
||||
},
|
||||
},
|
||||
Execute: inst.dump,
|
||||
},
|
||||
{
|
||||
Name: "run-cmd",
|
||||
Description: "Run only single command",
|
||||
Flags: func(ctx context.Context, r *readline.Readline, fs *readline.FlagSets) error {
|
||||
connectionFlags(fs)
|
||||
return nil
|
||||
},
|
||||
Args: tree.Args{
|
||||
{
|
||||
Name: "command",
|
||||
},
|
||||
},
|
||||
Execute: inst.runCommand,
|
||||
},
|
||||
{
|
||||
Name: "run-file",
|
||||
Description: "Execute commands from file",
|
||||
Flags: func(ctx context.Context, r *readline.Readline, fs *readline.FlagSets) error {
|
||||
connectionFlags(fs)
|
||||
return nil
|
||||
},
|
||||
Args: tree.Args{
|
||||
{
|
||||
Name: "filename",
|
||||
},
|
||||
},
|
||||
Execute: inst.runFile,
|
||||
},
|
||||
{
|
||||
Name: "restore",
|
||||
Description: "Restore a database dump",
|
||||
Flags: func(ctx context.Context, r *readline.Readline, fs *readline.FlagSets) error {
|
||||
fs.Default().Bool("verbose", false, "verbose mode")
|
||||
// Options controlling the output content:
|
||||
fs.Default().Bool("data-only", false, "restore only the data, no schema")
|
||||
fs.Default().Bool("clean", false, "clean (drop) database objects before recreating")
|
||||
fs.Default().Bool("exit-on-error", false, "exit on error, default is to continue")
|
||||
fs.Default().Bool("schema-only", false, "restore only the schema, no data")
|
||||
fs.Default().Bool("no-owner", false, "skip restoration of object ownership")
|
||||
connectionFlags(fs)
|
||||
fs.Internal().String("zip-cred", "", "configured zip credential name")
|
||||
if err := fs.Internal().SetValues("zip-cred", inst.zip.Config().CredentialNames()...); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
Args: tree.Args{
|
||||
{
|
||||
Name: "filename",
|
||||
Description: "Path to the dump file",
|
||||
},
|
||||
},
|
||||
Execute: inst.restore,
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
return inst
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ~ Public methods
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
|
||||
func (c *Command) Name() string {
|
||||
return c.commandTree.Node().Name
|
||||
}
|
||||
|
||||
func (c *Command) Description() string {
|
||||
return c.commandTree.Node().Description
|
||||
}
|
||||
|
||||
func (c *Command) Complete(ctx context.Context, r *readline.Readline) []goprompt.Suggest {
|
||||
return c.commandTree.Complete(ctx, r)
|
||||
}
|
||||
|
||||
func (c *Command) Execute(ctx context.Context, r *readline.Readline) error {
|
||||
return c.commandTree.Execute(ctx, r)
|
||||
}
|
||||
|
||||
func (c *Command) Help(ctx context.Context, r *readline.Readline) string {
|
||||
return c.commandTree.Help(ctx, r)
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ~ Private methods
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
|
||||
func (c *Command) execute(ctx context.Context, r *readline.Readline) error {
|
||||
return shell.New(ctx, c.l, "psql").
|
||||
Args(r.Args()...).
|
||||
Args(r.Flags()...).
|
||||
Args(r.AdditionalArgs()...).
|
||||
Run()
|
||||
}
|
||||
|
||||
func (c *Command) runFile(ctx context.Context, r *readline.Readline) error {
|
||||
return shell.New(ctx, c.l, "psql").
|
||||
Args(r.Flags()...).
|
||||
Args("--file", r.Args().At(1)).
|
||||
Args(r.AdditionalArgs()...).
|
||||
Run()
|
||||
}
|
||||
|
||||
func (c *Command) runCommand(ctx context.Context, r *readline.Readline) error {
|
||||
return shell.New(ctx, c.l, "psql").
|
||||
Args(r.Flags()...).
|
||||
Args("--command", r.Args().At(1)).
|
||||
Args(r.AdditionalArgs()...).
|
||||
Run()
|
||||
}
|
||||
|
||||
func (c *Command) dump(ctx context.Context, r *readline.Readline) error {
|
||||
fs := r.FlagSets().Default()
|
||||
ifs := r.FlagSets().Internal()
|
||||
|
||||
database := r.Args().At(1)
|
||||
dirname := r.Args().At(2)
|
||||
if err := os.MkdirAll(dirname, 0700); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
filename := fmt.Sprintf("%s/%s-%s", dirname, database, time.Now().Format("20060102150405"))
|
||||
if log.MustGet(ifs.GetBool("dump"))(c.l) {
|
||||
filename += ".dump"
|
||||
if err := fs.Set("format", "custom"); err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
filename += ".sql"
|
||||
}
|
||||
|
||||
if out, err := shell.New(ctx, c.l, "pg_dump").
|
||||
Args(fs.Visited().Args()...).
|
||||
Args(r.AdditionalFlags()...).
|
||||
Args(database).
|
||||
Args(r.AdditionalArgs()...).
|
||||
Args(">", filename).
|
||||
Output(); err != nil {
|
||||
return errors.Wrap(err, string(out))
|
||||
}
|
||||
|
||||
if log.MustGet(ifs.GetBool("zip"))(c.l) {
|
||||
if err := c.zip.Create(ctx, filename); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if cred := log.MustGet(ifs.GetString("zip-cred"))(c.l); cred != "" {
|
||||
if err := c.zip.CreateWithPassword(ctx, filename, cred); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *Command) restore(ctx context.Context, r *readline.Readline) error {
|
||||
flags := r.Flags()
|
||||
filename := r.Args().At(1)
|
||||
|
||||
if out, err := shell.New(ctx, c.l, "pg_restore").
|
||||
Args(flags...).
|
||||
Args(r.AdditionalFlags()...).
|
||||
Args(r.AdditionalArgs()...).
|
||||
Args(filename).
|
||||
Output(); err != nil {
|
||||
return errors.Wrap(err, string(out))
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user