Skip to content

Commit 3e3f8f2

Browse files
authored
Update Bigtable README.md. (#5469)
* Consolidate package-info.java into Bigtable README.md. * Consolidate package-info.java into Bigtable README.md.
1 parent 32de049 commit 3e3f8f2

2 files changed

Lines changed: 49 additions & 79 deletions

File tree

google-cloud-clients/google-cloud-bigtable/README.md

Lines changed: 49 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ heavy development and is not ready for production use. Please continue to use th
99
[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
1010

1111
- [Product Documentation][bigtable-product-docs]
12-
- [Client Library Documentation][bigtable-client-lib-docs]
13-
12+
- [Client Library Documentation - Data API](https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigtable/data/v2/package-summary.html)
13+
- [Client Library Documentation - Admin API](https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigtable/admin/v2/package-summary.html)
1414
> Note: This client is under heavy development and should not be used in production.
1515
1616
## Quickstart
@@ -40,29 +40,63 @@ See the
4040
[Authentication](https://github.com/googleapis/google-cloud-java#authentication)
4141
section in the base directory's README.
4242

43-
## About Cloud Bigtable
44-
45-
[Cloud Bigtable][cloud-bigtable] is Google's NoSQL Big Data database service. It's
46-
the same database that powers many core Google services, including Search, Analytics, Maps, and
47-
Gmail.
48-
49-
Be sure to activate the Cloud Bigtable API and the Cloud Bigtable Admin API on the Developer's
50-
Console to use Cloud Bigtable from your project.
51-
52-
See the [Bigtable client lib docs][bigtable-client-lib-docs] to learn how to
53-
interact with Cloud Bigtable using this Client Library.
54-
5543
## Getting Started
5644
#### Prerequisites
5745
For this tutorial, you will need a
58-
[Google Developers Console](https://console.developers.google.com/) project with the Cloud Bigtable
46+
[Google Cloud Platform Console](https://console.developers.google.com/) project with the Cloud Bigtable
5947
API enabled. You will need to
6048
[enable billing](https://support.google.com/cloud/answer/6158867?hl=en) to use Google Cloud Bigtable.
6149
[Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your
6250
project set up. You will also need to set up the local development environment by [installing the
6351
Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line:
6452
`gcloud auth login`.
6553

54+
## About Cloud Bigtable
55+
56+
[Cloud Bigtable][cloud-bigtable] is Google's NoSQL Big Data database service. It's
57+
the same database that powers many core Google services, including Search, Analytics, Maps, and
58+
Gmail.
59+
60+
Be sure to activate the Cloud Bigtable API and the Cloud Bigtable Admin API under APIs & Services in the GCP Console to use Cloud Bigtable from your project.
61+
62+
See the Bigtable client library documentation ([Admin API](https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigtable/admin/v2/package-summary.html) and [Data API](https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigtable/data/v2/package-summary.html)) to learn how to
63+
interact with Cloud Bigtable using this Client Library.
64+
65+
## Concepts
66+
67+
Cloud Bigtable is composed of instances, clusters, nodes and tables.
68+
69+
### Instances
70+
Instances are containers for clusters.
71+
72+
### Clusters
73+
Clusters represent the actual Cloud Bigtable service. Each cluster belongs to a single Cloud Bigtable instance, and an instance can have up to 4 clusters. When your application
74+
sends requests to a Cloud Bigtable instance, those requests are actually handled by one of the clusters in the instance.
75+
76+
### Nodes
77+
Each cluster in a production instance has 3 or more nodes, which are compute resources that Cloud Bigtable uses to manage your data.
78+
79+
### Tables
80+
Tables contain the actual data and are replicated across all of the clusters in an instance.
81+
82+
83+
## Clients
84+
The Cloud Bigtable API consists of:
85+
86+
### Data API
87+
Allows callers to persist and query data in a table. It's exposed by [BigtableDataClient](https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigtable/data/v2/BigtableDataClient.html).
88+
89+
### Admin API
90+
Allows callers to create and manage instances, clusters, tables, and access permissions. This API is exposed by: [BigtableInstanceAdminClient](https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigtable/admin/v2/BigtableInstanceAdminClient.html) for Instance and Cluster level resources.
91+
92+
See [BigtableTableAdminClient](https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigtable/admin/v2/BigtableTableAdminClient.html) for table management.
93+
94+
See [BigtableDataClient](https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigtable/data/v2/BigtableDataClient.html) for the data client.
95+
96+
See [BigtableInstanceAdminClient](https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigtable/admin/v2/BigtableInstanceAdminClient.html) for the instance admin client.
97+
98+
See [BigtableTableAdminClient](https://googleapis.dev/java/google-cloud-clients/latest/com/google/cloud/bigtable/admin/v2/BigtableTableAdminClient.html) for the table admin client.
99+
66100
#### Calling Cloud Bigtable
67101

68102
The Cloud Bigtable API is split into 3 parts: Data API, Instance Admin API and Table Admin API.

google-cloud-clients/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/package-info.java

Lines changed: 0 additions & 64 deletions
This file was deleted.

0 commit comments

Comments
 (0)