-
Notifications
You must be signed in to change notification settings - Fork 6.5k
Add Bigtable hello world sample. #371
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 hidden or 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,6 +1,7 @@ | ||
[run] | ||
include = | ||
appengine/* | ||
bigtable/* | ||
bigquery/* | ||
blog/* | ||
cloud_logging/* | ||
|
This file contains hidden or 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 hidden or 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,67 @@ | ||
# Cloud Bigtable Hello World | ||
|
||
This is a simple application that demonstrates using the [Google Cloud Client | ||
Library][gcloud-python] to connect to and interact with Cloud Bigtable. | ||
|
||
[gcloud-python]: https://github.com/GoogleCloudPlatform/gcloud-python | ||
|
||
|
||
## Provision a cluster | ||
|
||
Follow the instructions in the [user documentation](https://cloud.google.com/bigtable/docs/creating-cluster) | ||
to create a Google Cloud Platform project and Cloud Bigtable cluster if necessary. | ||
You'll need to reference your project ID, zone and cluster ID to run the application. | ||
|
||
|
||
## Run the application | ||
|
||
First, set your [Google Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials) | ||
|
||
Install the dependencies with pip. | ||
|
||
``` | ||
$ pip install -r requirements.txt | ||
``` | ||
|
||
Run the application. Replace the command-line parameters with values for your cluster. | ||
|
||
``` | ||
$ python main.py my-project my-cluster us-central1-c | ||
``` | ||
|
||
You will see output resembling the following: | ||
|
||
``` | ||
Create table Hello-Bigtable-1234 | ||
Write some greetings to the table | ||
Scan for all greetings: | ||
greeting0: Hello World! | ||
greeting1: Hello Cloud Bigtable! | ||
greeting2: Hello HappyBase! | ||
Delete table Hello-Bigtable-1234 | ||
``` | ||
|
||
## Understanding the code | ||
|
||
The [application](main.py) uses the [Google Cloud Bigtable HappyBase | ||
package][Bigtable HappyBase], an implementation of the [HappyBase][HappyBase] | ||
library, to make calls to Cloud Bigtable. It demonstrates several basic | ||
concepts of working with Cloud Bigtable via this API: | ||
|
||
[Bigtable HappyBase]: https://googlecloudplatform.github.io/gcloud-python/stable/happybase-package.html | ||
[HappyBase]: http://happybase.readthedocs.io/en/latest/index.html | ||
|
||
- Creating a [Connection][HappyBase Connection] to a Cloud Bigtable | ||
[Cluster][Cluster API]. | ||
- Using the [Connection][HappyBase Connection] interface to create, disable and | ||
delete a [Table][HappyBase Table]. | ||
- Using the Connection to get a Table. | ||
- Using the Table to write rows via a [put][HappyBase Table Put] and scan | ||
across multiple rows using [scan][HappyBase Table Scan]. | ||
|
||
[Cluster API]: https://googlecloudplatform.github.io/gcloud-python/stable/bigtable-cluster.html | ||
[HappyBase Connection]: https://googlecloudplatform.github.io/gcloud-python/stable/happybase-connection.html | ||
[HappyBase Table]: https://googlecloudplatform.github.io/gcloud-python/stable/happybase-table.html | ||
[HappyBase Table Put]: https://googlecloudplatform.github.io/gcloud-python/stable/happybase-table.html#gcloud.bigtable.happybase.table.Table.put | ||
[HappyBase Table Scan]: https://googlecloudplatform.github.io/gcloud-python/stable/happybase-table.html#gcloud.bigtable.happybase.table.Table.scan | ||
|
This file contains hidden or 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,95 @@ | ||
#!/usr/bin/env python | ||
|
||
# Copyright 2016 Google Inc. | ||
# | ||
# 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. | ||
|
||
"""Demonstrates how to connect to Cloud Bigtable and run some basic operations. | ||
|
||
Prerequisites: | ||
|
||
- Create a Cloud Bigtable cluster. | ||
https://cloud.google.com/bigtable/docs/creating-cluster | ||
- Set your Google Application Default Credentials. | ||
https://developers.google.com/identity/protocols/application-default-credentials | ||
- Set the GCLOUD_PROJECT environment variable to your project ID. | ||
https://support.google.com/cloud/answer/6158840 | ||
""" | ||
|
||
import argparse | ||
import uuid | ||
|
||
from gcloud import bigtable | ||
from gcloud.bigtable import happybase | ||
|
||
|
||
def main(project, cluster_id, zone, table_name): | ||
# The client must be created with admin=True because it will create a | ||
# table. | ||
client = bigtable.Client(project=project, admin=True) | ||
|
||
with client: | ||
cluster = client.cluster(zone, cluster_id) | ||
cluster.reload() | ||
connection = happybase.Connection(cluster=cluster) | ||
|
||
print('Creating the {} table.'.format(table_name)) | ||
column_family_name = 'cf1' | ||
connection.create_table( | ||
table_name, | ||
{ | ||
column_family_name: dict() # Use default options. | ||
}) | ||
table = connection.table(table_name) | ||
|
||
print('Writing some greetings to the table.') | ||
column_name = '{fam}:greeting'.format(fam=column_family_name) | ||
greetings = [ | ||
'Hello World!', | ||
'Hello Cloud Bigtable!', | ||
'Hello HappyBase!', | ||
] | ||
for value in greetings: | ||
# Use a random key to distribute writes more evenly across shards. | ||
# See: https://cloud.google.com/bigtable/docs/schema-design | ||
row_key = str(uuid.uuid4()) | ||
table.put(row_key, {column_name: value}) | ||
|
||
print('Scanning for all greetings:') | ||
for key, row in table.scan(): | ||
print('\t{}: {}'.format(key, row[column_name])) | ||
|
||
print('Deleting the {} table.'.format(table_name)) | ||
connection.delete_table(table_name) | ||
|
||
|
||
if __name__ == '__main__': | ||
parser = argparse.ArgumentParser( | ||
description='A sample application that connects to Cloud' + | ||
' Bigtable.', | ||
formatter_class=argparse.ArgumentDefaultsHelpFormatter) | ||
parser.add_argument( | ||
'project', | ||
help='Google Cloud Platform project ID that contains the Cloud' + | ||
' Bigtable cluster.') | ||
parser.add_argument( | ||
'cluster', help='ID of the Cloud Bigtable cluster to connect to.') | ||
parser.add_argument( | ||
'zone', help='Zone that contains the Cloud Bigtable cluster.') | ||
parser.add_argument( | ||
'--table', | ||
help='Table to create and destroy.', | ||
default='Hello-Bigtable') | ||
|
||
args = parser.parse_args() | ||
main(args.project, args.cluster, args.zone, args.table) |
This file contains hidden or 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,47 @@ | ||
# Copyright 2016 Google Inc. | ||
# | ||
# 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. | ||
|
||
import random | ||
import re | ||
import sys | ||
|
||
from hello import main | ||
|
||
import pytest | ||
|
||
TABLE_NAME_FORMAT = 'Hello-Bigtable-{}' | ||
TABLE_NAME_RANGE = 10000 | ||
|
||
|
||
@pytest.mark.skipif( | ||
sys.version_info >= (3, 0), | ||
reason=("grpc doesn't yet support python3 " | ||
'https://github.com/grpc/grpc/issues/282')) | ||
def test_main(cloud_config, capsys): | ||
table_name = TABLE_NAME_FORMAT.format( | ||
random.randrange(TABLE_NAME_RANGE)) | ||
main( | ||
cloud_config.project, | ||
cloud_config.bigtable_cluster, | ||
cloud_config.bigtable_zone, | ||
table_name) | ||
|
||
out, _ = capsys.readouterr() | ||
assert re.search( | ||
re.compile(r'Creating the Hello-Bigtable-[0-9]+ table\.'), out) | ||
assert re.search(re.compile(r'Writing some greetings to the table\.'), out) | ||
assert re.search(re.compile(r'Scanning for all greetings'), out) | ||
assert re.search(re.compile(r'greeting0: Hello World!'), out) | ||
assert re.search( | ||
re.compile(r'Deleting the Hello-Bigtable-[0-9]+ table\.'), out) |
This file contains hidden or 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 @@ | ||
gcloud[grpc]==0.14.0 |
This file contains hidden or 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 hidden or 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 hidden or 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
Binary file not shown.
This file contains hidden or 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
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.
You'll need to update the encrypted version of this in secrets.tar.gz, the password is in valentine.
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.
Done.