djorm-ext-hstore 0.6

限制和注意事项

• PostgreSQL 的 hstore 实现没有类型概念；它存储字符串键到字符串值的映射。这个库不尝试将键或值强制转换为字符串。

• 使用此包时，hstore 扩展不会自动安装。您必须手动安装它。（为了执行测试，您必须在 template1 数据库上安装 hstore 扩展。）

• 运行测试时，hstore 扩展必须在 template1 数据库上安装。（简短版本）

类

该库提供了三个主要类

djorm_hstore.fields.DictionaryField

一个ORM字段，用于在hstore列中存储字符串键/值对的映射。

djorm_hstore.fields.ReferencesField

一个ORM字段，基于DictionaryField构建，用于存储字符串键到django对象引用的映射，类似于ForeignKey。

djorm_hstore.models.HStoreManager

一个ORM管理器，提供了库的大部分查询功能。

注意：预定义的hstore管理器继承了djorm-ext-expressions模块（django orm扩展包的一部分）的所有功能。

用法

最初定义一些示例模型

from django.db import models
from djorm_hstore.fields import DictionaryField
from djorm_hstore.models import HStoreManager

class Something(models.Model):
    name = models.CharField(max_length=32)
    data = DictionaryField(db_index=True)
    objects = HStoreManager()

    def __unicode__(self):
        return self.name

然后您将data字段视为简单的字符串对字典

instance = Something.objects.create(name='something', data={'a': '1', 'b': '2'})
assert instance.data['a'] == '1'

empty = Something.objects.create(name='empty')
assert empty.data == {}

empty.data['a'] = '1'
empty.save()
assert Something.objects.get(name='something').data['a'] == '1'

您可以对hstore字段发出索引查询

from djorm_hstore.expressions import HstoreExpression as HE

# equivalence
Something.objects.filter(data={'a': '1', 'b': '2'})

# subset by key/value mapping
Something.objects.where(HE("data").contains({'a':'1'}))

# subset by list of keys
Something.objects.where(HE("data").contains(['a', 'b']))

# subset by single key
Something.objects.where(HE("data").contains("a"))

您还可以通过使用管理器利用一些数据库端功能

# identify the keys present in an hstore field
>>> Something.objects.filter(id=1).hkeys(attr='data')
['a', 'b']

# peek at a a named value within an hstore field
>>> Something.objects.filter(id=1).hpeek(attr='data', key='a')
'1'

# remove a key/value pair from an hstore field
>>> Something.objects.filter(name='something').hremove('data', 'b')

除了过滤器以及用于检索键或hstore字段值的具体方法外，我们还可以使用注释，然后我们可以根据它们进行过滤。

from djorm_hstore.functions import HstoreSlice, HstorePeek, HstoreKeys

queryset = SomeModel.objects.annotate_functions(
    sliced = HstoreSlice("hstorefield", ['v']),
    peeked = HstorePeek("hstorefield", "v"),
    keys = HstoreKeys("hstorefield"),
)

Psycopg2 hstore注册

如果您出于某种原因必须使用djorm_hstore与未安装hstore扩展的数据库一起使用，则可以通过在数据库配置中将HAS_HSTORE设置为False来跳过hstore注册。

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'name',
        'USER': 'user',
        'PASSWORD': 'pass',
        'HOST': 'localhost',
        'PORT': '',
    },
    'other': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'other',
        'USER': 'user',
        'PASSWORD': 'pass',
        'HOST': 'localhost',
        'PORT': '',
        'HAS_HSTORE': False,
    }
}

如果您这样做，那么不要尝试在此数据库中创建DictionaryField。请务必查看allow_syncdb文档。