Exceptions

Exception hierarchy

• Error

  • SettingsError

  • NotFound

    • InstanceNotFound

    • RoleNotFound

    • DatabaseNotFound

  • InvalidVersion

  • InstanceStateError

  • CommandError

  • SystemError

    • FileExistsError

    • FileNotFoundError

  • ConfigurationError

Exception classes

exception pglift.exceptions.Error(message)

Base class for operational error.

Parameters:

message (str)

Return type:

None

exception pglift.exceptions.SettingsError(message)

An error about settings.

Parameters:

message (str)

Return type:

None

exception pglift.exceptions.NotFound(name, hint=None)

Base class for errors when an object with name is not found.

Parameters:

• name (str)

• hint (str | None)

Return type:

None

abstract property object_type: str

Type of object that’s not found.

exception pglift.exceptions.InstanceNotFound(name, hint=None)

PostgreSQL instance not found or mis-configured.

Parameters:

• name (str)

• hint (str | None)

Return type:

None

exception pglift.exceptions.RoleNotFound(name, hint=None)

PostgreSQL role not found.

Parameters:

• name (str)

• hint (str | None)

Return type:

None

exception pglift.exceptions.DatabaseNotFound(name, hint=None)

PostgreSQL database not found.

Parameters:

• name (str)

• hint (str | None)

Return type:

None

exception pglift.exceptions.InvalidVersion(message)

Invalid PostgreSQL version.

Parameters:

message (str)

Return type:

None

exception pglift.exceptions.InstanceStateError(message)

Unexpected instance state.

Parameters:

message (str)

Return type:

None

exception pglift.exceptions.CommandError(returncode, cmd, stdout=None, stderr=None)

Execution of a command, in a subprocess, failed.

Parameters:

• returncode (int)

• cmd (Sequence[str])

• stdout (str | None)

• stderr (str | None)

Return type:

None

exception pglift.exceptions.SystemError(message)

Error (unexpected state) on target system.

Parameters:

message (str)

Return type:

None

exception pglift.exceptions.FileExistsError(message)

Parameters:

message (str)

Return type:

None

exception pglift.exceptions.FileNotFoundError(message)

Parameters:

message (str)

Return type:

None

exception pglift.exceptions.ConfigurationError(path, message)

A configuration entry is missing or invalid.

Parameters:

• path (PurePath)

• message (str)

Return type:

None

path

configuration file path

exception pglift.exceptions.DependencyError(message)

Requested operation failed to due some database dependency.

Parameters:

message (str)

Return type:

None