Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add support for table snapshot (#1320)
* feat: add table snapshot support Allows users to generate a persistent copy of an existing table as it were at a given point in time within the same project. * feat: add support for table snapshot * add comment on operationType * lint update and remove extraneous update table snapshot IT * add cleanup for restoredTable * update base on comments * update based on comments
- Loading branch information
1 parent
9bd442a
commit d783292
Showing
6 changed files
with
301 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
112 changes: 112 additions & 0 deletions
112
google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/SnapshotTableDefinition.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| /* | ||
| * Copyright 2021 Google LLC | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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 com.google.cloud.bigquery; | ||
|
|
||
| import com.google.api.client.util.DateTime; | ||
| import com.google.api.core.BetaApi; | ||
| import com.google.api.services.bigquery.model.Table; | ||
| import com.google.auto.value.AutoValue; | ||
| import com.google.common.annotations.VisibleForTesting; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| @AutoValue | ||
| @BetaApi | ||
| public abstract class SnapshotTableDefinition extends TableDefinition { | ||
|
|
||
| private static final long serialVersionUID = 2113445776046717526L; | ||
|
|
||
| @AutoValue.Builder | ||
| public abstract static class Builder | ||
| extends TableDefinition.Builder<SnapshotTableDefinition, Builder> { | ||
|
|
||
| /** Reference describing the ID of the table that was snapshot. * */ | ||
| public abstract Builder setBaseTableId(TableId baseTableId); | ||
|
|
||
| /** | ||
| * The time at which the base table was snapshot. This value is reported in the JSON response | ||
| * using RFC3339 format. * | ||
| */ | ||
| public abstract Builder setSnapshotTime(String dateTime); | ||
|
|
||
| public abstract Builder setTimePartitioning(TimePartitioning timePartitioning); | ||
|
|
||
| public abstract Builder setRangePartitioning(RangePartitioning rangePartitioning); | ||
|
|
||
| public abstract Builder setClustering(Clustering clustering); | ||
|
|
||
| /** Creates a {@code SnapshotTableDefinition} object. */ | ||
| public abstract SnapshotTableDefinition build(); | ||
| } | ||
|
|
||
| @Nullable | ||
| public abstract TableId getBaseTableId(); | ||
|
|
||
| @Nullable | ||
| public abstract String getSnapshotTime(); | ||
|
|
||
| @Nullable | ||
| public abstract TimePartitioning getTimePartitioning(); | ||
|
|
||
| @Nullable | ||
| public abstract RangePartitioning getRangePartitioning(); | ||
|
|
||
| @Nullable | ||
| public abstract Clustering getClustering(); | ||
|
|
||
| /** Returns a builder for a snapshot table definition. */ | ||
| public static SnapshotTableDefinition.Builder newBuilder() { | ||
| return new AutoValue_SnapshotTableDefinition.Builder().setType(Type.SNAPSHOT); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| public abstract SnapshotTableDefinition.Builder toBuilder(); | ||
|
|
||
| @Override | ||
| Table toPb() { | ||
| Table tablePb = super.toPb(); | ||
| com.google.api.services.bigquery.model.SnapshotDefinition snapshotDefinition = | ||
| new com.google.api.services.bigquery.model.SnapshotDefinition(); | ||
| snapshotDefinition.setBaseTableReference(getBaseTableId().toPb()); | ||
| snapshotDefinition.setSnapshotTime(DateTime.parseRfc3339(getSnapshotTime())); | ||
| tablePb.setSnapshotDefinition(snapshotDefinition); | ||
| if (getTimePartitioning() != null) { | ||
| tablePb.setTimePartitioning(getTimePartitioning().toPb()); | ||
| } | ||
| if (getRangePartitioning() != null) { | ||
| tablePb.setRangePartitioning(getRangePartitioning().toPb()); | ||
| } | ||
| if (getClustering() != null) { | ||
| tablePb.setClustering(getClustering().toPb()); | ||
| } | ||
| return tablePb; | ||
| } | ||
|
|
||
| static SnapshotTableDefinition fromPb(Table tablePb) { | ||
| Builder builder = newBuilder().table(tablePb); | ||
| com.google.api.services.bigquery.model.SnapshotDefinition snapshotDefinition = | ||
| tablePb.getSnapshotDefinition(); | ||
| if (snapshotDefinition != null) { | ||
| if (snapshotDefinition.getBaseTableReference() != null) { | ||
| builder.setBaseTableId(TableId.fromPb(snapshotDefinition.getBaseTableReference())); | ||
| } | ||
| if (snapshotDefinition.getSnapshotTime() != null) { | ||
| builder.setSnapshotTime(snapshotDefinition.getSnapshotTime().toStringRfc3339()); | ||
| } | ||
| } | ||
| return builder.build(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
72 changes: 72 additions & 0 deletions
72
...e-cloud-bigquery/src/test/java/com/google/cloud/bigquery/SnapshotTableDefinitionTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /* | ||
| * Copyright 2021 Google LLC | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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 com.google.cloud.bigquery; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertTrue; | ||
|
|
||
| import org.junit.Test; | ||
|
|
||
| public class SnapshotTableDefinitionTest { | ||
|
|
||
| private static final TableId BASE_TABLE_ID = TableId.of("DATASET_NAME", "BASE_TABLE_NAME"); | ||
| private static final String SNAPSHOT_TIME = "2021-05-19T11:32:26.553Z"; | ||
| private static final SnapshotTableDefinition SNAPSHOTTABLE_DEFINITION = | ||
| SnapshotTableDefinition.newBuilder() | ||
| .setBaseTableId(BASE_TABLE_ID) | ||
| .setSnapshotTime(SNAPSHOT_TIME) | ||
| .build(); | ||
|
|
||
| @Test | ||
| public void testToBuilder() { | ||
| compareSnapshotTableDefinition( | ||
| SNAPSHOTTABLE_DEFINITION, SNAPSHOTTABLE_DEFINITION.toBuilder().build()); | ||
| SnapshotTableDefinition snapshotTableDefinition = | ||
| SNAPSHOTTABLE_DEFINITION.toBuilder().setSnapshotTime("2021-05-20T11:32:26.553Z").build(); | ||
| assertEquals("2021-05-20T11:32:26.553Z", snapshotTableDefinition.getSnapshotTime()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testBuilder() { | ||
| assertEquals(TableDefinition.Type.SNAPSHOT, SNAPSHOTTABLE_DEFINITION.getType()); | ||
| assertEquals(BASE_TABLE_ID, SNAPSHOTTABLE_DEFINITION.getBaseTableId()); | ||
| assertEquals(SNAPSHOT_TIME, SNAPSHOTTABLE_DEFINITION.getSnapshotTime()); | ||
| SnapshotTableDefinition snapshotTableDefinition = | ||
| SnapshotTableDefinition.newBuilder() | ||
| .setBaseTableId(BASE_TABLE_ID) | ||
| .setSnapshotTime(SNAPSHOT_TIME) | ||
| .build(); | ||
| assertEquals(SNAPSHOTTABLE_DEFINITION, snapshotTableDefinition); | ||
| } | ||
|
|
||
| @Test | ||
| public void testToAndFromPb() { | ||
| SnapshotTableDefinition snapshotTableDefinition = SNAPSHOTTABLE_DEFINITION.toBuilder().build(); | ||
| assertTrue( | ||
| TableDefinition.fromPb(snapshotTableDefinition.toPb()) instanceof SnapshotTableDefinition); | ||
| compareSnapshotTableDefinition( | ||
| snapshotTableDefinition, | ||
| TableDefinition.<SnapshotTableDefinition>fromPb(snapshotTableDefinition.toPb())); | ||
| } | ||
|
|
||
| private void compareSnapshotTableDefinition( | ||
| SnapshotTableDefinition expected, SnapshotTableDefinition value) { | ||
| assertEquals(expected, value); | ||
| assertEquals(expected.getBaseTableId(), value.getBaseTableId()); | ||
| assertEquals(expected.getSnapshotTime(), value.getSnapshotTime()); | ||
| } | ||
| } |
Oops, something went wrong.