pscale connect <mydatabase> <mybranch>
Create a secure connection to a database and branch for a local client
Arguments
| Name | Description |
|---|
mydatabase | |
mybranch | |
Options
| Name | Description |
|---|
--help, -h | Show help |
--execute <string> | Run this command after successfully connecting to the database |
--execute-env-url <string> | Environment variable name that contains the exposed Database URL. (default "DATABASE_URL") |
--execute-protocol <string> | Protocol for the exposed URL (by default DATABASE_URL) value in execute (default "mysql2") |
--host <string> | Local host to bind and listen for connections (default "127.0.0.1") |
--org <string> | The organization for the current user |
--port <string> | Local port to bind and listen for connections (default "3306") |
--remote-addr <string> | PlanetScale Database remote network address. By default the remote address is populated automatically from the PlanetScale API |
--help, -h | Show help |
--api-token <string> | The API token to use for authenticating against the PlanetScale API |
--api-url <string> | The base URL for the PlanetScale API. (default "https://api.planetscale.com/") |
--config <string> | Config file (default is $HOME/.config/planetscale/pscale.yml) |
--debug | Enable debug mode |
--format, -f <string> | Show output in a specific format. Possible values: [human, json, csv] (default "human") |
--no-color | Disable color output |
--service-token <string> | Service Token for authenticating |
--service-token-name <string> | The Service Token name for authenticating |