Package CedarBackup2 :: Package extend :: Module postgresql :: Class PostgresqlConfig
[show private | hide private]
[frames | no frames]

Type PostgresqlConfig

object --+
         |
        PostgresqlConfig


Class representing PostgreSQL configuration.

The PostgreSQL configuration information is used for backing up PostgreSQL databases.

The following restrictions exist on data in this class:
Method Summary
  __init__(self, user, compressMode, all, databases)
Constructor for the PostgresqlConfig class.
  __repr__(self)
Official string representation for class instance.
  __str__(self)
Informal string representation for class instance.
  __cmp__(self, other)
Definition of equals operator for this class.
  _getAll(self)
Property target used to get the 'all' flag.
  _getCompressMode(self)
Property target used to get the compress mode.
  _getDatabases(self)
Property target used to get the databases list.
  _getUser(self)
Property target used to get the user value.
  _setAll(self, value)
Property target used to set the 'all' flag.
  _setCompressMode(self, value)
Property target used to set the compress mode.
  _setDatabases(self, value)
Property target used to set the databases list.
  _setUser(self, value)
Property target used to set the user value.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Property Summary
  user: User to execute backup as.
  all: Indicates whether to back up all databases.
  databases: List of databases to back up.
  compressMode: Compress mode to be used for backed-up files.

Method Details

__init__(self, user=None, compressMode=None, all=None, databases=None)
(Constructor)

Constructor for the PostgresqlConfig class.
Parameters:
user - User to execute backup as.
compressMode - Compress mode for backed-up files.
all - Indicates whether to back up all databases.
databases - List of databases to back up.
Overrides:
__builtin__.object.__init__

__repr__(self)
(Representation operator)

Official string representation for class instance.
Overrides:
__builtin__.object.__repr__

__str__(self)
(Informal representation operator)

Informal string representation for class instance.
Overrides:
__builtin__.object.__str__

__cmp__(self, other)
(Comparison operator)

Definition of equals operator for this class.
Parameters:
other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

_getAll(self)

Property target used to get the 'all' flag.

_getCompressMode(self)

Property target used to get the compress mode.

_getDatabases(self)

Property target used to get the databases list.

_getUser(self)

Property target used to get the user value.

_setAll(self, value)

Property target used to set the 'all' flag. No validations, but we normalize the value to True or False.

_setCompressMode(self, value)

Property target used to set the compress mode. If not None, the mode must be one of the values in VALID_COMPRESS_MODES.
Raises:
ValueError - If the value is not valid.

_setDatabases(self, value)

Property target used to set the databases list. Either the value must be None or each element must be a string.
Raises:
ValueError - If the value is not a string.

_setUser(self, value)

Property target used to set the user value.

Property Details

user

User to execute backup as.
Get Method:
_getUser(self)
Set Method:
_setUser(self, value)

all

Indicates whether to back up all databases.
Get Method:
_getAll(self)
Set Method:
_setAll(self, value)

databases

List of databases to back up.
Get Method:
_getDatabases(self)
Set Method:
_setDatabases(self, value)

compressMode

Compress mode to be used for backed-up files.
Get Method:
_getCompressMode(self)
Set Method:
_setCompressMode(self, value)

Generated by Epydoc 2.1 on Mon Sep 4 13:49:33 2006 http://epydoc.sf.net