Skip to content

Latest commit

 

History

History
127 lines (84 loc) · 4.14 KB

README.pt-br.md

File metadata and controls

127 lines (84 loc) · 4.14 KB
Raw

No SeiQueLa ORM

EM DESENVOLVIMENTO

🇺🇸 Documentação em Inglês

No SeiQueLa é um ORM pequeno e expressivo para interagir com o Google Datastore inspirado no Django, Mongo-Engine e Peewee.

Instalação

A biblioteca pode ser baixada usando o pip:

$ pip install noseiquela_orm

Modo de uso

Criando as classes de modelo:

from noseiquela_orm.entity import Model
from noseiquela_orm.types.key import KeyProperty
from noseiquela_orm.types import properties


class Customer(Model):
    name = properties.StringProperty(required=True)
    age = properties.IntegerProperty(required=True)
    is_deleted = properties.BooleanProperty(default=False, required=True)

Para definir uma chave, basta atribuir uma KeyProperty a um atributo de nome id. Caso não seja definido explicitamente, ele será definido automaticamente.

Para atribuir uma parent_key, basta passar o modelo referente a chave externa. Pode ser a propria classe ou uma string com o nome da classe.

O "tipo"/"kind" de cada modelo é o nome da propria classe, mas caso deseje definir algum diferente, basta definir o __kind__ com o valor desejado.

class CustomerAddress(Model):
    __kind__ = "Address"
    id = KeyProperty(parent="Customer")

    number = properties.IntegerProperty(required=True)
    address_one = properties.StringProperty(required=True)
    address_two = properties.StringProperty()
    is_default = properties.BooleanProperty(required=True, default=True)
    is_deleted = properties.BooleanProperty(required=True, default=False)

Caso precise mudar o projeto, namespace (ou qualquer outro parametro do google.cloud.datastore.Client), basta criar uma classe Meta dentro do modelo com as informações desejadas.

class Product(Model):
    quantity = properties.IntegerProperty(required=True)
    name = properties.StringProperty(required=True)
    value = properties.FloatProperty(required=True)

    class Meta:
        namespace = "production"
        project = "products"

Criando novas entidades:

new_customer = Customer(
    name="Geraldo Castro",
    age=29,
)

new_customer.save()

Caso um id não tenha sido definido antes de salvar, será definido um e atribuido a instancia com o valor inserido no banco.

É obrigatorio que ao salvar uma entidade que possua um ancestor/parent, que o valor do parent_id tenha um valor atribuido.

new_address = CustomerAddress(
    parent_id=new_customer.id,
    number=199,
    address_one="Some St.",
    is_default=True
)

new_address.save()

Buscando no banco:

customer = Customer.query.filter(name="Geraldo Castro").first()
customer_address = Customer.query.filter(parend_id=customer.id)

less_than_or_eq_29 = Customer.query.filter(age__le=29) # age <= 29
more_than_30 = Customer.query.filter(age__gt=30) # age > 30

first_customer = Customer.query.first()

dict_customer = first_customer.as_dict()
g_entity_customer = first_customer.as_entity()

all_customers = [
    customer.as_dict()
    for customer in Customer.query.all()
]

Autenticação

A biblioteca utiliza-se da maneira padrão de autenticação das bibliotecas da Google (google-auth-library-python).

A busca por credenciais acontece na seguinte ordem:

  1. Se a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS estiver definida para um caminho de uma service account válida.

  2. Se o Google Cloud SDK estiver instalado e tiver as credenciais da aplicação a ser utilizada, essas serão carregadas.

  3. Se a aplicação estiver rodando no App Engine standard environment (primeira geração), então as credenciais e o ID do projeto são pegos do App Identity Service.

  4. Se a aplicação estiver rodando no Compute Engine, Cloud Run, App Engine flexible environment ou App Engine standard environment (segunda geração), então as credenciais e o ID do projeto são pegos do Metadata Service.

Mais detalhes nesse link.