Notploy

MySQL

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

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

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

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

Commands

notploy mysql change-password

Calls POST /api/trpc/mysql.changePassword.

notploy mysql change-password --mysqlId <value> --password <value> [options]
OptionTypeRequiredAllowed values
--mysqlId <value>stringYes—
--password <value>stringYes—
--type <value>stringNouser, root
--profile <name>stringNo—

notploy mysql change-status

Calls POST /api/trpc/mysql.changeStatus.

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

notploy mysql create

Calls POST /api/trpc/mysql.create.

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

notploy mysql deploy

Calls POST /api/trpc/mysql.deploy.

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

notploy mysql move

Calls POST /api/trpc/mysql.move.

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

notploy mysql one

Calls GET /api/trpc/mysql.one.

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

notploy mysql read-logs

Calls GET /api/trpc/mysql.readLogs.

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

notploy mysql rebuild

Calls POST /api/trpc/mysql.rebuild.

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

notploy mysql reload

Calls POST /api/trpc/mysql.reload.

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

notploy mysql remove

Calls POST /api/trpc/mysql.remove.

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

notploy mysql save-environment

Calls POST /api/trpc/mysql.saveEnvironment.

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

notploy mysql save-external-port

Calls POST /api/trpc/mysql.saveExternalPort.

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

Calls GET /api/trpc/mysql.search.

notploy mysql 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 mysql start

Calls POST /api/trpc/mysql.start.

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

notploy mysql stop

Calls POST /api/trpc/mysql.stop.

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

notploy mysql update

Calls POST /api/trpc/mysql.update.

notploy mysql update --mysqlId <value> [options]
OptionTypeRequiredAllowed values
--mysqlId <value>stringYes—
--name <value>stringNo—
--appName <value>stringNo—
--description <value>stringNo—
--databaseName <value>stringNo—
--databaseUser <value>stringNo—
--databasePassword <value>stringNo—
--databaseRootPassword <value>stringNo—
--dockerImage <value>stringNo—
--command <value>stringNo—
--args <json>arrayNo—
--env <value>stringNo—
--memoryReservation <value>stringNo—
--memoryLimit <value>stringNo—
--cpuReservation <value>stringNo—
--cpuLimit <value>stringNo—
--externalPort <value>numberNo—
--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—

MongoDB

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

PostgreSQL

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

On this page

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