evita-schema-change

Apply evitaDB schema changes across contracts, DTOs, builders, mutations, and serializers.

70|7|Updated Feb 22, 2023
One-click install
npx skills add https://github.com/FgForrest/evitaDB --skill evita-schema-change
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: evita-schema-change
Source: https://github.com/FgForrest/evitaDB/tree/main/.claude/skills/evita-schema-change
Command: npx skills add https://github.com/FgForrest/evitaDB --skill evita-schema-change

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Streamlines end-to-end evitaDB schema changes across contracts, DTOs, builders, mutations, and serializers.

Core Features & Use Cases

  • Comprehensive 8-layer recipe covering contracts, DTOs, builders, mutations, external APIs (gRPC/GraphQL/REST) with backward compatibility, Kryo and WAL serializers.
  • Applies to adding a new field, enum, or configuration option to any evitaDB schema type (ReferenceSchema, EntitySchema, AttributeSchema, etc.).
  • Use case: Extend a ReferenceSchema with a new boolean field and propagate changes across all layers safely.

Quick Start

Follow the eight-layer recipe to add a new field to an evitaDB schema.

Frequently Asked Questions about evita-schema-change

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new field to an evitaDB schema while maintaining backward compatibility?▼

To add a new field to an evitaDB schema while maintaining backward compatibility, follow an eight-layer recipe that propagates changes across contracts, DTOs, builders, mutations, external APIs, Kryo serializers, WAL serializers, and validation.

What is the eight-layer pattern for evitaDB schema mutations?▼

The eight-layer pattern for evitaDB schema mutations is a comprehensive recipe covering contracts, DTOs, builders, mutations, external APIs (gRPC/GraphQL/REST), Kryo serializers, WAL serializers, and thorough validation to ensure safe schema changes.

How do I propagate evitaDB schema changes across gRPC, GraphQL, and REST APIs?▼

To propagate evitaDB schema changes across gRPC, GraphQL, and REST APIs, apply the schema change recipe that systematically updates external API layers alongside contracts, DTOs, and mutations to preserve consistency.

Can I extend ReferenceSchema or EntitySchema with a new configuration option safely?▼

Yes, you can safely extend ReferenceSchema, EntitySchema, or AttributeSchema with a new configuration option by applying the end-to-end schema change recipe across all eight layers, including serializers and validation.

Why do evitaDB schema changes require updating both Kryo and WAL serializers?▼

Updating both Kryo and WAL serializers during evitaDB schema changes is required to ensure data persistence and write-ahead logging correctly recognize the mutated schema structures without breaking existing serialized data.

What are the limitations of modifying evitaDB schema types across multiple API layers?▼

Modifying evitaDB schema types requires touching all eight layers simultaneously; skipping validation or serializer updates in any layer will break data consistency or backward compatibility across gRPC, GraphQL, and REST APIs.