Type alias UpgradeServiceOptions

UpgradeServiceOptions: {
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}

Options for upgrading a service.

See databases.Database#upgradeService.

Type declaration

  • Optional configuration?: Record<string, any>

    An object mapping configuration option names to values.

    See also databases.Database#getServiceConfiguration.

  • Optional dependencies?: Record<string, string>

    An object mapping dependency aliases to mount points.

    See also databases.Database#getServiceDependencies.

  • Optional development?: boolean

    Whether the service should be installed in development mode.

    See also databases.Database#setServiceDevelopmentMode.

    Default: false

  • Optional force?: boolean

    Unless set to true, upgrading a service that does not already exist will fall back to installing the new service.

    Default: false

  • Optional legacy?: boolean

    Whether the service should be installed in legacy compatibility mode

    This overrides the engines option in the service manifest (if any).

    Default: false

  • Optional setup?: boolean

    Whether the "setup" script should be executed.

    Default: true

  • Optional teardown?: boolean

    Whether the existing service's "teardown" script should be executed prior to upgrading that service.

    Default: false

Settings

Theme