The cinder.objects.base Module

The cinder.objects.base Module

Cinder common internal object model

class CinderComparableObject

Bases: oslo_versionedobjects.base.ComparableVersionedObject

class CinderObject(context=None, **kwargs)

Bases: oslo_versionedobjects.base.VersionedObject


Returns a dict of changed fields with tz unaware datetimes.

Any timezone aware datetime field will be converted to UTC timezone and returned as timezone unaware datetime.

This will allow us to pass these fields directly to a db update method as they can’t have timezone information.

obj_make_compatible(primitive, target_version)
class CinderObjectDictCompat

Bases: oslo_versionedobjects.base.VersionedObjectDictCompat

Mix-in to provide dictionary key access compat.

If an object needs to support attribute access using dictionary items instead of object attributes, inherit from this class. This should only be used as a temporary measure until all callers are converted to use modern attribute access.

NOTE(berrange) This class will eventually be deleted.

get(key, value=<class 'oslo_versionedobjects.base._NotSpecifiedSentinel'>)

For backwards-compatibility with dict-based objects.

NOTE(danms): May be removed in the future.

class CinderObjectRegistry

Bases: oslo_versionedobjects.base.VersionedObjectRegistry

registration_hook(cls, index)

Hook called when registering a class.

This method takes care of adding the class to cinder.objects namespace.

Should registering class have a method called cinder_ovo_cls_init it will be called to support class initialization. This is convenient for all persistent classes that need to register their models.

class CinderObjectSerializer(version_cap=None)

Bases: oslo_versionedobjects.base.VersionedObjectSerializer


alias of CinderObject

serialize_entity(context, entity)
class CinderObjectVersionsHistory

Bases: dict

Helper class that maintains objects version history.

Current state of object versions is aggregated in a single version number that explicitly identifies a set of object versions. That way a service is able to report what objects it supports using a single string and all the newer services will know exactly what that mean for a single object.

add(ver, updates)
class CinderPersistentObject

Bases: object

Mixin class for Persistent objects.

This adds the fields that we use in common for all persistent objects.

class Case(whens, value=None, else_=None)

Bases: object

Class for conditional value selection for conditional_update.

class Not(value, field=None, auto_none=True)

Bases: cinder.db.api.Condition

Class for negated condition values for conditional_update.

By default NULL values will be treated like Python treats None instead of how SQL treats it.

So for example when values are (1, 2) it will evaluate to True when we have value 3 or NULL, instead of only with 3 like SQL does.

get_filter(model, field=None)
as_read_deleted(*args, **kwds)

Context manager to make OVO with modified read deleted context.

This temporarily modifies the context embedded in an object to have a different read_deleted parameter.

Parameter mode accepts most of the same parameters as our model_query DB method. We support ‘yes’, ‘no’, and ‘only’.


with obj.as_read_deleted():
if obj.status = ‘deleted’:
classmethod cinder_ovo_cls_init()

This method is called on OVO registration and sets the DB model.

conditional_update(values, expected_values=None, filters=(), save_all=False, session=None, reflect_changes=True, order=None)

Compare-and-swap update.

A conditional object update that, unlike normal update, will SAVE the contents of the update to the DB.

Update will only occur in the DB and the object if conditions are met.

If no expected_values are passed in we will default to make sure that all fields have not been changed in the DB. Since we cannot know the original value in the DB for dirty fields in the object those will be excluded.

We have 4 different condition types we can use in expected_values:
  • Equality: {‘status’: ‘available’}
  • Inequality: {‘status’: vol_obj.Not(‘deleting’)}
  • In range: {‘status’: [‘available’, ‘error’]
  • Not in range: {‘status’: vol_obj.Not([‘in-use’, ‘attaching’])

Method accepts additional filters, which are basically anything that can be passed to a sqlalchemy query’s filter method, for example:

[~sql.exists().where( == models.Snapshot.volume_id)]

We can select values based on conditions using Case objects in the ‘values’ argument. For example:

has_snapshot_filter = sql.exists().where(
    models.Snapshot.volume_id ==
case_values = volume.Case([(has_snapshot_filter, 'has-snapshot')],
volume.conditional_update({'status': case_values},
                          {'status': 'available'}))

And we can use DB fields using model class attribute for example to store previous status in the corresponding field even though we don’t know which value is in the db from those we allowed:

volume.conditional_update({'status': 'deleting',
                           'previous_status': volume.model.status},
                          {'status': ('available', 'error')})
  • values – Dictionary of key-values to update in the DB.
  • expected_values – Dictionary of conditions that must be met for the update to be executed.
  • filters – Iterable with additional filters
  • save_all – Object may have changes that are not in the DB, this will say whether we want those changes saved as well.
  • session – Session to use for the update
  • reflect_changes – If we want changes made in the database to be reflected in the versioned object. This may mean in some cases that we have to reload the object from the database.
  • order – Specific order of fields in which to update the values

number of db rows that were updated, which can be used as a boolean, since it will be 0 if we couldn’t update the DB and 1 if we could, because we are using unique index id.

classmethod exists(context, id_)
fields = {'deleted': Boolean(default=False,nullable=True), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deleted_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}
classmethod get_by_id(context, id, *args, **kwargs)
obj_as_admin(*args, **kwds)

Context manager to make an object call as an admin.

This temporarily modifies the context embedded in an object to be elevated() and restores it after the call completes. Example usage:

with obj.obj_as_admin():
update_single_status_where(new_status, expected_status, filters=())
class ClusteredObject

Bases: object

class ObjectListBase(*args, **kwargs)

Bases: oslo_versionedobjects.base.ObjectListBase

obj_make_compatible(primitive, target_version)
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.