Notploy

MariaDB

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

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

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

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

Commands

notploy mariadb change-password

Calls POST /api/trpc/mariadb.changePassword.

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

notploy mariadb change-status

Calls POST /api/trpc/mariadb.changeStatus.

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

notploy mariadb create

Calls POST /api/trpc/mariadb.create.

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

notploy mariadb deploy

Calls POST /api/trpc/mariadb.deploy.

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

notploy mariadb move

Calls POST /api/trpc/mariadb.move.

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

notploy mariadb one

Calls GET /api/trpc/mariadb.one.

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

notploy mariadb read-logs

Calls GET /api/trpc/mariadb.readLogs.

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

notploy mariadb rebuild

Calls POST /api/trpc/mariadb.rebuild.

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

notploy mariadb reload

Calls POST /api/trpc/mariadb.reload.

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

notploy mariadb remove

Calls POST /api/trpc/mariadb.remove.

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

notploy mariadb save-environment

Calls POST /api/trpc/mariadb.saveEnvironment.

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

notploy mariadb save-external-port

Calls POST /api/trpc/mariadb.saveExternalPort.

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

Calls GET /api/trpc/mariadb.search.

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

Calls POST /api/trpc/mariadb.start.

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

notploy mariadb stop

Calls POST /api/trpc/mariadb.stop.

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

notploy mariadb update

Calls POST /api/trpc/mariadb.update.

notploy mariadb update --mariadbId <value> [options]
OptionTypeRequiredAllowed values
--mariadbId <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—

On this page