Esta página aún no está traducida: se muestra la versión en inglés.

Esquema como código

Declara el modelo en código, súbelo y recibe los tipos de vuelta. Así llega un desarrollador al esquema: el panel de administración y el código editan el mismo modelo, y la generación de código cierra el ciclo para cada motor.

Cuándo usarlo

• Quieres que el modelo de datos viva en el código y se revise como código: declaras, schema diff, schema push.
• Los tipos del motor nunca deben desfasarse del modelo desplegado: schema codegen vuelve a generar los tipos de Unreal C++ y Unity C#.
• Un cambio incompatible tiene que poder leerse y cancelarse antes de ejecutarse: propuesta → plan → aplicación.
• Reutilizas un mismo paquete (Stat, Interactable) en varios proyectos: lo declaras una sola vez como preset.
• No lo necesitas si un operador solo ajusta valores en el panel de administración. Aun así, el cambio del modelo aparece en la comparación con el código.

Quién hace qué

En resumen

[Entity("item")]
public class Item
{
    public string Name = "";
    public Rarity Rarity;              // an enum declared the same way
    public Stats Stats = new();        // a part — embedded, no lifecycle of its own
}

[Part("stats")]
public class Stats { public int Power; public int Weight; }

@Entity('item')
export class Item {
  name = '';
  rarity!: Rarity;                   // an enum declared the same way
  stats = new Stats();               // a part — embedded, no lifecycle of its own
}

@Part('stats')
export class Stats { power = 0; weight = 0; }

@entity("item")
class Item:
    name: str = ""
    rarity: Rarity                     # an enum declared the same way
    stats: Stats = Stats()             # a part — embedded, no lifecycle of its own

@part("stats")
class Stats:
    power: int = 0
    weight: int = 0

USTRUCT(PSPart = "stats")
struct FItemStats
{
    GENERATED_BODY()

    UPROPERTY() int32 Power;
    UPROPERTY() int32 Weight;
};

UCLASS(PSEntity = "item")
class UItem : public UObject
{
    GENERATED_BODY()

    UPROPERTY() FString    Name;
    UPROPERTY() EPSRarity  Rarity;       // an enum declared the same way
    UPROPERTY() FItemStats Stats;        // a part — embedded, no lifecycle of its own
};
// declarations compile into the same pushed model — playserv push from the UE project or CI

[Entity("item")]
public class Item
{
    public string Name = "";
    public Rarity Rarity;              // an enum declared the same way
    public Stats Stats = new();        // a part — embedded, no lifecycle of its own
}

[Part("stats")]
public class Stats { public int Power; public int Weight; }

playserv schema diff       # local declarations vs deployed schema
playserv schema push       # with a revision precondition — no blind overwrites
playserv schema codegen    # regenerate Unreal C++ / Unity C# types

El modelo

Qué lleva una declaración.

Qué garantiza una subida.

Qué garantiza la generación de código.

Qué garantiza una migración.

Errores

• Quien llama sin el rol recibe forbidden, y el modelo desplegado no se toca: un rechazo nunca deja una subida a medias. Es un rechazo distinto al de una revisión desactualizada, que es precondition_failed y significa que la comparación se hizo contra un esquema que cambió desde entonces: vuelve a comparar y sube otra vez.
• Un valor fuera de un límite declarado se rechaza al escribirlo, nunca se recorta, y lo mismo pasa con una cadena que supera su longitud declarada. Recortar daría un valor válido pero incorrecto.
• Una secuencia UTF-8 inválida se rechaza al escribirla, en lugar de repararse.
• Un cambio persistente incompatible sin una migración declarada no se puede publicar.

Límites

Los topes que dependen de la forma de la declaración se comprueban al declarar —al desplegar o al publicar— y no en el primer uso, en todos los casos en que el síntoma en tiempo de ejecución no parecería un rechazo. Las cifras llegarán con el capítulo sobre los límites de la plataforma.