Notploy

PostgreSQL

Provision and operate PostgreSQL databases, including backups and external ports. Generated from the `notploy` command surface.

Provision and operate PostgreSQL databases, including backups and external ports.

notploy postgres exposes 16 commands. They map one-to-one onto the postgres.* API operations, so anything reachable from the dashboard is reachable from here.

Run notploy postgres --help to list these commands in your terminal, or notploy postgres <command> --help for a single command.

Commands

notploy postgres change-password

Calls POST /api/trpc/postgres.changePassword.

notploy postgres change-password --postgresId <value> --password <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--password <value>stringYes—
--profile <name>stringNo—

notploy postgres change-status

Calls POST /api/trpc/postgres.changeStatus.

notploy postgres change-status --postgresId <value> --applicationStatus <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--applicationStatus <value>stringYesidle, running, done, error
--profile <name>stringNo—

notploy postgres create

Calls POST /api/trpc/postgres.create.

notploy postgres create --name <value> --databaseName <value> --databaseUser <value> --databasePassword <value> --environmentId <value> [options]
OptionTypeRequiredAllowed values
--name <value>stringYes—
--appName <value>stringNo—
--databaseName <value>stringYes—
--databaseUser <value>stringYes—
--databasePassword <value>stringYes—
--dockerImage <value>stringNo—
--environmentId <value>stringYes—
--description <value>stringNo—
--serverId <value>stringNo—
--profile <name>stringNo—

notploy postgres deploy

Calls POST /api/trpc/postgres.deploy.

notploy postgres deploy --postgresId <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--profile <name>stringNo—

notploy postgres move

Calls POST /api/trpc/postgres.move.

notploy postgres move --postgresId <value> --targetEnvironmentId <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--targetEnvironmentId <value>stringYes—
--profile <name>stringNo—

notploy postgres one

Calls GET /api/trpc/postgres.one.

notploy postgres one --postgresId <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--profile <name>stringNo—

notploy postgres read-logs

Calls GET /api/trpc/postgres.readLogs.

notploy postgres read-logs --postgresId <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--tail <value>numberNo—
--since <value>stringNo—
--search <value>stringNo—
--profile <name>stringNo—

notploy postgres rebuild

Calls POST /api/trpc/postgres.rebuild.

notploy postgres rebuild --postgresId <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--profile <name>stringNo—

notploy postgres reload

Calls POST /api/trpc/postgres.reload.

notploy postgres reload --postgresId <value> --appName <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--appName <value>stringYes—
--profile <name>stringNo—

notploy postgres remove

Calls POST /api/trpc/postgres.remove.

notploy postgres remove --postgresId <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--profile <name>stringNo—

notploy postgres save-environment

Calls POST /api/trpc/postgres.saveEnvironment.

notploy postgres save-environment --postgresId <value> --env <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--env <value>stringYes—
--profile <name>stringNo—

notploy postgres save-external-port

Calls POST /api/trpc/postgres.saveExternalPort.

notploy postgres save-external-port --postgresId <value> --externalPort <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--externalPort <value>numberYes—
--profile <name>stringNo—

Calls GET /api/trpc/postgres.search.

notploy postgres search [options]
OptionTypeRequiredAllowed values
--q <value>stringNo—
--name <value>stringNo—
--appName <value>stringNo—
--description <value>stringNo—
--projectId <value>stringNo—
--environmentId <value>stringNo—
--limit <value>numberNo—
--offset <value>numberNo—
--profile <name>stringNo—

notploy postgres start

Calls POST /api/trpc/postgres.start.

notploy postgres start --postgresId <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--profile <name>stringNo—

notploy postgres stop

Calls POST /api/trpc/postgres.stop.

notploy postgres stop --postgresId <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--profile <name>stringNo—

notploy postgres update

Calls POST /api/trpc/postgres.update.

notploy postgres update --postgresId <value> [options]
OptionTypeRequiredAllowed values
--postgresId <value>stringYes—
--name <value>stringNo—
--appName <value>stringNo—
--databaseName <value>stringNo—
--databaseUser <value>stringNo—
--databasePassword <value>stringNo—
--description <value>stringNo—
--dockerImage <value>stringNo—
--command <value>stringNo—
--args <json>arrayNo—
--env <value>stringNo—
--memoryReservation <value>stringNo—
--externalPort <value>numberNo—
--memoryLimit <value>stringNo—
--cpuReservation <value>stringNo—
--cpuLimit <value>stringNo—
--applicationStatus <value>stringNoidle, running, done, error
--healthCheckSwarm <json>objectNo—
--restartPolicySwarm <json>objectNo—
--placementSwarm <json>objectNo—
--updateConfigSwarm <json>objectNo—
--rollbackConfigSwarm <json>objectNo—
--modeSwarm <json>objectNo—
--labelsSwarm <json>objectNo—
--networkSwarm <json>arrayNo—
--stopGracePeriodSwarm <value>numberNo—
--endpointSpecSwarm <json>objectNo—
--ulimitsSwarm <json>arrayNo—
--replicas <value>numberNo—
--createdAt <value>stringNo—
--environmentId <value>stringNo—
--networkIds <json>arrayNo—
--detachNotployNetwork [boolean]booleanNo—
--no-detachNotployNetworkbooleanNo—
--profile <name>stringNo—

MySQL

Provision and operate MySQL databases, including backups and external ports. Generated from the `notploy` command surface.

Redis

Provision and operate Redis instances, including backups and external ports. Generated from the `notploy` command surface.

On this page

Commandsnotploy postgres change-passwordnotploy postgres change-statusnotploy postgres createnotploy postgres deploynotploy postgres movenotploy postgres onenotploy postgres read-logsnotploy postgres rebuildnotploy postgres reloadnotploy postgres removenotploy postgres save-environmentnotploy postgres save-external-portnotploy postgres searchnotploy postgres startnotploy postgres stopnotploy postgres update