Skip to content

[BEAM-9821] Populate all SpannerIO batching parameters in display data. #11528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheNeuralBit merged 4 commits into from
May 19, 2020
Merged

[BEAM-9821] Populate all SpannerIO batching parameters in display data. #11528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7c81b93
Populate all SpannerIO batching parameters in display data.
nielm Apr 26, 2020
9ded9e2
Fix capitalization, clarify descriptions
TheNeuralBit May 14, 2020
192e9ad
fix capitalization, clarify description Grouped
TheNeuralBit May 14, 2020
30a68f5
Refactor to extract single method for popuplating displayData
nielm May 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion .../io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/spanner/SpannerIO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -953,9 +953,23 @@ public SpannerWriteResult expand(PCollection<Mutation> input) {
@Override
public void populateDisplayData(DisplayData.Builder builder) {
super.populateDisplayData(builder);
populateDisplayDataWithParamaters(builder);
}

private void populateDisplayDataWithParamaters(DisplayData.Builder builder) {
getSpannerConfig().populateDisplayData(builder);
builder.add(
DisplayData.item("batchSizeBytes", getBatchSizeBytes()).withLabel("Batch Size in Bytes"));
DisplayData.item("batchSizeBytes", getBatchSizeBytes())
.withLabel("Max batch size in bytes"));
builder.add(
DisplayData.item("maxNumMutations", getMaxNumMutations())
.withLabel("Max number of mutated cells in each batch"));
builder.add(
DisplayData.item("maxNumRows", getMaxNumRows())
.withLabel("Max number of rows in each batch"));
builder.add(
DisplayData.item("groupingFactor", getGroupingFactor())
.withLabel("Number of batches to sort over"));
}
}

Expand Down Expand Up @@ -992,6 +1006,12 @@ public WriteGrouped(Write spec) {
this.spec = spec;
}

@Override
public void populateDisplayData(DisplayData.Builder builder) {
super.populateDisplayData(builder);
spec.populateDisplayDataWithParamaters(builder);
}

@Override
public SpannerWriteResult expand(PCollection<MutationGroup> input) {

Expand Down
36 changes: 33 additions & 3 deletions ...e-cloud-platform/src/test/java/org/apache/beam/sdk/io/gcp/spanner/SpannerIOWriteTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,20 +589,50 @@ public void retryOnAbortedAndDeadlineExceeded() throws InterruptedException {
}

@Test
public void displayData() throws Exception {
public void displayDataWrite() throws Exception {
SpannerIO.Write write =
SpannerIO.write()
.withProjectId("test-project")
.withInstanceId("test-instance")
.withDatabaseId("test-database")
.withBatchSizeBytes(123);
.withBatchSizeBytes(123)
.withMaxNumMutations(456)
.withMaxNumRows(789)
.withGroupingFactor(100);

DisplayData data = DisplayData.from(write);
assertThat(data.items(), hasSize(4));
assertThat(data.items(), hasSize(7));
assertThat(data, hasDisplayItem("projectId", "test-project"));
assertThat(data, hasDisplayItem("instanceId", "test-instance"));
assertThat(data, hasDisplayItem("databaseId", "test-database"));
assertThat(data, hasDisplayItem("batchSizeBytes", 123));
assertThat(data, hasDisplayItem("maxNumMutations", 456));
assertThat(data, hasDisplayItem("maxNumRows", 789));
assertThat(data, hasDisplayItem("groupingFactor", 100));
}

@Test
public void displayDataWriteGrouped() throws Exception {
SpannerIO.WriteGrouped writeGrouped =
SpannerIO.write()
.withProjectId("test-project")
.withInstanceId("test-instance")
.withDatabaseId("test-database")
.withBatchSizeBytes(123)
.withMaxNumMutations(456)
.withMaxNumRows(789)
.withGroupingFactor(100)
.grouped();

DisplayData data = DisplayData.from(writeGrouped);
assertThat(data.items(), hasSize(7));
assertThat(data, hasDisplayItem("projectId", "test-project"));
assertThat(data, hasDisplayItem("instanceId", "test-instance"));
assertThat(data, hasDisplayItem("databaseId", "test-database"));
assertThat(data, hasDisplayItem("batchSizeBytes", 123));
assertThat(data, hasDisplayItem("maxNumMutations", 456));
assertThat(data, hasDisplayItem("maxNumRows", 789));
assertThat(data, hasDisplayItem("groupingFactor", 100));
}

@Test
Expand Down