|
| 1 | +{ |
| 2 | + "name": "bigtable", |
| 3 | + "name_pretty": "Google Cloud Bigtable", |
| 4 | + "api_description": "is Google's NoSQL Big Data database service. It's the\nsame database that powers many core Google services, including Search,\nAnalytics, Maps, and Gmail.", |
| 5 | + "product_documentation": "https://cloud.google.com/bigtable", |
| 6 | + "client_documentation": "https://cloud.google.com/python/docs/reference/bigtable/latest", |
| 7 | + "issue_tracker": "https://issuetracker.google.com/savedsearches/559777", |
| 8 | + "release_level": "stable", |
| 9 | + "language": "python", |
| 10 | + "library_type": "GAPIC_COMBO", |
| 11 | + "repo": "googleapis/google-cloud-python", |
| 12 | + "distribution_name": "google-cloud-bigtable", |
| 13 | + "api_id": "bigtable.googleapis.com", |
| 14 | + "requires_billing": true, |
| 15 | + "samples": [ |
| 16 | + { |
| 17 | + "name": "Hello World in Cloud Bigtable", |
| 18 | + "description": "Demonstrates how to connect to Cloud Bigtable and run some basic operations. More information available at: https://cloud.google.com/bigtable/docs/samples-python-hello", |
| 19 | + "file": "main.py", |
| 20 | + "runnable": true, |
| 21 | + "custom_content": "<pre>usage: main.py [-h] [--table TABLE] project_id instance_id<br>Demonstrates how to connect to Cloud Bigtable and run some basic operations.<br>Prerequisites: - Create a Cloud Bigtable cluster.<br>https://cloud.google.com/bigtable/docs/creating-cluster - Set your Google<br>Application Default Credentials.<br>https://developers.google.com/identity/protocols/application-default-<br>credentials<br><br><br>positional arguments:<br> project_id Your Cloud Platform project ID.<br> instance_id ID of the Cloud Bigtable instance to connect to.<br><br><br>optional arguments:<br> -h, --help show this help message and exit<br> --table TABLE Table to create and destroy. (default: Hello-Bigtable)</pre>", |
| 22 | + "override_path": "hello" |
| 23 | + }, |
| 24 | + { |
| 25 | + "name": "Hello World using HappyBase", |
| 26 | + "description": "This sample demonstrates using the Google Cloud Client Library HappyBase package, an implementation of the HappyBase API to connect to and interact with Cloud Bigtable. More information available at: https://cloud.google.com/bigtable/docs/samples-python-hello-happybase", |
| 27 | + "file": "main.py", |
| 28 | + "runnable": true, |
| 29 | + "custom_content": "<pre>usage: main.py [-h] [--table TABLE] project_id instance_id<br>Demonstrates how to connect to Cloud Bigtable and run some basic operations.<br>Prerequisites: - Create a Cloud Bigtable cluster.<br>https://cloud.google.com/bigtable/docs/creating-cluster - Set your Google<br>Application Default Credentials.<br>https://developers.google.com/identity/protocols/application-default-<br>credentials<br><br><br>positional arguments:<br> project_id Your Cloud Platform project ID.<br> instance_id ID of the Cloud Bigtable instance to connect to.<br><br><br>optional arguments:<br> -h, --help show this help message and exit<br> --table TABLE Table to create and destroy. (default: Hello-Bigtable)</pre>", |
| 30 | + "override_path": "hello_happybase" |
| 31 | + }, |
| 32 | + { |
| 33 | + "name": "cbt Command Demonstration", |
| 34 | + "description": "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. More information about this quickstart is available at https://cloud.google.com/bigtable/docs/quickstart-cbt", |
| 35 | + "file": "instanceadmin.py", |
| 36 | + "runnable": true, |
| 37 | + "custom_content": "<pre>usage: instanceadmin.py [-h] [run] [dev-instance] [del-instance] [add-cluster] [del-cluster] project_id instance_id cluster_id<br>Demonstrates how to connect to Cloud Bigtable and run some basic operations.<br>Prerequisites: - Create a Cloud Bigtable cluster.<br>https://cloud.google.com/bigtable/docs/creating-cluster - Set your Google<br>Application Default Credentials.<br>https://developers.google.com/identity/protocols/application-default-<br>credentials<br><br><br>positional arguments:<br> project_id Your Cloud Platform project ID.<br> instance_id ID of the Cloud Bigtable instance to connect to.<br><br><br>optional arguments:<br> -h, --help show this help message and exit<br> --table TABLE Table to create and destroy. (default: Hello-Bigtable)</pre>", |
| 38 | + "override_path": "instanceadmin" |
| 39 | + }, |
| 40 | + { |
| 41 | + "name": "Metric Scaler", |
| 42 | + "description": "This sample demonstrates how to use Stackdriver Monitoring to scale Cloud Bigtable based on CPU usage.", |
| 43 | + "file": "metricscaler.py", |
| 44 | + "runnable": true, |
| 45 | + "custom_content": "<pre>usage: metricscaler.py [-h] [--high_cpu_threshold HIGH_CPU_THRESHOLD] [--low_cpu_threshold LOW_CPU_THRESHOLD] [--short_sleep SHORT_SLEEP] [--long_sleep LONG_SLEEP] bigtable_instance bigtable_cluster<br>usage: metricscaler.py [-h] [--high_cpu_threshold HIGH_CPU_THRESHOLD] <br> [--low_cpu_threshold LOW_CPU_THRESHOLD] <br> [--short_sleep SHORT_SLEEP] [--long_sleep LONG_SLEEP] <br> bigtable_instance bigtable_cluster <br><br> <br>Scales Cloud Bigtable clusters based on CPU usage. <br><br> <br>positional arguments: <br> bigtable_instance ID of the Cloud Bigtable instance to connect to. <br> bigtable_cluster ID of the Cloud Bigtable cluster to connect to. <br><br> <br>optional arguments: <br> -h, --help show this help message and exit <br> --high_cpu_threshold HIGH_CPU_THRESHOLD <br> If Cloud Bigtable CPU usage is above this threshold, <br> scale up <br> --low_cpu_threshold LOW_CPU_THRESHOLD <br> If Cloud Bigtable CPU usage is below this threshold, <br> scale down <br> --short_sleep SHORT_SLEEP <br> How long to sleep in seconds between checking metrics <br> after no scale operation <br> --long_sleep LONG_SLEEP <br> How long to sleep in seconds between checking metrics <br> after a scaling operation</pre>", |
| 46 | + "override_path": "metricscaler" |
| 47 | + }, |
| 48 | + { |
| 49 | + "name": "Quickstart", |
| 50 | + "description": "Demonstrates of Cloud Bigtable. This sample creates a Bigtable client, connects to an instance and then to a table, then closes the connection.", |
| 51 | + "file": "main.py", |
| 52 | + "runnable": true, |
| 53 | + "custom_content": "<pre>usage: main.py [-h] [--table TABLE] project_id instance_id <br><br> <br>positional arguments: <br> project_id Your Cloud Platform project ID. <br> instance_id ID of the Cloud Bigtable instance to connect to. <br><br> <br>optional arguments: <br> -h, --help show this help message and exit <br> --table TABLE Existing table used in the quickstart. (default: my-table)</pre>", |
| 54 | + "override_path": "quickstart" |
| 55 | + }, |
| 56 | + { |
| 57 | + "name": "Quickstart using HappyBase", |
| 58 | + "description": "Demonstrates of Cloud Bigtable using HappyBase. This sample creates a Bigtable client, connects to an instance and then to a table, then closes the connection.", |
| 59 | + "file": "main.py", |
| 60 | + "runnable": true, |
| 61 | + "custom_content": "<pre>usage: main.py [-h] [--table TABLE] project_id instance_id<br>usage: main.py [-h] [--table TABLE] project_id instance_id <br><br> <br>positional arguments: <br> project_id Your Cloud Platform project ID. <br> instance_id ID of the Cloud Bigtable instance to connect to. <br><br> <br>optional arguments: <br> -h, --help show this help message and exit <br> --table TABLE Existing table used in the quickstart. (default: my-table)</pre>", |
| 62 | + "override_path": "quickstart_happybase" |
| 63 | + }, |
| 64 | + { |
| 65 | + "name": "Snippets", |
| 66 | + "description": "This folder contains snippets for Python Cloud Bigtable.", |
| 67 | + "override_path": "snippets" |
| 68 | + }, |
| 69 | + { |
| 70 | + "name": "Table Admin", |
| 71 | + "description": "Demonstrates how to connect to Cloud Bigtable and run some basic operations.", |
| 72 | + "file": "tableadmin.py", |
| 73 | + "runnable": true, |
| 74 | + "custom_content": "<pre>usage: tableadmin.py [-h] [run] [delete] [--table TABLE] project_id instance_id <br><br> <br>Demonstrates how to connect to Cloud Bigtable and run some basic operations. <br>Prerequisites: - Create a Cloud Bigtable cluster. <br>https://cloud.google.com/bigtable/docs/creating-cluster - Set your Google <br>Application Default Credentials. <br>https://developers.google.com/identity/protocols/application-default- <br>credentials <br><br> <br>positional arguments: <br> project_id Your Cloud Platform project ID. <br> instance_id ID of the Cloud Bigtable instance to connect to. <br><br> <br>optional arguments: <br> -h, --help show this help message and exit <br> --table TABLE Table to create and destroy. (default: Hello-Bigtable)</pre>", |
| 75 | + "override_path": "tableadmin" |
| 76 | + } |
| 77 | + ], |
| 78 | + "default_version": "v2", |
| 79 | + "codeowner_team": "@googleapis/api-bigtable @googleapis/api-bigtable-partners", |
| 80 | + "api_shortname": "bigtable" |
| 81 | +} |
0 commit comments