io.evitadb.api.requestResponse.schema.mutation.attribute.SetAttributeSchemaUniqueMutation 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.GlobalAttributeSchemaContract;
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.EntitySchemaProvider;
import io.evitadb.api.requestResponse.schema.dto.GlobalAttributeSchema;
import io.evitadb.api.requestResponse.schema.mutation.CombinableCatalogSchemaMutation;
import io.evitadb.api.requestResponse.schema.mutation.CombinableLocalEntitySchemaMutation;
import io.evitadb.api.requestResponse.schema.mutation.LocalCatalogSchemaMutation;
import io.evitadb.api.requestResponse.schema.mutation.LocalEntitySchemaMutation;
import io.evitadb.api.requestResponse.schema.mutation.ReferenceSchemaMutator;
import io.evitadb.utils.Assert;
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;
/**
* Mutation is responsible for setting value to a {@link AttributeSchemaContract#isUnique()}
* in {@link EntitySchemaContract}.
* Mutation can be used for altering also the existing {@link AttributeSchemaContract} or
* {@link GlobalAttributeSchemaContract} alone.
* Mutation implements {@link CombinableLocalEntitySchemaMutation} allowing to resolve conflicts with the same mutation
* if the mutation is placed twice in the mutation pipeline.
*
* @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2022
*/
@ThreadSafe
@Immutable
@EqualsAndHashCode
public class SetAttributeSchemaUniqueMutation
implements GlobalAttributeSchemaMutation, EntityAttributeSchemaMutation, ReferenceAttributeSchemaMutation,
CombinableLocalEntitySchemaMutation, CombinableCatalogSchemaMutation {
@Serial private static final long serialVersionUID = 9015269199183582415L;
@Getter @Nonnull private final String name;
@Getter @Nonnull private final AttributeUniquenessType unique;
public SetAttributeSchemaUniqueMutation(@Nonnull String name, @Nonnull AttributeUniquenessType unique) {
this.name = name;
this.unique = unique;
}
@Nullable
@Override
public MutationCombinationResult combineWith(@Nonnull CatalogSchemaContract currentCatalogSchema, @Nonnull LocalCatalogSchemaMutation existingMutation) {
if (existingMutation instanceof SetAttributeSchemaUniqueMutation theExistingMutation && name.equals(theExistingMutation.getName())) {
return new MutationCombinationResult<>(null, this);
} else {
return null;
}
}
@Nullable
@Override
public MutationCombinationResult combineWith(
@Nonnull CatalogSchemaContract currentCatalogSchema,
@Nonnull EntitySchemaContract currentEntitySchema,
@Nonnull LocalEntitySchemaMutation existingMutation
) {
if (existingMutation instanceof SetAttributeSchemaUniqueMutation theExistingMutation && name.equals(theExistingMutation.getName())) {
return new MutationCombinationResult<>(null, this);
} else {
return null;
}
}
@Nonnull
@Override
public S mutate(@Nullable CatalogSchemaContract catalogSchema, @Nullable S attributeSchema, @Nonnull Class schemaType) {
Assert.isPremiseValid(attributeSchema != null, "Attribute schema is mandatory!");
if (attributeSchema instanceof GlobalAttributeSchema globalAttributeSchema) {
//noinspection unchecked,rawtypes
return (S) GlobalAttributeSchema._internalBuild(
name,
globalAttributeSchema.getNameVariants(),
globalAttributeSchema.getDescription(),
globalAttributeSchema.getDeprecationNotice(),
unique,
globalAttributeSchema.getGlobalUniquenessType(),
globalAttributeSchema.isFilterable(),
globalAttributeSchema.isSortable(),
globalAttributeSchema.isLocalized(),
globalAttributeSchema.isNullable(),
globalAttributeSchema.isRepresentative(),
(Class) globalAttributeSchema.getType(),
globalAttributeSchema.getDefaultValue(),
globalAttributeSchema.getIndexedDecimalPlaces()
);
} else if (attributeSchema instanceof EntityAttributeSchema entityAttributeSchema) {
//noinspection unchecked,rawtypes
return (S) EntityAttributeSchema._internalBuild(
name,
entityAttributeSchema.getNameVariants(),
entityAttributeSchema.getDescription(),
entityAttributeSchema.getDeprecationNotice(),
unique,
entityAttributeSchema.isFilterable(),
entityAttributeSchema.isSortable(),
entityAttributeSchema.isLocalized(),
entityAttributeSchema.isNullable(),
entityAttributeSchema.isRepresentative(),
(Class)entityAttributeSchema.getType(),
entityAttributeSchema.getDefaultValue(),
entityAttributeSchema.getIndexedDecimalPlaces()
);
} else {
//noinspection unchecked,rawtypes
return (S) AttributeSchema._internalBuild(
name,
attributeSchema.getNameVariants(),
attributeSchema.getDescription(),
attributeSchema.getDeprecationNotice(),
unique,
attributeSchema.isFilterable(),
attributeSchema.isSortable(),
attributeSchema.isLocalized(),
attributeSchema.isNullable(),
(Class) attributeSchema.getType(),
attributeSchema.getDefaultValue(),
attributeSchema.getIndexedDecimalPlaces()
);
}
}
@Nullable
@Override
public CatalogSchemaWithImpactOnEntitySchemas mutate(@Nullable CatalogSchemaContract catalogSchema, @Nonnull EntitySchemaProvider entitySchemaAccessor) {
Assert.isPremiseValid(catalogSchema != null, "Catalog schema is mandatory!");
final GlobalAttributeSchemaContract existingAttributeSchema = catalogSchema.getAttribute(name)
.orElseThrow(() -> new InvalidSchemaMutationException(
"The attribute `" + name + "` is not defined in catalog `" + catalogSchema.getName() + "` schema!"
));
final GlobalAttributeSchemaContract updatedAttributeSchema = mutate(catalogSchema, existingAttributeSchema, GlobalAttributeSchemaContract.class);
return replaceAttributeIfDifferent(
catalogSchema, existingAttributeSchema, updatedAttributeSchema, entitySchemaAccessor, this
);
}
@Nullable
@Override
public EntitySchemaContract mutate(@Nonnull CatalogSchemaContract catalogSchema, @Nullable EntitySchemaContract entitySchema) {
Assert.isPremiseValid(entitySchema != null, "Entity schema is mandatory!");
final EntityAttributeSchemaContract existingAttributeSchema = entitySchema.getAttribute(name)
.orElseThrow(() -> new InvalidSchemaMutationException(
"The attribute `" + name + "` is not defined in entity `" + entitySchema.getName() + "` schema!"
));
final EntityAttributeSchemaContract updatedAttributeSchema = mutate(catalogSchema, existingAttributeSchema, EntityAttributeSchemaContract.class);
return replaceAttributeIfDifferent(
entitySchema, existingAttributeSchema, updatedAttributeSchema
);
}
@Nullable
@Override
public ReferenceSchemaContract mutate(@Nonnull EntitySchemaContract entitySchema, @Nullable ReferenceSchemaContract referenceSchema, @Nonnull ConsistencyChecks consistencyChecks) {
Assert.isPremiseValid(referenceSchema != null, "Reference schema is mandatory!");
Assert.isTrue(
consistencyChecks == ReferenceSchemaMutator.ConsistencyChecks.SKIP || referenceSchema.isIndexed(),
() -> new InvalidSchemaMutationException(
"The reference `" + referenceSchema.getName() + "` is in entity `" + entitySchema.getName() + "` is not indexed! " +
"Non-indexed references must not contain filterable attribute `" + name + "`!"
)
);
final AttributeSchemaContract existingAttributeSchema = getReferenceAttributeSchemaOrThrow(entitySchema, referenceSchema, name);
final AttributeSchemaContract updatedAttributeSchema = mutate(null, existingAttributeSchema, AttributeSchemaContract.class);
return replaceAttributeIfDifferent(
referenceSchema, existingAttributeSchema, updatedAttributeSchema
);
}
@Nonnull
@Override
public Operation operation() {
return Operation.UPSERT;
}
@Override
public String toString() {
return "Set attribute `" + name + "` schema: " +
", unique=" + unique;
}
}