You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by pa...@apache.org on 2022/07/10 03:37:59 UTC
[shardingsphere] branch master updated: Add missing java doc for DistSQL statement (#18984)
This is an automated email from the ASF dual-hosted git repository.
panjuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 1c91f71ec16 Add missing java doc for DistSQL statement (#18984)
1c91f71ec16 is described below
commit 1c91f71ec16ed8df1f04c3e8305a892d33b01d63
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Sun Jul 10 11:37:54 2022 +0800
Add missing java doc for DistSQL statement (#18984)
---
.../distsql/parser/statement/ral/AdvancedDistSQLStatement.java | 2 +-
.../distsql/parser/statement/ral/QueryableRALStatement.java | 3 +++
.../distsql/parser/statement/ral/UpdatableRALStatement.java | 3 +++
.../statement/ral/common/queryable/ShowAuthorityRuleStatement.java | 2 --
.../statement/ral/common/queryable/ShowInstanceModeStatement.java | 2 --
.../statement/ral/common/updatable/AlterInstanceStatement.java | 3 +++
.../statement/ral/common/updatable/ApplyDistSQLStatement.java | 2 +-
.../statement/ral/common/updatable/DiscardDistSQLStatement.java | 2 +-
.../statement/ral/common/updatable/LabelInstanceStatement.java | 4 ++--
.../statement/ral/common/updatable/SetInstanceStatusStatement.java | 2 +-
.../parser/statement/ral/common/updatable/SetVariableStatement.java | 4 ++--
.../statement/ral/common/updatable/UnlabelInstanceStatement.java | 4 ++--
.../statement/status/SetReadwriteSplittingStatusStatement.java | 2 +-
.../proxy/backend/text/distsql/DistSQLBackendHandlerFactory.java | 6 +++---
14 files changed, 23 insertions(+), 18 deletions(-)
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/AdvancedDistSQLStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/AdvancedDistSQLStatement.java
index bc47bec7881..21a831c9324 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/AdvancedDistSQLStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/AdvancedDistSQLStatement.java
@@ -18,7 +18,7 @@
package org.apache.shardingsphere.distsql.parser.statement.ral;
/**
- * Advanced dist sql statement.
+ * Advanced Dist SQL statement.
*/
public abstract class AdvancedDistSQLStatement extends RALStatement {
}
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/QueryableRALStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/QueryableRALStatement.java
index b69b966f8a8..093c18c7d04 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/QueryableRALStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/QueryableRALStatement.java
@@ -17,5 +17,8 @@
package org.apache.shardingsphere.distsql.parser.statement.ral;
+/**
+ * Queryable RAL statement.
+ */
public abstract class QueryableRALStatement extends RALStatement {
}
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/UpdatableRALStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/UpdatableRALStatement.java
index b554f2be8dc..f1e54cc25f2 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/UpdatableRALStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/UpdatableRALStatement.java
@@ -17,5 +17,8 @@
package org.apache.shardingsphere.distsql.parser.statement.ral;
+/**
+ * Updatable RAL statement.
+ */
public abstract class UpdatableRALStatement extends RALStatement {
}
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/queryable/ShowAuthorityRuleStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/queryable/ShowAuthorityRuleStatement.java
index d8f01e3328d..b8842e76e3d 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/queryable/ShowAuthorityRuleStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/queryable/ShowAuthorityRuleStatement.java
@@ -17,12 +17,10 @@
package org.apache.shardingsphere.distsql.parser.statement.ral.common.queryable;
-import lombok.NoArgsConstructor;
import org.apache.shardingsphere.distsql.parser.statement.ral.QueryableRALStatement;
/**
* Show authority rule statement.
*/
-@NoArgsConstructor
public final class ShowAuthorityRuleStatement extends QueryableRALStatement {
}
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/queryable/ShowInstanceModeStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/queryable/ShowInstanceModeStatement.java
index 6842bfa7d60..36778302314 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/queryable/ShowInstanceModeStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/queryable/ShowInstanceModeStatement.java
@@ -17,12 +17,10 @@
package org.apache.shardingsphere.distsql.parser.statement.ral.common.queryable;
-import lombok.Getter;
import org.apache.shardingsphere.distsql.parser.statement.ral.QueryableRALStatement;
/**
* Show instance mode statement.
*/
-@Getter
public final class ShowInstanceModeStatement extends QueryableRALStatement {
}
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/AlterInstanceStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/AlterInstanceStatement.java
index c319b45023a..ad3a7703e9f 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/AlterInstanceStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/AlterInstanceStatement.java
@@ -21,6 +21,9 @@ import lombok.Getter;
import lombok.RequiredArgsConstructor;
import org.apache.shardingsphere.distsql.parser.statement.ral.UpdatableRALStatement;
+/**
+ * Alter instance statement.
+ */
@RequiredArgsConstructor
@Getter
public final class AlterInstanceStatement extends UpdatableRALStatement {
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/ApplyDistSQLStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/ApplyDistSQLStatement.java
index 78bc9e360dc..b718418c25f 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/ApplyDistSQLStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/ApplyDistSQLStatement.java
@@ -20,7 +20,7 @@ package org.apache.shardingsphere.distsql.parser.statement.ral.common.updatable;
import org.apache.shardingsphere.distsql.parser.statement.ral.UpdatableRALStatement;
/**
- * Apply dist sql statement.
+ * Apply Dist SQL statement.
*/
public final class ApplyDistSQLStatement extends UpdatableRALStatement {
}
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/DiscardDistSQLStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/DiscardDistSQLStatement.java
index c79d47cbc49..7143430e1bc 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/DiscardDistSQLStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/DiscardDistSQLStatement.java
@@ -20,7 +20,7 @@ package org.apache.shardingsphere.distsql.parser.statement.ral.common.updatable;
import org.apache.shardingsphere.distsql.parser.statement.ral.UpdatableRALStatement;
/**
- * Discard dist sql statement.
+ * Discard Dist SQL statement.
*/
public final class DiscardDistSQLStatement extends UpdatableRALStatement {
}
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/LabelInstanceStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/LabelInstanceStatement.java
index 52c8820487a..0923700bb9e 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/LabelInstanceStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/LabelInstanceStatement.java
@@ -26,9 +26,9 @@ import java.util.Collection;
/**
* Label instance statement.
*/
-@Getter
@RequiredArgsConstructor
-public class LabelInstanceStatement extends UpdatableRALStatement {
+@Getter
+public final class LabelInstanceStatement extends UpdatableRALStatement {
private final boolean overwrite;
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/SetInstanceStatusStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/SetInstanceStatusStatement.java
index 546e6780c96..f3e7623db90 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/SetInstanceStatusStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/SetInstanceStatusStatement.java
@@ -24,8 +24,8 @@ import org.apache.shardingsphere.distsql.parser.statement.ral.UpdatableRALStatem
/**
* Set instance status statement.
*/
-@Getter
@RequiredArgsConstructor
+@Getter
public class SetInstanceStatusStatement extends UpdatableRALStatement {
private final String status;
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/SetVariableStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/SetVariableStatement.java
index 506003f93cd..228f468312c 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/SetVariableStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/SetVariableStatement.java
@@ -24,9 +24,9 @@ import org.apache.shardingsphere.distsql.parser.statement.ral.UpdatableRALStatem
/**
* Set variable statement.
*/
-@Getter
@RequiredArgsConstructor
-public class SetVariableStatement extends UpdatableRALStatement {
+@Getter
+public final class SetVariableStatement extends UpdatableRALStatement {
private final String name;
diff --git a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/UnlabelInstanceStatement.java b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/UnlabelInstanceStatement.java
index 97925559e01..c80d3ecd697 100644
--- a/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/UnlabelInstanceStatement.java
+++ b/shardingsphere-distsql/shardingsphere-distsql-statement/src/main/java/org/apache/shardingsphere/distsql/parser/statement/ral/common/updatable/UnlabelInstanceStatement.java
@@ -26,9 +26,9 @@ import java.util.Collection;
/**
* Unlabel instance statement.
*/
-@Getter
@RequiredArgsConstructor
-public class UnlabelInstanceStatement extends UpdatableRALStatement {
+@Getter
+public final class UnlabelInstanceStatement extends UpdatableRALStatement {
private final String instanceId;
diff --git a/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-distsql/shardingsphere-readwrite-splitting-distsql-statement/src/main/java/org/apache/shardingsphere/readwritesplitting/distsql/parser/statement/status/SetReadwriteSplittingStatusStatement.java b/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-distsql/shardingsphere-readwrite-splitting-distsql-statement/src/main/java/org/apache/shardingsp [...]
index d5ff9bec33c..9052ae5462f 100644
--- a/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-distsql/shardingsphere-readwrite-splitting-distsql-statement/src/main/java/org/apache/shardingsphere/readwritesplitting/distsql/parser/statement/status/SetReadwriteSplittingStatusStatement.java
+++ b/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-distsql/shardingsphere-readwrite-splitting-distsql-statement/src/main/java/org/apache/shardingsphere/readwritesplitting/distsql/parser/statement/status/SetReadwriteSplittingStatusStatement.java
@@ -28,8 +28,8 @@ import java.util.Optional;
/**
* Set readwrite-splitting status statement.
*/
-@Getter
@RequiredArgsConstructor
+@Getter
public class SetReadwriteSplittingStatusStatement extends UpdatableRALStatement implements FromDatabaseAvailable {
private final String status;
diff --git a/shardingsphere-proxy/shardingsphere-proxy-backend/src/main/java/org/apache/shardingsphere/proxy/backend/text/distsql/DistSQLBackendHandlerFactory.java b/shardingsphere-proxy/shardingsphere-proxy-backend/src/main/java/org/apache/shardingsphere/proxy/backend/text/distsql/DistSQLBackendHandlerFactory.java
index 7e7f5ef64ba..7f5b1dff5a9 100644
--- a/shardingsphere-proxy/shardingsphere-proxy-backend/src/main/java/org/apache/shardingsphere/proxy/backend/text/distsql/DistSQLBackendHandlerFactory.java
+++ b/shardingsphere-proxy/shardingsphere-proxy-backend/src/main/java/org/apache/shardingsphere/proxy/backend/text/distsql/DistSQLBackendHandlerFactory.java
@@ -58,7 +58,7 @@ public final class DistSQLBackendHandlerFactory {
return RQLBackendHandlerFactory.newInstance((RQLStatement) sqlStatement, connectionSession);
}
if (sqlStatement instanceof RDLStatement) {
- checkLockedDatabase(connectionSession);
+ checkDatabaseLocked(connectionSession);
return RDLBackendHandlerFactory.newInstance((RDLStatement) sqlStatement, connectionSession);
}
if (sqlStatement instanceof RALStatement) {
@@ -66,13 +66,13 @@ public final class DistSQLBackendHandlerFactory {
|| sqlStatement instanceof UpdatableScalingRALStatement) {
return RALBackendHandlerFactory.newInstance((RALStatement) sqlStatement, connectionSession);
}
- checkLockedDatabase(connectionSession);
+ checkDatabaseLocked(connectionSession);
return RALBackendHandlerFactory.newInstance((RALStatement) sqlStatement, connectionSession);
}
throw new UnsupportedOperationException(sqlStatement.getClass().getCanonicalName());
}
- private static void checkLockedDatabase(final ConnectionSession connectionSession) {
+ private static void checkDatabaseLocked(final ConnectionSession connectionSession) {
String databaseName = connectionSession.getDatabaseName();
if (null == databaseName) {
return;