glance/glance/db/sqlalchemy/models.py

233 lines
8.0 KiB
Python

# vim: tabstop=4 shiftwidth=4 softtabstop=4
# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""
SQLAlchemy models for glance data
"""
import json
from sqlalchemy import Column, Integer, String, BigInteger
from sqlalchemy.ext.compiler import compiles
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import ForeignKey, DateTime, Boolean, Text
from sqlalchemy.orm import relationship, backref, object_mapper
from sqlalchemy.types import TypeDecorator
from sqlalchemy import Index, UniqueConstraint
from glance.openstack.common import timeutils
from glance.openstack.common import uuidutils
BASE = declarative_base()
@compiles(BigInteger, 'sqlite')
def compile_big_int_sqlite(type_, compiler, **kw):
return 'INTEGER'
class JSONEncodedDict(TypeDecorator):
"""Represents an immutable structure as a json-encoded string"""
impl = Text
def process_bind_param(self, value, dialect):
if value is not None:
value = json.dumps(value)
return value
def process_result_value(self, value, dialect):
if value is not None:
value = json.loads(value)
return value
class ModelBase(object):
"""Base class for Nova and Glance Models"""
__table_args__ = {'mysql_engine': 'InnoDB'}
__table_initialized__ = False
__protected_attributes__ = set([
"created_at", "updated_at", "deleted_at", "deleted"])
created_at = Column(DateTime, default=timeutils.utcnow,
nullable=False)
updated_at = Column(DateTime, default=timeutils.utcnow,
nullable=False, onupdate=timeutils.utcnow)
deleted_at = Column(DateTime)
deleted = Column(Boolean, nullable=False, default=False)
def save(self, session=None):
"""Save this object"""
# import api here to prevent circular dependency problem
import glance.db.sqlalchemy.api as db_api
session = session or db_api._get_session()
session.add(self)
session.flush()
def delete(self, session=None):
"""Delete this object"""
self.deleted = True
self.deleted_at = timeutils.utcnow()
self.save(session=session)
def update(self, values):
"""dict.update() behaviour."""
for k, v in values.iteritems():
self[k] = v
def __setitem__(self, key, value):
setattr(self, key, value)
def __getitem__(self, key):
return getattr(self, key)
def __iter__(self):
self._i = iter(object_mapper(self).columns)
return self
def next(self):
n = self._i.next().name
return n, getattr(self, n)
def keys(self):
return self.__dict__.keys()
def values(self):
return self.__dict__.values()
def items(self):
return self.__dict__.items()
def to_dict(self):
d = self.__dict__.copy()
# NOTE(flaper87): Remove
# private state instance
# It is not serializable
# and causes CircularReference
d.pop("_sa_instance_state")
return d
class Image(BASE, ModelBase):
"""Represents an image in the datastore"""
__tablename__ = 'images'
__table_args__ = (Index('checksum_image_idx', 'checksum'),
Index('ix_images_is_public', 'is_public'),
Index('ix_images_deleted', 'deleted'),
Index('owner_image_idx', 'owner'),)
id = Column(String(36), primary_key=True, default=uuidutils.generate_uuid)
name = Column(String(255))
disk_format = Column(String(20))
container_format = Column(String(20))
size = Column(BigInteger)
status = Column(String(30), nullable=False)
is_public = Column(Boolean, nullable=False, default=False)
checksum = Column(String(32))
min_disk = Column(Integer, nullable=False, default=0)
min_ram = Column(Integer, nullable=False, default=0)
owner = Column(String(255))
protected = Column(Boolean, nullable=False, default=False)
class ImageProperty(BASE, ModelBase):
"""Represents an image properties in the datastore"""
__tablename__ = 'image_properties'
__table_args__ = (Index('ix_image_properties_image_id', 'image_id'),
Index('ix_image_properties_deleted', 'deleted'),
UniqueConstraint('image_id',
'name',
name='ix_image_properties_'
'image_id_name'),)
id = Column(Integer, primary_key=True)
image_id = Column(String(36), ForeignKey('images.id'),
nullable=False)
image = relationship(Image, backref=backref('properties'))
name = Column(String(255), nullable=False)
value = Column(Text)
class ImageTag(BASE, ModelBase):
"""Represents an image tag in the datastore"""
__tablename__ = 'image_tags'
__table_args__ = (Index('ix_image_tags_image_id', 'image_id'),
Index('ix_image_tags_image_id_tag_value',
'image_id',
'value'),)
id = Column(Integer, primary_key=True, nullable=False)
image_id = Column(String(36), ForeignKey('images.id'), nullable=False)
image = relationship(Image, backref=backref('tags'))
value = Column(String(255), nullable=False)
class ImageLocation(BASE, ModelBase):
"""Represents an image location in the datastore"""
__tablename__ = 'image_locations'
__table_args__ = (Index('ix_image_locations_image_id', 'image_id'),
Index('ix_image_locations_deleted', 'deleted'),)
id = Column(Integer, primary_key=True, nullable=False)
image_id = Column(String(36), ForeignKey('images.id'), nullable=False)
image = relationship(Image, backref=backref('locations'))
value = Column(Text(), nullable=False)
meta_data = Column(JSONEncodedDict(), default={})
class ImageMember(BASE, ModelBase):
"""Represents an image members in the datastore"""
__tablename__ = 'image_members'
unique_constraint_key_name = 'image_members_image_id_member_deleted_at_key'
__table_args__ = (Index('ix_image_members_deleted', 'deleted'),
Index('ix_image_members_image_id', 'image_id'),
Index('ix_image_members_image_id_member',
'image_id',
'member'),
UniqueConstraint('image_id',
'member',
'deleted_at',
name=unique_constraint_key_name),)
id = Column(Integer, primary_key=True)
image_id = Column(String(36), ForeignKey('images.id'),
nullable=False)
image = relationship(Image, backref=backref('members'))
member = Column(String(255), nullable=False)
can_share = Column(Boolean, nullable=False, default=False)
status = Column(String(20), nullable=False, default="pending")
def register_models(engine):
"""
Creates database tables for all models with the given engine
"""
models = (Image, ImageProperty, ImageMember)
for model in models:
model.metadata.create_all(engine)
def unregister_models(engine):
"""
Drops database tables for all models with the given engine
"""
models = (Image, ImageProperty)
for model in models:
model.metadata.drop_all(engine)