forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request googleapis#1489 from dhermes/bigtable-happybase-table
Adding Bigtable HappyBase Table class.
- Loading branch information
Showing
5 changed files
with
289 additions
and
0 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,93 @@ | ||
# Copyright 2016 Google Inc. 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. | ||
|
||
"""Google Cloud Bigtable HappyBase table module.""" | ||
|
||
|
||
from gcloud.bigtable.table import Table as _LowLevelTable | ||
|
||
|
||
def make_row(cell_map, include_timestamp): | ||
"""Make a row dict for a Thrift cell mapping. | ||
.. note:: | ||
This method is only provided for HappyBase compatibility, but does not | ||
actually work. | ||
:type cell_map: dict | ||
:param cell_map: Dictionary with ``fam:col`` strings as keys and ``TCell`` | ||
instances as values. | ||
:type include_timestamp: bool | ||
:param include_timestamp: Flag to indicate if cell timestamps should be | ||
included with the output. | ||
:raises: :class:`NotImplementedError <exceptions.NotImplementedError>` | ||
always | ||
""" | ||
raise NotImplementedError('The Cloud Bigtable API output is not the same ' | ||
'as the output from the Thrift server, so this ' | ||
'helper can not be implemented.', 'Called with', | ||
cell_map, include_timestamp) | ||
|
||
|
||
def make_ordered_row(sorted_columns, include_timestamp): | ||
"""Make a row dict for sorted Thrift column results from scans. | ||
.. note:: | ||
This method is only provided for HappyBase compatibility, but does not | ||
actually work. | ||
:type sorted_columns: list | ||
:param sorted_columns: List of ``TColumn`` instances from Thrift. | ||
:type include_timestamp: bool | ||
:param include_timestamp: Flag to indicate if cell timestamps should be | ||
included with the output. | ||
:raises: :class:`NotImplementedError <exceptions.NotImplementedError>` | ||
always | ||
""" | ||
raise NotImplementedError('The Cloud Bigtable API output is not the same ' | ||
'as the output from the Thrift server, so this ' | ||
'helper can not be implemented.', 'Called with', | ||
sorted_columns, include_timestamp) | ||
|
||
|
||
class Table(object): | ||
"""Representation of Cloud Bigtable table. | ||
Used for adding data and | ||
:type name: str | ||
:param name: The name of the table. | ||
:type connection: :class:`.Connection` | ||
:param connection: The connection which has access to the table. | ||
""" | ||
|
||
def __init__(self, name, connection): | ||
self.name = name | ||
# This remains as legacy for HappyBase, but only the cluster | ||
# from the connection is needed. | ||
self.connection = connection | ||
self._low_level_table = None | ||
if self.connection is not None: | ||
self._low_level_table = _LowLevelTable(self.name, | ||
self.connection._cluster) | ||
|
||
def __repr__(self): | ||
return '<table.Table name=%r>' % (self.name,) |
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,97 @@ | ||
# Copyright 2016 Google Inc. 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. | ||
|
||
import unittest2 | ||
|
||
|
||
class Test_make_row(unittest2.TestCase): | ||
|
||
def _callFUT(self, *args, **kwargs): | ||
from gcloud.bigtable.happybase.table import make_row | ||
return make_row(*args, **kwargs) | ||
|
||
def test_it(self): | ||
with self.assertRaises(NotImplementedError): | ||
self._callFUT({}, False) | ||
|
||
|
||
class Test_make_ordered_row(unittest2.TestCase): | ||
|
||
def _callFUT(self, *args, **kwargs): | ||
from gcloud.bigtable.happybase.table import make_ordered_row | ||
return make_ordered_row(*args, **kwargs) | ||
|
||
def test_it(self): | ||
with self.assertRaises(NotImplementedError): | ||
self._callFUT([], False) | ||
|
||
|
||
class TestTable(unittest2.TestCase): | ||
|
||
def _getTargetClass(self): | ||
from gcloud.bigtable.happybase.table import Table | ||
return Table | ||
|
||
def _makeOne(self, *args, **kwargs): | ||
return self._getTargetClass()(*args, **kwargs) | ||
|
||
def test_constructor(self): | ||
from gcloud._testing import _Monkey | ||
from gcloud.bigtable.happybase import table as MUT | ||
|
||
name = 'table-name' | ||
cluster = object() | ||
connection = _Connection(cluster) | ||
tables_constructed = [] | ||
|
||
def make_low_level_table(*args, **kwargs): | ||
result = _MockLowLevelTable(*args, **kwargs) | ||
tables_constructed.append(result) | ||
return result | ||
|
||
with _Monkey(MUT, _LowLevelTable=make_low_level_table): | ||
table = self._makeOne(name, connection) | ||
self.assertEqual(table.name, name) | ||
self.assertEqual(table.connection, connection) | ||
|
||
table_instance, = tables_constructed | ||
self.assertEqual(table._low_level_table, table_instance) | ||
self.assertEqual(table_instance.args, (name, cluster)) | ||
self.assertEqual(table_instance.kwargs, {}) | ||
|
||
def test_constructor_null_connection(self): | ||
name = 'table-name' | ||
connection = None | ||
table = self._makeOne(name, connection) | ||
self.assertEqual(table.name, name) | ||
self.assertEqual(table.connection, connection) | ||
self.assertEqual(table._low_level_table, None) | ||
|
||
def test___repr__(self): | ||
name = 'table-name' | ||
table = self._makeOne(name, None) | ||
self.assertEqual(repr(table), '<table.Table name=\'table-name\'>') | ||
|
||
|
||
class _Connection(object): | ||
|
||
def __init__(self, cluster): | ||
self._cluster = cluster | ||
|
||
|
||
class _MockLowLevelTable(object): | ||
|
||
def __init__(self, *args, **kwargs): | ||
self.args = args | ||
self.kwargs = kwargs |
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