Home | Trees | Index | Help |
|
---|
Package CedarBackup2 :: Package extend :: Module mysql :: Class LocalConfig |
|
object
--+
|
LocalConfig
Class representing this extension's configuration document.
This is not a general-purpose configuration object like the main Cedar Backup configuration object. Instead, it just knows how to parse and emit MySQL-specific configuration values. Third parties who need to read and write configuration related to this extension should access it through the constructor,validate
and addConfig
methods.
Note: Lists within this class are "unordered" for equality comparisons.
Method Summary | |
---|---|
Initializes a configuration object. | |
Official string representation for class instance. | |
Informal string representation for class instance. | |
Definition of equals operator for this class. | |
Validates configuration represented by the object. | |
Adds a <mysql> configuration section as the next child of a parent. | |
Property target used to get the mysql configuration value. | |
Parses a mysql configuration section. (Static method) | |
Internal method to parse an XML string into the object. | |
Property target used to set the mysql configuration value. | |
Inherited from object | |
x.__delattr__('name') <==> del x.name | |
x.__getattribute__('name') <==> x.name | |
x.__hash__() <==> hash(x) | |
T.__new__(S, ...) -> a new object with type S, a subtype of T | |
helper for pickle | |
helper for pickle | |
x.__setattr__('name', value) <==> x.name = value |
Property Summary | |
---|---|
mysql : Mysql configuration in terms of a MysqlConfig object. |
Instance Method Details |
---|
__init__(self,
xmlData=None,
xmlPath=None,
validate=True)
|
__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. Lists within this
class are "unordered" for equality comparisons.
|
validate(self)Validates configuration represented by the object. The compress mode must be filled in. Then, if the 'all' flag is set, no databases are allowed, and if the 'all' flag is not set, at least one database is required.
|
addConfig(self, xmlDom, parentNode)Adds a <mysql> configuration section as the next child of a parent. Third parties should use this function to write configuration related to this extension. We add the following fields to the document:user //cb_config/mysql/user password //cb_config/mysql/password compressMode //cb_config/mysql/compress_mode all //cb_config/mysql/allWe also add groups of the following items, one list element per item: database //cb_config/mysql/database
|
_getMysql(self)Property target used to get the mysql configuration value. |
_parseXmlData(self, xmlData)Internal method to parse an XML string into the object. This method parses the XML document into a DOM tree (xmlDom ) and then calls a static method to parse the mysql
configuration section.
|
_setMysql(self, value)Property target used to set the mysql configuration value. If notNone , the value must be a MysqlConfig
object.
|
Static Method Details |
---|
_parseMysql(parentNode)Parses a mysql configuration section. We read the following fields:user //cb_config/mysql/user password //cb_config/mysql/password compressMode //cb_config/mysql/compress_mode all //cb_config/mysql/allWe also read groups of the following item, one list element per item: databases //cb_config/mysql/database
|
Property Details |
---|
mysqlMysql configuration in terms of aMysqlConfig object.
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Mon Dec 18 22:53:31 2006 | http://epydoc.sf.net |