Table of Contents

Class SchemaComparisonResult

Namespace
Excalibur.Data.ElasticSearch.Projections
Assembly
Excalibur.Data.ElasticSearch.dll

Represents the result of comparing two schemas.

public sealed class SchemaComparisonResult
Inheritance
SchemaComparisonResult
Inherited Members

Properties

AddedFields

Gets the fields added in the target schema.

public required IReadOnlyList<FieldChange> AddedFields { get; init; }

Property Value

IReadOnlyList<FieldChange>

The fields added in the target schema.

AreIdentical

Gets a value indicating whether the schemas are identical.

public required bool AreIdentical { get; init; }

Property Value

bool

A value indicating whether the schemas are identical.

BreakingChanges

Gets any breaking changes detected.

public IReadOnlyList<string>? BreakingChanges { get; init; }

Property Value

IReadOnlyList<string>

Any breaking changes detected.

IsBackwardsCompatible

Gets a value indicating whether the target schema is backwards compatible with the source.

public required bool IsBackwardsCompatible { get; init; }

Property Value

bool

A value indicating whether the target schema is backwards compatible with the source.

ModifiedFields

Gets the fields with modified types or properties.

public required IReadOnlyList<FieldChange> ModifiedFields { get; init; }

Property Value

IReadOnlyList<FieldChange>

The fields with modified types or properties.

RemovedFields

Gets the fields removed from the source schema.

public required IReadOnlyList<FieldChange> RemovedFields { get; init; }

Property Value

IReadOnlyList<FieldChange>

The fields removed from the source schema.

Warnings

Gets any warnings about the schema changes.

public IReadOnlyList<string>? Warnings { get; init; }

Property Value

IReadOnlyList<string>

Any warnings about the schema changes.