io.evitadb.api.requestResponse.schema.mutation.attribute.CreateAttributeSchemaMutation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of evita_api Show documentation
Show all versions of evita_api Show documentation
Module contains external API of the evitaDB.
The newest version!
/*
*
* _ _ ____ ____
* _____ _(_) |_ __ _| _ \| __ )
* / _ \ \ / / | __/ _` | | | | _ \
* | __/\ V /| | || (_| | |_| | |_) |
* \___| \_/ |_|\__\__,_|____/|____/
*
* Copyright (c) 2023-2024
*
* Licensed under the Business Source License, Version 1.1 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://github.com/FgForrest/evitaDB/blob/master/LICENSE
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.evitadb.api.requestResponse.schema.mutation.attribute;
import io.evitadb.api.exception.InvalidSchemaMutationException;
import io.evitadb.api.requestResponse.cdc.Operation;
import io.evitadb.api.requestResponse.schema.AttributeSchemaContract;
import io.evitadb.api.requestResponse.schema.CatalogSchemaContract;
import io.evitadb.api.requestResponse.schema.EntityAttributeSchemaContract;
import io.evitadb.api.requestResponse.schema.EntitySchemaContract;
import io.evitadb.api.requestResponse.schema.NamedSchemaContract;
import io.evitadb.api.requestResponse.schema.NamedSchemaWithDeprecationContract;
import io.evitadb.api.requestResponse.schema.ReferenceSchemaContract;
import io.evitadb.api.requestResponse.schema.builder.InternalSchemaBuilderHelper.MutationCombinationResult;
import io.evitadb.api.requestResponse.schema.dto.AttributeSchema;
import io.evitadb.api.requestResponse.schema.dto.AttributeUniquenessType;
import io.evitadb.api.requestResponse.schema.dto.EntityAttributeSchema;
import io.evitadb.api.requestResponse.schema.dto.EntitySchema;
import io.evitadb.api.requestResponse.schema.dto.ReferenceSchema;
import io.evitadb.api.requestResponse.schema.dto.ReflectedReferenceSchema;
import io.evitadb.api.requestResponse.schema.mutation.CombinableLocalEntitySchemaMutation;
import io.evitadb.api.requestResponse.schema.mutation.LocalEntitySchemaMutation;
import io.evitadb.api.requestResponse.schema.mutation.SchemaMutation;
import io.evitadb.dataType.ClassifierType;
import io.evitadb.dataType.EvitaDataTypes;
import io.evitadb.utils.Assert;
import io.evitadb.utils.ClassifierUtils;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.ThreadSafe;
import java.io.Serial;
import java.io.Serializable;
import java.util.Collections;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
* Mutation is responsible for setting up a new {@link AttributeSchemaContract} in the {@link EntitySchemaContract}.
* Mutation can be used for altering also the existing {@link AttributeSchemaContract} alone.
* Mutation implements {@link CombinableLocalEntitySchemaMutation} allowing to resolve conflicts with
* {@link RemoveAttributeSchemaMutation} mutation (if such is found in mutation pipeline).
*
* @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2022
*/
@ThreadSafe
@Immutable
@EqualsAndHashCode
public class CreateAttributeSchemaMutation implements ReferenceAttributeSchemaMutation, CombinableLocalEntitySchemaMutation {
@Serial private static final long serialVersionUID = -7082514745878566818L;
@Getter @Nonnull private final String name;
@Getter @Nullable private final String description;
@Getter @Nullable private final String deprecationNotice;
@Getter @Nonnull private final AttributeUniquenessType unique;
@Getter private final boolean filterable;
@Getter private final boolean sortable;
@Getter private final boolean localized;
@Getter private final boolean nullable;
@Getter private final boolean representative;
@Getter @Nonnull private final Class type;
@Getter @Nullable private final Serializable defaultValue;
@Getter private final int indexedDecimalPlaces;
@Nullable
private static S makeMutationIfDifferent(
@Nonnull AttributeSchemaContract createdVersion,
@Nonnull AttributeSchemaContract existingVersion,
@Nonnull Function propertyRetriever,
@Nonnull Function mutationCreator
) {
final T newValue = propertyRetriever.apply(createdVersion);
return Objects.equals(propertyRetriever.apply(existingVersion), newValue) ?
null : mutationCreator.apply(newValue);
}
public CreateAttributeSchemaMutation(
@Nonnull String name,
@Nullable String description,
@Nullable String deprecationNotice,
@Nullable AttributeUniquenessType unique,
boolean filterable,
boolean sortable,
boolean localized,
boolean nullable,
boolean representative,
@Nonnull Class type,
@Nullable Serializable defaultValue,
int indexedDecimalPlaces
) {
ClassifierUtils.validateClassifierFormat(ClassifierType.ATTRIBUTE, name);
if (!EvitaDataTypes.isSupportedTypeOrItsArray(type)) {
throw new InvalidSchemaMutationException("The type `" + type + "` is not allowed in attributes!");
}
this.name = name;
this.description = description;
this.deprecationNotice = deprecationNotice;
this.unique = unique == null ? AttributeUniquenessType.NOT_UNIQUE : unique;
this.filterable = filterable;
this.sortable = sortable;
this.localized = localized;
this.nullable = nullable;
this.representative = representative;
this.type = type;
this.defaultValue = defaultValue;
this.indexedDecimalPlaces = indexedDecimalPlaces;
}
@Nullable
@Override
public MutationCombinationResult combineWith(
@Nonnull CatalogSchemaContract currentCatalogSchema,
@Nonnull EntitySchemaContract currentEntitySchema,
@Nonnull LocalEntitySchemaMutation existingMutation
) {
// when the attribute schema was removed before and added again, we may remove both operations
// and leave only operations that reset the original settings do defaults
if (existingMutation instanceof RemoveAttributeSchemaMutation removeAttributeSchema && Objects.equals(removeAttributeSchema.getName(), name)) {
final EntityAttributeSchemaContract createdVersion = mutate(currentCatalogSchema, null, EntityAttributeSchemaContract.class);
final EntityAttributeSchemaContract existingSchema = currentEntitySchema.getAttribute(name).orElseThrow();
return new MutationCombinationResult<>(
null,
Stream.of(
makeMutationIfDifferent(
createdVersion, existingSchema,
NamedSchemaContract::getDescription,
newValue -> new ModifyAttributeSchemaDescriptionMutation(name, newValue)
),
makeMutationIfDifferent(
createdVersion, existingSchema,
NamedSchemaWithDeprecationContract::getDeprecationNotice,
newValue -> new ModifyAttributeSchemaDeprecationNoticeMutation(name, newValue)
),
makeMutationIfDifferent(
createdVersion, existingSchema,
AttributeSchemaContract::getType,
newValue -> new ModifyAttributeSchemaTypeMutation(name, newValue, indexedDecimalPlaces)
),
makeMutationIfDifferent(
createdVersion, existingSchema,
AttributeSchemaContract::getDefaultValue,
newValue -> new ModifyAttributeSchemaDefaultValueMutation(name, defaultValue)
),
makeMutationIfDifferent(
createdVersion, existingSchema,
AttributeSchemaContract::isFilterable,
newValue -> new SetAttributeSchemaFilterableMutation(name, newValue)
),
makeMutationIfDifferent(
createdVersion, existingSchema,
AttributeSchemaContract::getUniquenessType,
newValue -> new SetAttributeSchemaUniqueMutation(name, newValue)
),
makeMutationIfDifferent(
createdVersion, existingSchema,
AttributeSchemaContract::isSortable,
newValue -> new SetAttributeSchemaSortableMutation(name, newValue)
),
makeMutationIfDifferent(
createdVersion, existingSchema,
AttributeSchemaContract::isLocalized,
newValue -> new SetAttributeSchemaLocalizedMutation(name, newValue)
),
makeMutationIfDifferent(
createdVersion, existingSchema,
AttributeSchemaContract::isNullable,
newValue -> new SetAttributeSchemaNullableMutation(name, newValue)
),
makeMutationIfDifferent(
createdVersion, existingSchema,
attributeSchemaContract -> ((EntityAttributeSchema) attributeSchemaContract).isRepresentative(),
newValue -> new SetAttributeSchemaRepresentativeMutation(name, newValue)
)
)
.filter(Objects::nonNull)
.toArray(LocalEntitySchemaMutation[]::new)
);
} else {
return null;
}
}
@Nonnull
@Override
public S mutate(@Nullable CatalogSchemaContract catalogSchema, @Nullable S attributeSchema, @Nonnull Class schemaType) {
if (EntityAttributeSchemaContract.class.isAssignableFrom(schemaType)) {
//noinspection unchecked,rawtypes
return (S) EntityAttributeSchema._internalBuild(
name, description, deprecationNotice,
unique, filterable, sortable, localized, nullable, representative,
(Class) type, defaultValue,
indexedDecimalPlaces
);
} else if (AttributeSchemaContract.class.isAssignableFrom(schemaType)) {
//noinspection unchecked,rawtypes
return (S) AttributeSchema._internalBuild(
name, description, deprecationNotice,
unique, filterable, sortable, localized, nullable,
(Class) type, defaultValue,
indexedDecimalPlaces
);
} else {
throw new InvalidSchemaMutationException("Unsupported schema type: " + schemaType);
}
}
@Nullable
@Override
public EntitySchemaContract mutate(@Nonnull CatalogSchemaContract catalogSchema, @Nullable EntitySchemaContract entitySchema) {
Assert.isPremiseValid(entitySchema != null, "Entity schema is mandatory!");
final EntityAttributeSchemaContract newAttributeSchema = mutate(catalogSchema, null, EntityAttributeSchemaContract.class);
final EntityAttributeSchemaContract existingAttributeSchema = entitySchema.getAttribute(name).orElse(null);
if (existingAttributeSchema == null) {
return EntitySchema._internalBuild(
entitySchema.version() + 1,
entitySchema.getName(),
entitySchema.getNameVariants(),
entitySchema.getDescription(),
entitySchema.getDeprecationNotice(),
entitySchema.isWithGeneratedPrimaryKey(),
entitySchema.isWithHierarchy(),
entitySchema.isWithPrice(),
entitySchema.getIndexedPricePlaces(),
entitySchema.getLocales(),
entitySchema.getCurrencies(),
Stream.concat(
entitySchema.getAttributes().values().stream(),
Stream.of(newAttributeSchema)
)
.collect(
Collectors.toMap(
AttributeSchemaContract::getName,
Function.identity()
)
),
entitySchema.getAssociatedData(),
entitySchema.getReferences(),
entitySchema.getEvolutionMode(),
entitySchema.getSortableAttributeCompounds()
);
} else if (existingAttributeSchema.equals(newAttributeSchema)) {
// the mutation must have been applied previously - return the schema we don't need to alter
return entitySchema;
} else {
// ups, there is conflict in attribute settings
throw new InvalidSchemaMutationException(
"The attribute `" + name + "` already exists in entity `" + entitySchema.getName() + "` schema and" +
" it has different definition. To alter existing attribute schema you need to use different mutations."
);
}
}
@Nullable
@Override
public ReferenceSchemaContract mutate(@Nonnull EntitySchemaContract entitySchemaContract, @Nullable ReferenceSchemaContract referenceSchema, @Nonnull ConsistencyChecks consistencyChecks) {
Assert.isPremiseValid(referenceSchema != null, "Reference schema is mandatory!");
@SuppressWarnings({"unchecked", "rawtypes"}) final AttributeSchema newAttributeSchema = AttributeSchema._internalBuild(
name, description, deprecationNotice,
unique, filterable, sortable, localized, nullable,
(Class) type, defaultValue,
indexedDecimalPlaces
);
final Optional existingAttributeSchema = getReferenceAttributeSchema(referenceSchema, name);
if (existingAttributeSchema.isEmpty()) {
if (referenceSchema instanceof ReflectedReferenceSchema reflectedReferenceSchema) {
return reflectedReferenceSchema
.withDeclaredAttributes(
Stream.concat(
reflectedReferenceSchema.getDeclaredAttributes().values().stream(),
Stream.of(newAttributeSchema)
)
.collect(
Collectors.toMap(
AttributeSchemaContract::getName,
Function.identity()
)
)
);
} else {
return ReferenceSchema._internalBuild(
referenceSchema.getName(),
referenceSchema.getNameVariants(),
referenceSchema.getDescription(),
referenceSchema.getDeprecationNotice(),
referenceSchema.getReferencedEntityType(),
referenceSchema.isReferencedEntityTypeManaged() ? Collections.emptyMap() : referenceSchema.getEntityTypeNameVariants(s -> null),
referenceSchema.isReferencedEntityTypeManaged(),
referenceSchema.getCardinality(),
referenceSchema.getReferencedGroupType(),
referenceSchema.isReferencedGroupTypeManaged() ? Collections.emptyMap() : referenceSchema.getGroupTypeNameVariants(s -> null),
referenceSchema.isReferencedGroupTypeManaged(),
referenceSchema.isIndexed(),
referenceSchema.isFaceted(),
Stream.concat(
referenceSchema.getAttributes().values().stream(),
Stream.of(newAttributeSchema)
)
.collect(
Collectors.toMap(
AttributeSchemaContract::getName,
Function.identity()
)
),
referenceSchema.getSortableAttributeCompounds()
);
}
} else if (existingAttributeSchema.get().equals(newAttributeSchema)) {
// the mutation must have been applied previously - return the schema we don't need to alter
return referenceSchema;
} else {
// ups, there is conflict in attribute settings
throw new InvalidSchemaMutationException(
"The attribute `" + name + "` already exists in entity `" + entitySchemaContract.getName() + "`" +
" reference `" + referenceSchema.getName() + "` schema and" +
" it has different definition. To alter existing attribute schema you need to use different mutations."
);
}
}
@Nonnull
@Override
public Operation operation() {
return Operation.UPSERT;
}
@Override
public String toString() {
return "Create attribute schema: " +
"name='" + name + '\'' +
", description='" + description + '\'' +
", deprecationNotice='" + deprecationNotice + '\'' +
", unique=" + unique +
", filterable=" + filterable +
", sortable=" + sortable +
", localized=" + localized +
", nullable=" + nullable +
", representative=" + representative +
", type=" + type +
", defaultValue=" + defaultValue +
", indexedDecimalPlaces=" + indexedDecimalPlaces;
}
}