Home | Trees | Index | Help |
|
---|
Package openid :: Package store :: Module sqlstore :: Class SQLStore |
|
object
--+ |OpenIDStore
--+ | SQLStore
MySQLStore
,
PostgreSQLStore
,
SQLiteStore
This is the parent class for the SQL stores, which contains the logic common to all of the SQL stores.
The table names used are determined by the class variables
and associations_table
. To change the name of
the tables used, pass new table names into the constructor.nonces_table
To create the tables with the proper schema, see the
method.createTables
This class shouldn't be used directly. Use one of its subclasses instead, as those contain the code necessary to use a specific database.
All methods other than__init__
and createTables
should be considered
implementation details.
Method Summary | |
---|---|
This creates a new SQLStore instance. | |
This method creates the database tables necessary for this store to work. | |
__getattr__(self,
attr)
| |
Convert a blob as returned by the SQL engine into a str object. | |
Convert a str object into the necessary object for storing in the database as a blob. | |
int |
Remove expired associations from the store. |
int |
Remove expired nonces from the store. |
Get the most recent association that has been set for this server URL and handle. | |
Remove the association for the given server URL and handle, returning whether the association existed at all. | |
Set the association for the server URL. | |
txn_cleanupAssociations(self)
| |
txn_cleanupNonces(self)
| |
This method creates the database tables necessary for this store to work. | |
Get the most recent association that has been set for this server URL and handle. | |
Remove the association for the given server URL and handle, returning whether the association existed at all. | |
Set the association for the server URL. | |
Return whether this nonce is present, and if it is, then remove it from the set. | |
Return whether this nonce is present, and if it is, then remove it from the set. | |
Inherited from OpenIDStore :
cleanup
Inherited from object :
__delattr__ ,
__getattribute__ ,
__hash__ ,
__new__ ,
__reduce__ ,
__reduce_ex__ ,
__repr__ ,
__setattr__ ,
__str__
|
Class Variable Summary | |
---|---|
str |
associations_table : This is the default name of the table to keep associations in |
str |
nonces_table : This is the default name of the table to keep nonces in. |
Method Details |
---|
__init__(self,
conn,
associations_table=None,
nonces_table=None)
This creates a new SQLStore instance. It requires an established
database connection be given to it, and it allows overriding the
default table names.
|
createTables(self, *args, **kwargs)This method creates the database tables necessary for this store to work. It should not be called if the tables already exist. |
blobDecode(self, blob)Convert a blob as returned by the SQL engine into a str object. str -> str |
blobEncode(self, s)Convert a str object into the necessary object for storing in the database as a blob. |
cleanupAssociations(self, *args, **kwargs)Remove expired associations from the store. This method is not called in the normal operation of the library. It provides a way for store admins to keep their storage from filling up with expired data.
|
cleanupNonces(self, *args, **kwargs)Remove expired nonces from the store. Discards any nonce from storage that is old enough that its
timestamp would not pass
|
getAssociation(self, *args, **kwargs)Get the most recent association that has been set for this server URL and handle. str -> NoneType or Association |
removeAssociation(self, *args, **kwargs)Remove the association for the given server URL and handle, returning whether the association existed at all. (str, str) -> bool |
storeAssociation(self, *args, **kwargs)Set the association for the server URL. Association -> NoneType |
txn_createTables(self)This method creates the database tables necessary for this store to work. It should not be called if the tables already exist. |
txn_getAssociation(self, server_url, handle=None)Get the most recent association that has been set for this server URL and handle. str -> NoneType or Association |
txn_removeAssociation(self, server_url, handle)Remove the association for the given server URL and handle, returning whether the association existed at all. (str, str) -> bool |
txn_storeAssociation(self, server_url, association)Set the association for the server URL. Association -> NoneType |
txn_useNonce(self, server_url, timestamp, salt)Return whether this nonce is present, and if it is, then remove it from the set. str -> bool |
useNonce(self, *args, **kwargs)Return whether this nonce is present, and if it is, then remove it from the set. str -> bool
|
Class Variable Details |
---|
associations_tableThis is the default name of the table to keep associations in
|
nonces_tableThis is the default name of the table to keep nonces in.
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Fri Jun 27 15:48:22 2008 | http://epydoc.sf.net |