Skip to content

Commit

Permalink
Bigtable: Create Instanceadmin sample (#1664)
Browse files Browse the repository at this point in the history
* Python instanceadmin sample

instanceadmin python sample

* Updated instanceadmin.py

* modify instanceadmin as per comments

* Update instanceadmin.py as per the local review comments.

* Update instanceadmin

* update instanceadmin, to fix ci failures.

* update instanceadmin

* update instanceadmin

* Implement review comments
  • Loading branch information
sangramql authored and billyjacobson committed Aug 31, 2018
1 parent c5b3a45 commit aff66d6
Show file tree
Hide file tree
Showing 4 changed files with 401 additions and 0 deletions.
120 changes: 120 additions & 0 deletions bigtable/instanceadmin/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
.. This file is automatically generated. Do not edit this file directly.
Google Cloud Bigtable table creation
===============================================================================

https://cloud.google.com/bigtable/docs/quickstart-cbt

This page explains how to use the cbt command to connect to a Cloud Bigtable instance, perform basic administrative tasks, and read and write data in a table.

Google Cloud Bigtable Python Samples
===============================================================================

.. image:: https://gstatic.com/cloudssh/images/open-btn.png
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=bigtable/hello/README.rst


This directory contains samples for Google Cloud Bigtable. `Google Cloud Bigtable`_ is Google's NoSQL Big Data database service. It's the same database that powers many core Google services, including Search, Analytics, Maps, and Gmail.




.. _Google Cloud Bigtable: https://cloud.google.com/bigtable/docs

Setup
-------------------------------------------------------------------------------


Authentication
++++++++++++++

This sample requires you to have authentication setup. Refer to the
`Authentication Getting Started Guide`_ for instructions on setting up
credentials for applications.

.. _Authentication Getting Started Guide:
https://cloud.google.com/docs/authentication/getting-started

Install Dependencies
++++++++++++++++++++

#. Clone python-docs-samples and change directory to the sample directory you want to use.

.. code-block:: bash
$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
#. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions.

.. _Python Development Environment Setup Guide:
https://cloud.google.com/python/setup

#. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+.

.. code-block:: bash
$ virtualenv env
$ source env/bin/activate
#. Install the dependencies needed to run the samples.

.. code-block:: bash
$ pip install -r requirements.txt
.. _pip: https://pip.pypa.io/
.. _virtualenv: https://virtualenv.pypa.io/

Samples
-------------------------------------------------------------------------------

Basic example
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. image:: https://gstatic.com/cloudssh/images/open-btn.png
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=bigtable/instanceadmin.py,bigtable/instanceadmin/README.rst




To run this sample:

.. code-block:: bash
$ python instanceadmin.py
usage: instanceadmin.py [-h] [run] [dev-instance] [del-instance] [add-cluster] [del-cluster] project_id instance_id cluster_id
Demonstrates how to connect to Cloud Bigtable and run some basic operations
to create instance, create cluster, delete instance and delete cluster.
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
positional arguments:
project_id Your Cloud Platform project ID.
instance_id ID of the Cloud Bigtable instance to connect to.
cluster_id ID of the Cloud Bigtable cluster to connect to.
optional arguments:
-h, --help show this help message and exit
The client library
-------------------------------------------------------------------------------

This sample uses the `Google Cloud Client Library for Python`_.
You can read the documentation for more details on API usage and use GitHub
to `browse the source`_ and `report issues`_.

.. _Google Cloud Client Library for Python:
https://googlecloudplatform.github.io/google-cloud-python/
.. _browse the source:
https://github.com/GoogleCloudPlatform/google-cloud-python
.. _report issues:
https://github.com/GoogleCloudPlatform/google-cloud-python/issues


.. _Google Cloud SDK: https://cloud.google.com/sdk/
23 changes: 23 additions & 0 deletions bigtable/instanceadmin/README.rst.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# This file is used to generate README.rst

product:
name: Google Cloud Bigtable and run some basic operations.
short_name: Cloud Bigtable
url: https://cloud.google.com/bigtable/docs
description: >
`Google Cloud Bigtable`_ is Google's NoSQL Big Data database service. It's
the same database that powers many core Google services, including Search,
Analytics, Maps, and Gmail.

setup:
- auth
- install_deps

samples:
- name: Basic example with Bigtable Column family and GC rules.
file: instanceadmin.py
show_help: true

cloud_client_library: true

folder: bigtable/instanceadmin

0 comments on commit aff66d6

Please sign in to comment.