io.evitadb.api.requestResponse.schema.mutation.SchemaMutation 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.
/*
*
* _ _ ____ ____
* _____ _(_) |_ __ _| _ \| __ )
* / _ \ \ / / | __/ _` | | | | _ \
* | __/\ 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;
import io.evitadb.api.requestResponse.mutation.Mutation;
import io.evitadb.api.requestResponse.schema.EntitySchemaContract;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.ThreadSafe;
/**
* Entity {@link Mutation} allows to execute mutation operations on {@link EntitySchemaContract} object itself.
* Each change increments {@link EntitySchemaContract#version()} by one.
*
* These traits should help to manage concurrent transactional process as updates to the same entity could be executed
* safely and concurrently as long as schema modification doesn't overlap. Modification alters only the schema model,
* but mutation application on the engine side have side effects such as index creation or removal. Schema mutations
* happen transactionally - either completely or not at all.
*
* @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2021
*/
@Immutable
@ThreadSafe
public non-sealed interface SchemaMutation extends Mutation {
}