t.d.b.InteractionBase : class documentation

Encode the given string if necessary for printing to logs.

Log the query and any args or kwargs using twisted.python.log.msg if InteractionBase.LOG is True.

Simply makes same twisted.enterprise.dbapi.ConnectionPool.runOperation call, but with call to log function.

Simply makes same twisted.enterprise.dbapi.ConnectionPool.runQuery call, but with call to log function.

Execute given query within the given transaction. Also, makes call to log function.

Select rows from a table.

Parameters	tablename	The tablename to select rows from.
	id	If given, only the row with the given id will be returned (or None if not found).
	where	Conditional of the same form as the where parameter in DBObject.find.
	group	String describing how to group results.
	limit	Integer limit on the number of results. If this value is 1, then the result will be a single dictionary. Otherwise, if id is not specified, an array will be returned. This can also be a tuple, where the first value is the integer limit and the second value is an integer offset. In the case that an offset is specified, an array will always be returned.
	orderby	String describing how to order the results.
	select	Columns to select. Default is *.
Returns	If limit is 1 or id is set, then the result is one dictionary or None if not found. Otherwise, an array of dictionaries are returned.

Private callback for actual select query call.

Convert {'name': value} to an insert "values" string like "(%s,%s,%s)".

Insert a row into the given table.

Parameters	tablename	Table to insert a row into.
	vals	Values to insert. Should be a dictionary in the form of {'name': value, 'othername': value}.
	txn	If txn is given it will be used for the query, otherwise a typical runQuery will be used
Returns	A Deferred that calls a callback with the id of new row.

Escape column names for insertion into SQL statement.

Parameters	colnames	A List of string column names.
Returns	A List of string escaped column names.

Insert many values into a table.

Parameters	tablename	Table to insert a row into.
	vals	Values to insert. Should be a list of dictionaries in the form of {'name': value, 'othername': value}.
Returns	A Deferred.

Using the given txn, get the id of the last inserted row.

Returns

The integer id of the last inserted row.

Delete from the given tablename.

Parameters	where	Conditional of the same form as the where parameter in DBObject.find. If given, the rows deleted will be restricted to ones matching this conditional.
Returns	A Deferred.

Update a row into the given table.

Parameters	tablename	Table to insert a row into.
	args	Values to insert. Should be a dictionary in the form of {'name': value, 'othername': value}.
	where	Conditional of the same form as the where parameter in DBObject.find. If given, the rows updated will be restricted to ones matching this conditional.
	txn	If txn is given it will be used for the query, otherwise a typical runQuery will be used
Returns	A Deferred

Given a row from a database query (values), create a hash using keys from the table schema and values from the given values;

Parameters	txn	The transaction to use for the schema update query.
	values	A row from a db (as a list).
	tablename	Name of the table to fetch the schema for.

Get the schema (in the form of a list of column names) for a given tablename. Use the given transaction if specified.

Insert the given object into its table.

Returns

A Deferred that sends a callback the inserted object.

Update the given object's row in the object's table.

Returns

A Deferred that sends a callback the updated object.

Update the given object based on the information in the object's table.

Returns

A Deferred that sends a callback the updated object.

Convert a conditional to the form needed for a query using the DBAPI. For instance, for most DB's question marks in the query string have to be converted to %s. This will vary by database.

Parameters	where	Conditional of the same form as the where parameter in DBObject.find.
Returns	A conditional in the same form as the where parameter in DBObject.find.

Convert dictionary of arguments to form needed for DB update query. This method will vary by database driver.

Parameters	args	Values to insert. Should be a dictionary in the form of {'name': value, 'othername': value}.
Returns	A tuple of the form ('name = %s, othername = %s, ...', argvalues).

Get the number of rows in the given table (optionally, that meet the given where criteria).

Parameters	tablename	The tablename to count rows from.
	where	Conditional of the same form as the where parameter in DBObject.find.
Returns	A Deferred that returns the number of rows.