Skip to content

bigtable-client-intro.rst

Latest commit

 

History

History
96 lines (65 loc) · 3.04 KB

bigtable-client-intro.rst

File metadata and controls

96 lines (65 loc) · 3.04 KB

Base for Everything

Warning

gRPC is required for using the Cloud Bigtable API. As of May 2016, grpcio is only supported in Python 2.7, so importing :mod:`gcloud.bigtable` in other versions of Python will fail.

To use the API, the :class:`Client <gcloud.bigtable.client.Client>` class defines a high-level interface which handles authorization and creating other objects:

from gcloud.bigtable.client import Client
client = Client()

Long-lived Defaults

When creating a :class:`Client <gcloud.bigtable.client.Client>`, the user_agent argument has sensible a default (:data:`DEFAULT_USER_AGENT <gcloud.bigtable.client.DEFAULT_USER_AGENT>`). However, you may over-ride it and the value will be used throughout all API requests made with the client you create.

Configuration

  • For an overview of authentication in gcloud-python, see :doc:`gcloud-auth`.

  • In addition to any authentication configuration, you can also set the :envvar:`GCLOUD_PROJECT` environment variable for the Google Cloud Console project you'd like to interact with. If your code is running in Google App Engine or Google Compute Engine the project will be detected automatically. (Setting this environment variable is not required, you may instead pass the project explicitly when constructing a :class:`Client <gcloud.storage.client.Client>`).

  • After configuring your environment, create a :class:`Client <gcloud.storage.client.Client>`

    >>> from gcloud import bigtable
>>> client = bigtable.Client()

    or pass in credentials and project explicitly

    >>> from gcloud import bigtable
>>> client = bigtable.Client(project='my-project', credentials=creds)

Tip

Be sure to use the Project ID, not the Project Number.

Admin API Access

If you'll be using your client to make Instance Admin and Table Admin API requests, you'll need to pass the admin argument:

client = bigtable.Client(admin=True)

Read-Only Mode

If on the other hand, you only have (or want) read access to the data, you can pass the read_only argument:

client = bigtable.Client(read_only=True)

This will ensure that the :data:`READ_ONLY_SCOPE <gcloud.bigtable.client.READ_ONLY_SCOPE>` is used for API requests (so any accidental requests that would modify data will fail).

Next Step

After a :class:`Client <gcloud.bigtable.client.Client>`, the next highest-level object is a :class:`Instance <gcloud.bigtable.instance.Instance>`. You'll need one before you can interact with tables or data.

Head next to learn about the :doc:`bigtable-instance-api`.