org.jooq.WithAsStep1 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation
The newest version!
/*
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import static org.jooq.SQLDialect.*;

import org.jetbrains.annotations.NotNull;

/**
 * This type is part of the jOOQ DSL to create {@link Select}, {@link Insert},
 * {@link Update}, {@link Delete}, {@link Merge} statements prefixed with a
 * WITH clause and with {@link CommonTableExpression}s.
 * 
 * Example:
 * 

 * DSL.with("table", "col1", "col2")
 *    .as(
 *        select(one(), two())
 *    )
 *    .select()
 *    .from("table")
 * 
 *
 * @author Lukas Eder
 */
public interface WithAsStep1 {

    /**
     * Associate a subselect with a common table expression's table and column
     * names.
     */
    @NotNull @CheckReturnValue
    @Support
    WithStep as(ResultQuery> query);

    /**
     * Associate a materialized subselect with a common table expression's table
     * and column names.
     * 
     * This adds the PostgreSQL 12 MATERIALIZED hint to the common
     * table expression definition, or silently ignores it, if the hint is not
     * supported.
     */
    @NotNull @CheckReturnValue
    @Support
    WithStep asMaterialized(ResultQuery> query);

    /**
     * Associate a non-materialized subselect with a common table expression's
     * table and column names.
     * 
     * This adds the PostgreSQL 12 NOT MATERIALIZED hint to the
     * common table expression definition, or silently ignores it, if the hint
     * is not supported.
     */
    @NotNull @CheckReturnValue
    @Support
    WithStep asNotMaterialized(ResultQuery> query);
}