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.
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
docs: samples and tests for auto-generated createDatabase and createInstance APIs. #2764
Merged
Merged
Changes from 25 commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
edc5bbf
fix: prevent illegal negative timeout values into thread sleep() meth…
arpan14 49a85df
Merge pull request #1 from arpan14/retryerror
arpan14 4cd497b
Fixing lint issues.
arpan14 4a6aa8e
Merge branch 'googleapis:main' into main
arpan14 b2aa09d
Merge branch 'googleapis:main' into main
arpan14 8d6d71e
Merge branch 'googleapis:main' into main
arpan14 77e6e7d
Merge branch 'googleapis:main' into main
arpan14 e8b7fad
Merge branch 'googleapis:main' into main
arpan14 8aa84e1
Merge branch 'googleapis:main' into main
arpan14 57fd405
Merge branch 'googleapis:main' into main
arpan14 1253563
Merge branch 'googleapis:main' into main
arpan14 c249a05
chore: adding a few samples with auto-gen clients.
arpan14 6eb9f2d
chore: adding integration tests for samples.
arpan14 e2baca9
chore: fixing the end-point for staging.
arpan14 01a2369
chore: modified test for CreateDatabaseWithDefaultLeaderSample.
arpan14 8daf0df
chore: adding sample and integration test for CreateInstanceSample.
arpan14 22dbd2f
chore: adding license headers.
arpan14 b0ce7ca
chore: fix lint errors.
arpan14 cfada59
chore: rename file and add sample tags.
arpan14 4846143
chore: address comments.
arpan14 17bf04d
Update samples/snippets/src/main/java/com/example/spanner/v2/CreateDa…
arpan14 6087d7f
chore: rename file path.
arpan14 033a505
chore: remove admin settings.
arpan14 91febb4
Merge branch 'googleapis:main' into auto-gen-admin-client
arpan14 2bb6e11
chore: address comments.
arpan14 a20463e
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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
78 changes: 78 additions & 0 deletions
78
.../main/java/com/example/spanner/admin/generated/CreateDatabaseWithDefaultLeaderSample.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,78 @@ | ||
| /* | ||
| * Copyright 2023 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.example.spanner.admin.generated; | ||
|
|
||
| //[START spanner_create_database_with_default_leader] | ||
|
|
||
| import com.google.cloud.spanner.SpannerException; | ||
| import com.google.cloud.spanner.SpannerExceptionFactory; | ||
| import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient; | ||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.spanner.admin.database.v1.CreateDatabaseRequest; | ||
| import com.google.spanner.admin.database.v1.Database; | ||
| import java.io.IOException; | ||
| import java.util.concurrent.ExecutionException; | ||
|
|
||
| public class CreateDatabaseWithDefaultLeaderSample { | ||
|
|
||
| static void createDatabaseWithDefaultLeader() throws IOException { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| final String instanceName = "projects/my-project/instances/my-instance-id"; | ||
| final String databaseId = "my-database-name"; | ||
| final String defaultLeader = "my-default-leader"; | ||
| createDatabaseWithDefaultLeader(instanceName, databaseId, defaultLeader); | ||
| } | ||
|
|
||
| static void createDatabaseWithDefaultLeader(String instanceName, String databaseId, | ||
| String defaultLeader) throws IOException { | ||
| DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create(); | ||
|
|
||
| try { | ||
| Database createdDatabase = | ||
| databaseAdminClient.createDatabaseAsync( | ||
| CreateDatabaseRequest.newBuilder() | ||
| .setParent(instanceName) | ||
| .setCreateStatement("CREATE DATABASE `" + databaseId + "`") | ||
| .addAllExtraStatements( | ||
| ImmutableList.of("CREATE TABLE Singers (" | ||
| + " SingerId INT64 NOT NULL," | ||
| + " FirstName STRING(1024)," | ||
| + " LastName STRING(1024)," | ||
| + " SingerInfo BYTES(MAX)" | ||
| + ") PRIMARY KEY (SingerId)", | ||
| "CREATE TABLE Albums (" | ||
| + " SingerId INT64 NOT NULL," | ||
| + " AlbumId INT64 NOT NULL," | ||
| + " AlbumTitle STRING(MAX)" | ||
| + ") PRIMARY KEY (SingerId, AlbumId)," | ||
| + " INTERLEAVE IN PARENT Singers ON DELETE CASCADE", | ||
| "ALTER DATABASE " + "`" + databaseId + "`" | ||
| + " SET OPTIONS ( default_leader = '" + defaultLeader + "' )")) | ||
| .build()).get(); | ||
| System.out.println("Created database [" + createdDatabase.getName() + "]"); | ||
| System.out.println("\tDefault leader: " + createdDatabase.getDefaultLeader()); | ||
| } catch (ExecutionException e) { | ||
| // If the operation failed during execution, expose the cause. | ||
| throw (SpannerException) e.getCause(); | ||
| } catch (InterruptedException e) { | ||
| // Throw when a thread is waiting, sleeping, or otherwise occupied, | ||
| // and the thread is interrupted, either before or during the activity. | ||
| throw SpannerExceptionFactory.propagateInterrupt(e); | ||
| } | ||
| } | ||
| } | ||
| //[END spanner_create_database_with_default_leader] | ||
70 changes: 70 additions & 0 deletions
70
...les/snippets/src/main/java/com/example/spanner/admin/generated/CreateInstanceExample.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,70 @@ | ||
| /* | ||
| * Copyright 2023 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.example.spanner.admin.generated; | ||
|
|
||
| //[START spanner_create_instance] | ||
| import com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient; | ||
| import com.google.spanner.admin.instance.v1.CreateInstanceRequest; | ||
| import com.google.spanner.admin.instance.v1.Instance; | ||
| import com.google.spanner.admin.instance.v1.InstanceConfigName; | ||
| import com.google.spanner.admin.instance.v1.ProjectName; | ||
| import java.io.IOException; | ||
| import java.util.concurrent.ExecutionException; | ||
|
|
||
| class CreateInstanceExample { | ||
|
|
||
| static void createInstance() throws IOException { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| String projectId = "my-project"; | ||
| String instanceId = "my-instance"; | ||
| createInstance(projectId, instanceId); | ||
| } | ||
|
|
||
| static void createInstance(String projectId, String instanceId) throws IOException { | ||
| InstanceAdminClient instanceAdminClient = InstanceAdminClient.create(); | ||
|
|
||
| // Set Instance configuration. | ||
| int nodeCount = 2; | ||
| String displayName = "Descriptive name"; | ||
|
|
||
| // Create an Instance object that will be used to create the instance. | ||
| Instance instance = | ||
| Instance.newBuilder() | ||
| .setDisplayName(displayName) | ||
| .setNodeCount(nodeCount) | ||
| .setConfig( | ||
| InstanceConfigName.of(projectId, "regional-us-central1").toString()) | ||
| .build(); | ||
| try { | ||
| // Wait for the createInstance operation to finish. | ||
| Instance createdInstance = instanceAdminClient.createInstanceAsync( | ||
| CreateInstanceRequest.newBuilder() | ||
| .setParent(ProjectName.of(projectId).toString()) | ||
| .setInstanceId(instanceId) | ||
| .setInstance(instance) | ||
| .build()).get(); | ||
| System.out.printf("Instance %s was successfully created%n", createdInstance.getName()); | ||
| } catch (ExecutionException e) { | ||
| System.out.printf( | ||
| "Error: Creating instance %s failed with error message %s%n", | ||
| instance.getName(), e.getMessage()); | ||
| } catch (InterruptedException e) { | ||
| System.out.println("Error: Waiting for createInstance operation to finish was interrupted"); | ||
| } | ||
| } | ||
| } | ||
| //[END spanner_create_instance] |
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
61 changes: 61 additions & 0 deletions
61
...est/java/com/example/spanner/admin/generated/CreateDatabaseWithDefaultLeaderSampleIT.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,61 @@ | ||
| /* | ||
| * Copyright 2023 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.example.spanner.admin.generated; | ||
|
|
||
| import static org.junit.Assert.assertTrue; | ||
|
|
||
| import com.example.spanner.SampleRunner; | ||
| import com.google.spanner.admin.instance.v1.InstanceConfig; | ||
| import com.google.spanner.admin.instance.v1.InstanceName; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| @RunWith(JUnit4.class) | ||
| public class CreateDatabaseWithDefaultLeaderSampleIT extends SampleTestBaseV2 { | ||
|
|
||
| @Test | ||
| public void testCreateDatabaseWithDefaultLeader() throws Exception { | ||
| final String databaseId = idGenerator.generateDatabaseId(); | ||
|
|
||
| // Finds possible default leader | ||
|
|
||
| final String instanceConfigId = instanceAdminClient.getInstance( | ||
| InstanceName.of(projectId, multiRegionalInstanceId)).getConfig(); | ||
| final InstanceConfig config = instanceAdminClient.getInstanceConfig(instanceConfigId); | ||
| assertTrue( | ||
| "Expected instance config " + instanceConfigId + " to have at least one leader option", | ||
| config.getLeaderOptionsCount() > 0 | ||
| ); | ||
| final String defaultLeader = config.getLeaderOptions(0); | ||
|
|
||
| // Runs sample | ||
| final String out = SampleRunner.runSample(() -> | ||
| CreateDatabaseWithDefaultLeaderSample.createDatabaseWithDefaultLeader( | ||
| getInstanceName(projectId, multiRegionalInstanceId), | ||
| databaseId, | ||
| defaultLeader | ||
| ) | ||
| ); | ||
|
|
||
| assertTrue( | ||
| "Expected created database to have default leader " + defaultLeader + "." | ||
| + " Output received was " + out, | ||
| out.contains("Default leader: " + defaultLeader) | ||
| ); | ||
| } | ||
| } |
43 changes: 43 additions & 0 deletions
43
...es/snippets/src/test/java/com/example/spanner/admin/generated/CreateInstanceSampleIT.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,43 @@ | ||
| /* | ||
| * Copyright 2023 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.example.spanner.admin.generated; | ||
|
|
||
| import static org.junit.Assert.assertTrue; | ||
|
|
||
| import com.example.spanner.SampleRunner; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| @RunWith(JUnit4.class) | ||
| public class CreateInstanceSampleIT extends SampleTestBaseV2 { | ||
|
|
||
| @Test | ||
| public void testCreateInstance() throws Exception { | ||
| final String instanceId = idGenerator.generateInstanceId(); | ||
|
|
||
| // Runs sample | ||
| final String out = SampleRunner.runSample(() -> | ||
| CreateInstanceExample.createInstance(projectId, instanceId) | ||
| ); | ||
|
|
||
| assertTrue( | ||
| "Expected created instance " + instanceId + "." | ||
| + " Output received was " + out, out.contains("was successfully created") | ||
| ); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Could we use a default leader name here that is more similar to the actual value that a user would have to use. That might help users who don't know what the default leader option is, to understand and learn that.