Pular para o conteúdo principal
Data e Schema

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

Referência de objetos do Schema

Um Schema é feito de três tipos de objeto, e os objetos são feitos de campos. As Entities guardam os Records do seu jogo, as Parts são grupos reutilizáveis de campos dentro delas e os Enums são listas fixas de valores. Esta página é a referência de cada um; Building a Game Schema mostra como criá-los.


Entities, Parts e Enums

ObjetoO que éTem Records própriosExemplo
EntityUm objeto independente: uma tabela de Records que o seu jogo lê e grava.Sim, listados em DataShips, Pilots, MatchResults
PartUm grupo reutilizável de campos que só existe dentro de uma Entity ou de outra Part.Não, os valores dela ficam no Record que a incluiStats, Loadout
EnumUma lista fixa de valores permitidos para um campo.NãoShipClass: Fighter, Bomber, Scout

Tipos de campo

Todo campo tem um tipo, e é ele que decide o que o campo guarda.

TipoGuardaAlvoCardinalidade
PrimitiveUm valor direto, de um dos tipos primitivos.—Um valor
Enum referenceUm valor de um Enum.Um EnumUm valor
Relationship → entityUm vínculo com um Record de outra Entity, pelo ID dele.Uma Entity1-para-1 ou 1-para-muitos
Inclusion ↳ partOs campos de uma Part, embutidos neste Record.Uma Part1-para-1 ou 1-para-muitos

Relationship e inclusion ligam objetos, mas de formas diferentes. Um relationship aponta para um Record que existe por conta própria e pode ser compartilhado: um piloto aponta para uma nave, e vários pilotos podem apontar para a mesma nave. Um inclusion embute uma estrutura que pertence ao objeto pai e não tem vida própria: os Stats de uma nave só existem como parte daquela nave.

Relationship — vínculo com um Record separadoPilotsShipschave estrangeiraInclusion — estrutura embutidaShipsStats (part)

Tipos primitivos

TipoGuarda
TextUma string curta
Long textUma string de várias linhas
IntegerUm número inteiro
NumberUm número de ponto flutuante
DecimalUm número de precisão fixa
Booleantrue ou false
Date & timeUm timestamp ISO
DateUma data, YYYY-MM-DD
UUIDUm identificador único
JSONUm objeto estruturado
EmailUm endereço de e-mail validado
URLUm link

Configurações de campo

ConfiguraçãoSignificado
NameLetras, dígitos e sublinhados, começando com uma letra, com até 64 caracteres. Id, CreatedAt e UpdatedAt são reservados.
DefaultO valor que um novo Record recebe quando nenhum é informado.
RequiredUm Record não pode ser salvo sem um valor.
UniqueDois Records não podem ter o mesmo valor.
IndexedAcelera a filtragem e a ordenação por este campo.

Configurações da Entity

Além dos campos, uma Entity tem algumas configurações. Elas ficam no editor da Entity: New ▾ → Entity para uma nova, ou o lápis ao lado do nome dela.

ConfiguraçãoO que faz
Singleton entityA Entity guarda exatamente um Record, sem chave de negócio própria; as referências a ela dispensam o ID. Use para configurações globais, como as regras de partida. Em Data, ela aparece como um único formulário em vez de uma lista.
Display fieldO campo que representa um Record onde quer que ele seja referenciado: células de relação, o painel do Record, o seletor de Records. Auto escolhe um para você.
Access controlQuem pode ler e gravar os Records da Entity. Veja Access Control.
Owned by playerCada Record pertence a um Player, marcado pelo servidor quando um Player o cria. Veja Entities com posse pelo Player.
Read accessPara uma Entity com posse pelo Player: Owner, cada Player lê só os próprios Records, ou Public, todos podem ler todos os Records.
On player deleteObrigatório para uma Entity com posse pelo Player: o que acontece com os Records de um Player quando ele é excluído.
On player deleteOs Records do Player são
cascade-deleteExcluídos junto com o Player.
anonymiseMantidos, com o dono substituído por um marcador anônimo estável.
restrictMantidos, e o Player não pode ser excluído enquanto existir algum.

Raw fields

Por padrão, um Record só pode ter os campos que a Entity dele declara. Em vez disso, uma Entity pode permitir raw fields: os Records passam a aceitar chaves extras que o Schema não define, para dados livres que você não quer modelar. Raw fields não podem ser filtrados, ordenados nem indexados, e só são acessíveis lendo o Record. Eles são ativados pela API ou pelo MCP; o Backoffice não tem uma configuração para eles.

Raw fields trocam estrutura por flexibilidade

Os campos declarados são validados, tipados e consultáveis; os raw fields não são nada disso. Use-os para dados que você sempre lê por inteiro e modele tudo em que vai querer pesquisar.

Schemas publicados a partir do código

Uma Entity ou Part pode vir do código do seu jogo em vez do Backoffice, publicada com a ferramenta de Schema do SDK. Ela passa a ter o rótulo CODE: a estrutura fica somente leitura no Backoffice e as mudanças vêm do código, enquanto os Records continuam editáveis em Data. Uma publicação a partir do código não pode assumir um objeto de mesmo nome criado no Backoffice.


Próximos passos

Atualizado em 16 de out. de 2026