Skip to content
This repository was archived by the owner on Mar 23, 2026. It is now read-only.

Commit afb571c

Browse files
obada-abobada-ab
authored
feat: add primary key and foreign keys (#2744)
Add support for creating/updating primary and foreign keys Internal b/284849902
1 parent aa38428 commit afb571c

16 files changed

Lines changed: 1143 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/java-bigquery/tree
145145
| Create Table Cmek | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/CreateTableCmek.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/CreateTableCmek.java) |
146146
| Create Table External Hive Partitioned | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/CreateTableExternalHivePartitioned.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/CreateTableExternalHivePartitioned.java) |
147147
| Create Table Without Schema | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/CreateTableWithoutSchema.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/CreateTableWithoutSchema.java) |
148+
| Create Tables With Primary And Foreign Keys | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/CreateTablesWithPrimaryAndForeignKeys.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/CreateTablesWithPrimaryAndForeignKeys.java) |
148149
| Create View | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/CreateView.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/CreateView.java) |
149150
| Dataset Exists | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/DatasetExists.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/DatasetExists.java) |
150151
| Ddl Create View | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/DdlCreateView.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/DdlCreateView.java) |

‎google-cloud-bigquery/clirr-ignored-differences.xml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,19 @@
4444
<className>com/google/cloud/bigquery/TableInfo*</className>
4545
<method>*DefaultCollation(*)</method>
4646
</difference>
47-
4847
<difference>
4948
<differenceType>7013</differenceType>
5049
<className>com/google/cloud/bigquery/TableInfo*</className>
5150
<method>*CloneDefinition(*)</method>
5251
</difference>
52+
<difference>
53+
<differenceType>7013</differenceType>
54+
<className>com/google/cloud/bigquery/StandardTableDefinition*</className>
55+
<method>*TableConstraints(*)</method>
56+
</difference>
57+
<difference>
58+
<differenceType>7013</differenceType>
59+
<className>com/google/cloud/bigquery/TableInfo*</className>
60+
<method>*TableConstraints(*)</method>
61+
</difference>
5362
</differences>

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/ColumnReference.java‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
/*
2+
* Copyright 2023 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.cloud.bigquery;
18+
19+
import com.google.auto.value.AutoValue;
20+
import com.google.common.annotations.VisibleForTesting;
21+
import javax.annotation.Nullable;
22+
23+
@AutoValue
24+
public abstract class ColumnReference {
25+
public static ColumnReference.Builder newBuilder() {
26+
return new AutoValue_ColumnReference.Builder();
27+
}
28+
29+
static ColumnReference fromPb(
30+
com.google.api.services.bigquery.model.TableConstraints.ForeignKeys.ColumnReferences
31+
columnReference) {
32+
ColumnReference.Builder builder = newBuilder();
33+
34+
if (columnReference.getReferencedColumn() != null) {
35+
builder.setReferencedColumn(columnReference.getReferencedColumn());
36+
}
37+
38+
if (columnReference.getReferencingColumn() != null) {
39+
builder.setReferencingColumn(columnReference.getReferencingColumn());
40+
}
41+
42+
return builder.build();
43+
}
44+
45+
com.google.api.services.bigquery.model.TableConstraints.ForeignKeys.ColumnReferences toPb() {
46+
47+
com.google.api.services.bigquery.model.TableConstraints.ForeignKeys.ColumnReferences
48+
columnReference =
49+
new com.google.api.services.bigquery.model.TableConstraints.ForeignKeys
50+
.ColumnReferences();
51+
columnReference.setReferencedColumn(getReferencedColumn());
52+
columnReference.setReferencingColumn(getReferencingColumn());
53+
54+
return columnReference;
55+
}
56+
57+
@Nullable
58+
public abstract String getReferencedColumn();
59+
60+
@Nullable
61+
public abstract String getReferencingColumn();
62+
63+
/** Returns a builder for column reference. */
64+
@VisibleForTesting
65+
public abstract ColumnReference.Builder toBuilder();
66+
67+
@AutoValue.Builder
68+
public abstract static class Builder {
69+
70+
/** The target column of this reference. * */
71+
public abstract ColumnReference.Builder setReferencedColumn(String referencedColumn);
72+
73+
/** The source column of this reference. * */
74+
public abstract ColumnReference.Builder setReferencingColumn(String referencingColumn);
75+
76+
/** Creates a {@code ColumnReference} object. */
77+
public abstract ColumnReference build();
78+
}
79+
}

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/ForeignKey.java‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
/*
2+
* Copyright 2023 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.cloud.bigquery;
18+
19+
import com.google.auto.value.AutoValue;
20+
import com.google.common.annotations.VisibleForTesting;
21+
import java.io.Serializable;
22+
import java.util.List;
23+
import java.util.stream.Collectors;
24+
import javax.annotation.Nullable;
25+
26+
@AutoValue
27+
public abstract class ForeignKey implements Serializable {
28+
public static ForeignKey.Builder newBuilder() {
29+
return new AutoValue_ForeignKey.Builder();
30+
}
31+
32+
static ForeignKey fromPb(
33+
com.google.api.services.bigquery.model.TableConstraints.ForeignKeys foreignKey) {
34+
ForeignKey.Builder builder = newBuilder();
35+
36+
if (foreignKey.getName() != null) {
37+
builder.setName(foreignKey.getName());
38+
}
39+
40+
if (foreignKey.getReferencedTable() != null) {
41+
com.google.api.services.bigquery.model.TableConstraints.ForeignKeys.ReferencedTable
42+
referencedTable = foreignKey.getReferencedTable();
43+
builder.setReferencedTable(
44+
TableId.of(
45+
referencedTable.getProjectId(),
46+
referencedTable.getDatasetId(),
47+
referencedTable.getTableId()));
48+
}
49+
50+
if (foreignKey.getColumnReferences() != null) {
51+
builder.setColumnReferences(
52+
foreignKey.getColumnReferences().stream()
53+
.map(ColumnReference::fromPb)
54+
.collect(Collectors.toList()));
55+
}
56+
57+
return builder.build();
58+
}
59+
60+
com.google.api.services.bigquery.model.TableConstraints.ForeignKeys toPb() {
61+
62+
com.google.api.services.bigquery.model.TableConstraints.ForeignKeys foreignKey =
63+
new com.google.api.services.bigquery.model.TableConstraints.ForeignKeys();
64+
if (getName() != null) {
65+
foreignKey.setName(getName());
66+
}
67+
if (getReferencedTable() != null) {
68+
TableId referencedTableId = getReferencedTable();
69+
foreignKey.setReferencedTable(
70+
new com.google.api.services.bigquery.model.TableConstraints.ForeignKeys.ReferencedTable()
71+
.setTableId(referencedTableId.getTable())
72+
.setDatasetId(referencedTableId.getDataset())
73+
.setProjectId(referencedTableId.getProject()));
74+
}
75+
if (getColumnReferences() != null) {
76+
foreignKey.setColumnReferences(
77+
getColumnReferences().stream().map(ColumnReference::toPb).collect(Collectors.toList()));
78+
}
79+
return foreignKey;
80+
}
81+
82+
@Nullable
83+
public abstract String getName();
84+
85+
@Nullable
86+
public abstract TableId getReferencedTable();
87+
88+
@Nullable
89+
public abstract List<ColumnReference> getColumnReferences();
90+
91+
/** Returns a builder for foreign key. */
92+
@VisibleForTesting
93+
public abstract ForeignKey.Builder toBuilder();
94+
95+
@AutoValue.Builder
96+
public abstract static class Builder {
97+
98+
/** The name of the foreign key. * */
99+
public abstract ForeignKey.Builder setName(String name);
100+
101+
/** The table referenced by this foreign key. * */
102+
public abstract ForeignKey.Builder setReferencedTable(TableId referencedTable);
103+
104+
/** The set of column references for this foreign key. * */
105+
public abstract ForeignKey.Builder setColumnReferences(List<ColumnReference> columnReferences);
106+
107+
/** Creates a {@code ForignKey} object. */
108+
public abstract ForeignKey build();
109+
}
110+
}

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/PrimaryKey.java‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
/*
2+
* Copyright 2023 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.cloud.bigquery;
18+
19+
import com.google.auto.value.AutoValue;
20+
import com.google.common.annotations.VisibleForTesting;
21+
import java.io.Serializable;
22+
import java.util.List;
23+
import javax.annotation.Nullable;
24+
25+
@AutoValue
26+
public abstract class PrimaryKey implements Serializable {
27+
public static PrimaryKey.Builder newBuilder() {
28+
return new AutoValue_PrimaryKey.Builder();
29+
}
30+
31+
static PrimaryKey fromPb(
32+
com.google.api.services.bigquery.model.TableConstraints.PrimaryKey primaryKey) {
33+
PrimaryKey.Builder builder = newBuilder();
34+
35+
if (primaryKey.getColumns() != null) {
36+
builder.setColumns(primaryKey.getColumns());
37+
}
38+
39+
return builder.build();
40+
}
41+
42+
com.google.api.services.bigquery.model.TableConstraints.PrimaryKey toPb() {
43+
44+
com.google.api.services.bigquery.model.TableConstraints.PrimaryKey primaryKey =
45+
new com.google.api.services.bigquery.model.TableConstraints.PrimaryKey();
46+
if (getColumns() != null) {
47+
primaryKey.setColumns(getColumns());
48+
}
49+
return primaryKey;
50+
}
51+
52+
@Nullable
53+
public abstract List<String> getColumns();
54+
55+
/** Returns a builder for primary key. */
56+
@VisibleForTesting
57+
public abstract PrimaryKey.Builder toBuilder();
58+
59+
@AutoValue.Builder
60+
public abstract static class Builder {
61+
62+
/** The column names that are primary keys. * */
63+
public abstract PrimaryKey.Builder setColumns(List<String> columns);
64+
65+
/** Creates a {@code PrimaryKey} object. */
66+
public abstract PrimaryKey build();
67+
}
68+
}

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/StandardTableDefinition.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,8 @@ public abstract static class Builder
161161
*/
162162
public abstract Builder setClustering(Clustering clustering);
163163

164+
public abstract Builder setTableConstraints(TableConstraints tableConstraints);
165+
164166
/** Creates a {@code StandardTableDefinition} object. */
165167
public abstract StandardTableDefinition build();
166168
}
@@ -221,6 +223,13 @@ public abstract static class Builder
221223
@Nullable
222224
public abstract Clustering getClustering();
223225

226+
/**
227+
* Returns the table constraints for this table. Returns {@code null} if no table constraints are
228+
* set for this table.
229+
*/
230+
@Nullable
231+
public abstract TableConstraints getTableConstraints();
232+
224233
/** Returns a builder for a BigQuery standard table definition. */
225234
public static Builder newBuilder() {
226235
return new AutoValue_StandardTableDefinition.Builder().setType(Type.TABLE);
@@ -259,6 +268,9 @@ Table toPb() {
259268
if (getClustering() != null) {
260269
tablePb.setClustering(getClustering().toPb());
261270
}
271+
if (getTableConstraints() != null) {
272+
tablePb.setTableConstraints(getTableConstraints().toPb());
273+
}
262274
return tablePb;
263275
}
264276

@@ -296,6 +308,9 @@ static StandardTableDefinition fromPb(Table tablePb) {
296308
if (tablePb.getNumLongTermBytes() != null) {
297309
builder.setNumLongTermBytes(tablePb.getNumLongTermBytes());
298310
}
311+
if (tablePb.getTableConstraints() != null) {
312+
builder.setTableConstraints(TableConstraints.fromPb(tablePb.getTableConstraints()));
313+
}
299314
return builder.setNumBytes(tablePb.getNumBytes()).setLocation(tablePb.getLocation()).build();
300315
}
301316
}

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/Table.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,12 @@ public TableInfo.Builder setCloneDefinition(CloneDefinition cloneDefinition) {
168168
return this;
169169
}
170170

171+
@Override
172+
public Builder setTableConstraints(TableConstraints tableConstraints) {
173+
infoBuilder.setTableConstraints(tableConstraints);
174+
return this;
175+
}
176+
171177
@Override
172178
public Table build() {
173179
return new Table(bigquery, infoBuilder);

0 commit comments

Comments
 (0)