s.t.p.PeopleBroker(AccessBroker) : class documentation

Part of sasync.test.people View In Hierarchy Source for test.py Project Page for sAsync

Undocumented
Method __init__ Constructs an instance of me, optionally specifying parameters for an SQLAlchemy engine object that serves this instance only.
Method startup No summary
Method first No summary
Method everybody Undocumented
Method addPerson Undocumented
Method familyMembers Undocumented
Method fakeTransaction Undocumented
Method erroneousTransaction Undocumented
Method nestedTransaction Undocumented
Method makeFoobarTable Undocumented

Inherited from AccessBroker:

Instance Variable q A property-generated reference to a threaded task queue that is dedicated to my database connection.
Instance Variable connection The current SQLAlchemy connection object, if any yet exists. Generated by my connect method.
Class Method setup Constructs a global queue for all instances of me, returning a deferred that fires with it.
Method singleton Undocumented
Method connect Undocumented
Method waitUntilRunning Returns a Deferred that fires when the broker is running and ready for transactions.
Method callWhenRunning Calls the f-args-kw combo when the broker is running and ready for transactions.
Method table Instantiates a new table object, creating it in the transaction thread as needed.
Method shutdown Shuts down my database transaction functionality and threaded task queue, returning a Deferred that fires when all queued tasks are done and the shutdown is complete.
Method handleResult No summary
Method s Polymorphic method for working with select instances within a cached selection subcontext.
Method select Just returns an SQLAlchemy select object. You do everything else.
Method selex Supply columns as arguments and this method generates a select on the columns, yielding a placeholder object with the same attributes as the select object itself.
Method selectorator No summary
Method execute Does a connection.execute(*args, **kw) as a transaction, in my thread with my current connection, with all the usual handling of the ResultProxy.
Method sql Executes raw SQL as a transaction, in my thread with my current connection, with any rows of the result returned as a list.
Method produceRows No summary
Method deferToQueue Dispatches callable(*args, **kw) as a task via the like-named method of my asynchronous queue, returning a Deferred to its eventual result.
def __init__(self, url, **kw):

Constructs an instance of me, optionally specifying parameters for an SQLAlchemy engine object that serves this instance only.

def startup(self):

This method runs before the first transaction to start my synchronous task queue. Override it to get whatever pre-transaction stuff you have run in the main loop before a database engine/connection is created.

@transact
def first(self):

This method automatically runs as the first transaction after completion of startup. Override it to define table contents or whatever else you want as a first transaction that immediately follows your pre-transaction stuff.

You don't need to decorate the method with @transact, but it doesn't break anything if you do.

@transact
def everybody(self):
Undocumented
@transact
def addPerson(self, firstName, lastName):
Undocumented
@transact
def familyMembers(self, lastName):
Undocumented
@transact
def fakeTransaction(self, x):
Undocumented
@transact
def erroneousTransaction(self):
Undocumented
@transact
def nestedTransaction(self, x):
Undocumented
@transact
def makeFoobarTable(self):
Undocumented
API Documentation for sAsync, generated by pydoctor at 2018-08-29 10:51:15.