Pular para o conteúdo principal
Data e Schema

Esta página ainda não foi traduzida: mostrando a versão em inglês.

Construir o Schema do jogo

Você monta o Schema na página Schema, e toda mudança entra em vigor por meio de uma migração. Criar um objeto ou editar um campo ainda não muda nada: a mudança fica preparada (staged). Quando estiver pronto, você revisa as mudanças preparadas como uma única migração e a aplica. Abra a página em Schema, em Engineering, na barra lateral; ela vale para o Environment selecionado na barra superior.

A página tem três abas: Diagram, o Schema inteiro como um grafo; Table view, um objeto e seus campos; e History, as migrações aplicadas até agora. Clicar em um objeto no diagrama abre esse objeto em Table view. Os objetos e os tipos de campo estão descritos na Schema Object Reference.


Planeje a estrutura antes

Antes de criar qualquer coisa, esboce o que o seu jogo guarda: o que existe por conta própria (Entities), quais grupos de campos se repetem (Parts) e quais valores vêm de uma lista fixa (Enums). Crie nessa ordem, Enums e Parts primeiro, para que já estejam disponíveis quando você adicionar os campos que os usam.

ErroEm vez disso
Ligar com um relationship uma estrutura que pertence ao objeto paiEmbuta-a com um inclusion: os stats de uma nave pertencem à nave.
Embutir com um inclusion algo que existe por conta própriaLigue com um relationship: um piloto aponta para uma nave que vários pilotos podem compartilhar.
Repetir o mesmo grupo de campos em várias EntitiesColoque o grupo em uma Part e inclua-a em todos os lugares.
Campos de texto livre para valores de uma lista fixaUse um enum reference.

Criar um objeto

Escolha o tipo

Clique em New ▾ e escolha Entity, Part ou Enum.

Preencha os dados

Dê um nome e, no caso de um Enum, os valores. Para uma Entity, escolha também as configurações: singleton, acesso e posse pelo Player. O campo de exibição é definido depois, quando a Entity já tiver campos.

Prepare a mudança

Clique em Stage entity, Stage part ou Stage enum. O objeto aparece no Schema marcado como não salvo, e a mudança fica aguardando a revisão.


Adicionar um campo

Abra o objeto

Selecione a Entity ou a Part em Table view e clique em Add field.

Escolha o tipo

Escolha Primitive e o tipo, Enum reference e o Enum, Relationship → entity e a Entity de destino, ou Inclusion ↳ part e a Part. Para um relationship ou um inclusion, escolha 1-to-1 ou 1-to-many.

Configure o campo

Dê um nome e, se quiser, um Default e as restrições Required, Unique e Indexed. Veja Configurações de campo.

Adicione

Clique em Add field. Como qualquer edição, o campo fica preparado até você aplicar a migração.

Em Table view, cada objeto também mostra onde é usado: Referenced by para uma Entity, Included in para uma Part e Used by para um Enum.


Revisar e aplicar as mudanças

As mudanças preparadas entram em vigor juntas, como uma única migração. Enquanto houver algo preparado, o cabeçalho da página mostra Discard e Review migration; com mais de um objeto preparado, mostra também quantos são.

Abra a revisão

Clique em Review migration. O diálogo lista cada mudança e o impacto dela nos dados existentes.

Confira o impacto

ImpactoSignificado
Backward compatible ou Breaks backward compatibilitySe as leituras e gravações existentes continuam funcionando.
Requires backfillOs Records existentes precisam de um valor para a mudança, por exemplo um novo campo obrigatório sem valor padrão.
Rows affected (estimate)Quantos Records existentes a migração altera.
WarningsDados que seriam perdidos ou valores ainda em uso, veja abaixo.

Aplique

Clique em Apply migration. Ao terminar, o diálogo informa que o Schema está atualizado ou que a migração falhou. Cancel fecha a revisão e mantém as mudanças preparadas.

Discard descarta tudo o que está preparado.

As mudanças preparadas ficam no seu navegador

As mudanças que você prepara ficam guardadas neste navegador, para este Project, até você aplicá-las ou descartá-las. As outras pessoas da equipe não as veem, e elas não acompanham você em outro navegador.

MudançaAtenção a
Tornar um campo obrigatório, sem valor padrãoOs Records existentes precisam de um valor: a migração exige um backfill.
Mudar o tipo de um campoOs valores existentes precisam ser convertidos; a migração exige um backfill.
Tornar um campo único em uma Entity com RecordsOs Records existentes não podem ter valores repetidos.
Remover um campoOs dados dele vão embora, veja Remover um campo.
Remover um valor de EnumAinda pode haver Records usando esse valor; a revisão avisa você.

Excluir um objeto

Delete entity, Delete part ou Delete enum, no editor de um objeto, exclui o objeto na hora, sem migração. Um objeto que ainda é referenciado, incluído ou usado só pode ser excluído quando nada mais apontar para ele. Para excluir uma Entity que tem Records, você precisa digitar o nome dela. Excluir uma Part também exclui as linhas guardadas dela em todas as Entities que a incluem.

A exclusão de um objeto não passa pela preparação

Ao contrário das outras mudanças, ela vale no momento em que você confirma, e não há revisão em que voltar atrás.


Remover um campo e recuperá-lo

Quando uma migração remove um campo opcional, os dados dele são mantidos por 7 dias. Nesse período, o campo ainda pode ser lido, mas não gravado. Para recuperá-lo, adicione um campo com o mesmo nome e o mesmo tipo em uma nova migração; um tipo diferente é recusado. Depois dos 7 dias, os dados são excluídos de vez.

Um campo obrigatório, ou a chave da Entity, não tem esse prazo: os dados são excluídos quando a migração é aplicada.


Histórico

History lista as migrações do Project, da mais recente para a mais antiga, com um selo que indica o risco de cada uma: Safe, Caution ou Breaking. Uma migração que nunca foi aplicada mostra o status no lugar da versão: Draft, Planned, Applying, Failed ou Cancelled. Limite a lista a um período.


Próximos passos

Atualizado em 16 de out. de 2026