Skip to content
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

Jump to bottom

docs: update samples README.md #667

Merged
merged 3 commits into from Aug 12, 2020
Merged

docs: update samples README.md #667

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f98a50
docs: update samples README.md and refactor SimpleQuery
stephaniewang526 Aug 10, 2020
a9424dd
fix typos
stephaniewang526 Aug 10, 2020
0bbb1c8
revert back changes to SimpleQuery
stephaniewang526 Aug 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 15 additions & 6 deletions samples/README.md
View file
Open in desktop
Expand Up @@ -2,16 +2,25 @@

## Running a sample using Cloud Shell

The Google Cloud Shell has application default credentials from its compute instance which will allow you to run an integration test without having to obtain `GOOGLE_APPLICATION_CREDENTIANS`.
The Google Cloud Shell has application default credentials from its compute instance which will allow you to run an integration test without having to obtain `GOOGLE_APPLICATION_CREDENTIALS`. Go to [BigQuery Client Readme](https://github.com/googleapis/java-bigquery#samples) to run each sample in the Cloud Shell.

However, certain samples require environment variables to be set. For instance, in `CreateDatasetIT.java`:
## Running a sample using command line

First set up `GOOGLE_APPLICATION_CREDENTIALS` and `GOOGLE_CLOUD_PROJECT` environment variables before running any samples.

To run a sample:
1. `cd samples/snippets` - all samples are located in `java-bigquery/samples/snippets` directory.
2. `mvn compile exec:java -Dexec.mainClass=com.example.bigquery.SimpleQuery` - this runs the [SimpleQuery sample](https://github.com/googleapis/java-bigquery/blob/master/samples/snippets/src/main/java/com/example/bigquery/SimpleQuery.java) which runs the BigQuery query method. You can update the developer's `TODO` section in the snippet if you wish to run a different query.

## Running a sample integration test using command line

Note that some samples require environment variables to be set. For instance, in `CreateDatasetIT.java`:

`private static final String GOOGLE_CLOUD_PROJECT = System.getenv("GOOGLE_CLOUD_PROJECT");` - this sample integration test requires you to specific the [Google Cloud Project](https://cloud.google.com/resource-manager/docs/creating-managing-projects) you would like to run the test in.

Make sure to set environment variables, if necessary, before running the sample, or else you will get an error asking you to set it.

To run a samples integration tests in the cloud shell, simply run the following commands:

`cd samples/snippets` - all samples are located in `java-bigquery/samples/snippets` directory.
To run a samples integration tests:

`mvn -Dtest=GetTableIT test` - this runs the integration test of `GetTable.java` sample.
1. `cd samples/snippets` - all samples are located in `java-bigquery/samples/snippets` directory.
2. `mvn -Dtest=GetTableIT test` - this runs the integration test of `GetTable.java` sample.