Skip to content

fix: deprecate databaseId on datastore-v1-proto-client DatastoreOptions #1190

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
merged 4 commits into from
Sep 14, 2023
Merged

fix: deprecate databaseId on datastore-v1-proto-client DatastoreOptions #1190

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
9d77f9e
fix: deprecate `databaseId` on datastore-v1-proto-client DatastoreOpt…
kolea2 Sep 13, 2023
da39c4f
lint
kolea2 Sep 13, 2023
fbeba2b
Merge branch 'main' of github.com:googleapis/java-datastore into data…
kolea2 Sep 14, 2023
2135012
review feedback
kolea2 Sep 14, 2023
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
33 changes: 30 additions & 3 deletions datastore-v1-proto-client/src/main/java/com/google/datastore/v1/client/DatastoreOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@
*/
public class DatastoreOptions {
private final String projectId;
private final String databaseId;

@Deprecated private final String databaseId;

private final String projectEndpoint;
private final String host;
private final String localHost;
Expand Down Expand Up @@ -75,7 +77,9 @@ public static class Builder {
"Can set at most one of project endpoint, host, and local host.";

private String projectId;
private String databaseId;

@Deprecated private String databaseId;

private String projectEndpoint;
private String host;
private String localHost;
Expand Down Expand Up @@ -107,8 +111,19 @@ public Builder projectId(String projectId) {
return this;
}

/** Sets the database ID used to access Cloud Datastore. */
/**
* This field is ignored and will be removed in a future release. Please set the database id on
* the request itself. For example:
*
* <pre>{@code
* CommitRequest.newBuilder()
* .setDatabaseId("my-database-id")
* ....
* .build();
* }</pre>
*/
@BetaApi
@Deprecated
public Builder databaseId(String databaseId) {
this.databaseId = databaseId;
return this;
Expand Down Expand Up @@ -188,7 +203,19 @@ public String getProjectId() {
return projectId;
}

/**
* This field is ignored and will be removed in a future release. Please set the database id on
* the request itself. For example:
*
* <pre>{@code
* CommitRequest.newBuilder()
* .setDatabaseId("my-database-id")
* ....
* .build();
* }</pre>
*/
@BetaApi
@Deprecated
public String getDatabaseId() {
return databaseId;
}
Expand Down
1 change: 1 addition & 0 deletions ...ore-v1-proto-client/src/test/java/com/google/datastore/v1/client/DatastoreClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ public void create_LocalHost() {
}

@Test
// TODO: remove this test once deprecated `databaseId` is removed
public void setDatabaseId() {
DatastoreOptions options =
new DatastoreOptions.Builder()
Expand Down
1 change: 0 additions & 1 deletion google-cloud-datastore/src/main/java/com/google/cloud/datastore/spi/v1/HttpDatastoreRpc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ public HttpDatastoreRpc(DatastoreOptions options) {
com.google.datastore.v1.client.DatastoreOptions.Builder clientBuilder =
new com.google.datastore.v1.client.DatastoreOptions.Builder()
.projectId(options.getProjectId())
.databaseId(options.getDatabaseId())
.initializer(getHttpRequestInitializer(options, httpTransportOptions))
.transport(transport);
String normalizedHost = options.getHost() != null ? options.getHost().toLowerCase() : "";
Expand Down