BigTable Admin Samples

bigtable/api/README.md

@@ -0,0 +1,38 @@
+# Google BigTable Sample
+
+## Description
+
+All code in the `src` directory demonstrates how to connect to Cloud Bigtable and run some basic operations to create instance, create cluster, delete instance and delete cluster.
+
+## Build and Run
+1.  **Enable APIs** - [Enable the BigTable API](https://console.cloud.google.com/flows/enableapi?apiid=bigtable)
+    and create a new project or select an existing project.
+2.  **Download The Credentials** - Click "Go to credentials" after enabling the APIs. Click "New Credentials"
+    and select "Service Account Key". Create a new service account, use the JSON key type, and
+    select "Create". Once downloaded, set the environment variable `GOOGLE_APPLICATION_CREDENTIALS`
+    to the path of the JSON key that was downloaded.
+3.  **Clone the repo** and cd into this directory
+    ```sh
+    $ git clone https://github.com/GoogleCloudPlatform/php-docs-samples
+    $ cd php-docs-samples/bigtable/api
+    ```
+
+4.  **Install dependencies** via [Composer](http://getcomposer.org/doc/00-intro.md).
+    Run `php composer.phar install` (if composer is installed locally) or `composer install`
+    (if composer is installed globally).
+5.  Run `php SNIPPET_NAME.php`. The usage will print for each if no arguments
+    are provided:
+    ```sh
+    $ php src/run_instance_operations.php
+    Usage: php src/run_instance_operations.php PROJECT_ID INSTANCE_ID TABLE_ID
+
+    $ php src/run_instance_operations.php your-project-id your-instance-id your-table-id
+    ```
+
+## Contributing changes
+
+* See [CONTRIBUTING.md](../../CONTRIBUTING.md)
+
+## Licensing
+
+* See [LICENSE](../../LICENSE)

bigtable/api/composer.json

@@ -0,0 +1,9 @@
+{
+    "require": {
+        "google/cloud-bigtable": "^0.9.1"
+    },
+    "require-dev": {
+        "google/cloud-tools": "^0.8",
+        "phpunit/phpunit": "^5.0"
+    }
+}

bigtable/api/phpunit.xml.dist

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2018 Google LLC.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<phpunit backupGlobals="false"
+         strict="true"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         syntaxCheck="false"
+         timeoutForSmallTests="10"
+         timeoutForMediumTests="30"
+         timeoutForLargeTests="120">
+    <testsuites>
+        <testsuite name="PHP bigtable Instance test">
+          <file>./test/bigtableTest.php</file>
+        </testsuite>
+    </testsuites>
+    <logging>
+        <log type="coverage-clover" target="./build/logs/clover.xml"/>
+    </logging>
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="true">
+            <directory>./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

bigtable/api/src/create_cluster.php

@@ -0,0 +1,104 @@
+<?php
+
+/**
+ * Copyright 2018 Google LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/bigtable/api/README.md
+ */
+
+// Include Google Cloud dependendencies using Composer
+require_once __DIR__ . '/../vendor/autoload.php';
+
+if (count($argv) < 3 || count($argv) > 5) {
+    return printf("Usage: php %s PROJECT_ID INSTANCE_ID CLUSTER_ID [LOCATION_ID]" . PHP_EOL, __FILE__);
+}
+list($_, $project_id, $instance_id, $cluster_id) = $argv;
+$location_id = isset($argv[4]) ? $argv[4] : 'us-east1-b';
+
+// [START bigtable_create_cluster]
+
+use Google\Cloud\Bigtable\Admin\V2\BigtableInstanceAdminClient;
+use Google\Cloud\Bigtable\Admin\V2\Cluster;
+use Google\Cloud\Bigtable\Admin\V2\StorageType;
+use Google\ApiCore\ApiException;
+
+
+/** Uncomment and populate these variables in your code */
+// $project_id = 'The Google project ID';
+// $instance_id = 'The Bigtable instance ID';
+// $cluster_id = 'The Bigtable cluster ID';
+// $location_id = 'The Bigtable region ID';
+
+
+$instanceAdminClient = new BigtableInstanceAdminClient();
+
+$instanceName = $instanceAdminClient->instanceName($project_id, $instance_id);
+$clusterName = $instanceAdminClient->clusterName($project_id, $instance_id, $cluster_id);
+
+printf("Adding Cluster to Instance %s" . PHP_EOL, $instance_id);
+try {
+    $instanceAdminClient->getInstance($instanceName);
+} catch (ApiException $e) {
+    if ($e->getStatus() === 'NOT_FOUND') {
+        printf("Instance %s does not exists." . PHP_EOL, $instance_id);
+        return;
+    } else {
+        throw $e;
+    }
+}
+printf("Listing Clusters:" . PHP_EOL);
+
+$storage_type = StorageType::SSD;
+$serve_nodes = 3;
+
+$clustersBefore = $instanceAdminClient->listClusters($instanceName)->getClusters();
+$clusters = $clustersBefore->getIterator();
+foreach ($clusters as $cluster) {
+    print($cluster->getName() . PHP_EOL);
+}
+
+$cluster = new Cluster();
+$cluster->setServeNodes($serve_nodes);
+$cluster->setDefaultStorageType($storage_type);
+$cluster->setLocation(
+    $instanceAdminClient->locationName(
+        $project_id,
+        $location_id
+    )
+);
+try {
+    $instanceAdminClient->getCluster($clusterName);
+    printf("Cluster %s already exists, aborting...", $cluster_id);
+} catch (ApiException $e) {
+    if ($e->getStatus() === 'NOT_FOUND') {
+        $operationResponse = $instanceAdminClient->createCluster($instanceName, $cluster_id, $cluster);
+
+        $operationResponse->pollUntilComplete();
+        if ($operationResponse->operationSucceeded()) {
+            $result = $operationResponse->getResult();
+            printf("Cluster created: %s", $cluster_id);
+        } else {
+            $error = $operationResponse->getError();
+            printf("Cluster not created: %s", $error);
+        }
+    } else {
+        throw $e;
+    }
+}
+// [END bigtable_create_cluster]

bigtable/api/src/create_dev_instance.php

@@ -0,0 +1,106 @@
+<?php
+
+/**
+ * Copyright 2018 Google LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/bigtable/api/README.md
+ */
+
+// Include Google Cloud dependendencies using Composer
+require_once __DIR__ . '/../vendor/autoload.php';
+
+if (count($argv) < 3 || count($argv) > 5) {
+    return printf("Usage: php %s PROJECT_ID INSTANCE_ID CLUSTER_ID [LOCATION_ID]" . PHP_EOL, __FILE__);
+}
+list($_, $project_id, $instance_id, $cluster_id) = $argv;
+$location_id = isset($argv[4]) ? $argv[4] : 'us-east1-b';
+
+// [START bigtable_create_dev_instance]
+
+use Google\Cloud\Bigtable\Admin\V2\BigtableInstanceAdminClient;
+use Google\Cloud\Bigtable\Admin\V2\Instance;
+use Google\Cloud\Bigtable\Admin\V2\Cluster;
+use Google\Cloud\Bigtable\Admin\V2\StorageType;
+use Google\Cloud\Bigtable\Admin\V2\Instance\Type as InstanceType;
+use Google\ApiCore\ApiException;
+
+/** Uncomment and populate these variables in your code */
+// $project_id = 'The Google project ID';
+// $instance_id = 'The Bigtable instance ID';
+// $cluster_id = 'The Bigtable cluster ID';
+// $location_id = 'The Bigtable region ID';
+
+
+$instanceAdminClient = new BigtableInstanceAdminClient();
+
+$projectName = $instanceAdminClient->projectName($project_id);
+$instanceName = $instanceAdminClient->instanceName($project_id, $instance_id);
+
+
+printf("Creating a DEVELOPMENT Instance" . PHP_EOL);
+// Set options to create an Instance
+
+$storage_type = StorageType::HDD;
+$development = InstanceType::DEVELOPMENT;
+$labels = ['dev-label' => 'dev-label'];
+
+
+# Create instance with given options
+$instance = new Instance();
+$instance->setDisplayName($instance_id);
+$instance->setLabels($labels);
+$instance->setType($development);
+
+// Create cluster with given options
+$cluster = new Cluster();
+$cluster->setDefaultStorageType($storage_type);
+$cluster->setLocation(
+    $instanceAdminClient->locationName(
+        $project_id,
+        $location_id
+    )
+);
+$clusters = [
+    $cluster_id => $cluster
+];
+// Create development instance with given options
+try {
+    $instanceAdminClient->getInstance($instanceName);
+    printf("Instance %s already exists." . PHP_EOL, $instance_id);
+} catch (ApiException $e) {
+    if ($e->getStatus() === 'NOT_FOUND') {
+        printf("Creating a development Instance: %s" . PHP_EOL, $instance_id);
+        $operationResponse = $instanceAdminClient->createInstance(
+            $projectName,
+            $instance_id,
+            $instance,
+            $clusters
+        );
+        $operationResponse->pollUntilComplete();
+        if (!$operationResponse->operationSucceeded()) {
+            $error = $operationResponse->getError();
+            throw $error;
+        } else {
+            printf("Instance %s created.", $instance_id);
+        }
+    } else {
+        throw $e;
+    }
+}
+// [END bigtable_create_dev_instance]

bigtable/api/src/create_family_gc_intersection.php

@@ -0,0 +1,74 @@
+<?php
+
+/**
+ * Copyright 2018 Google LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/bigtable/api/README.md
+ */
+
+// Include Google Cloud dependendencies using Composer
+require_once __DIR__ . '/../vendor/autoload.php';
+
+if (count($argv) != 4) {
+    return printf("Usage: php %s PROJECT_ID INSTANCE_ID TABLE_ID" . PHP_EOL, __FILE__);
+}
+list($_, $project_id, $instance_id, $table_id) = $argv;
+
+// [START bigtable_create_family_gc_intersection]
+use Google\Cloud\Bigtable\Admin\V2\GcRule\Intersection as GcRuleIntersection;
+use Google\Cloud\Bigtable\Admin\V2\ModifyColumnFamiliesRequest\Modification;
+use Google\Cloud\Bigtable\Admin\V2\BigtableInstanceAdminClient;
+use Google\Cloud\Bigtable\Admin\V2\BigtableTableAdminClient;
+use Google\Cloud\Bigtable\Admin\V2\ColumnFamily;
+use Google\Cloud\Bigtable\Admin\V2\GcRule;
+use Google\Protobuf\Duration;
+
+
+/** Uncomment and populate these variables in your code */
+// $project_id = 'The Google project ID';
+// $instance_id = 'The Bigtable instance ID';
+// $table_id = 'The Bigtable table ID';
+
+$tableAdminClient = new BigtableTableAdminClient();
+
+$tableName = $tableAdminClient->tableName($project_id, $instance_id, $table_id);
+
+print('Creating column family cf4 with Intersection GC rule...' . PHP_EOL);
+$columnFamily4 = new ColumnFamily();
+
+$intersection_rule = new GcRuleIntersection();
+$intersection_array = [
+    (new GcRule)->setMaxAge((new Duration())->setSeconds(3600 * 24 * 5)),
+    (new GcRule)->setMaxNumVersions(2)
+];
+$intersection_rule->setRules($intersection_array);
+
+$intersection = new GcRule();
+$intersection->setIntersection($intersection_rule);
+
+$columnFamily4->setGCRule($intersection);
+
+$columnModification = new Modification();
+$columnModification->setId('cf4');
+$columnModification->setCreate($columnFamily4);
+$tableAdminClient->modifyColumnFamilies($tableName, [$columnModification]);
+
+print('Created column family cf4 with Union GC rule' . PHP_EOL);
+
+// [END bigtable_create_family_gc_intersection]