Módulo google.appengine.ext.db.metadata

Resumo

Modelos e funções auxiliares para acessar metadados do armazenamento de dados do app.

A criação dessas entidades por usuários não é possível. Elas são criadas como resultados de consultas de metadados __namespace__, __kind__ e __property__, como

# Encontrar todos os namespaces q = db.GqlQuery(“SELECT * FROM __namespace__”) for p in q.run():

print “namespace:”, repr(p.namespace_name)

ou

# Encontrar todas as propriedades de A com nome iniciado por letra minúscula q = db.GqlQuery(“SELECT __key__ from __property__ ” +

“WHERE __key__ >= :1 AND __key__ < :2”, Property.key_for_property(“A”, “a”), Property.key_for_property(“A”, chr(ord(“z”) + 1)))

for p in q.run():

print “%s: %s” % (Property.key_to_kind(p), Property.key_to_property(p))

ou, usando objetos de consulta

# Encontrar todos os tipos >= “a” q = metadata.Kind().all() q.filter(“__key__ >=”, metadata.Kind.key_for_kind(“a”)) for p in q.run():

print “kind:”, repr(p.kind_name)

Conteúdo

class google.appengine.ext.db.metadata.BaseMetadata(parent=None, key_name=None, _app=None, _from_entity=False, **kwds)source

Bases: google.appengine.ext.db.Model

Classe base para todos os modelos de metadados.

KIND_NAME = '__BaseMetadata__'

classmethod kind()source

Modificação do nome do tipo.

class google.appengine.ext.db.metadata.EntityGroup(parent=None, key_name=None, _app=None, _from_entity=False, **kwds)source

Bases: google.appengine.ext.db.metadata.BaseMetadata

Modelo para metadados __entity_group__ (disponível apenas no armazenamento de dados HR).

Esses metadados contêm uma propriedade __version__ numérica que garante o aumento em cada mudança no grupo de entidades. A versão pode aumentar mesmo na ausência de alterações visíveis ao usuário no grupo de entidades. A entidade __entity_group__ pode não existir. None se o grupo de entidades nunca tiver sido gravado.

ID = 1

KIND_NAME = '__entity_group__'

classmethod key_for_entity(entity_or_key)source

Retorna a chave de metadados do grupo de entidades que contém entity_or_key.

Use essa chave para receber (get()) a entidade de metadados __entity_group__ ao grupo de entidades que contém entity_or_key.

Parâmetros

entity_or_key: uma chave ou entidade com a chave __entity_group__ que você quer.

Retorna

A chave __entity_group__ do grupo de entidades que contém entity_or_key.

version

Uma propriedade de número inteiro.

class google.appengine.ext.db.metadata.Kind(parent=None, key_name=None, _app=None, _from_entity=False, **kwds)source

Bases: google.appengine.ext.db.metadata.BaseMetadata

Modelo para os resultados da consulta de metadados __kind__.

KIND_NAME = '__kind__'

classmethod key_for_kind(kind)source

Retorna a chave __kind__ do tipo.

Parâmetros

kind: tipo com a chave solicitada.

Retorna

A chave do tipo.

classmethod key_to_kind(key)source

Retorna o tipo especificado por determinada chave __kind__.

Parâmetros

key: chave com o nome solicitado.

Retorna

O tipo especificado pela chave.

kind_name

Retorna o nome do tipo especificado pela chave dessa entidade.

class google.appengine.ext.db.metadata.Namespace(parent=None, key_name=None, _app=None, _from_entity=False, **kwds)source

Bases: google.appengine.ext.db.metadata.BaseMetadata

Modelo para os resultados da consulta de metadados __namespace__.

EMPTY_NAMESPACE_ID = 1

KIND_NAME = '__namespace__'

classmethod key_for_namespace(namespace)source

Retorna a chave __namespace__ do namespace.

Parâmetros

namespace: namespace com a chave solicitada.

Retorna

A chave do namespace.

classmethod key_to_namespace(key)source

Retorna o namespace especificado por determinada chave de __namespace__.

Parâmetros

key: chave com o nome solicitado.

Retorna

O namespace especificado pela chave.

namespace_name

Retorna o nome do namespace especificado pela chave dessa entidade.

class google.appengine.ext.db.metadata.Property(parent=None, key_name=None, _app=None, _from_entity=False, **kwds)source

Bases: google.appengine.ext.db.metadata.BaseMetadata

Modelo para resultados da consulta de metadados __property__.

KIND_NAME = '__property__'

classmethod key_for_kind(kind)source

Retorne a chave __property__ de kind.

Parâmetros

kind: tipo com a chave solicitada.

Retorna

A chave pai das chaves __property__ de tipo.

classmethod key_for_property(kind, property)source

Retorne a chave __property__ da propriedade do tipo.

Parâmetros

• kind: tipo com a chave solicitada.

• property: propriedade com a chave solicitada.

Retorna

A chave da propriedade do tipo.

classmethod key_to_kind(key)source

Devolve o tipo especificado por determinada chave __property__.

Parâmetros

key: chave com o nome do tipo solicitado.

Retorna

O tipo especificado pela chave.

classmethod key_to_property(key)source

Retorna a propriedade especificada por determinada chave __property__.

Parâmetros

key: chave com o nome da propriedade solicitado.

Retorna

Propriedade especificada pela chave ou None se a chave especificou apenas um tipo.

kind_name

Retorna o nome do tipo especificado pela chave dessa entidade.

property_name

Retorna o nome da propriedade especificado pela chave desta entidade.

property_representation

Uma propriedade que armazena uma lista de strings.

Uma forma abreviada do tipo mais comum de ListProperty.

google.appengine.ext.db.metadata.get_entity_group_version(entity_or_key)source

Retorna a versão do grupo de entidades que contém entity_or_key.

Parâmetros

entity_or_key: uma chave ou entidade com a versão que você quer.

Retorna: a versão do grupo de entidades que contém entity_or_key. Essa

versão tem o aumento garantido a cada alteração no grupo de entidades. A versão pode aumentar mesmo na ausência de alterações visíveis ao usuário no grupo de entidades. Pode retornar None se o grupo de entidades nunca foi gravado.

Em armazenamentos de dados não HR, essa função retorna None.

google.appengine.ext.db.metadata.get_kinds(start=None, end=None)source

Retorna todos os tipos no intervalo especificado.

Parâmetros

• start: retorna apenas os tipos >= start, se start não for None.

• end: retorna apenas os tipos < end, se end não for None.

Retorna

Uma lista de nomes de tipos entre os valores inicial e final (opcionais).

google.appengine.ext.db.metadata.get_namespaces(start=None, end=None)source

Retorna todos os namespaces no intervalo especificado.

Parâmetros

• start: retorna apenas os namespaces >= start, se start não for None.

• end: retorna apenas os namespaces < end, se end não for None.

Retorna

Uma lista de nomes de namespaces entre os valores inicial e final (opcionais).

google.appengine.ext.db.metadata.get_properties_of_kind(kind, start=None, end=None)source

Retorna todas as propriedades do tipo no intervalo especificado.

OBSERVAÇÃO: essa função não retorna propriedades não indexadas.

Parâmetros

• kind: nome do tipo com as propriedades que você quer.

• start: retornar apenas propriedades >= start, se start não for None.

• end: retornar apenas propriedades < end, se end não for None.

Retorna

Uma lista de nomes de propriedades de tipo entre os valores inicial e final (opcional).

google.appengine.ext.db.metadata.get_representations_of_kind(kind, start=None, end=None)source

Retorna todas as representações de propriedades do tipo no intervalo especificado.

OBSERVAÇÃO: essa função não retorna propriedades não indexadas.

Parâmetros

• kind: nome do tipo com as propriedades que você quer.

• start: retornar apenas propriedades >= start, se start não for None.

• end: retornar apenas propriedades < end, se end não for None.

Retorna

Um dicionário que mapeia nomes de propriedades para a respectiva lista de representações.