As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Python Client 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.

• Client Library Documentation

• Product Documentation

Async Data Client

v2.23.0 includes a release of the new BigtableDataClientAsync client, accessible at the import path google.cloud.bigtable.data.

The new client brings a simplified API and increased performance using asyncio. The new client is focused on the data API (i.e. reading and writing Bigtable data), with admin operations remaining exclusively in the existing synchronous client.

Feedback and bug reports are welcome at cbt-python-client-v3-feedback@google.com, or through the Github issue tracker.

Note

It is generally not recommended to use the async client in an otherwise synchronous codebase. To make use of asyncio’s performance benefits, the codebase should be designed to be async from the ground up.

Quick Start

In order to use this library, you first need to go through the following steps:

1. Select or create a Cloud Platform project.

2. Enable billing for your project.

3. Enable the Cloud Bigtable API.

4. Setup Authentication.

Installation

Install this library in a virtualenv using pip. virtualenv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.

With virtualenv, it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

Supported Python Versions

Python >= 3.7

Deprecated Python Versions

• Python 2.7: the last released version which supported Python 2.7 was version 1.7.0, released 2021-02-09.

• Python 3.5: the last released version which supported Python 3.5 was version 1.7.0, released 2021-02-09.

• Python 3.6: the last released version which supported Python 3.6 was version v2.10.1, released 2022-06-03.

Mac/Linux

pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-bigtable

Windows

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-bigtable

Next Steps

• Read the Client Library Documentation for Cloud Bigtable API to see other available methods on the client.

• Read the Product documentation to learn more about the product and see How-to Guides.

Note

Because this client uses grpc library, it is safe to share instances across threads. In multiprocessing scenarios, the best practice is to create client instances after the invocation of os.fork() by multiprocessing.pool.Pool or multiprocessing.Process.

Client Types

• Classic Client
  • Base for Everything
  • Instance Admin API
  • Table Admin API
  • Data API
  • Client
  • Cluster
  • Instance
  • Table
  • App Profile
  • Backup
  • Column Families
  • Encryption Info
  • Bigtable Row
  • Row Data
  • Bigtable Row Filters
  • Row Set
  • Mutations Batching
• Async Data Client
  • Bigtable Data Client Async
  • Table Async
  • Mutations Batcher Async
  • Read Rows Query
  • Rows and Cells
  • Bigtable Row Filters
  • Mutations
  • Read Modify Write Rules
  • Custom Exceptions
  • Execute Query Iterator Async
  • Execute Query Values
  • Execute Query Metadata

Changelog

For a list of all google-cloud-bigtable releases:

• Changelog
  • 2.26.0 (2024-08-12)
  • 2.25.0 (2024-07-18)
  • 2.24.0 (2024-06-11)
  • 2.23.1 (2024-04-15)
  • 2.23.0 (2024-02-07)
  • 2.22.0 (2023-12-12)
  • 2.21.0 (2023-08-02)
  • 2.20.0 (2023-07-17)
  • 2.19.0 (2023-06-08)
  • 2.18.1 (2023-05-11)
  • 2.18.0 (2023-05-10)
  • 2.17.0 (2023-03-01)
  • 2.16.0 (2023-02-27)
  • 2.15.0 (2023-01-10)
  • 2.14.1 (2022-12-06)
  • 2.14.0 (2022-11-30)
  • 2.13.2 (2022-10-20)
  • 2.13.1 (2022-10-10)
  • 2.13.0 (2022-09-29)
  • 2.12.0 (2022-09-19)
  • 2.11.3 (2022-08-17)
  • 2.11.2 (2022-08-11)
  • 2.11.1 (2022-08-08)
  • 2.11.0 (2022-08-04)
  • 2.10.1 (2022-06-03)
  • 2.10.0 (2022-05-30)
  • 2.9.0 (2022-04-14)
  • 2.8.1 (2022-04-07)
  • 2.8.0 (2022-04-04)
  • 2.7.1 (2022-03-17)
  • 2.7.0 (2022-03-06)
  • 2.6.0 (2022-02-26)
  • 2.5.2 (2022-02-24)
  • 2.5.1 (2022-02-17)
  • 2.5.0 (2022-02-07)
  • 2.4.0 (2021-09-24)
  • 2.3.3 (2021-07-24)
  • 2.3.2 (2021-07-20)
  • 2.3.1 (2021-07-13)
  • 2.3.0 (2021-07-01)
  • 2.2.0 (2021-04-30)
  • 2.1.0 (2021-04-21)
  • 2.0.0 (2021-04-06)
  • 2.0.0-dev1 (2021-02-24)
  • 1.7.0 (2021-02-09)
  • 1.6.1 (2020-12-01)
  • 1.6.0 (2020-11-16)
  • 1.5.1 (2020-10-06)
  • 1.5.0 (2020-09-22)
  • 1.4.0 (2020-07-21)
  • 1.3.0 (2020-07-16)
  • 1.2.1
  • 1.2.0
  • 1.1.0
  • 1.0.0
  • 0.34.0
  • 0.33.0
  • 0.32.1
  • 0.32.0
  • 0.31.1
  • 0.31.0
  • 0.30.2
  • 0.30.1
  • 0.30.0
  • 0.29.0
  • 0.28.1
  • 0.28.0