io.micronaut.data.jdbc.annotation.JoinTable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-data-jdbc Show documentation

Data Repository Support for Micronaut

There is a newer version: 4.9.3

/*
 * Copyright 2017-2020 original authors
 *
 * Licensed 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
 *
 * https://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 io.micronaut.data.jdbc.annotation;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Subset of the JPA join table annotation allowing support for bidirectional and unidirectional one-to-many join fetches only.
 *
 * Unlike the JPA version this is simplification and relies on a thid
 *
 * @author graemerocher
 * @since 1.0.0
 */
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface JoinTable {
    /**
     * @return The name of the join table
     */
    String name() default "";

    /**
     * @return The join columns to use.
     */
    JoinColumn[] joinColumns() default {};

    /**
     * @return The inverse join columns to use.
     */
    JoinColumn[] inverseJoinColumns() default {};

    /**
     * @return The alias to use for the query
     */
    String alias() default "";
}