org.springframework.data.relational.core.sql.Select Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-relational Show documentation
Show all versions of spring-data-relational Show documentation
Spring Data Relational support
/*
* Copyright 2019-2023 the original author or 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 org.springframework.data.relational.core.sql;
import java.util.List;
import java.util.OptionalLong;
import org.springframework.lang.Nullable;
/**
* AST for a {@code SELECT} statement. Visiting order:
*
* - Self
* - {@link Column SELECT columns}
* - {@link Table FROM tables} clause
* - {@link Join JOINs}
* - {@link Condition WHERE} condition
* - {@link OrderByField ORDER BY fields}
*
*
* @author Mark Paluch
* @author Myeonghyeon Lee
* @since 1.1
* @see StatementBuilder
* @see SelectBuilder
* @see SQL
*/
public interface Select extends Segment, Visitable {
/**
* Creates a new {@link SelectBuilder}.
*
* @return a new {@link SelectBuilder}.
*/
static SelectBuilder builder() {
return new DefaultSelectBuilder();
}
From getFrom();
/**
* @return the {@link List} of {@link OrderByField ORDER BY} fields.
*/
List getOrderBy();
/**
* Optional limit. Used for limit/offset paging.
*
* @return
*/
OptionalLong getLimit();
/**
* Optional offset. Used for limit/offset paging.
*
* @return
*/
OptionalLong getOffset();
/**
* Flag if this select is to return distinct rows.
*
* @return
*/
boolean isDistinct();
@Nullable
LockMode getLockMode();
}