-
Notifications
You must be signed in to change notification settings - Fork 603
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
add readmes for all packages #1495
Merged
callmehiphop
merged 7 commits into
googleapis:master
from
stephenplusplus:spp--module-readmes
Aug 26, 2016
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
9910b45
add bigquery readme
stephenplusplus 22307c2
add all readmes
stephenplusplus ae8ec11
copy readme as part of release script
stephenplusplus a352ab2
gcloud-node -> google-cloud-node
stephenplusplus 02f3275
fix youre good to gos
stephenplusplus ccb0a62
add resource manager scope
stephenplusplus 70bc888
exclude unecessary files
stephenplusplus File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
# @google-cloud/bigquery | ||
> Google BigQuery Client Library for Node.js | ||
|
||
*Looking for more Google APIs than just BigQuery? You might want to check out [`google-cloud`][google-cloud].* | ||
|
||
- [API Documentation][gcloud-bigquery-docs] | ||
- [Official Documentation][cloud-bigquery-docs] | ||
|
||
|
||
```sh | ||
$ npm install --save @google-cloud/bigquery | ||
``` | ||
```js | ||
var bigquery = require('@google-cloud/bigquery')({ | ||
projectId: 'grape-spaceship-123', | ||
keyFilename: '/path/to/keyfile.json' | ||
}); | ||
|
||
// Access an existing dataset and table. | ||
var schoolsDataset = bigquery.dataset('schools'); | ||
var schoolsTable = schoolsDataset.table('schoolsData'); | ||
|
||
// Import data into a table. | ||
schoolsTable.import('/local/file.json', function(err, job) {}); | ||
|
||
// Get results from a query job. | ||
var job = bigquery.job('job-id'); | ||
|
||
// Use a callback. | ||
job.getQueryResults(function(err, rows) {}); | ||
|
||
// Or get the same results as a readable stream. | ||
job.getQueryResults().on('data', function(row) {}); | ||
``` | ||
|
||
|
||
## Authentication | ||
|
||
It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services. | ||
|
||
### On Google Compute Engine | ||
|
||
If you are running this client on Google Compute Engine, we handle authentication for you with no configuration. You just need to make sure that when you [set up the GCE instance][gce-how-to], you add the correct scopes for the APIs you want to access. | ||
|
||
``` js | ||
// Authenticating on a global basis. | ||
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' | ||
|
||
var bigQuery = require('@google-cloud/bigquery')({ | ||
projectId: projectId | ||
}); | ||
|
||
// ...you're good to go! | ||
``` | ||
|
||
### Elsewhere | ||
|
||
If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: | ||
|
||
1. Visit the [Google Developers Console][dev-console]. | ||
2. Create a new project or click on an existing project. | ||
3. Navigate to **APIs & auth** > **APIs section** and turn on the following APIs (you may need to enable billing in order to use these services): | ||
* BigQuery API | ||
4. Navigate to **APIs & auth** > **Credentials** and then: | ||
* If you want to use a new service account, click on **Create new Client ID** and select **Service account**. After the account is created, you will be prompted to download the JSON key file that the library uses to authenticate your requests. | ||
* If you want to generate a new key for an existing service account, click on **Generate new JSON key** and download the JSON key file. | ||
|
||
``` js | ||
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' | ||
|
||
var bigQuery = require('@google-cloud/bigquery')({ | ||
projectId: projectId, | ||
|
||
// The path to your key file: | ||
keyFilename: '/path/to/keyfile.json' | ||
|
||
// Or the contents of the key file: | ||
credentials: require('./path/to/keyfile.json') | ||
}); | ||
|
||
// ...you're good to go! | ||
``` | ||
|
||
|
||
[google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node | ||
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using | ||
[dev-console]: https://console.developers.google.com/project | ||
[gcloud-bigquery-docs]: https://googlecloudplatform.github.io/google-cloud-node/#/docs/bigquery | ||
[cloud-bigquery-docs]: https://cloud.google.com/bigquery/what-is-bigquery |
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,109 @@ | ||
# @google-cloud/bigtable | ||
> Google Cloud Bigtable Client Library for Node.js | ||
|
||
*Looking for more Google APIs than just Bigtable? You might want to check out [`google-cloud`][google-cloud].* | ||
|
||
- [API Documentation][gcloud-bigtable-docs] | ||
- [Official Documentation][cloud-bigtable-docs] | ||
|
||
*You may need to [create a cluster][cloud-bigtable-cluster] to use the Google Cloud Bigtable API with your project.* | ||
|
||
|
||
```sh | ||
$ npm install --save @google-cloud/bigtable | ||
``` | ||
```js | ||
var bigtable = require('@google-cloud/bigtable')({ | ||
projectId: 'grape-spaceship-123', | ||
keyFilename: '/path/to/keyfile.json', | ||
zone: 'my-zone', | ||
cluster: 'my-cluster' | ||
}); | ||
|
||
var table = bigtable.table('prezzy'); | ||
|
||
table.getRows(function(err, rows) {}); | ||
|
||
// Update a row in your table. | ||
var row = table.row('alincoln'); | ||
|
||
row.save('follows:gwashington', 1, function(err) { | ||
if (err) { | ||
// Error handling omitted. | ||
} | ||
|
||
row.get('follows:gwashington', function(err, data) { | ||
if (err) { | ||
// Error handling omitted. | ||
} | ||
|
||
// data = { | ||
// follows: { | ||
// gwashington: [ | ||
// { | ||
// value: 1 | ||
// } | ||
// ] | ||
// } | ||
// } | ||
}); | ||
}); | ||
``` | ||
|
||
|
||
## Authentication | ||
|
||
It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services. | ||
|
||
### On Google Compute Engine | ||
|
||
If you are running this client on Google Compute Engine, we handle authentication for you with no configuration. You just need to make sure that when you [set up the GCE instance][gce-how-to], you add the correct scopes for the APIs you want to access. | ||
|
||
``` js | ||
// Authenticating on a global basis. | ||
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' | ||
|
||
var bigtable = require('@google-cloud/bigtable')({ | ||
projectId: projectId | ||
}); | ||
|
||
// ...you're good to go! | ||
``` | ||
|
||
### Elsewhere | ||
|
||
If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: | ||
|
||
1. Visit the [Google Developers Console][dev-console]. | ||
2. Create a new project or click on an existing project. | ||
3. Navigate to **APIs & auth** > **APIs section** and turn on the following APIs (you may need to enable billing in order to use these services): | ||
* Cloud Bigtable API | ||
* Cloud Bigtable Admin API | ||
* Cloud Bigtable Table Admin API | ||
4. Navigate to **APIs & auth** > **Credentials** and then: | ||
* If you want to use a new service account, click on **Create new Client ID** and select **Service account**. After the account is created, you will be prompted to download the JSON key file that the library uses to authenticate your requests. | ||
* If you want to generate a new key for an existing service account, click on **Generate new JSON key** and download the JSON key file. | ||
|
||
``` js | ||
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' | ||
|
||
var bigtable = require('@google-cloud/bigtable')({ | ||
projectId: projectId, | ||
|
||
// The path to your key file: | ||
keyFilename: '/path/to/keyfile.json' | ||
|
||
// Or the contents of the key file: | ||
credentials: require('./path/to/keyfile.json') | ||
}); | ||
|
||
// ...you're good to go! | ||
``` | ||
|
||
|
||
[google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node | ||
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using | ||
[dev-console]: https://console.developers.google.com/project | ||
[gcloud-bigtable-docs]: https://googlecloudplatform.github.io/google-cloud-node/#/docs/bigtable | ||
[cloud-bigtable-docs]: https://cloud.google.com/bigtable/docs | ||
[cloud-bigtable-cluster]: https://cloud.google.com/bigtable/docs/creating-compute-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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
# @google-cloud/compute | ||
> Google Compute Engine Client Library for Node.js | ||
|
||
*Looking for more Google APIs than just Compute Engine? You might want to check out [`google-cloud`][google-cloud].* | ||
|
||
- [API Documentation][gcloud-compute-docs] | ||
- [Official Documentation][cloud-compute-docs] | ||
|
||
|
||
```sh | ||
$ npm install --save @google-cloud/compute | ||
``` | ||
```js | ||
var gce = require('@google-cloud/compute')({ | ||
projectId: 'grape-spaceship-123', | ||
keyFilename: '/path/to/keyfile.json' | ||
}); | ||
|
||
// Create a new VM using the latest OS image of your choice. | ||
var zone = gce.zone('us-central1-a'); | ||
var name = 'ubuntu-http'; | ||
|
||
zone.createVM(name, { os: 'ubuntu' }, function(err, vm, operation) { | ||
// `operation` lets you check the status of long-running tasks. | ||
|
||
operation | ||
.on('error', function(err) {}) | ||
.on('running', function(metadata) {}) | ||
.on('complete', function() { | ||
// Virtual machine created! | ||
}); | ||
}); | ||
``` | ||
|
||
|
||
## Authentication | ||
|
||
It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services. | ||
|
||
### On Google Compute Engine | ||
|
||
If you are running this client on Google Compute Engine, we handle authentication for you with no configuration. You just need to make sure that when you [set up the GCE instance][gce-how-to], you add the correct scopes for the APIs you want to access. | ||
|
||
``` js | ||
// Authenticating on a global basis. | ||
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' | ||
|
||
var gce = require('@google-cloud/compute')({ | ||
projectId: projectId | ||
}); | ||
|
||
// ...you're good to go! | ||
``` | ||
|
||
### Elsewhere | ||
|
||
If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: | ||
|
||
1. Visit the [Google Developers Console][dev-console]. | ||
2. Create a new project or click on an existing project. | ||
3. Navigate to **APIs & auth** > **APIs section** and turn on the following APIs (you may need to enable billing in order to use these services): | ||
* Google Compute Engine API | ||
4. Navigate to **APIs & auth** > **Credentials** and then: | ||
* If you want to use a new service account, click on **Create new Client ID** and select **Service account**. After the account is created, you will be prompted to download the JSON key file that the library uses to authenticate your requests. | ||
* If you want to generate a new key for an existing service account, click on **Generate new JSON key** and download the JSON key file. | ||
|
||
``` js | ||
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' | ||
|
||
var gce = require('@google-cloud/compute')({ | ||
projectId: projectId, | ||
|
||
// The path to your key file: | ||
keyFilename: '/path/to/keyfile.json' | ||
|
||
// Or the contents of the key file: | ||
credentials: require('./path/to/keyfile.json') | ||
}); | ||
|
||
// ...you're good to go! | ||
``` | ||
|
||
|
||
[google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node | ||
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using | ||
[dev-console]: https://console.developers.google.com/project | ||
[gcloud-compute-docs]: https://googlecloudplatform.github.io/google-cloud-node/#/docs/compute | ||
[cloud-compute-docs]: https://cloud.google.com/compute/docs |
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.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
Sorry, something went wrong.