modules/api/src/main/java/org/apache/ignite/schema/definition/builder/TableSchemaBuilder.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.schema.definition.builder;

import java.util.Map;
import org.apache.ignite.schema.definition.ColumnDefinition;
import org.apache.ignite.schema.definition.PrimaryKeyDefinition;
import org.apache.ignite.schema.definition.TableDefinition;
import org.apache.ignite.schema.definition.index.IndexDefinition;

/**
 * Table descriptor builder.
 */
public interface TableSchemaBuilder extends SchemaObjectBuilder {
    /**
     * Adds columns to the table.
     *
     * @param columns Table columns.
     * @return {@code This} for chaining.
     */
    TableSchemaBuilder columns(ColumnDefinition... columns);

    /**
     * Adds an index.
     *
     * @param indexDefinition Table index.
     * @return {@code This} for chaining.
     */
    TableSchemaBuilder withIndex(IndexDefinition indexDefinition);

    /**
     * Shortcut method for adding {@link PrimaryKeyDefinition} of single column.
     *
     * @param colName Key column name.
     * @return {@code This} for chaining.
     */
    TableSchemaBuilder withPrimaryKey(String colName);

    /**
     * Adds primary key constraint to the table.
     *
     * @param primaryKeyDefinition Primary key.
     * @return {@code This} for chaining.
     */
    TableSchemaBuilder withPrimaryKey(PrimaryKeyDefinition primaryKeyDefinition);

    /** {@inheritDoc} */
    @Override TableSchemaBuilder withHints(Map<String, String> hints);

    /**
     * Builds table.
     *
     * @return Table.
     */
    @Override TableDefinition build();

}