Previous topic

The nova.db.sqlalchemy.migration Module

Next topic

The nova.db.sqlalchemy.session Module

This Page

Psst... hey. You're reading the latest content, but it might be out of sync with code. You can read Nova 2011.2 docs or all OpenStack docs too.

The nova.db.sqlalchemy.models Module

SQLAlchemy models for nova data.

class AgentBuild(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents an agent build.

architecture
created_at
deleted
deleted_at
hypervisor
id
md5hash
os
updated_at
url
version
class Aggregate(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a cluster of hosts that exists in this zone.

availability_zone
created_at
deleted
deleted_at
hosts
id
metadetails
name
operational_state
updated_at
class AggregateHost(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a host that is member of an aggregate.

aggregate_id
created_at
deleted
deleted_at
host
id
updated_at
class AggregateMetadata(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a metadata key/value pair for an aggregate.

aggregate_id
created_at
deleted
deleted_at
id
key
updated_at
value
class AuthToken(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents an authorization token for all API transactions.

Fields are a string representing the actual token and a user id for mapping to the actual user

cdn_management_url
created_at
deleted
deleted_at
server_management_url
storage_url
token_hash
updated_at
user_id
class BandwidthUsage(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Cache for instance bandwidth usage data pulled from the hypervisor

bw_in
bw_out
created_at
deleted
deleted_at
id
last_refreshed
mac
start_period
updated_at
class BlockDeviceMapping(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents block device mapping that is defined by EC2

connection_info
created_at
delete_on_termination
deleted
deleted_at
device_name
id
instance
instance_id
no_device
snapshot
snapshot_id
updated_at
virtual_name
volume
volume_id
volume_size
class Cell(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents parent and child cells of this cell.

api_url
created_at
deleted
deleted_at
id
is_parent
name
password
rpc_host
rpc_port
rpc_virtual_host
updated_at
username
weight_offset
weight_scale
class Certificate(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a an x509 certificate

created_at
deleted
deleted_at
file_name
id
project_id
updated_at
user_id
class ComputeNode(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a running compute service on a host.

cpu_info
created_at
current_workload
deleted
deleted_at
disk_available_least
free_disk_gb
free_ram_mb
hypervisor_hostname
hypervisor_type
hypervisor_version
id
local_gb
local_gb_used
memory_mb
memory_mb_used
running_vms
service
service_id
updated_at
vcpus
vcpus_used
class Console(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a console session for an instance.

created_at
deleted
deleted_at
id
instance_id
instance_name
password
pool
pool_id
port
updated_at
class ConsolePool(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents pool of consoles on the same physical node.

address
compute_host
console_type
created_at
deleted
deleted_at
host
id
password
public_hostname
updated_at
username
class DNSDomain(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a DNS domain with availability zone or project info.

availability_zone
created_at
deleted
deleted_at
domain
project
project_id
scope
updated_at
class FixedIp(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a fixed ip for an instance.

address
allocated
created_at
deleted
deleted_at
host
id
instance_id
leased
network_id
reserved
updated_at
virtual_interface_id
class FloatingIp(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a floating ip that dynamically forwards to a fixed ip.

address
auto_assigned
created_at
deleted
deleted_at
fixed_ip_id
host
id
interface
pool
project_id
updated_at
class Instance(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a guest vm.

access_ip_v4
access_ip_v6
architecture
auto_disk_config
availability_zone
cell_name
config_drive
created_at
default_ephemeral_device
default_swap_device
deleted
deleted_at
disable_terminate
display_description
display_name
ephemeral_gb
host
hostname
id
image_ref
injected_files = []
instance_type_id
kernel_id
key_data
key_name
launch_index
launched_at
launched_on
locked
memory_mb
name
os_type
power_state
progress
project_id
ramdisk_id
reservation_id
root_device_name
root_gb
scheduled_at
server_name
shutdown_terminate
task_state
terminated_at
updated_at
user_data
user_id
uuid
vcpus
vm_mode
vm_state
class InstanceActions(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a guest VM’s actions and results

action
created_at
deleted
deleted_at
error
id
instance_uuid
updated_at
class InstanceFault(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

code
created_at
deleted
deleted_at
details
id
instance_uuid
message
updated_at
class InstanceInfoCache(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a cache of information about an instance

created_at
deleted
deleted_at
id
instance
instance_id
network_info
updated_at
class InstanceMetadata(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a metadata key/value pair for an instance

created_at
deleted
deleted_at
id
instance
instance_id
key
updated_at
value
class InstanceTypeExtraSpecs(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents additional specs as key/value pairs for an instance_type

created_at
deleted
deleted_at
id
instance_type
instance_type_id
key
updated_at
value
class InstanceTypes(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represent possible instance_types or flavor of VM offered

created_at
deleted
deleted_at
ephemeral_gb
flavorid
id
instances
memory_mb
name
root_gb
rxtx_factor
swap
updated_at
vcpu_weight
vcpus
class IscsiTarget(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represates an iscsi target for a given host

created_at
deleted
deleted_at
host
id
target_num
updated_at
volume
volume_id
class KeyPair(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a public key pair for ssh.

created_at
deleted
deleted_at
fingerprint
id
name
public_key
updated_at
user_id
class Migration(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a running host-to-host migration.

created_at
deleted
deleted_at
dest_compute
dest_host
id
instance_uuid
new_instance_type_id
old_instance_type_id
source_compute
status
updated_at
class Network(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a network.

bridge
bridge_interface
broadcast
cidr
cidr_v6
created_at
deleted
deleted_at
dhcp_start
dns1
dns2
gateway
gateway_v6
host
id
injected
label
multi_host
netmask
netmask_v6
priority
project_id
rxtx_base
updated_at
uuid
vlan
vpn_private_address
vpn_public_address
vpn_public_port
class NovaBase

Bases: object

Base class for Nova Models.

created_at = Column(None, DateTime(), table=None, default=ColumnDefault(<function <lambda> at 0xacda87c>))
delete(session=None)

Delete this object.

deleted = Column(None, Boolean(), table=None, default=ColumnDefault(False))
deleted_at = Column(None, DateTime(), table=None)
get(key, default=None)
iteritems()

Make the model object behave like a dict.

Includes attributes from joins.

metadata = None
next()
save(session=None)

Save this object.

update(values)

Make the model object behave like a dict

updated_at = Column(None, DateTime(), table=None, onupdate=ColumnDefault(<function <lambda> at 0xacda8b4>))
class Project(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a project.

created_at
deleted
deleted_at
description
id
members
name
project_manager
updated_at
class ProviderFirewallRule(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a rule in a security group.

cidr
created_at
deleted
deleted_at
from_port
id
protocol
to_port
updated_at
class Quota(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

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 deployment is used. If the row is present but the hard limit is Null, then the resource is unlimited.

created_at
deleted
deleted_at
hard_limit
id
project_id
resource
updated_at
class S3Image(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Compatibility layer for the S3 image service talking to Glance

created_at
deleted
deleted_at
id
updated_at
uuid
class SMBackendConf(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents the connection to the backend for SM.

config_params
created_at
deleted
deleted_at
flavor_id
id
sr_type
sr_uuid
updated_at
class SMFlavors(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a flavor for SM volumes.

created_at
deleted
deleted_at
description
id
label
updated_at
class SMVolume(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

backend_id
created_at
deleted
deleted_at
id
updated_at
vdi_uuid
class SecurityGroup(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a security group.

created_at
deleted
deleted_at
description
id
instances
name
project_id
updated_at
user_id
class SecurityGroupIngressRule(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a rule in a security group.

cidr
created_at
deleted
deleted_at
from_port
grantee_group
group_id
id
parent_group
parent_group_id
protocol
to_port
updated_at
class SecurityGroupInstanceAssociation(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

created_at
deleted
deleted_at
id
instance_id
security_group_id
updated_at
class Service(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a running service on a host.

availability_zone
binary
created_at
deleted
deleted_at
disabled
host
id
report_count
topic
updated_at
class Snapshot(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a block storage device that can be attached to a vm.

created_at
deleted
deleted_at
display_description
display_name
id
name
progress
project_id
status
updated_at
user_id
volume_id
volume_name
volume_size
class User(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a user.

access_key
created_at
deleted
deleted_at
id
is_admin
name
secret_key
updated_at
class UserProjectAssociation(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

created_at
deleted
deleted_at
project_id
updated_at
user_id
class UserProjectRoleAssociation(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

created_at
deleted
deleted_at
project
project_id
role
updated_at
user
user_id
class UserRoleAssociation(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

created_at
deleted
deleted_at
role
updated_at
user
user_id
class VirtualInterface(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a virtual interface on an instance.

address
created_at
deleted
deleted_at
id
instance_id
network_id
updated_at
uuid
class Volume(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represents a block storage device that can be attached to a vm.

attach_status
attach_time
availability_zone
created_at
deleted
deleted_at
display_description
display_name
host
id
instance
instance_id
launched_at
mountpoint
name
project_id
provider_auth
provider_location
scheduled_at
size
snapshot_id
status
terminated_at
updated_at
user_id
volume_type_id
class VolumeMetadata(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

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.Base, nova.db.sqlalchemy.models.NovaBase

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 VolumeTypes(**kwargs)

Bases: sqlalchemy.ext.declarative.Base, nova.db.sqlalchemy.models.NovaBase

Represent possible volume_types of volumes offered

created_at
deleted
deleted_at
id
name
updated_at
volumes
register_models()

Register Models and create metadata.

Called from nova.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.