Notploy

MongoDB

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

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

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

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

Commands

notploy mongo change-password

Calls POST /api/trpc/mongo.changePassword.

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

notploy mongo change-status

Calls POST /api/trpc/mongo.changeStatus.

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

notploy mongo create

Calls POST /api/trpc/mongo.create.

notploy mongo create --name <value> --environmentId <value> --databaseUser <value> --databasePassword <value> [options]
OptionTypeRequiredAllowed values
--name <value>stringYes—
--appName <value>stringNo—
--dockerImage <value>stringNo—
--environmentId <value>stringYes—
--description <value>stringNo—
--databaseUser <value>stringYes—
--databasePassword <value>stringYes—
--serverId <value>stringNo—
--replicaSets [boolean]booleanNo—
--no-replicaSetsbooleanNo—
--profile <name>stringNo—

notploy mongo deploy

Calls POST /api/trpc/mongo.deploy.

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

notploy mongo move

Calls POST /api/trpc/mongo.move.

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

notploy mongo one

Calls GET /api/trpc/mongo.one.

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

notploy mongo read-logs

Calls GET /api/trpc/mongo.readLogs.

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

notploy mongo rebuild

Calls POST /api/trpc/mongo.rebuild.

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

notploy mongo reload

Calls POST /api/trpc/mongo.reload.

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

notploy mongo remove

Calls POST /api/trpc/mongo.remove.

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

notploy mongo save-environment

Calls POST /api/trpc/mongo.saveEnvironment.

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

notploy mongo save-external-port

Calls POST /api/trpc/mongo.saveExternalPort.

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

Calls GET /api/trpc/mongo.search.

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

Calls POST /api/trpc/mongo.start.

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

notploy mongo stop

Calls POST /api/trpc/mongo.stop.

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

notploy mongo update

Calls POST /api/trpc/mongo.update.

notploy mongo update --mongoId <value> [options]
OptionTypeRequiredAllowed values
--mongoId <value>stringYes—
--name <value>stringNo—
--appName <value>stringNo—
--description <value>stringNo—
--databaseUser <value>stringNo—
--databasePassword <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—
--replicaSets [boolean]booleanNo—
--no-replicaSetsbooleanNo—
--networkIds <json>arrayNo—
--detachNotployNetwork [boolean]booleanNo—
--no-detachNotployNetworkbooleanNo—
--profile <name>stringNo—

MariaDB

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

MySQL

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

On this page

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