io.evitadb.api.requestResponse.schema.mutation.CombinableEntitySchemaMutation 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
Module contains external API of the evitaDB.
There is a newer version: 2024.10.0
/*
 *
 *                         _ _        ____  ____
 *               _____   _(_) |_ __ _|  _ \| __ )
 *              / _ \ \ / / | __/ _` | | | |  _ \
 *             |  __/\ V /| | || (_| | |_| | |_) |
 *              \___| \_/ |_|\__\__,_|____/|____/
 *
 *   Copyright (c) 2023
 *
 *   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;

import io.evitadb.api.requestResponse.schema.CatalogSchemaContract;
import io.evitadb.api.requestResponse.schema.EntitySchemaContract;
import io.evitadb.api.requestResponse.schema.EntitySchemaEditor;
import io.evitadb.api.requestResponse.schema.builder.InternalSchemaBuilderHelper.MutationCombinationResult;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Implementations of this interface signalize that they might conflict with other {@link EntitySchemaMutation} in
 * the pipeline. Method {@link #combineWith(CatalogSchemaContract, EntitySchemaContract, EntitySchemaMutation)}
 * allows to examine each of the pipeline mutation and react to it.
 *
 * The interface was created mainly for the needs of {@link EntitySchemaEditor.EntitySchemaBuilder} where it's in our
 * interest to create the least amount of schema mutations possible. Most of the schema mutation are usually quite
 * expensive on larger databases and if there is chance to avoid those, we should try to do that. Consider situation
 * when the client calls operations like `attribute` -> `not filterable`, `attribute` -> filterable by accident.
 * Should we drop laboriously built index on such attribute just to create it again from the scratch or should we
 * eliminate the opposite commands on the spot?! We chose the latter - the builder produces only the minimal set of
 * necessary changes.
 *
 * @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2022
 */
public interface CombinableEntitySchemaMutation extends EntitySchemaMutation {

	/**
	 * Method checks the passed `existingMutation` in the mutation pipeline and optionally creates
	 * {@link MutationCombinationResult} that contains the description of required changes in order to keep
	 * the pipeline short without duplicated or redundant information.
	 *
	 * @param currentCatalogSchema the current state of the catalog schema that can be consulted
	 * @param currentEntitySchema the current state of the entity schema that can be consulted
	 * @param existingMutation the existing mutation in the pipeline
	 * @return NULL if pipeline should not be changed, combination result otherwise
	 * @see MutationCombinationResult
	 */
	@Nullable
	MutationCombinationResult combineWith(
		@Nonnull CatalogSchemaContract currentCatalogSchema,
		@Nonnull EntitySchemaContract currentEntitySchema,
		@Nonnull EntitySchemaMutation existingMutation
	);

}