Skip to content

Commit 3ae95e3

Browse files
olavloiteolavloite
committed
chore: rename to autoPartitionMode
1 parent 13541b1 commit 3ae95e3

File tree

5 files changed

+34
-36
lines changed

5 files changed

+34
-36
lines changed

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/Connection.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1051,10 +1051,10 @@ default boolean isDelayTransactionStartUntilFirstWrite() {
10511051
* flag in combination with {@link #setDataBoostEnabled(boolean)} to force all queries on this
10521052
* connection to use data boost.
10531053
*/
1054-
void setAlwaysUsePartitionedQueries(boolean alwaysUsePartitionedQueries);
1054+
void setAutoPartitionMode(boolean autoPartitionMode);
10551055

10561056
/** Returns whether this connection will execute all queries as partitioned queries. */
1057-
boolean isAlwaysUsePartitionedQueries();
1057+
boolean isAutoPartitionMode();
10581058

10591059
/**
10601060
* Sets the maximum number of partitions that should be included as a hint to Cloud Spanner when

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -219,14 +219,14 @@ static UnitOfWorkType of(TransactionMode transactionMode) {
219219
private AutocommitDmlMode autocommitDmlMode = AutocommitDmlMode.TRANSACTIONAL;
220220
private TimestampBound readOnlyStaleness = TimestampBound.strong();
221221
/**
222-
* alwaysUsePartitionedQueries will force this connection to execute all queries as partitioned
223-
* queries. If a query cannot be executed as a partitioned query, for example if it is not
224-
* partitionable, then the query will fail. This mode is intended for integrations with frameworks
225-
* that should always use partitioned queries, and that do not support executing custom SQL
226-
* statements. This setting can be used in combination with the dataBoostEnabled flag to force all
227-
* queries to use data boost.
222+
* autoPartitionMode will force this connection to execute all queries as partitioned queries. If
223+
* a query cannot be executed as a partitioned query, for example if it is not partitionable, then
224+
* the query will fail. This mode is intended for integrations with frameworks that should always
225+
* use partitioned queries, and that do not support executing custom SQL statements. This setting
226+
* can be used in combination with the dataBoostEnabled flag to force all queries to use data
227+
* boost.
228228
*/
229-
private boolean alwaysUsePartitionedQueries;
229+
private boolean autoPartitionMode;
230230
/**
231231
* dataBoostEnabled=true will cause all partitionedQueries to use data boost. All other queries
232232
* and other statements ignore this flag.
@@ -272,7 +272,7 @@ static UnitOfWorkType of(TransactionMode transactionMode) {
272272
this.returnCommitStats = options.isReturnCommitStats();
273273
this.delayTransactionStartUntilFirstWrite = options.isDelayTransactionStartUntilFirstWrite();
274274
this.dataBoostEnabled = options.isDataBoostEnabled();
275-
this.alwaysUsePartitionedQueries = options.isAlwaysUsePartitionedQueries();
275+
this.autoPartitionMode = options.isAutoPartitionMode();
276276
this.maxPartitions = options.getMaxPartitions();
277277
this.maxPartitionedParallelism = options.getMaxPartitionedParallelism();
278278
this.ddlClient = createDdlClient();
@@ -1038,13 +1038,13 @@ public boolean isDataBoostEnabled() {
10381038
}
10391039

10401040
@Override
1041-
public void setAlwaysUsePartitionedQueries(boolean alwaysUsePartitionedQueries) {
1042-
this.alwaysUsePartitionedQueries = alwaysUsePartitionedQueries;
1041+
public void setAutoPartitionMode(boolean autoPartitionMode) {
1042+
this.autoPartitionMode = autoPartitionMode;
10431043
}
10441044

10451045
@Override
1046-
public boolean isAlwaysUsePartitionedQueries() {
1047-
return this.alwaysUsePartitionedQueries;
1046+
public boolean isAutoPartitionMode() {
1047+
return this.autoPartitionMode;
10481048
}
10491049

10501050
@Override
@@ -1450,7 +1450,7 @@ private ResultSet internalExecuteQuery(
14501450
&& (analyzeMode != AnalyzeMode.NONE || statement.hasReturningClause())),
14511451
"Statement must either be a query or a DML mode with analyzeMode!=NONE or returning clause");
14521452
UnitOfWork transaction = getCurrentUnitOfWorkOrStartNewUnitOfWork();
1453-
if (alwaysUsePartitionedQueries && statement.getType() == StatementType.QUERY) {
1453+
if (autoPartitionMode && statement.getType() == StatementType.QUERY) {
14541454
return runPartitionedQuery(
14551455
statement.getStatement(), PartitionOptions.getDefaultInstance(), options);
14561456
}
@@ -1472,7 +1472,7 @@ private AsyncResultSet internalExecuteQueryAsync(
14721472
|| (statement.getType() == StatementType.UPDATE && statement.hasReturningClause()),
14731473
"Statement must be a query or DML with returning clause.");
14741474
ConnectionPreconditions.checkState(
1475-
!(alwaysUsePartitionedQueries && statement.getType() == StatementType.QUERY),
1475+
!(autoPartitionMode && statement.getType() == StatementType.QUERY),
14761476
"Partitioned queries cannot be executed asynchronously");
14771477
UnitOfWork transaction = getCurrentUnitOfWorkOrStartNewUnitOfWork();
14781478
return ResultSets.toAsyncResultSet(

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionOptions.java

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ public String[] getValidValues() {
181181
private static final boolean DEFAULT_TRACK_SESSION_LEAKS = true;
182182
private static final boolean DEFAULT_TRACK_CONNECTION_LEAKS = true;
183183
private static final boolean DEFAULT_DATA_BOOST_ENABLED = false;
184-
private static final boolean DEFAULT_ALWAYS_USE_PARTITIONED_QUERIES = false;
184+
private static final boolean DEFAULT_AUTO_PARTITION_MODE = false;
185185
private static final int DEFAULT_MAX_PARTITIONS = 0;
186186
private static final int DEFAULT_MAX_PARTITIONED_PARALLELISM = 1;
187187

@@ -239,8 +239,7 @@ public String[] getValidValues() {
239239
public static final String TRACK_CONNECTION_LEAKS_PROPERTY_NAME = "trackConnectionLeaks";
240240

241241
public static final String DATA_BOOST_ENABLED_PROPERTY_NAME = "dataBoostEnabled";
242-
public static final String ALWAYS_USE_PARTITIONED_QUERIES_PROPERTY_NAME =
243-
"alwaysUsePartitionedQueries";
242+
public static final String AUTO_PARTITION_MODE_PROPERTY_NAME = "autoPartitionMode";
244243
public static final String MAX_PARTITIONS_PROPERTY_NAME = "maxPartitions";
245244
public static final String MAX_PARTITIONED_PARALLELISM_PROPERTY_NAME =
246245
"maxPartitionedParallelism";
@@ -347,11 +346,11 @@ public String[] getValidValues() {
347346
+ "This setting is only used for partitioned queries and is ignored by all other statements.",
348347
DEFAULT_DATA_BOOST_ENABLED),
349348
ConnectionProperty.createBooleanProperty(
350-
ALWAYS_USE_PARTITIONED_QUERIES_PROPERTY_NAME,
349+
AUTO_PARTITION_MODE_PROPERTY_NAME,
351350
"Execute all queries on this connection as partitioned queries. "
352351
+ "Executing a query that cannot be partitioned will fail. "
353352
+ "Executing a query in a read/write transaction will also fail.",
354-
DEFAULT_ALWAYS_USE_PARTITIONED_QUERIES),
353+
DEFAULT_AUTO_PARTITION_MODE),
355354
ConnectionProperty.createIntProperty(
356355
MAX_PARTITIONS_PROPERTY_NAME,
357356
"The max partitions hint value to use for partitioned queries. "
@@ -624,7 +623,7 @@ public static Builder newBuilder() {
624623
private final boolean trackConnectionLeaks;
625624

626625
private final boolean dataBoostEnabled;
627-
private final boolean alwaysUsePartitionedQueries;
626+
private final boolean autoPartitionMode;
628627
private final int maxPartitions;
629628
private final int maxPartitionedParallelism;
630629

@@ -676,7 +675,7 @@ private ConnectionOptions(Builder builder) {
676675
this.trackConnectionLeaks = parseTrackConnectionLeaks(this.uri);
677676

678677
this.dataBoostEnabled = parseDataBoostEnabled(this.uri);
679-
this.alwaysUsePartitionedQueries = parseAlwaysUsePartitionedQueries(this.uri);
678+
this.autoPartitionMode = parseAutoPartitionMode(this.uri);
680679
this.maxPartitions = parseMaxPartitions(this.uri);
681680
this.maxPartitionedParallelism = parseMaxPartitionedParallelism(this.uri);
682681

@@ -957,9 +956,9 @@ static boolean parseDataBoostEnabled(String uri) {
957956
}
958957

959958
@VisibleForTesting
960-
static boolean parseAlwaysUsePartitionedQueries(String uri) {
961-
String value = parseUriProperty(uri, ALWAYS_USE_PARTITIONED_QUERIES_PROPERTY_NAME);
962-
return value != null ? Boolean.parseBoolean(value) : DEFAULT_ALWAYS_USE_PARTITIONED_QUERIES;
959+
static boolean parseAutoPartitionMode(String uri) {
960+
String value = parseUriProperty(uri, AUTO_PARTITION_MODE_PROPERTY_NAME);
961+
return value != null ? Boolean.parseBoolean(value) : DEFAULT_AUTO_PARTITION_MODE;
963962
}
964963

965964
@VisibleForTesting
@@ -1257,8 +1256,8 @@ boolean isDataBoostEnabled() {
12571256
return this.dataBoostEnabled;
12581257
}
12591258

1260-
boolean isAlwaysUsePartitionedQueries() {
1261-
return this.alwaysUsePartitionedQueries;
1259+
boolean isAutoPartitionMode() {
1260+
return this.autoPartitionMode;
12621261
}
12631262

12641263
int getMaxPartitions() {

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionStatementExecutorImpl.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -521,15 +521,14 @@ public StatementResult statementSetDataBoostEnabled(Boolean dataBoostEnabled) {
521521
public StatementResult statementShowAlwaysUsePartitionedQueries() {
522522
return resultSet(
523523
String.format("%sALWAYS_USE_PARTITIONED_QUERIES", getNamespace(connection.getDialect())),
524-
getConnection().isAlwaysUsePartitionedQueries(),
524+
getConnection().isAutoPartitionMode(),
525525
SHOW_ALWAYS_USE_PARTITIONED_QUERIES);
526526
}
527527

528528
@Override
529529
public StatementResult statementSetAlwaysUsePartitionedQueries(
530530
Boolean alwaysUsePartitionedQueries) {
531-
getConnection()
532-
.setAlwaysUsePartitionedQueries(Preconditions.checkNotNull(alwaysUsePartitionedQueries));
531+
getConnection().setAutoPartitionMode(Preconditions.checkNotNull(alwaysUsePartitionedQueries));
533532
return noResult(SET_ALWAYS_USE_PARTITIONED_QUERIES);
534533
}
535534

‎google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ConnectionOptionsTest.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -557,25 +557,25 @@ public void testDataBoostEnabledDefault() {
557557
}
558558

559559
@Test
560-
public void testAlwaysUsePartitionedQueries() {
560+
public void testAutoPartitionMode() {
561561
ConnectionOptions options =
562562
ConnectionOptions.newBuilder()
563563
.setUri(
564-
"cloudspanner:/projects/test-project-123/instances/test-instance/databases/test-database?alwaysUsePartitionedQueries=true")
564+
"cloudspanner:/projects/test-project-123/instances/test-instance/databases/test-database?autoPartitionMode=true")
565565
.setCredentialsUrl(FILE_TEST_PATH)
566566
.build();
567-
assertTrue(options.isAlwaysUsePartitionedQueries());
567+
assertTrue(options.isAutoPartitionMode());
568568
}
569569

570570
@Test
571-
public void testAlwaysUsePartitionedQueriesDefault() {
571+
public void testAutoPartitionModeDefault() {
572572
ConnectionOptions options =
573573
ConnectionOptions.newBuilder()
574574
.setUri(
575575
"cloudspanner:/projects/test-project-123/instances/test-instance/databases/test-database")
576576
.setCredentialsUrl(FILE_TEST_PATH)
577577
.build();
578-
assertFalse(options.isAlwaysUsePartitionedQueries());
578+
assertFalse(options.isAutoPartitionMode());
579579
}
580580

581581
@Test

0 commit comments

Comments
 (0)