-
Notifications
You must be signed in to change notification settings - Fork 438
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bigtable: checkAndMutateRow api implementation (#1333)
* checkAndMutateRow api * fix doc * fix snippet test * change snippet test * address feedback * update note * update comment * apply note to truemutations * fix comment * fix snippet test
- Loading branch information
Showing
8 changed files
with
676 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| <?php | ||
| /** | ||
| * Copyright 2018, Google LLC All rights reserved. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| namespace Google\Cloud\Bigtable; | ||
|
|
||
| use Google\Cloud\Bigtable\V2\Mutation; | ||
| use Google\Cloud\Bigtable\V2\Mutation\DeleteFromColumn; | ||
| use Google\Cloud\Bigtable\V2\Mutation\DeleteFromFamily; | ||
| use Google\Cloud\Bigtable\V2\Mutation\DeleteFromRow; | ||
| use Google\Cloud\Bigtable\V2\Mutation\SetCell; | ||
| use Google\Cloud\Bigtable\V2\TimestampRange; | ||
|
|
||
| /** | ||
| * Represents a Mutation to perform data operation on Bigtable table. | ||
| * This is used to insert,update, delete operation on row in Bigtable table. | ||
| */ | ||
| class Mutations | ||
| { | ||
| /** | ||
| * Creates Insert/Update mutation for a row. | ||
| * | ||
| * @param string $family Family name of the row. | ||
| * @param string $qualifier Column qualifier of the row. | ||
| * @param string $value Value of the column qualifier. | ||
| * @param string|int $timeStamp [optional] A timestamp value, in microseconds. | ||
| * Use the value `-1` to utilize the current Bigtable server time. | ||
| * **Defaults to** the current local system time. | ||
| * | ||
| * @return Mutations returns current Mutations object. | ||
| */ | ||
| public function upsert($family, $qualifier, $value, $timeStamp = null) | ||
| { | ||
| $mutationSetCell = (new SetCell) | ||
| ->setFamilyName($family) | ||
| ->setColumnQualifier($qualifier) | ||
| ->setValue($value); | ||
| if ($timeStamp === null) { | ||
| $mutationSetCell->setTimestampMicros( | ||
| // gives milli second | ||
| round($this->microtime() * 1000) | ||
| // multiply by 1000 to get micro | ||
| * 1000 | ||
| ); | ||
| } else { | ||
| $mutationSetCell->setTimestampMicros($timeStamp); | ||
| } | ||
| $this->mutations[] = (new Mutation)->setSetCell($mutationSetCell); | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Creates delete from family mutation for a row. | ||
| * | ||
| * @param string $family Family name of the row. | ||
| * | ||
| * @return Mutations returns current Mutations object. | ||
| */ | ||
| public function deleteFromFamily($family) | ||
| { | ||
| $this->mutations[] = (new Mutation) | ||
| ->setDeleteFromFamily( | ||
| (new DeleteFromFamily)->setFamilyName($family) | ||
| ); | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Creates delete from column mutation for a row. | ||
| * | ||
| * @param string $family Family name of the row. | ||
| * @param string $qualifier Column qualifier of the row. | ||
| * @param array $timeRange [optional] Array of values value, in microseconds to | ||
| * delete from column, keyed by `start` and `end` representing time range | ||
| * window. | ||
| * `start` **Defaults to** 0 | ||
| * `end` **Defaults to** infinity | ||
| * @return Mutations returns current Mutations object. | ||
| */ | ||
| public function deleteFromColumn($family, $qualifier, array $timeRange = []) | ||
| { | ||
| $deleteFromColumn = (new DeleteFromColumn) | ||
| ->setFamilyName($family) | ||
| ->setColumnQualifier($qualifier); | ||
| if (!empty($timeRange)) { | ||
| $timestampRange = new TimestampRange; | ||
| if (isset($timeRange['start'])) { | ||
| $timestampRange->setStartTimestampMicros($timeRange['start']); | ||
| } | ||
| if (isset($timeRange['end'])) { | ||
| $timestampRange->setEndTimestampMicros($timeRange['end']); | ||
| } | ||
| $deleteFromColumn->setTimeRange($timestampRange); | ||
| } | ||
| $this->mutations[] = (new Mutation)->setDeleteFromColumn($deleteFromColumn); | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Creates delete row mutation for a row. | ||
| * | ||
| * @return Mutations returns current Mutations object. | ||
| */ | ||
| public function deleteRow() | ||
| { | ||
| $this->mutations[] = (new Mutation)->setDeleteFromRow(new DeleteFromRow); | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Returns current unix timestamp with microseconds. This method exists for | ||
| * testing purposes. | ||
| * | ||
| * @return float | ||
| */ | ||
| protected function microtime() | ||
| { | ||
| return microtime(true); | ||
| } | ||
|
|
||
| /** | ||
| * Returns protobuf representation of Mutations. | ||
| * | ||
| * @internal | ||
| * @access private | ||
| * @return array returns array of protobuf representation of Mutations. | ||
| */ | ||
| public function toProto() | ||
| { | ||
| return $this->mutations; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.