/*
 * 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.catalog.annotations;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import org.apache.ignite.catalog.IndexType;

/**
 * Describes a table.
 */
@Target(TYPE)
@Retention(RUNTIME)
public @interface Table {
    /**
     * Default zone name.
     */
    String DEFAULT_ZONE = "Default";

    /**
     * Default schema name.
     */
    String DEFAULT_SCHEMA = "PUBLIC";

    /**
     * The name of the table. If it's empty, the name of the class annotated with this annotation will be used.
     *
     * @return The name of the table.
     */
    String value() default "";

    /**
     * The schema name.
     *
     * @return The schema name.
     */
    String schemaName() default DEFAULT_SCHEMA;

    /**
     * Indexes to create on this table.
     *
     * @return Indexes to create on this table.
     */
    Index[] indexes() default {};

    /**
     * Primary key type.
     *
     * @return Primary key type.
     */
    IndexType primaryKeyType() default IndexType.DEFAULT;

    /**
     * References to colocation columns.
     *
     * @return Colocation columns.
     */
    ColumnRef[] colocateBy() default {};

    /**
     * Class annotated with {@link Zone} annotation to create a zone.
     *
     * @return Zone description class.
     */
    Zone zone() default @Zone(value = DEFAULT_ZONE, storageProfiles = "");
}
