RPKI Engine  1.0
Public Member Functions | Public Attributes | Static Public Attributes
rpki::sql::sql_persistent Class Reference
Inheritance diagram for rpki::sql::sql_persistent:
Inheritance graph
Collaboration diagram for rpki::sql::sql_persistent:
Collaboration graph

List of all members.

Public Member Functions

def sql_decode
def sql_delete
def sql_delete_hook
def sql_encode
def sql_fetch
def sql_fetch_all
def sql_fetch_hook
def sql_fetch_where
def sql_fetch_where1
def sql_init
def sql_insert_hook
def sql_is_dirty
def sql_mark_clean
def sql_mark_deleted
def sql_mark_dirty
def sql_store
def sql_update_hook

Public Attributes

 gctx

Static Public Attributes

 sql_debug = False
 Enable logging of SQL actions.
 sql_deleted = False
 Whether our cached copy of this object has been deleted.
 sql_in_db = False
 Whether this object is already in SQL or not.

Detailed Description

Mixin for persistent class that needs to be stored in SQL.

Definition at line 141 of file sql.py.


Member Function Documentation

def rpki::sql::sql_persistent::sql_decode (   self,
  vals 
)
def rpki::sql::sql_persistent::sql_delete (   self)
def rpki::sql::sql_persistent::sql_delete_hook (   self)
Customization hook.

Reimplemented in rpki::rpkid::roa_obj.

Definition at line 354 of file sql.py.

Referenced by sql_delete().

Here is the caller graph for this function:

def rpki::sql::sql_persistent::sql_encode (   self)
Convert object attributes into a dict for use with canned SQL
queries.  This is a default version that assumes a one-to-one
mapping between column names in SQL and attribute names in Python.
If you need something fancier, override this.

Definition at line 309 of file sql.py.

References rpki::publication::config_elt::sql_template, rpki::publication::client_elt::sql_template, rpki::left_right::self_elt::sql_template, rpki::rpkid::ca_obj::sql_template, rpki::rpkid::ca_detail_obj::sql_template, rpki::left_right::bsc_elt::sql_template, rpki::left_right::repository_elt::sql_template, rpki::left_right::parent_elt::sql_template, rpki::left_right::child_elt::sql_template, rpki::rpkid::child_cert_obj::sql_template, rpki::rpkid::revoked_cert_obj::sql_template, rpki::rpkid::roa_obj::sql_template, and rpki::rpkid::ghostbuster_obj::sql_template.

Referenced by sql_store().

Here is the caller graph for this function:

def rpki::sql::sql_persistent::sql_fetch (   cls,
  gctx,
  id 
)
Fetch one object from SQL, based on its primary key.

Since in this one case we know that the primary index is also the
cache key, we check for a cache hit directly in the hope of
bypassing the SQL lookup entirely.

This method is usually called via a one-line class-specific
wrapper.  As a convenience, we also accept an id of None, and just
return None in this case.

Definition at line 162 of file sql.py.

Referenced by rpki::publication::config_elt::serve_fetch_one_maybe(), and rpki::publication::config_elt::serve_set().

Here is the caller graph for this function:

def rpki::sql::sql_persistent::sql_fetch_all (   cls,
  gctx 
)
Fetch all objects of this type from SQL.

Definition at line 200 of file sql.py.

Referenced by rpki::publication::client_elt::serve_fetch_all(), and rpki::left_right::self_elt::serve_fetch_all().

Here is the caller graph for this function:

def rpki::sql::sql_persistent::sql_fetch_hook (   self)
Customization hook.

Reimplemented in rpki::rpkid::roa_obj.

Definition at line 335 of file sql.py.

def rpki::sql::sql_persistent::sql_fetch_where (   cls,
  gctx,
  where,
  args = None,
  also_from = None 
)
Fetch objects of this type matching an arbitrary SQL WHERE expression.

Definition at line 207 of file sql.py.

Referenced by rpki::left_right::data_elt::serve_fetch_all().

Here is the caller graph for this function:

def rpki::sql::sql_persistent::sql_fetch_where1 (   cls,
  gctx,
  where,
  args = None,
  also_from = None 
)
Fetch one object from SQL, based on an arbitrary SQL WHERE expression.

Definition at line 185 of file sql.py.

Referenced by rpki::left_right::data_elt::serve_fetch_one_maybe(), and rpki::publication::client_elt::serve_fetch_one_maybe().

Here is the caller graph for this function:

def rpki::sql::sql_persistent::sql_init (   cls,
  gctx,
  row,
  key 
)
Initialize one Python object from the result of a SQL query.

Definition at line 234 of file sql.py.

def rpki::sql::sql_persistent::sql_insert_hook (   self)
Customization hook.

Reimplemented in rpki::rpkid::roa_obj.

Definition at line 341 of file sql.py.

Referenced by sql_store().

Here is the caller graph for this function:

def rpki::sql::sql_persistent::sql_is_dirty (   self)
def rpki::sql::sql_persistent::sql_mark_clean (   self)
Mark this object as not needing to be written back to SQL.

Definition at line 252 of file sql.py.

Referenced by sql_delete(), and sql_store().

Here is the caller graph for this function:

def rpki::sql::sql_persistent::sql_mark_deleted (   self)
Mark this object as needing to be deleted in SQL.

Definition at line 264 of file sql.py.

References sql_deleted, and sql_mark_dirty().

Referenced by rpki::rpkid::roa_obj::revoke(), and rpki::rpkid::ghostbuster_obj::revoke().

Here is the call graph for this function:

Here is the caller graph for this function:

def rpki::sql::sql_persistent::sql_mark_dirty (   self)
def rpki::sql::sql_persistent::sql_store (   self)
def rpki::sql::sql_persistent::sql_update_hook (   self)
Customization hook.

Definition at line 347 of file sql.py.

Referenced by sql_store().

Here is the caller graph for this function:


Member Data Documentation

Reimplemented in rpki::rpkid::ghostbuster_obj, rpki::rpkid::roa_obj, rpki::rpkid::revoked_cert_obj, rpki::rpkid::child_cert_obj, rpki::rpkid::ca_detail_obj, and rpki::rpkid::ca_obj.

Definition at line 236 of file sql.py.

Referenced by rpki::left_right::data_elt::bsc(), rpki::left_right::self_elt::bscs(), rpki::left_right::child_elt::ca_from_class_name(), rpki::left_right::repository_elt::call_pubd(), rpki::left_right::parent_elt::cas(), rpki::left_right::self_elt::children(), rpki::left_right::bsc_elt::children(), rpki::left_right::child_elt::fetch_child_certs(), rpki::left_right::self_elt::ghostbusters(), rpki::left_right::data_elt::make_reply_clone_hook(), rpki::left_right::self_elt::parents(), rpki::left_right::bsc_elt::parents(), rpki::left_right::repository_elt::parents(), rpki::left_right::child_elt::parents(), rpki::left_right::parent_elt::query_up_down(), rpki::left_right::self_elt::repositories(), rpki::left_right::bsc_elt::repositories(), rpki::left_right::parent_elt::repository(), rpki::left_right::self_elt::roas(), rpki::left_right::data_elt::self(), rpki::left_right::list_published_objects_elt::serve_dispatch(), rpki::left_right::list_received_resources_elt::serve_dispatch(), rpki::left_right::data_elt::serve_fetch_all(), rpki::publication::client_elt::serve_fetch_all(), rpki::left_right::self_elt::serve_fetch_all(), rpki::left_right::data_elt::serve_fetch_one_maybe(), rpki::publication::config_elt::serve_fetch_one_maybe(), rpki::publication::client_elt::serve_fetch_one_maybe(), rpki::left_right::self_elt::serve_fetch_one_maybe(), rpki::left_right::data_elt::serve_pre_save_hook(), rpki::publication::config_elt::serve_set(), rpki::left_right::child_elt::serve_up_down(), sql_delete(), sql_is_dirty(), sql_store(), rpki::left_right::self_elt::update_ghostbusters(), rpki::left_right::self_elt::update_roas(), and rpki::publication::publication_object_elt::uri_to_filename().

Enable logging of SQL actions.

Definition at line 159 of file sql.py.

Referenced by sql_delete(), and sql_store().

Whether our cached copy of this object has been deleted.

Definition at line 154 of file sql.py.

Referenced by sql_mark_deleted().

Whether this object is already in SQL or not.

Definition at line 149 of file sql.py.

Referenced by sql_delete(), and sql_store().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Properties