rattail.db.model

Core Data Models

class rattail.db.model.core.ModelBase(**kwargs)

Base class for all data models.

model_title

Optionally set this to a “humanized” version of the model name, for display in templates etc. Default value will be guessed from the model class name, e.g. ‘Product’ => “Products” and ‘CustomerOrder’ => “Customer Order”.

model_title_plural

Optionally set this to a “humanized” version of the plural model name, for display in templates etc. Default value will be guessed from the model class name, e.g. ‘Product’ => “Products” and ‘CustomerOrder’ => “Customer Orders”.

class rattail.db.model.core.Setting(**kwargs)

Represents a “raw” config setting stored within the database.

class rattail.db.model.core.Change(**kwargs)

Represents a changed (or deleted) record, which is pending synchronization to another database.

instance_uuid

Key for the object which was changed/etc. In most cases this will simply be the object’s UUID value, hence the column name. However in some cases it may contain something else; this is often needed in order to properly sync deletions to non-rattail systems, where the UUID is meaningless.

object_key

Synonym to the instance_uuid column. New code should perhaps reference the attribute by this (object_key) name instead, as the instance_uuid column may be renamed at some point, to this name.

Data Models for Contact Info

class rattail.db.model.contact.ContactMixin

Mixin which provides some useful methods for “contact” models, i.e. those which can play “parent” to email, phone and address records.

add_address(**kwargs)

Add a new “address” record to the contact.

add_email(**kwargs)

Add a new “email” record to the contact.

add_phone(**kwargs)

Add a new “phone” record to the contact.

first_address(**kwargs)

Return the first available address record for the contact.

first_email(invalid=False, **kwargs)

Return the first available email record for the contact.

Parameters:

invalid – If true, then this may return an email marked invalid; if false then only valid email will be returned.

first_email_address(invalid=False, **kwargs)

Return the first available email address for the contact.

first_phone(**kwargs)

Return the first available phone record for the contact.

first_phone_number(**kwargs)

Return the first available phone number for the contact.

make_address(**kwargs)

Make a new “address” record for the contact.

make_email(**kwargs)

Make a new “email” record for the contact.

make_phone(**kwargs)

Make a new “phone” record for the contact.

remove_address(address, **kwargs)

Remove the given address record from the contact.

remove_email(email, **kwargs)

Remove the given email record from the contact.

remove_phone(phone, **kwargs)

Remove the given phone record from the contact.

set_primary_address(address, flush=True)

Will re-arrange the contact’s address records as needed to ensure that the given address record is “primary” - i.e. first in the list.

set_primary_email(email, flush=True)

Will re-arrange the contact’s email records as needed to ensure that the given email record is “primary” - i.e. first in the list.

set_primary_phone(phone, flush=True)

Will re-arrange the contact’s phone records as needed to ensure that the given phone record is “primary” - i.e. first in the list.

class rattail.db.model.contact.EmailAddress(**kwargs)

Represents an email address associated with a contactable entity.

invalid

Flag indicating whether the email address is known to be invalid. Defaults to NULL, meaning the validity is “not known”.

class rattail.db.model.contact.MailingAddress(**kwargs)

Represents a physical / mailing address associated with a contactable entity.

class rattail.db.model.contact.PhoneNumber(**kwargs)

Represents a phone (or fax) number associated with a contactable entity.

Todo

Geez a lot of work left here…