modules/catalog/src/main/java/org/apache/ignite/internal/catalog/CatalogManager.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 org.apache.ignite.internal.catalog;

import java.util.concurrent.CompletableFuture;
import org.apache.ignite.internal.catalog.commands.AlterTableAddColumnParams;
import org.apache.ignite.internal.catalog.commands.AlterTableDropColumnParams;
import org.apache.ignite.internal.catalog.commands.CreateHashIndexParams;
import org.apache.ignite.internal.catalog.commands.CreateSortedIndexParams;
import org.apache.ignite.internal.catalog.commands.CreateTableParams;
import org.apache.ignite.internal.catalog.commands.DropIndexParams;
import org.apache.ignite.internal.catalog.commands.DropTableParams;
import org.apache.ignite.internal.manager.IgniteComponent;

/**
 * The catalog manager provides schema manipulation methods and is responsible for managing distributed operations.
 */
public interface CatalogManager extends IgniteComponent, CatalogService {
    /**
     * Creates new table.
     *
     * @param params Parameters.
     * @return Operation future.
     */
    CompletableFuture<Void> createTable(CreateTableParams params);

    /**
     * Drops table.
     *
     * @param params Parameters.
     * @return Operation future.
     */
    CompletableFuture<Void> dropTable(DropTableParams params);

    /**
     * Add columns to a table.
     *
     * @param params Parameters.
     * @return Operation future.
     */
    CompletableFuture<Void> addColumn(AlterTableAddColumnParams params);

    /**
     * Drops columns from table.
     *
     * @param params Parameters.
     * @return Operation future.
     */
    CompletableFuture<Void> dropColumn(AlterTableDropColumnParams params);

    /**
     * Creates new sorted index.
     *
     * @param params Parameters.
     * @return Operation future.
     */
    CompletableFuture<Void> createIndex(CreateSortedIndexParams params);

    /**
     * Creates new hash index.
     *
     * @param params Parameters.
     * @return Operation future.
     */
    CompletableFuture<Void> createIndex(CreateHashIndexParams params);

    /**
     * Drops index.
     *
     * @param params Parameters.
     * @return Operation future.
     */
    CompletableFuture<Void> dropIndex(DropIndexParams params);
}