The cinder.db.sqlalchemy.models
Module¶
SQLAlchemy models for cinder data.
-
class
Backup
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a backup of a volume to Swift.
-
availability_zone
¶
-
container
¶
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
display_description
¶
-
display_name
¶
-
fail_reason
¶
-
host
¶
-
id
¶
-
name
¶
-
num_dependent_backups
¶
-
object_count
¶
-
parent_id
¶
-
project_id
¶
-
service
¶
-
service_metadata
¶
-
size
¶
-
status
¶
-
temp_snapshot_id
¶
-
temp_volume_id
¶
-
updated_at
¶
-
user_id
¶
-
validate_fail_reason
(key, fail_reason)¶
-
volume_id
¶
-
-
class
Cgsnapshot
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a cgsnapshot.
-
consistencygroup
¶
-
consistencygroup_id
¶
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
description
¶
-
id
¶
-
name
¶
-
project_id
¶
-
status
¶
-
updated_at
¶
-
user_id
¶
-
-
class
CinderBase
¶ Bases:
oslo_db.sqlalchemy.models.TimestampMixin
,oslo_db.sqlalchemy.models.ModelBase
Base class for Cinder Models.
-
delete
(session)¶ Delete this object.
-
deleted
= Column(None, Boolean(), table=None, default=ColumnDefault(False))¶
-
deleted_at
= Column(None, DateTime(), table=None)¶
-
metadata
= None¶
-
-
class
ConsistencyGroup
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a consistencygroup.
-
availability_zone
¶
-
cgsnapshot_id
¶
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
description
¶
-
host
¶
-
id
¶
-
name
¶
-
project_id
¶
-
source_cgid
¶
-
status
¶
-
updated_at
¶
-
user_id
¶
-
volume_type_id
¶
-
-
class
DriverInitiatorData
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,oslo_db.sqlalchemy.models.TimestampMixin
,oslo_db.sqlalchemy.models.ModelBase
Represents private key-value pair specific an initiator for drivers
-
created_at
¶
-
id
¶
-
initiator
¶
-
key
¶
-
namespace
¶
-
updated_at
¶
-
value
¶
-
-
class
Encryption
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents encryption requirement for a volume type.
Encryption here is a set of performance characteristics describing cipher, provider, and key_size for a certain volume type.
-
cipher
¶
-
control_location
¶
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
encryption_id
¶
-
key_size
¶
-
provider
¶
-
updated_at
¶
-
volume_type
¶
-
volume_type_id
¶
-
-
class
ImageVolumeCacheEntry
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,oslo_db.sqlalchemy.models.ModelBase
Represents an image volume cache entry
-
host
¶
-
id
¶
-
image_id
¶
-
image_updated_at
¶
-
last_used
¶
-
size
¶
-
volume_id
¶
-
-
class
IscsiTarget
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents an iscsi target for a given host.
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
host
¶
-
id
¶
-
target_num
¶
-
updated_at
¶
-
volume
¶
-
volume_id
¶
-
-
class
QualityOfServiceSpecs
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents QoS specs as key/value pairs.
QoS specs is standalone entity that can be associated/disassociated with volume types (one to many relation). Adjacency list relationship pattern is used in this model in order to represent following hierarchical data with in flat table, e.g, following structure
- qos-specs-1 ‘Rate-Limit’
+——> consumer = ‘front-end’ +——> total_bytes_sec = 1048576 +——> total_iops_sec = 500
- qos-specs-2 ‘QoS_Level1’
+——> consumer = ‘back-end’ +——> max-iops = 1000 +——> min-iops = 200
is represented by:
id specs_id key value—— ——– ————- —– UUID-1 NULL QoSSpec_Name Rate-Limit UUID-2 UUID-1 consumer front-end UUID-3 UUID-1 total_bytes_sec 1048576 UUID-4 UUID-1 total_iops_sec 500 UUID-5 NULL QoSSpec_Name QoS_Level1 UUID-6 UUID-5 consumer back-end UUID-7 UUID-5 max-iops 1000 UUID-8 UUID-5 min-iops 200
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
id
¶
-
key
¶
-
specs
¶
-
specs_id
¶
-
updated_at
¶
-
value
¶
-
vol_types
¶
-
class
Quota
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a single quota override for a project.
If there is no row for a given project id and resource, then the default for the quota class is used. If there is no row for a given quota class and resource, then the default for the deployment is used. If the row is present but the hard limit is Null, then the resource is unlimited.
-
allocated
¶
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
hard_limit
¶
-
id
¶
-
project_id
¶
-
resource
¶
-
updated_at
¶
-
-
class
QuotaClass
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a single quota override for a quota class.
If there is no row for a given quota class and resource, then the default for the deployment is used. If the row is present but the hard limit is Null, then the resource is unlimited.
-
class_name
¶
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
hard_limit
¶
-
id
¶
-
resource
¶
-
updated_at
¶
-
-
class
QuotaUsage
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents the current usage for a given resource.
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
id
¶
-
in_use
¶
-
project_id
¶
-
reserved
¶
-
resource
¶
-
total
¶
-
until_refresh
¶
-
updated_at
¶
-
-
class
Reservation
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a resource reservation for quotas.
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
delta
¶
-
expire
¶
-
id
¶
-
project_id
¶
-
resource
¶
-
updated_at
¶
-
usage
¶
-
usage_id
¶
-
uuid
¶
-
-
class
Service
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a running service on a host.
-
availability_zone
¶
-
binary
¶
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
disabled
¶
-
disabled_reason
¶
-
host
¶
-
id
¶
-
modified_at
¶
-
object_available_version
¶
-
object_current_version
¶
-
report_count
¶
-
rpc_available_version
¶
-
rpc_current_version
¶
-
topic
¶
-
updated_at
¶
-
-
class
Snapshot
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a snapshot of volume.
-
cgsnapshot
¶
-
cgsnapshot_id
¶
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
display_description
¶
-
display_name
¶
-
encryption_key_id
¶
-
id
¶
-
name
¶
-
progress
¶
-
project_id
¶
-
provider_auth
¶
-
provider_id
¶
-
provider_location
¶
-
status
¶
-
updated_at
¶
-
user_id
¶
-
volume
¶
-
volume_id
¶
-
volume_name
¶
-
volume_size
¶
-
volume_type_id
¶
-
-
class
SnapshotMetadata
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a metadata key/value pair for a snapshot.
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
id
¶
-
key
¶
-
snapshot
¶
-
snapshot_id
¶
-
updated_at
¶
-
value
¶
-
-
class
Transfer
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a volume transfer request.
-
created_at
¶
-
crypt_hash
¶
-
deleted
¶
-
deleted_at
¶
-
display_name
¶
-
expires_at
¶
-
id
¶
-
salt
¶
-
updated_at
¶
-
volume
¶
-
volume_id
¶
-
-
class
Volume
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a block storage device that can be attached to a vm.
-
attach_status
¶
-
availability_zone
¶
-
bootable
¶
-
consistencygroup
¶
-
consistencygroup_id
¶
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
display_description
¶
-
display_name
¶
-
ec2_id
¶
-
encryption_key_id
¶
-
host
¶
-
id
¶
-
launched_at
¶
-
migration_status
¶
-
multiattach
¶
-
name
¶
-
name_id
¶
-
previous_status
¶
-
project_id
¶
-
provider_auth
¶
-
provider_geometry
¶
-
provider_id
¶
-
provider_location
¶
-
replication_driver_data
¶
-
replication_extended_status
¶
-
replication_status
¶
-
scheduled_at
¶
-
size
¶
-
snapshot_id
¶
-
source_volid
¶
-
status
¶
-
terminated_at
¶
-
updated_at
¶
-
user_id
¶
-
volume_type_id
¶
-
-
class
VolumeAdminMetadata
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents an administrator metadata key/value pair for a volume.
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
id
¶
-
key
¶
-
updated_at
¶
-
value
¶
-
volume
¶
-
volume_id
¶
-
-
class
VolumeAttachment
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a volume attachment for a vm.
-
attach_mode
¶
-
attach_status
¶
-
attach_time
¶
-
attached_host
¶
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
detach_time
¶
-
id
¶
-
instance_uuid
¶
-
mountpoint
¶
-
updated_at
¶
-
volume
¶
-
volume_id
¶
-
-
class
VolumeGlanceMetadata
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Glance metadata for a bootable volume.
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
id
¶
-
key
¶
-
snapshot_id
¶
-
updated_at
¶
-
value
¶
-
volume
¶
-
volume_id
¶
-
-
class
VolumeMetadata
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents a metadata key/value pair for a volume.
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
id
¶
-
key
¶
-
updated_at
¶
-
value
¶
-
volume
¶
-
volume_id
¶
-
-
class
VolumeTypeExtraSpecs
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represents additional specs as key/value pairs for a volume_type.
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
id
¶
-
key
¶
-
updated_at
¶
-
value
¶
-
volume_type
¶
-
volume_type_id
¶
-
-
class
VolumeTypeProjects
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represent projects associated volume_types.
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
id
¶
-
project_id
¶
-
updated_at
¶
-
volume_type
¶
-
volume_type_id
¶
-
-
class
VolumeTypes
(**kwargs)¶ Bases:
sqlalchemy.ext.declarative.api.Base
,cinder.db.sqlalchemy.models.CinderBase
Represent possible volume_types of volumes offered.
-
created_at
¶
-
deleted
¶
-
deleted_at
¶
-
description
¶
-
id
¶
-
is_public
¶
-
name
¶
-
qos_specs_id
¶
-
updated_at
¶
-
volumes
¶
-
-
register_models
()¶ Register Models and create metadata.
Called from cinder.db.sqlalchemy.__init__ as part of loading the driver, it will never need to be called explicitly elsewhere unless the connection is lost and needs to be reestablished.