foodb-cli v0.2.0
foodb-cli
Foo DB Command Line Interface (CLI)
Usage
$ npm install -g foodb-cli
$ edb COMMAND
running command...
$ edb (-v|--version|version)
foodb-cli/0.2.0 darwin-x64 node-v10.15.3
$ edb --help [COMMAND]
USAGE
$ edb COMMAND
...
Commands
edb add-role
edb backup
edb create
edb delete
edb failover
edb help [COMMAND]
edb list
edb query
edb remove-role
edb replicate
edb restore
edb add-role
add a role to an instance of postgres
USAGE
$ edb add-role
OPTIONS
--db=db database to modify
--permission=permission permissions for role
--role=role name of role
--skip skips confirm prompt
EXAMPLES
$ edb add-role
$ edb add-role --db='db1' --role='readonlyuser' --permission='read' --skip
See code: src/commands/add-role.ts
edb backup
backup an instance of postgres
USAGE
$ edb backup
OPTIONS
--db=db database to back up
--skip skips confirm prompt
--to=to name of backup
EXAMPLES
$ edb backup
$ edb backup --db='db1' --to='bk1' --skip
See code: src/commands/backup.ts
edb create
create a new instance of postgres or EDB Postgres Advanced Server (epas)
USAGE
$ edb create
OPTIONS
--db=db database identifier
--password=password database password
--port=port port used by database
--size=size size of database
--skip skips confirm prompt
--type=type type of database
--username=username database user name
EXAMPLES
$ edb create
$ edb create --db='db1' --type='postgres' --size='small'
$ edb create --db='db1' --type='epas' --size='large' --port=5445 --skip
See code: src/commands/create.ts
edb delete
delete an instance of postgres
USAGE
$ edb delete
OPTIONS
--db=db database to delete
--skip skips confirm prompt
EXAMPLES
$ edb delete
$ edb delete --db='db1' --skip
See code: src/commands/delete.ts
edb failover
fail over an instance of postgres to another instance
USAGE
$ edb failover
OPTIONS
--from=from database to fail over from
--skip skips confirm prompt
--to=to database to fail over to
EXAMPLES
$ edb failover
$ edb failover --from='db1' --to='db2' --skip
See code: src/commands/failover.ts
edb help [COMMAND]
display help for edb
USAGE
$ edb help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
edb list
list the instances of postgres, logs and backups on this server
USAGE
$ edb list
OPTIONS
--contains=contains search text for filtering
--skip skips confirm prompt
EXAMPLES
$ edb list
$ edb list --contains='db'
$ edb list --contains='log'
$ edb list --contains='backup' --skip
See code: src/commands/list.ts
edb query
query an instance of postgres
USAGE
$ edb query
OPTIONS
--db=db database to query
--sql=sql SQL statement to execute
EXAMPLES
$ edb query
$ edb query --db='node1' --sql="create table orders (...)"
$ edb query --db='node1' --sql="select * from orders"
See code: src/commands/query.ts
edb remove-role
remove a role from an instance of postgres
USAGE
$ edb remove-role
OPTIONS
--db=db database to modify
--role=role name of role
--skip skips confirm prompt
EXAMPLES
$ edb remove-role
$ edb remove-role --db='db1' --role='readonlyuser' --skip
See code: src/commands/remove-role.ts
edb replicate
replicate an instance of postgres to another instance
USAGE
$ edb replicate
OPTIONS
--direction=direction determines which way data replicates
--frequency=frequency determines how often replication occurs
--from=from database to replicate from
--skip skips confirm prompt
--tables=tables tables to replicate
--to=to database to replicate to
EXAMPLES
$ edb replicate
$ edb replicate --from='db1' --to='db2' --tables='orders,inventory'
$ edb replicate --from='db1' --to='db2' --frequency='once' --direction='single'
$ edb replicate --from='db1' --to='db2' --frequency='continuous' --direction='both' --skip
See code: src/commands/replicate.ts
edb restore
restore an instance of postgres
USAGE
$ edb restore
OPTIONS
--db=db database to restore
--from=from name of backup
--skip skips confirm prompt
EXAMPLES
$ edb restore
$ edb restore --db='db1' --from='bk1' --skip
See code: src/commands/restore.ts