Package qm :: Package test :: Package classes :: Module sql_result_stream :: Class SQLResultReader
[hide private]
[frames] | no frames]

Class SQLResultReader

source code

            object --+        
                     |        
   extension.Extension --+    
                         |    
result_reader.ResultReader --+
                             |
            object --+       |
                     |       |
   extension.Extension --+   |
                         |   |
             _SQLConnected --+
                             |
                            SQLResultReader

A 'SQLResultReader' reads result in from an SQL database.

This class currently supports PostgreSQL only.

Nested Classes [hide private]

Inherited from extension.Extension: Type, __metaclass__

Instance Methods [hide private]
 
__init__(self, arguments=None, **args)
Construct a new 'Extension'.
source code
 
_LoadAnnotations(self) source code
 
GetAnnotations(self)
Return this run's dictionary of annotations.
source code
 
_SetupResultCursors(self) source code
 
GetResult(self)
Return the next 'Result' from this reader.
source code

Inherited from result_reader.ResultReader: __iter__

Inherited from extension.Extension: GetClassName, GetExplicitArguments, MakeDomDocument, MakeDomElement, Write, __getattr__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  arguments = [<<class 'qm.fields.IntegerField'> run_id>]
A list of the arguments to the extension class.
  _argument_dictionary = {'connection': <<class 'qm.fields.Pytho...
A map from argument names to 'Field' instances.
  _argument_list = [<<class 'qm.fields.TextField'> db_module>, <...
A list of all the 'Field's in this class.
  run_id = 0

Inherited from result_reader.ResultReader: kind

Inherited from _SQLConnected: connection, db_module, db_name

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, arguments=None, **args)
(Constructor)

source code 

Construct a new 'Extension'.

'args': Keyword arguments providing values for Extension parameters. The values should be appropriate for the corresponding fields. Derived classes must pass along any unrecognized keyword arguments to this method so that additional arguments can be added in the future without necessitating changes to derived classes.

This method will place all of the arguments into this objects instance dictionary.

Derived classes may override this method, but should call this method during their processing.

Overrides: object.__init__
(inherited documentation)

GetAnnotations(self)

source code 

Return this run's dictionary of annotations.

Overrides: result_reader.ResultReader.GetAnnotations
(inherited documentation)

GetResult(self)

source code 

Return the next 'Result' from this reader.

returns -- A 'Result', or 'None' if there are no more results.

Overrides: result_reader.ResultReader.GetResult
(inherited documentation)

Class Variable Details [hide private]

_argument_dictionary

A map from argument names to 'Field' instances.

A map from the names of arguments for this class to the corresponding 'Field'.

Value:
{'connection': <<class 'qm.fields.PythonField'> connection>,
 'db_module': <<class 'qm.fields.TextField'> db_module>,
 'db_name': <<class 'qm.fields.TextField'> db_name>,
 'run_id': <<class 'qm.fields.IntegerField'> run_id>}

_argument_list

A list of all the 'Field's in this class.

This list combines the complete list of 'arguments'. 'Field's appear in the order reached by a pre-order breadth-first traversal of the hierarchy, starting from the most derived class.

Value:
[<<class 'qm.fields.TextField'> db_module>,
 <<class 'qm.fields.PythonField'> connection>,
 <<class 'qm.fields.TextField'> db_name>,
 <<class 'qm.fields.IntegerField'> run_id>]