DATAJDBC-498 Add LockMode for SelectBuilder

Author: mhyeon-lee

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSelect.java

@@ -27,6 +27,7 @@
  * Default {@link Select} implementation.
  *
  * @author Mark Paluch
+ * @author Myeonghyeon Lee
  * @since 1.1
  */
 class DefaultSelect implements Select {
@@ -39,9 +40,10 @@ class DefaultSelect implements Select {
 	private final List<Join> joins;
 	private final @Nullable Where where;
 	private final List<OrderByField> orderBy;
+	private final @Nullable LockMode lockMode;
 
 	DefaultSelect(boolean distinct, List<Expression> selectList, List<Table> from, long limit, long offset,
-			List<Join> joins, @Nullable Condition where, List<OrderByField> orderBy) {
+			List<Join> joins, @Nullable Condition where, List<OrderByField> orderBy, @Nullable LockMode lockMode) {
 
 		this.distinct = distinct;
 		this.selectList = new SelectList(new ArrayList<>(selectList));
@@ -51,6 +53,7 @@ class DefaultSelect implements Select {
 		this.joins = new ArrayList<>(joins);
 		this.orderBy = Collections.unmodifiableList(new ArrayList<>(orderBy));
 		this.where = where != null ? new Where(where) : null;
+		this.lockMode = lockMode;
 	}
 
 	/*
@@ -85,6 +88,16 @@ public boolean isDistinct() {
 		return distinct;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.relational.core.sql.Select#getLockMode()
+	 */
+	@Nullable
+	@Override
+	public LockMode getLockMode() {
+		return lockMode;
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.relational.core.sql.Visitable#visit(org.springframework.data.relational.core.sql.Visitor)

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DefaultSelectBuilder.java

@@ -31,6 +31,7 @@
  *
  * @author Mark Paluch
  * @author Jens Schauder
+ * @author Myeonghyeon Lee
  * @since 1.1
  */
 class DefaultSelectBuilder implements SelectBuilder, SelectAndFrom, SelectFromAndJoin, SelectWhereAndOr {
@@ -43,6 +44,7 @@ class DefaultSelectBuilder implements SelectBuilder, SelectAndFrom, SelectFromAn
 	private List<Join> joins = new ArrayList<>();
 	private @Nullable Condition where;
 	private List<OrderByField> orderBy = new ArrayList<>();
+	private @Nullable LockMode lockMode;
 
 	/*
 	 * (non-Javadoc)
@@ -265,13 +267,23 @@ public DefaultSelectBuilder join(Join join) {
 		return this;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.relational.core.sql.SelectBuilder.SelectLock#lock(org.springframework.data.relational.core.sql.LockMode)
+	 */
+	@Override
+	public SelectLock lock(LockMode lockMode) {
+		this.lockMode = lockMode;
+		return this;
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.relational.core.sql.SelectBuilder.BuildSelect#build()
 	 */
 	@Override
 	public Select build() {
-		DefaultSelect select = new DefaultSelect(distinct, selectList, from, limit, offset, joins, where, orderBy);
+		DefaultSelect select = new DefaultSelect(distinct, selectList, from, limit, offset, joins, where, orderBy, lockMode);
 		SelectValidator.validate(select);
 		return select;
 	}
@@ -448,6 +460,16 @@ public SelectFromAndJoin offset(long offset) {
 			return selectBuilder.offset(offset);
 		}
 
+		/*
+		 * (non-Javadoc)
+		 * @see org.springframework.data.relational.core.sql.SelectBuilder.SelectLock#lock(org.springframework.data.relational.core.sql.LockMode)
+		 */
+		@Override
+		public SelectLock lock(LockMode lockMode) {
+			selectBuilder.join(finishJoin());
+			return selectBuilder.lock(lockMode);
+		}
+
 		/*
 		 * (non-Javadoc)
 		 * @see org.springframework.data.relational.core.sql.SelectBuilder.BuildSelect#build()

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/LockMode.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2020 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;
+
+/**
+ * Lock Mode Types of SELECT statements.
+ *
+ * @author Myeonghyeon Lee
+ * @since 2.0
+ */
+public enum LockMode {
+	PESSIMISTIC_READ,
+	PESSIMISTIC_WRITE
+}

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/LockOptions.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2020 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;
+
+/**
+ * LockOptions has a LOCK option to apply to the Select statement.
+ *
+ * @author Myeonghyeon Lee
+ * @since 2.0
+ */
+public class LockOptions {
+	private final LockMode lockMode;
+
+	public LockOptions(LockMode lockMode) {
+		this.lockMode = lockMode;
+	}
+
+	public LockMode getLockMode() {
+		return this.lockMode;
+	}
+}

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Select.java

@@ -15,6 +15,8 @@
  */
 package org.springframework.data.relational.core.sql;
 
+import org.springframework.lang.Nullable;
+
 import java.util.List;
 import java.util.OptionalLong;
 
@@ -30,6 +32,7 @@
  * </ol>
  *
  * @author Mark Paluch
+ * @author Myeonghyeon Lee
  * @since 1.1
  * @see StatementBuilder
  * @see SelectBuilder
@@ -71,4 +74,7 @@ static SelectBuilder builder() {
 	 * @return
 	 */
 	boolean isDistinct();
+
+	@Nullable
+	LockMode getLockMode();
 }

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SelectBuilder.java

@@ -22,6 +22,7 @@
  *
  * @author Mark Paluch
  * @author Jens Schauder
+ * @author Myeonghyeon Lee
  * @since 1.1
  * @see StatementBuilder
  */
@@ -211,9 +212,9 @@ interface SelectFrom extends BuildSelect {
 	}
 
 	/**
-	 * Builder exposing {@code FROM}, {@code JOIN}, {@code WHERE} and {@code LIMIT/OFFSET} methods.
+	 * Builder exposing {@code FROM}, {@code JOIN}, {@code WHERE}, {@code LIMIT/OFFSET} and {@code LOCK} methods.
 	 */
-	interface SelectFromAndOrderBy extends SelectFrom, SelectOrdered, SelectLimitOffset, BuildSelect {
+	interface SelectFromAndOrderBy extends SelectFrom, SelectOrdered, SelectLimitOffset, SelectLock, BuildSelect {
 
 		@Override
 		SelectFromAndOrderBy limitOffset(long limit, long offset);
@@ -247,9 +248,10 @@ interface SelectFromAndOrderBy extends SelectFrom, SelectOrdered, SelectLimitOff
 	}
 
 	/**
-	 * Builder exposing {@code FROM}, {@code JOIN}, {@code WHERE} and {@code LIMIT/OFFSET} methods.
+	 * Builder exposing {@code FROM}, {@code JOIN}, {@code WHERE}, {@code LIMIT/OFFSET} and {@code LOCK} methods.
 	 */
-	interface SelectFromAndJoin extends SelectFromAndOrderBy, BuildSelect, SelectJoin, SelectWhere, SelectLimitOffset {
+	interface SelectFromAndJoin
+		extends SelectFromAndOrderBy, BuildSelect, SelectJoin, SelectWhere, SelectLimitOffset, SelectLock {
 
 		/**
 		 * Declare a {@link Table} to {@code SELECT … FROM}. Multiple calls to this or other {@code from} methods keep
@@ -315,10 +317,10 @@ interface SelectFromAndJoin extends SelectFromAndOrderBy, BuildSelect, SelectJoi
 	}
 
 	/**
-	 * Builder exposing {@code FROM}, {@code WHERE}, {@code LIMIT/OFFSET}, and JOIN {@code AND} continuation methods.
+	 * Builder exposing {@code FROM}, {@code WHERE}, {@code LIMIT/OFFSET}, JOIN {@code AND} and {@code LOCK} continuation methods.
 	 */
 	interface SelectFromAndJoinCondition
-			extends BuildSelect, SelectJoin, SelectWhere, SelectOnCondition, SelectLimitOffset {
+			extends BuildSelect, SelectJoin, SelectWhere, SelectOnCondition, SelectLimitOffset, SelectLock {
 
 		/**
 		 * Apply {@code limit} and {@code offset} parameters to the select statement. To read the first 20 rows from start
@@ -380,9 +382,9 @@ interface SelectLimitOffset {
 	}
 
 	/**
-	 * Builder exposing {@code ORDER BY} methods.
+	 * Builder exposing {@code ORDER BY} and {@code LOCK} methods.
 	 */
-	interface SelectOrdered extends BuildSelect {
+	interface SelectOrdered extends SelectLock, BuildSelect {
 
 		/**
 		 * Add one or more {@link Column columns} to order by.
@@ -410,9 +412,9 @@ interface SelectOrdered extends BuildSelect {
 	}
 
 	/**
-	 * Interface exposing {@code WHERE} methods.
+	 * Interface exposing {@code WHERE}, {@code LOCK} methods.
 	 */
-	interface SelectWhere extends SelectOrdered, BuildSelect {
+	interface SelectWhere extends SelectOrdered, SelectLock, BuildSelect {
 
 		/**
 		 * Apply a {@code WHERE} clause.
@@ -428,7 +430,7 @@ interface SelectWhere extends SelectOrdered, BuildSelect {
 	/**
 	 * Interface exposing {@code AND}/{@code OR} combinator methods for {@code WHERE} {@link Condition}s.
 	 */
-	interface SelectWhereAndOr extends SelectOrdered, BuildSelect {
+	interface SelectWhereAndOr extends SelectOrdered, SelectLock, BuildSelect {
 
 		/**
 		 * Combine the previous {@code WHERE} {@link Condition} using {@code AND}.
@@ -452,7 +454,7 @@ interface SelectWhereAndOr extends SelectOrdered, BuildSelect {
 	/**
 	 * Interface exposing {@code JOIN} methods.
 	 */
-	interface SelectJoin extends BuildSelect {
+	interface SelectJoin extends SelectLock, BuildSelect {
 
 		/**
 		 * Declare a {@code JOIN} {@code table}.
@@ -518,7 +520,7 @@ interface SelectOnConditionComparison {
 	/**
 	 * Builder exposing JOIN and {@code JOIN … ON} continuation methods.
 	 */
-	interface SelectOnCondition extends SelectJoin, BuildSelect {
+	interface SelectOnCondition extends SelectJoin, SelectLock, BuildSelect {
 
 		/**
 		 * Declare an additional source column in the {@code JOIN}.
@@ -530,6 +532,20 @@ interface SelectOnCondition extends SelectJoin, BuildSelect {
 		SelectOnConditionComparison and(Expression column);
 	}
 
+	/**
+	 * Lock methods.
+	 */
+	interface SelectLock extends BuildSelect {
+
+		/**
+		 * Apply lock to read.
+		 *
+		 * @param lockMode lockMode to read.
+		 * @return {@code this} builder.
+		 */
+		SelectLock lock(LockMode lockMode);
+	}
+
 	/**
 	 * Interface exposing the {@link Select} build method.
 	 */

spring-data-relational/src/test/java/org/springframework/data/relational/core/sql/SelectBuilderUnitTests.java

@@ -27,6 +27,7 @@
  * Unit tests for {@link SelectBuilder}.
  *
  * @author Mark Paluch
+ * @author Myeonghyeon Lee
  */
 public class SelectBuilderUnitTests {
 
@@ -147,4 +148,63 @@ public void joins() {
 		assertThat(join.getType()).isEqualTo(JoinType.JOIN);
 	}
 
+	@Test // DATAJDBC-498
+	public void selectWithLock() {
+
+		SelectBuilder builder = StatementBuilder.select();
+
+		Table table = SQL.table("mytable");
+		Column foo = table.column("foo");
+		Column bar = table.column("bar");
+		LockMode lockMode = LockMode.PESSIMISTIC_WRITE;
+
+		Select select = builder.select(foo, bar).from(table).lock(lockMode).build();
+
+		CapturingVisitor visitor = new CapturingVisitor();
+		select.visit(visitor);
+
+		assertThat(visitor.enter).containsSequence(foo, table, bar, table, new From(table), table);
+		assertThat(select.getLockMode()).isEqualTo(lockMode);
+	}
+
+	@Test // DATAJDBC-498
+	public void selectWithWhereWithLock() {
+
+		SelectBuilder builder = StatementBuilder.select();
+
+		Table table = SQL.table("mytable");
+		Column foo = table.column("foo");
+
+		Comparison condition = foo.isEqualTo(SQL.literalOf("bar"));
+		LockMode lockMode = LockMode.PESSIMISTIC_WRITE;
+
+		Select select = builder.select(foo).from(table).where(condition).lock(lockMode).build();
+
+		CapturingVisitor visitor = new CapturingVisitor();
+		select.visit(visitor);
+
+		assertThat(visitor.enter).containsSequence(foo, table, new From(table), table, new Where(condition));
+		assertThat(select.getLockMode()).isEqualTo(lockMode);
+	}
+
+	@Test // DATAJDBC-498
+	public void orderByWithLock() {
+
+		SelectBuilder builder = StatementBuilder.select();
+
+		Table table = SQL.table("mytable");
+
+		Column foo = SQL.column("foo", table).as("foo");
+
+		OrderByField orderByField = OrderByField.from(foo).asc();
+		LockMode lockMode = LockMode.PESSIMISTIC_WRITE;
+
+		Select select = builder.select(foo).from(table).orderBy(orderByField).lock(lockMode).build();
+
+		CapturingVisitor visitor = new CapturingVisitor();
+		select.visit(visitor);
+
+		assertThat(visitor.enter).containsSequence(foo, table, new From(table), table, orderByField, foo);
+		assertThat(select.getLockMode()).isEqualTo(lockMode);
+	}
 }