---
name: "sqitch-upgrade"
section: "3pm"
platform: "linux"
package: "sqitch"
version: "1.5.2-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/sqitch-upgrade"
---

# sqitch-upgrade(3pm)

Upgrade the registry to the current version

## Name

sqitch-upgrade - Upgrade the registry to the current version

## Synopsis

```
  sqitch upgrade [options] [<database>]
```

## Description

Upgrades the Sqitch registry for a database. That is, it makes sure that the schema the Sqitch uses for its registry is up-to-date. This will occasionally be necessary when new features are added to Sqitch that require registry schema changes.

The `"<database>"` parameter specifies the database to which to connect, and may also be specified as the `"--target"` option. It can be target name, a URI, an engine name, or plan file path.

## Options

- "-t"

  - "--target"

  The target database to which to connect. This option can be either a URI or the name of a target in the configuration.

- "--registry"

  ```
    sqitch upgrade --registry registry
  ```

  The name of the Sqitch registry schema or database in which sqitch stores its own data.

- "--db-client"

  - "--client"

  ```
    sqitch upgrade --client /usr/local/pgsql/bin/psql
  ```

  Path to the command-line client for the database engine. Defaults to a client in the current path named appropriately for the database engine.

- "-d"

  - "--db-name"

  ```
    sqitch upgrade --db-name widgets
    sqitch upgrade -d bricolage
  ```

  Name of the database. In general, targets and URIs are preferred, but this option can be used to override the database name in a target.

- "-u"

  - "--db-user"

  - "--db-username"

  ```
    sqitch upgrade --db-username root
    sqitch upgrade --db-user postgres
    sqitch upgrade -u Mom
  ```

  User name to use when connecting to the database. Does not apply to all engines. In general, targets and URIs are preferred, but this option can be used to override the user name in a target.

- "-h"

  - "--db-host"

  ```
    sqitch upgrade --db-host db.example.com
    sqitch upgrade -h appdb.example.net
  ```

  Host name to use when connecting to the database. Does not apply to all engines. In general, targets and URIs are preferred, but this option can be used to override the host name in a target.

- "-p"

  - "--db-port"

  ```
    sqitch upgrade --db-port 7654
    sqitch upgrade -p 5431
  ```

  Port number to connect to. Does not apply to all engines. In general, targets and URIs are preferred, but this option can be used to override the port in a target.

## Sqitch

Part of the sqitch suite.