-
Notifications
You must be signed in to change notification settings - Fork 121
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(samples): add create cmek table (#511)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [X] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/java-bigquery/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [X] Ensure the tests and linter pass - [X] Code coverage does not decrease (if any source code was changed) - [X] Appropriate docs were updated (if necessary)
- Loading branch information
Praful Makani
authored
Jul 6, 2020
1 parent
2a63c66
commit b5fd40f
Showing
2 changed files
with
154 additions
and
0 deletions.
There are no files selected for viewing
71 changes: 71 additions & 0 deletions
71
samples/snippets/src/main/java/com/example/bigquery/CreateTableCMEK.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,71 @@ | ||
/* | ||
* Copyright 2020 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.bigquery; | ||
|
||
// [START bigquery_create_table_cmek] | ||
import com.google.cloud.bigquery.BigQuery; | ||
import com.google.cloud.bigquery.BigQueryException; | ||
import com.google.cloud.bigquery.BigQueryOptions; | ||
import com.google.cloud.bigquery.EncryptionConfiguration; | ||
import com.google.cloud.bigquery.Field; | ||
import com.google.cloud.bigquery.Schema; | ||
import com.google.cloud.bigquery.StandardSQLTypeName; | ||
import com.google.cloud.bigquery.StandardTableDefinition; | ||
import com.google.cloud.bigquery.TableDefinition; | ||
import com.google.cloud.bigquery.TableId; | ||
import com.google.cloud.bigquery.TableInfo; | ||
|
||
// Sample to create a cmek table | ||
public class CreateTableCMEK { | ||
|
||
public static void runCreateTableCMEK() { | ||
// TODO(developer): Replace these variables before running the sample. | ||
String datasetName = "MY_DATASET_NAME"; | ||
String tableName = "MY_TABLE_NAME"; | ||
String kmsKeyName = "MY_KEY_NAME"; | ||
Schema schema = | ||
Schema.of( | ||
Field.of("stringField", StandardSQLTypeName.STRING), | ||
Field.of("booleanField", StandardSQLTypeName.BOOL)); | ||
// i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey} | ||
EncryptionConfiguration encryption = | ||
EncryptionConfiguration.newBuilder().setKmsKeyName(kmsKeyName).build(); | ||
createTableCMEK(datasetName, tableName, schema, encryption); | ||
} | ||
|
||
public static void createTableCMEK( | ||
String datasetName, String tableName, Schema schema, EncryptionConfiguration configuration) { | ||
try { | ||
// Initialize client that will be used to send requests. This client only needs to be created | ||
// once, and can be reused for multiple requests. | ||
BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService(); | ||
|
||
TableId tableId = TableId.of(datasetName, tableName); | ||
TableDefinition tableDefinition = StandardTableDefinition.of(schema); | ||
TableInfo tableInfo = | ||
TableInfo.newBuilder(tableId, tableDefinition) | ||
.setEncryptionConfiguration(configuration) | ||
.build(); | ||
|
||
bigquery.create(tableInfo); | ||
System.out.println("Table cmek created successfully"); | ||
} catch (BigQueryException e) { | ||
System.out.println("Table cmek was not created. \n" + e.toString()); | ||
} | ||
} | ||
} | ||
// [END bigquery_create_table_cmek] |
83 changes: 83 additions & 0 deletions
83
samples/snippets/src/test/java/com/example/bigquery/CreateTableCMEKIT.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,83 @@ | ||
/* | ||
* Copyright 2020 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.bigquery; | ||
|
||
import static com.google.common.truth.Truth.assertThat; | ||
import static junit.framework.TestCase.assertNotNull; | ||
|
||
import com.google.cloud.bigquery.EncryptionConfiguration; | ||
import com.google.cloud.bigquery.Field; | ||
import com.google.cloud.bigquery.Schema; | ||
import com.google.cloud.bigquery.StandardSQLTypeName; | ||
import java.io.ByteArrayOutputStream; | ||
import java.io.PrintStream; | ||
import java.util.UUID; | ||
import org.junit.After; | ||
import org.junit.Before; | ||
import org.junit.BeforeClass; | ||
import org.junit.Test; | ||
|
||
public class CreateTableCMEKIT { | ||
|
||
private String tableName; | ||
private ByteArrayOutputStream bout; | ||
private PrintStream out; | ||
|
||
private static final String BIGQUERY_DATASET_NAME = requireEnvVar("BIGQUERY_DATASET_NAME"); | ||
private static final String BIGQUERY_KMS_KEY_NAME = requireEnvVar("BIGQUERY_KMS_KEY_NAME"); | ||
|
||
private static String requireEnvVar(String varName) { | ||
String value = System.getenv(varName); | ||
assertNotNull( | ||
"Environment variable " + varName + " is required to perform these tests.", | ||
System.getenv(varName)); | ||
return value; | ||
} | ||
|
||
@BeforeClass | ||
public static void checkRequirements() { | ||
requireEnvVar("BIGQUERY_DATASET_NAME"); | ||
requireEnvVar("BIGQUERY_KMS_KEY_NAME"); | ||
} | ||
|
||
@Before | ||
public void setUp() { | ||
tableName = "MY_TABLE_CMEK_TEST" + UUID.randomUUID().toString().substring(0, 8); | ||
bout = new ByteArrayOutputStream(); | ||
out = new PrintStream(bout); | ||
System.setOut(out); | ||
} | ||
|
||
@After | ||
public void tearDown() { | ||
// Clean up | ||
DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, tableName); | ||
System.setOut(null); | ||
} | ||
|
||
@Test | ||
public void testCreateTableCMEK() { | ||
Schema schema = | ||
Schema.of( | ||
Field.of("stringField", StandardSQLTypeName.STRING), | ||
Field.of("booleanField", StandardSQLTypeName.BOOL)); | ||
EncryptionConfiguration configuration = | ||
EncryptionConfiguration.newBuilder().setKmsKeyName(BIGQUERY_KMS_KEY_NAME).build(); | ||
CreateTableCMEK.createTableCMEK(BIGQUERY_DATASET_NAME, tableName, schema, configuration); | ||
assertThat(bout.toString()).contains("Table cmek created successfully"); | ||
} | ||
} |