> ## Documentation Index > Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # PlanetScale CLI commands: pgbouncer export const PlatformAvailability = ({current, vitess, postgres}) => { const docsHref = path => { if (!path) return path; const normalized = path.startsWith('/') ? path : `/${path}`; return normalized; }; const labels = { vitess: 'Vitess', postgres: 'Postgres' }; if (current === 'both') { return

Vitess and Postgres

; } const hasVitess = current === 'vitess' || Boolean(vitess); const hasPostgres = current === 'postgres' || Boolean(postgres); const only = !(hasVitess && hasPostgres); const engines = []; if (current === 'vitess' || current === 'postgres') engines.push(current); if (hasVitess && current !== 'vitess') engines.push('vitess'); if (hasPostgres && current !== 'postgres') engines.push('postgres'); return

{engines.map(engine => { const isCurrent = current === engine; const href = docsHref(engine === 'vitess' ? vitess : postgres); const label = only ? `${labels[engine]} only` : labels[engine]; const state = isCurrent || !href ? 'current' : 'link'; if (isCurrent || !href) { return {label} ; } return {label} ; })}

; }; ## Getting Started Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you've installed the `pscale` CLI, you can interact with PlanetScale and manage your databases straight from the command line. ## The `pgbouncer` command Manage [dedicated PgBouncers](/docs/postgres/connecting/pgbouncer) for a Postgres database branch. Dedicated PgBouncers run separately from the database nodes and provide connection pooling for primary or replica traffic. This is distinct from the local PgBouncer on port 6432 and from `pgbouncer.*` parameters on `pscale branch resize`. This command is only available for PostgreSQL databases. **`--org` is required.** **Usage:** ```bash theme={null} pscale pgbouncer ``` ### Available sub-commands | **Sub-command** | **Sub-command flags** | **Description** | **Product** | | :--------------------------------------------------- | :-------------------------------------------------------------------------------------- | :------------------------------------------- | :---------- | | `list ` | | List dedicated PgBouncers for a branch | Postgres | | `show ` | | Show a dedicated PgBouncer | Postgres | | `create ` | `--target`\*, `--name`, `--size`, `--replicas-per-cell` | Create a dedicated PgBouncer | Postgres | | `resize ` | `--size`, `--replicas-per-cell`, `--target`, `--parameters`, `--wait`, `--wait-timeout` | Change size, replicas, target, or parameters | Postgres | | `resize status ` | | Show the latest resize request | Postgres | | `resize cancel ` | | Cancel unfinished resize requests | Postgres | | `delete ` | `--force` | Delete a dedicated PgBouncer | Postgres | > \* *Flag is required* #### Sub-command flag descriptions | **Sub-command flag** | **Description** | **Applicable sub-commands** | | :-------------------- | :--------------------------------------------------------------------------------------------------------------- | :-------------------------- | | `--name` | Name for the PgBouncer. Optional on create; auto-generated if omitted. | `create` | | `--target` | Traffic target: `primary`, `replica`, or `replica_az_affinity`. Required on create. | `create`, `resize` | | `--size` | PgBouncer size SKU (for example `PGB_10`). | `create`, `resize` | | `--replicas-per-cell` | Number of PgBouncer replica servers per cell. | `create`, `resize` | | `--parameters` | Set a PgBouncer parameter as `namespace.name=value` (for example `pgbouncer.default_pool_size=100`). Repeatable. | `resize` | | `--wait` | Wait for the resize request to complete before returning. | `resize` | | `--wait-timeout` | Maximum time to wait with `--wait`. Default: `10m`. | `resize` | | `--force` | Delete a PgBouncer without confirmation. | `delete` | ### Available flags | **Flag** | **Description** | | :-------------------------- | :--------------------------------------------------- | | `-h`, `--help` | View help for `pgbouncer` command | | `--org ` | The organization for the current user (**required**) | ### Global flags | **Command** | **Description** | | :------------------------------ | :----------------------------------------------------------------------------------- | | `--api-token ` | The API token to use for authenticating against the PlanetScale API. | | `--api-url ` | The base URL for the PlanetScale API. Default is `https://api.planetscale.com/`. | | `--config ` | Config file. Default is `$HOME/.config/planetscale/pscale.yml`. | | `--debug` | Enable debug mode. | | `-f`, `--format ` | Show output in a specific format. Possible values: `human` (default), `json`, `csv`. | | `--no-color` | Disable color output. | | `--service-token ` | The service token for authenticating. | | `--service-token-id ` | The service token ID for authenticating. | ## Examples ```bash theme={null} pscale pgbouncer list --org pscale pgbouncer create --org --target replica --size PGB_10 pscale pgbouncer show --org pscale pgbouncer resize --org --size PGB_20 pscale pgbouncer resize status --org pscale pgbouncer delete --org --force ``` ## Related documentation ## Need help? Get help from [the PlanetScale Support team](https://planetscale.com/contact?initial=support), or join our [Discord community](https://pscale.link/community) to see how others are using PlanetScale.