-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #118 from GoogleCloudPlatform/readme
Re-organized readme files.
- Loading branch information
Showing
26 changed files
with
1,025 additions
and
482 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,84 @@ | ||
| ## BigQuery Samples | ||
| <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/> | ||
|
|
||
| These samples require two environment variables to be set: | ||
| # Google BigQuery Node.js Samples | ||
|
|
||
| - `GOOGLE_APPLICATION_CREDENTIALS` - Path to a service account file. You can | ||
| download one from your Google project's "permissions" page. | ||
| - `GCLOUD_PROJECT` - Id of your Google project. | ||
| [BigQuery][bigquery_docs] is Google's fully managed, petabyte scale, low cost | ||
| analytics data warehouse. | ||
|
|
||
| ## Run the samples | ||
| [bigquery_docs]: https://cloud.google.com/bigquery/docs/ | ||
|
|
||
| Install dependencies: | ||
| ## Table of Contents | ||
|
|
||
| npm install | ||
| * [Setup](#setup) | ||
| * [Samples](#samples) | ||
| * [Create A Simple Application With the API](#create-a-simple-application-with-the-api) | ||
| * [Calculate size of dataset](#calculate-size-of-dataset) | ||
| * [Loading Data with a POST Request](#loading-data-with-a-post-request) | ||
| * [Loading Data from Cloud Storage](#loading-data-from-cloud-storage) | ||
|
|
||
| ### getting_started.js | ||
| ## Setup | ||
|
|
||
| npm run getting_started | ||
| 1. Read [Prerequisites][prereq] and [How to run a sample][run] first. | ||
| 1. Install dependencies: | ||
|
|
||
| ### dataset_size.js | ||
| npm install | ||
|
|
||
| Usage: `npm run dataset_size -- <projectId> <datasetId>` | ||
| [prereq]: ../README.md#prerequisities | ||
| [run]: ../README.md#how-to-run-a-sample | ||
|
|
||
| ## Samples | ||
|
|
||
| ### Create A Simple Application With the API | ||
|
|
||
| View the [documentation][basics_docs] or the [source code][basics_code]. | ||
|
|
||
| __Run the sample:__ | ||
|
|
||
| node getting_started | ||
|
|
||
| [basics_docs]: https://cloud.google.com/bigquery/create-simple-app-api | ||
| [basics_code]: getting_started.js | ||
|
|
||
| ### Calculate size of dataset | ||
|
|
||
| View the [source code][size_code]. | ||
|
|
||
| __Run the sample:__ | ||
|
|
||
| Usage: `node dataset_size <projectId> <datasetId>` | ||
|
|
||
| Example: | ||
|
|
||
| npm run dataset_size -- bigquery-public-data hacker_news | ||
| node dataset_size bigquery-public-data hacker_news | ||
|
|
||
| [size_code]: dataset_size.js | ||
|
|
||
| ### Loading Data with a POST Request | ||
|
|
||
| View the [documentation][file_docs] or the [source code][file_code]. | ||
|
|
||
| ### load_data_from_csv.js | ||
| __Run the sample:__ | ||
|
|
||
| Usage: `npm run load_data_from_csv -- <path-to-file> <dataset-id> <table-name>` | ||
| Usage: `node load_data_from_csv <path-to-file> <dataset-id> <table-name>` | ||
|
|
||
| Example: | ||
|
|
||
| npm run load_data_from_csv -- data.csv my-dataset my-table | ||
| node load_data_from_csv resources/data.csv my-dataset my-table | ||
|
|
||
| ### load_data_from_gcs.js | ||
| [file_docs]: https://cloud.google.com/bigquery/loading-data-post-request | ||
| [file_code]: load_data_from_csv.js | ||
|
|
||
| Usage: `npm run load_data_from_gcs -- <bucket-name> <filename> <dataset-id> <table-name>` | ||
| ### Loading Data from Cloud Storage | ||
|
|
||
| View the [documentation][gcs_docs] or the [source code][gcs_code]. | ||
|
|
||
| __Run the sample:__ | ||
|
|
||
| Usage: `node load_data_from_gcs <bucket-name> <filename> <dataset-id> <table-name>` | ||
|
|
||
| Example: | ||
|
|
||
| npm run load_data_from_gcs -- my-bucket data.csv my-dataset my-table | ||
| node load_data_from_gcs my-bucket data.csv my-dataset my-table | ||
|
|
||
| [gcs_docs]: https://cloud.google.com/bigquery/docs/loading-data-cloud-storage | ||
| [gcs_code]: load_data_from_gcs.js |
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 |
|---|---|---|
| @@ -1,35 +1,93 @@ | ||
| ## Compute Engine Samples | ||
| <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/> | ||
|
|
||
| These samples require two environment variables to be set: | ||
| # Google Compute Engine Node.js Samples | ||
|
|
||
| - `GOOGLE_APPLICATION_CREDENTIALS` - Path to a service account file. You can | ||
| download one from your Google project's "permissions" page. | ||
| - `GCLOUD_PROJECT` - Id of your Google project. | ||
| [Compute Engine][compute_docs] lets you create and run virtual machines on | ||
| Google infrastructure. | ||
|
|
||
| ## Run the samples | ||
| [compute_docs]: https://cloud.google.com/compute/docs/ | ||
|
|
||
| Install dependencies: | ||
| ## Table of Contents | ||
|
|
||
| npm install | ||
| * [Setup](#setup) | ||
| * [Samples](#samples) | ||
| * [Sending mail with Sendgrid](#sending-mail-with-sendgrid) | ||
| * [Sending mail with Mailjet](#sending-mail-with-mailjet) | ||
| * [Listing instances (recommended)](#listing-instances-recommended) | ||
| * [Listing instances](#listing-instances) | ||
|
|
||
| ### sendgrid.js | ||
| ## Setup | ||
|
|
||
| Requires a `SENDGRID_API_KEY` environment variable to be set. | ||
| 1. Read [Prerequisites][prereq] and [How to run a sample][run] first. | ||
| 1. Install dependencies: | ||
|
|
||
| npm run sendgrid | ||
| npm install | ||
|
|
||
| ### mailjet.js | ||
| [prereq]: ../README.md#prerequisities | ||
| [run]: ../README.md#how-to-run-a-sample | ||
|
|
||
| Requires `MAILJET_API_KEY` and `MAILJET_API_SECRET` environment variables to be | ||
| set. | ||
| ## Samples | ||
|
|
||
| npm run mailjet | ||
| ### Sending mail with Sendgrid | ||
|
|
||
| ### vms.js | ||
| View the [documentation][sendgrid_docs] or the [source code][sendgrid_code]. | ||
|
|
||
| npm run vms | ||
| __Run the sample:__ | ||
|
|
||
| ### vms_api.js | ||
| 1. Set the `SENDGRID_API_KEY` environment variable: | ||
|
|
||
| npm run vms_api | ||
| export SENDGRID_API_KEY=<your-sendgrid-api-key> | ||
|
|
||
| 1. Start the server: | ||
|
|
||
| node sendgrid | ||
|
|
||
| 1. Open http://localhost:8080 in your browser | ||
|
|
||
| [sendgrid_docs]: https://cloud.google.com/compute/docs/tutorials/sending-mail/using-sendgrid | ||
| [sendgrid_code]: sendgrid.js | ||
|
|
||
| ### Sending mail with Mailjet | ||
|
|
||
| View the [documentation][mailjet_docs] or the [source code][mailjet_code]. | ||
|
|
||
| __Run the sample:__ | ||
|
|
||
| 1. Set the `MAILJET_API_KEY` environment variable: | ||
|
|
||
| export MAILJET_API_KEY=<your-mailjet-api-key> | ||
|
|
||
| 1. Set the `MAILJET_API_SECRET` environment variable: | ||
|
|
||
| export MAILJET_API_SECRET=<your-mailjet-api-secret> | ||
|
|
||
| 1. Start the server: | ||
|
|
||
| node mailjet | ||
|
|
||
| 1. Open http://localhost:8080 in your browser | ||
|
|
||
| [mailjet_docs]: https://cloud.google.com/compute/docs/tutorials/sending-mail/using-mailjet | ||
| [mailjet_code]: mailjet.js | ||
|
|
||
| ### Listing instances (recommended) | ||
|
|
||
| View the [documentation][vms_docs] or the [source code][vms_code]. | ||
|
|
||
| __Run the sample:__ | ||
|
|
||
| node vms | ||
|
|
||
| [vms_docs]: https://cloud.google.com/compute/docs/tutorials/nodejs-guide | ||
| [vms_code]: vms.js | ||
|
|
||
| ### Listing instances | ||
|
|
||
| View the [documentation][vms_api_docs] or the [source code][vms_api_code]. | ||
|
|
||
| __Run the sample:__ | ||
|
|
||
| node vms_api | ||
|
|
||
| [vms_api_docs]: https://cloud.google.com/compute/docs/tutorials/nodejs-guide | ||
| [vms_api_code]: vms_api.js |
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
Oops, something went wrong.