API 参考 — HappyBase 1.2.0 文档

> 本文由 [简悦 SimpRead](http://ksria.com/simpread/) 转码， 原文地址 [happybase.readthedocs.io](https://happybase.readthedocs.io/en/latest/api.html)

接口参考 [¶](#api-reference "Permalink to this headline")
=====================================================

本章包含 HappyBase 的详细 API 文档。建议先阅读[用户指南](user.html)，大致了解 HappyBase 的工作原理。

HappyBase API 的组织方式如下：

[`连接`](#happybase.Connection "happybase.Connection")：

[`"连接"`](#happybase.Connection "happybase.Connection")类是应用程序开发人员的主要入口点。它连接到 HBase Thrift 服务器，并提供表管理方法。

[`表`](#happybase.Table "happybase.Table")：

[`Table`](#happybase.Table "happybase.Table")类是用于与表中的数据进行交互的主类。此类提供用于数据检索和数据操作的方法。可以使用 [`Connection.table（）`](#happybase.Connection.table "happybase.Connection.table")方法获取此类的实例。

[`批次`](#happybase.Batch "happybase.Batch")：

[`Batch`](#happybase.Batch "happybase.Batch")类实现用于数据操作的批处理 API，可通过 [`Table.batch（）`](#happybase.Table.batch "happybase.Table.batch")方法获得。

[`连接池`](#happybase.ConnectionPool "happybase.ConnectionPool")：

[`类实现`](#happybase.ConnectionPool "happybase.ConnectionPool")线程安全的连接池，该连接池允许应用程序（重新）使用多个连接。

连接 [¶](#connection "Permalink to this headline")
------------------------------------------------

_类_`happybase.``Connection`(_host='localhost'_， _port=9090_， _timeout=None_， _autoconnect=True_， _table_prefix=None_， _table_prefix_separator=b'_'_， _compat='0.98'_， _transport='buffered'_， _protocol='binary'_)[¶](#happybase.Connection "Permalink to this definition")

连接到 HBase Thrift 服务器。

主机和端口参数指定要连接到的 HBase Thrift 服务器的主机名和 TCP 端口。如果省略 或 ，则建立与缺省端口 的连接。如果指定，则超时参数指定套接字超时（以毫秒为单位）。`None``localhost`

如果 autoconnect 为 True（默认值），则直接建立连接，否则必须在首次使用之前显式调用 [`Connection.open（）。`](#happybase.Connection.open "happybase.Connection.open")

可选的 table_prefix 和 table_prefix_separator 参数指定要附加到所有表名前面的前缀和分隔符字符串，例如，当调用 [`Connection.table（）`](#happybase.Connection.table "happybase.Connection.table")时。例如，如果 table_prefix 为 ，则所有表的名称都类似于 。`myproject``myproject_XYZ`

可选的 compat 参数设置此连接的兼容级别。较旧的 HBase 版本具有略有不同的 Thrift 接口，使用错误的协议可能会导致通信错误导致崩溃，因此请确保使用正确的协议。此值可以是字符串 、 、 或 （默认值）。`0.90``0.92``0.94``0.96`

可选的传输参数指定要使用的 Thrift 传输模式。此参数支持的值为（默认值）和 。请确保选择正确的一个，否则在建立连接时可能会看到不明显的连接错误或程序挂起。0.94 之前的 HBase 版本始终使用缓冲传输。从 HBase 0.94 开始，Thrift 服务器可以选择使用成帧传输，具体取决于传递给命令的参数。默认模式使用缓冲传输;、 和 模式使用成帧传输。`buffered``framed``hbase-daemon.sh start thrift``-threadpool``-hsha``-nonblocking``-threadedselector`

可选协议参数指定要使用的 Thrift 传输协议。此参数支持的值为（默认值）和 。请确保选择正确的一个，否则在建立连接时可能会看到不明显的连接错误或程序挂起。 是一种更紧凑的二进制格式，通常处理起来也更有效。 是 Happybase 使用的默认协议。`binary``compact``TCompactProtocol``TBinaryProtocol`

0.9 版中的新功能：协议参数

0.5 版中的新功能：超时参数

0.4 版中的新功能：table_prefix_separator 参数

0.4 版中的新功能：支持框架节俭传输

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1663688" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2325934" _msttexthash="69788004"><strong _istranslated="1">主机</strong>（<em _istranslated="1">str</em>） – 要连接到的主机</li><li _msthash="2326064" _msttexthash="71936475"><strong _istranslated="1">端口</strong>（<em _istranslated="1">int</em>） – 要连接到的端口</li><li _msthash="2326194" _msttexthash="211315481"><strong _istranslated="1">超时</strong>（<em _istranslated="1">int</em>） – 套接字超时（以毫秒为单位）（可选）</li><li _msthash="2326324" _msttexthash="106230072"><strong _istranslated="1">自动连接</strong>（<em _istranslated="1">布尔</em>） – 是否应直接打开连接</li><li _msthash="2326454" _msttexthash="221577356"><strong _istranslated="1">table_prefix</strong> （<em _istranslated="1">str</em>） – 用于构造表名的前缀（可选）</li><li _msthash="2326584" _msttexthash="149276361"><strong _istranslated="1">table_prefix_separator</strong> （<em _istranslated="1">str</em>） – 用于<cite _istranslated="1"> table_prefix</cite> 的分离器</li><li _msthash="2326714" _msttexthash="95658771"><strong _istranslated="1">兼容</strong>（<em _istranslated="1">str</em>） – 兼容模式（可选）</li><li _msthash="2326844" _msttexthash="123020209"><strong _istranslated="1">运输</strong>（<em _istranslated="1">str</em>） – 节俭运输方式（可选）</li></ul></td></tr></tbody></table>

`open`()[¶](#happybase.Connection.open "Permalink to this definition")

打开到 HBase 实例的基础传输。

此方法打开基础 Thrift 传输（TCP 连接）。

`close`()[¶](#happybase.Connection.close "Permalink to this definition")

关闭到 HBase 实例的下层传输。

此方法关闭基础 Thrift 传输（TCP 连接）。

`table`(_名称_ _，use_prefix = 真_)[¶](#happybase.Connection.table "Permalink to this definition")

返回表对象。

返回[`快乐的基础。`](#happybase.Table "happybase.Table")名为名称的表 的表实例。这不会导致到服务器的往返行程，并且不会检查表是否存在。

可选的 use_prefix 参数指定表前缀（如果有）是否在指定名称之前附加。如果要使用驻留在另一个 "前缀命名空间" 中的表，例如，来自同一 HBase 实例上共同托管的 "友好" 应用程序的表，请将其设置为 False。有关详细信息，请参阅[`连接`](#happybase.Connection "happybase.Connection")构造函数的 table_prefix 参数。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="2296515" _msttexthash="12292696">参数：</th><td><ul><li _msthash="3061721" _msttexthash="50600693"><strong _istranslated="1">名称</strong>（<em _istranslated="1">str</em>） – 表的名称</li><li _msthash="3061851" _msttexthash="190316100"><strong _istranslated="1">use_prefix</strong> （<em _istranslated="1">bool</em>） – 是否使用表前缀（如果有）</li></ul></td></tr><tr><th _msthash="2296710" _msttexthash="13304174">返回：</th><td><p _msthash="2587520" _msttexthash="7999407">表实例</p></td></tr><tr><th _msthash="2296905" _msttexthash="21643999">返回类型：</th><td><p><a href="#happybase.Table" title="happybase.Table"><code><span _msthash="2587767" _msttexthash="4860804">桌子</span></code></a></p></td></tr></tbody></table>

`tables`()[¶](#happybase.Connection.tables "Permalink to this definition")

返回此 HBase 实例中可用的表名的列表。

如果为此[`连接`](#happybase.Connection "happybase.Connection")设置了 table_prefix，则只会列出具有指定前缀的表。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="2296658" _msttexthash="13304174">返回：</th><td _msthash="2296242" _msttexthash="5415488">表名</td></tr><tr><th _msthash="2296853" _msttexthash="21643999">返回类型：</th><td _msthash="2296437" _msttexthash="15474173">字符串列表</td></tr></tbody></table>

`create_table`(_名称_，_族_)[¶](#happybase.Connection.create_table "Permalink to this definition")

创建表。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="2296801" _msttexthash="12292696">参数：</th><td><ul><li _msthash="3062007" _msttexthash="43604444"><strong _istranslated="1">名称</strong>（<em _istranslated="1">str</em>） – 表名称</li><li _msthash="3062137" _msttexthash="89358776"><strong _istranslated="1">族</strong>（<em _istranslated="1">字典</em>） – 每个列族的名称和选项</li></ul></td></tr></tbody></table>

families 参数是将列系列名称映射到包含此列系列的选项的字典的字典，例如

```
families = {
    'cf1': dict(max_versions=10),
    'cf2': dict(max_versions=1, block_cache_enabled=False),
    'cf3': dict(),  # use defaults
}
connection.create_table('mytable', families)
```

这些选项对应于 Thrift API 中的 ColumnDescriptor 结构，但请注意，这些名称应以 Python 样式提供，而不是以驼峰大小写表示法提供，例如 time_to_live，而不是 timeToLive。支持以下选项：

*   `max_versions` (int)
*   `compression` (str)
*   `in_memory` (布尔)
*   `bloom_filter_type` (str)
*   `bloom_filter_vector_size` (int)
*   `bloom_filter_nb_hashes` (int)
*   `block_cache_enabled` (布尔)
*   `time_to_live` (int)

`delete_table`(_名称_，_禁用 = 假_)[¶](#happybase.Connection.delete_table "Permalink to this definition")

删除指定的表。

版本 0.5 中的新功能：禁用参数

在 HBase 中，始终需要先禁用表，然后才能将其删除。如果 disable 参数为 True，则此方法首先禁用该表（如果尚未禁用），然后将其删除。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="2298153" _msttexthash="12292696">参数：</th><td><ul><li _msthash="3063749" _msttexthash="43604444"><strong _istranslated="1">名称</strong>（<em _istranslated="1">str</em>） – 表名称</li><li _msthash="3063879" _msttexthash="180587784"><strong _istranslated="1">disable</strong> （<em _istranslated="1">bool</em>） – 如果需要，是否首先禁用该表</li></ul></td></tr></tbody></table>

`enable_table`(_名字_)[¶](#happybase.Connection.enable_table "Permalink to this definition")

启用指定的表。

`disable_table`(_名字_)[¶](#happybase.Connection.disable_table "Permalink to this definition")

禁用指定的表。

`is_table_enabled`(_名字_)[¶](#happybase.Connection.is_table_enabled "Permalink to this definition")

返回是否启用了指定的表。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="2294058" _msttexthash="12292696">参数：</th><td><strong _msthash="2991274" _msttexthash="4389879">名字</strong> (<font _mstmutation="1" _msthash="2293642" _msttexthash="18781503"><em _mstmutation="1" _istranslated="1">str</em>）– 表名</font></td></tr><tr><th _msthash="2294253" _msttexthash="13304174">返回：</th><td _msthash="2293837" _msttexthash="25404158">是否启用了该表</td></tr><tr><th _msthash="2294448" _msttexthash="21643999">返回类型：</th><td _msthash="2294032" _msttexthash="4641585">布尔</td></tr></tbody></table>

`compact_table`(_名称_，_主要 = 假_)[¶](#happybase.Connection.compact_table "Permalink to this definition")

压缩指定的表。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="2294604" _msttexthash="12292696">参数：</th><td><ul><li _msthash="3059290" _msttexthash="43604444"><strong _istranslated="1">名称</strong>（<em _istranslated="1">str</em>） – 表名称</li><li _msthash="3059420" _msttexthash="83165654"><strong _istranslated="1">主要</strong>（<em _istranslated="1">bool</em>） – 是否执行主要压实。</li></ul></td></tr></tbody></table>

桌子 [¶](#table "Permalink to this headline")
-------------------------------------------

_类_`happybase.``Table`(_名称_，_连接_)[¶](#happybase.Table "Permalink to this definition")

HBase 表抽象类。

此类不能直接实例化; 请改用 [`Connection.table（）。`](#happybase.Connection.table "happybase.Connection.table")

`families`()[¶](#happybase.Table.families "Permalink to this definition")

检索此表的列系列。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1812083" _msttexthash="13304174">返回：</th><td _msthash="1811667" _msttexthash="64025832">从列系列名称到设置字典的映射</td></tr><tr><th _msthash="1812278" _msttexthash="21643999">返回类型：</th><td _msthash="1811862" _msttexthash="4296877">字典</td></tr></tbody></table>

`regions`()[¶](#happybase.Table.regions "Permalink to this definition")

检索此表的区域。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1812616" _msttexthash="13304174">返回：</th><td _msthash="1812200" _msttexthash="15669797">此表的区域</td></tr><tr><th _msthash="1812811" _msttexthash="21643999">返回类型：</th><td _msthash="1812395" _msttexthash="11295232">字典列表</td></tr></tbody></table>

`row`(_行_，_列 = 无_，_时间戳 = 无__，include_timestamp = 假_)[¶](#happybase.Table.row "Permalink to this definition")

检索单行数据。

此方法检索具有在 row 参数中指定的行键的行，并将此行的列和值作为字典返回。

row 参数是行的行键。如果指定了 columns 参数，则仅返回这些列的值，而不是返回所有可用列。列参数应为包含字节字符串的列表或元组。每个名称可以是列系列（如 或（尾随冒号不是必需的），也可以是带有限定符（如 ） 的列系列。`b'cf1'``b'cf1:'``b'cf1:col1'`

如果指定，则时间戳参数指定结果可能具有的最大版本。include_timestamp 参数指定单元格是作为单个值返回还是作为（值、时间戳）元组返回。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1814358" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2501564" _msttexthash="35380098"><strong _istranslated="1">行</strong>（<em _istranslated="1">str</em>） – 行键</li><li _msthash="2501694" _msttexthash="125396167"><strong _istranslated="1">列</strong>（<em _istranslated="1">list_or_tuple</em>） – 列列表（可选）</li><li _msthash="2501824" _msttexthash="101579088"><strong _istranslated="1">时间戳</strong>（<em _istranslated="1">int</em>） – 时间戳 （可选）</li><li _msthash="2501954" _msttexthash="155093783"><strong _istranslated="1">include_timestamp</strong> （<em _istranslated="1">布尔</em>值 ） – 是否返回时间戳</li></ul></td></tr><tr><th _msthash="1814553" _msttexthash="13304174">返回：</th><td><p _msthash="2074163" _msttexthash="67441192">列（限定符和族）到值的映射</p></td></tr><tr><th _msthash="1814748" _msttexthash="21643999">返回类型：</th><td><p _msthash="2074410" _msttexthash="4296877">字典</p></td></tr></tbody></table>

`rows`(_行_，_列 = 无_，_时间戳 = 无__，include_timestamp = 假_)[¶](#happybase.Table.rows "Permalink to this definition")

检索多行数据。

此方法检索具有在 rows 参数中指定的行键的行，该行参数应为行键的列表（或元组）。返回值是（row_key，row_dict）元组的列表。

列、时间戳和 include_timestamp 参数的行为与 [`row（）`](#happybase.Table.row "happybase.Table.row")完全相同。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1814488" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2501695" _msttexthash="51789335"><strong _istranslated="1">行</strong>（<em _istranslated="1">列表</em>） – 行键列表</li><li _msthash="2501825" _msttexthash="125396167"><strong _istranslated="1">列</strong>（<em _istranslated="1">list_or_tuple</em>） – 列列表（可选）</li><li _msthash="2501955" _msttexthash="101579088"><strong _istranslated="1">时间戳</strong>（<em _istranslated="1">int</em>） – 时间戳 （可选）</li><li _msthash="2502084" _msttexthash="155093783"><strong _istranslated="1">include_timestamp</strong> （<em _istranslated="1">布尔</em>值 ） – 是否返回时间戳</li></ul></td></tr><tr><th _msthash="1814683" _msttexthash="13304174">返回：</th><td><p _msthash="2074293" _msttexthash="44467202">映射列表（列到值）</p></td></tr><tr><th _msthash="1814878" _msttexthash="21643999">返回类型：</th><td><p _msthash="2074540" _msttexthash="11295232">字典列表</p></td></tr></tbody></table>

`cells`(_行_，_列_，_版本 = 无_，_时间戳 = 无__，include_timestamp = 假_)[¶](#happybase.Table.cells "Permalink to this definition")

从表中检索单个单元格的多个版本。

此方法检索单元格的多个版本（如果有）。

versions 参数定义最多要检索的单元格版本数。

时间戳和 include_timestamp 参数的行为与 [`row（） 完全相同`](#happybase.Table.row "happybase.Table.row")。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1815424" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2502890" _msttexthash="35380098"><strong _istranslated="1">行</strong>（<em _istranslated="1">str</em>） – 行键</li><li _msthash="2503020" _msttexthash="34833370"><strong _istranslated="1">列</strong>（<em _istranslated="1">str</em>） – 列名称</li><li _msthash="2503150" _msttexthash="87996584"><strong _istranslated="1">版本</strong>（<em _istranslated="1">int</em>） – 要检索的最大版本数</li><li _msthash="2503280" _msttexthash="101579088"><strong _istranslated="1">时间戳</strong>（<em _istranslated="1">int</em>） – 时间戳 （可选）</li><li _msthash="2503410" _msttexthash="155093783"><strong _istranslated="1">include_timestamp</strong> （<em _istranslated="1">布尔</em>值 ） – 是否返回时间戳</li></ul></td></tr><tr><th _msthash="1815619" _msttexthash="13304174">返回：</th><td><p _msthash="2075333" _msttexthash="9897043">单元格值</p></td></tr><tr><th _msthash="1815814" _msttexthash="21643999">返回类型：</th><td><p _msthash="2075580" _msttexthash="8140340">值列表</p></td></tr></tbody></table>

`scan`(_row_start = 无_ _，row_stop = 无_ _，row_prefix = 无_，_列 = 无_，_过滤器 = 无_，_时间戳 = 无_ _，include_timestamp = 假_ _，batch_size=1000_ _，scan_batching = 无_，_限制 = 无_ _，sorted_columns = 假_，_反向 = 假_)[¶](#happybase.Table.scan "Permalink to this definition")

为表中的数据创建扫描程序。

此方法返回可用于循环访问匹配行的可迭代对象。可以通过两种方式创建扫描仪：

*   row_start 和 row_stop 参数指定扫描程序应在其中启动和停止的行键。表是否包含任何具有指定键的行并不重要：row_start 之后的第一行将是第一个结果，row_stop 之前的最后一行将是最后一个结果。请注意，范围的开头是包含的，而结尾是排除的。
    
    row_start 和 row_stop 都可以为 "无"，以分别指定表的开头和结尾。如果两者都省略，则完成全表扫描。请注意，这通常会导致严重的性能问题。
    
*   或者，如果指定了 row_prefix，则仅返回行键与前缀匹配的行。如果给予，则不能使用 row_start 和 row_stop。

列、时间戳和 include_timestamp 参数的行为与 [`row（）`](#happybase.Table.row "happybase.Table.row")完全相同。

筛选器参数可能是区域服务器将在服务器上应用的筛选器字符串。

如果给出了限制，则最多将返回限制结果。

batch_size 参数指定从扫描程序检索结果时，每个批次应检索多少结果。仅当数据较大时，才将其设置为较低值（甚至 1），因为较小的批大小会导致增加到服务器的往返行程。

可选 scan_batching 仅用于高级使用; 它在 Java 端（在 Thrift 服务器内部）转换为 Scan.setBatching（）。通过设置此值，行可以拆分为部分行，因此结果行可能不完整，并且 te scanner 返回的结果数可能不再对应于扫描匹配的行数。

如果 sorted_columns 为 True，则此扫描程序返回的行中的列将按排序顺序检索，并且数据将存储在 OrderedDict 实例中。

如果反向为 True，扫描仪将反向执行扫描。这意味着 row_start 必须在 row_stop 之后进行字典编纂。请注意，范围的开头是独占的，而结尾是排他性的，就像在正向扫描中一样。

**兼容性说明：**

*   筛选器参数仅在使用 HBase 0.92（或更高版本）时可用。在 HBase 0.90 兼容模式中，指定筛选器会引发异常。
*   sorted_columns 参数仅在使用 HBase 0.96（或更高版本）时可用。
*   反向参数仅在使用 HBase 0.98（或更高版本）时可用。

1.1.0 版中的新功能：反向参数

0.8 版中的新功能：sorted_columns 参数

0.8 版中的新功能：scan_batching 参数

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1865344" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2559440" _msttexthash="126944051"><strong _istranslated="1">row_start</strong> （<em _istranslated="1">str</em>） – 起始行键（含）</li><li _msthash="2559570" _msttexthash="155752051"><strong _istranslated="1">row_stop</strong> （<em _istranslated="1">str</em>） – 要停止的行键（独占）</li><li _msthash="2559700" _msttexthash="157883388"><strong _istranslated="1">row_prefix</strong> （<em _istranslated="1">str</em>） – 行键的前缀，必须匹配</li><li _msthash="2559830" _msttexthash="125396167"><strong _istranslated="1">列</strong>（<em _istranslated="1">list_or_tuple</em>） – 列列表（可选）</li><li _msthash="2559960" _msttexthash="127278060"><strong _istranslated="1">过滤器</strong>（<em _istranslated="1">str</em>） – 过滤器字符串（可选）</li><li _msthash="2560090" _msttexthash="101579088"><strong _istranslated="1">时间戳</strong>（<em _istranslated="1">int</em>） – 时间戳 （可选）</li><li _msthash="2560220" _msttexthash="155093783"><strong _istranslated="1">include_timestamp</strong> （<em _istranslated="1">布尔</em>值 ） – 是否返回时间戳</li><li _msthash="2560350" _msttexthash="130947778"><strong _istranslated="1">batch_size</strong> （<em _istranslated="1">int</em>） – 用于检索结果的批大小</li><li _msthash="2560480" _msttexthash="226680272"><strong _istranslated="1">scan_batching</strong> （<em _istranslated="1">布尔</em>） – 服务器端扫描批处理（可选）</li><li _msthash="2630381" _msttexthash="81841032"><strong _istranslated="1">限制</strong>（<em _istranslated="1">int</em>） – 要返回的最大行数</li><li _msthash="2630524" _msttexthash="155654577"><strong _istranslated="1">sorted_columns</strong> （<em _istranslated="1">布尔</em>值） – 是否返回已排序的列</li><li _msthash="2630667" _msttexthash="82899778"><strong _istranslated="1">反向</strong>（<em _istranslated="1">布尔</em>值 ） – 是否反向执行扫描</li></ul></td></tr><tr><th _msthash="1865539" _msttexthash="13304174">返回：</th><td><p _msthash="2127905" _msttexthash="54201719">生成器生成与扫描匹配的行</p></td></tr><tr><th _msthash="1865734" _msttexthash="21643999">返回类型：</th><td><p _msthash="2128152" _msttexthash="75025873">可迭代<cite _istranslated="1">（row_key， row_data）</cite>元组</p></td></tr></tbody></table>

`put`(_行_，_数据_，_时间戳 = 无_， _wal=True_)[¶](#happybase.Table.put "Permalink to this definition")

在表中存储数据。

此方法将数据存储在 row 指定的行的数据参数中。数据参数是将列映射到值的字典。列名必须包含族和限定符部分，例如 ，尽管限定符部分可能是空字符串，例如 。`b'cf:col'``b'cf:'`

请注意，在许多情况下[`，batch（）`](#happybase.Table.batch "happybase.Table.batch")是操作数据的更合适的方法。

0.7 版中的新功能：wal 参数

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1816490" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2504216" _msttexthash="35380098"><strong _istranslated="1">行</strong>（<em _istranslated="1">str</em>） – 行键</li><li _msthash="2504346" _msttexthash="67552056"><strong _istranslated="1">data</strong> （<em _istranslated="1">dict</em>） – 要存储的数据</li><li _msthash="2504476" _msttexthash="101579088"><strong _istranslated="1">时间戳</strong>（<em _istranslated="1">int</em>） – 时间戳 （可选）</li><li _msthash="2504606" _msttexthash="101808200"><strong _istranslated="1">布尔</strong>（<em _istranslated="1">wal</em>） – 是否写入 WAL （可选）</li></ul></td></tr></tbody></table>

`delete`(_行_，_列 = 无_，_时间戳 = 无__，wal=True_)[¶](#happybase.Table.delete "Permalink to this definition")

从表中删除数据。

此方法删除由 row 指定的行的所有列，如果指定了 columns 参数，则仅删除部分列。

请注意，在许多情况下[`，batch（）`](#happybase.Table.batch "happybase.Table.batch")是操作数据的更合适的方法。

0.7 版中的新功能：wal 参数

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1817023" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2504879" _msttexthash="35380098"><strong _istranslated="1">行</strong>（<em _istranslated="1">str</em>） – 行键</li><li _msthash="2505009" _msttexthash="125396167"><strong _istranslated="1">列</strong>（<em _istranslated="1">list_or_tuple</em>） – 列列表（可选）</li><li _msthash="2505139" _msttexthash="101579088"><strong _istranslated="1">时间戳</strong>（<em _istranslated="1">int</em>） – 时间戳 （可选）</li><li _msthash="2505269" _msttexthash="101808200"><strong _istranslated="1">布尔</strong>（<em _istranslated="1">wal</em>） – 是否写入 WAL （可选）</li></ul></td></tr></tbody></table>

`batch`(_时间戳 = 无_ _，batch_size = 无_，_事务 = 假__，wal = 真_)[¶](#happybase.Table.batch "Permalink to this definition")

为此表创建新的批处理操作。

此方法返回可用于批量数据操作的新 [`Batch`](#happybase.Batch "happybase.Batch")实例。时间戳参数适用于批处理上的所有放置和删除。

如果给定，则 batch_size 参数指定最大批大小，在此之后，批处理应将突变发送到服务器。默认情况下，这是无界的。

事务参数指定返回的 [`Batch`](#happybase.Batch "happybase.Batch")实例在用作代码块中的上下文管理器时是否应以类似事务的方式运行。事务标志不能与 batch_size 结合使用。`with`

wal 参数确定是否应将突变写入 HBase 预写日志 （WAL）。此标志只能用于最近的 HBase 版本。如果指定，它将为此批处理上的所有放置和删除操作提供默认值。对于单个操作，可以使用 [`Batch.put（） 和 Batch.delete（） 的`](#happybase.Batch.put "happybase.Batch.put") [](#happybase.Batch.delete "happybase.Batch.delete")wal 参数覆盖此默认值。

0.7 版中的新功能：wal 参数

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1858012" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2551328" _msttexthash="488311005"><strong _istranslated="1">transaction</strong> （<em _istranslated="1">bool</em>） – 此批处理的行为是否应像事务一样（仅在用作上下文管理器时才有用）</li><li _msthash="2551458" _msttexthash="124803822"><strong _istranslated="1">batch_size</strong> （<em _istranslated="1">int</em>） – 批大小（可选）</li><li _msthash="2551588" _msttexthash="101579088"><strong _istranslated="1">时间戳</strong>（<em _istranslated="1">int</em>） – 时间戳 （可选）</li><li _msthash="2551718" _msttexthash="101808200"><strong _istranslated="1">布尔</strong>（<em _istranslated="1">wal</em>） – 是否写入 WAL （可选）</li></ul></td></tr><tr><th _msthash="1858207" _msttexthash="13304174">返回：</th><td><p _msthash="2120261" _msttexthash="14100034">批处理实例</p></td></tr><tr><th _msthash="1858402" _msttexthash="21643999">返回类型：</th><td><p><a href="#happybase.Batch" title="happybase.Batch"><code><span _msthash="2120508" _msttexthash="2294019">批</span></code></a></p></td></tr></tbody></table>

`counter_get`(_行_，_列_)[¶](#happybase.Table.counter_get "Permalink to this definition")

检索计数器列的当前值。

此方法检索计数器列的当前值。如果计数器列不存在，此函数将其初始化为 0。

请注意，应用程序代码_永远_不应直接存储递增或递减的计数器值; 为此，请使用原子 [`Table.counter_inc（）`](#happybase.Table.counter_inc "happybase.Table.counter_inc")和 [`Table.counter_dec（）`](#happybase.Table.counter_dec "happybase.Table.counter_dec")方法。

`counter_set`(_行_，_列_，_值 = 0_)[¶](#happybase.Table.counter_set "Permalink to this definition")

将计数器列设置为特定值。

此方法在指定的列中存储 64 位有符号整数值。

请注意，应用程序代码_永远_不应直接存储递增或递减的计数器值; 为此，请使用原子 [`Table.counter_inc（）`](#happybase.Table.counter_inc "happybase.Table.counter_inc")和 [`Table.counter_dec（）`](#happybase.Table.counter_dec "happybase.Table.counter_dec")方法。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1857895" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2551081" _msttexthash="35380098"><strong _istranslated="1">行</strong>（<em _istranslated="1">str</em>） – 行键</li><li _msthash="2551211" _msttexthash="34833370"><strong _istranslated="1">列</strong>（<em _istranslated="1">str</em>） – 列名称</li><li _msthash="2551341" _msttexthash="73285082"><strong _istranslated="1">值</strong>（<em _istranslated="1">int</em>） – 要设置的计数器值</li></ul></td></tr></tbody></table>

`counter_inc`(_行_，_列_，_值 = 1_)[¶](#happybase.Table.counter_inc "Permalink to this definition")

以原子方式递增（或递减）计数器列。

此方法以原子方式递增或递减由 row 指定的行中的计数器列。value 参数指定计数器应递增（对于正值）或递减（对于负值）的量。如果计数器列不存在，则在递增之前，它将自动初始化为 0。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1858038" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2551224" _msttexthash="35380098"><strong _istranslated="1">行</strong>（<em _istranslated="1">str</em>） – 行键</li><li _msthash="2551354" _msttexthash="34833370"><strong _istranslated="1">列</strong>（<em _istranslated="1">str</em>） – 列名称</li><li _msthash="2551484" _msttexthash="122248867"><strong _istranslated="1">值</strong>（<em _istranslated="1">int</em>） – 递增或递减的量（可选）</li></ul></td></tr><tr><th _msthash="1858233" _msttexthash="13304174">返回：</th><td><p _msthash="2120235" _msttexthash="28816515">递增后的计数器值</p></td></tr><tr><th _msthash="1858428" _msttexthash="21643999">返回类型：</th><td><p _msthash="2120482" _msttexthash="34567">int</p></td></tr></tbody></table>

`counter_dec`(_行_，_列_，_值 = 1_)[¶](#happybase.Table.counter_dec "Permalink to this definition")

以原子方式递减（或递增）计数器列。

此方法是调用值为否定[`的 Table.counter_inc（）`](#happybase.Table.counter_inc "happybase.Table.counter_inc")的快捷方式。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1858584" _msttexthash="13304174">返回：</th><td _msthash="1858168" _msttexthash="28635243">递减后的计数器值</td></tr><tr><th _msthash="1858779" _msttexthash="21643999">返回类型：</th><td _msthash="1858363" _msttexthash="34567">int</td></tr></tbody></table>

批 [¶](#batch "Permalink to this headline")
------------------------------------------

_类_`happybase.``Batch`(_表_，_时间戳 = 无__，batch_size = 无_，_事务 = 假__，wal = 真_)[¶](#happybase.Batch "Permalink to this definition")

批量突变类。

此类不能直接实例化; 请改用 [`Table.batch（）。`](#happybase.Table.batch "happybase.Table.batch")

`send`()[¶](#happybase.Batch.send "Permalink to this definition")

将批发送到服务器。

`put`(_行_，_数据_， _wal = 无_)[¶](#happybase.Batch.put "Permalink to this definition")

在表中存储数据。

参见 [`Table.put（）`](#happybase.Table.put "happybase.Table.put")来了解行、数据和 wal 参数的描述。通常不应使用 wal 参数; 它的唯一用途是覆盖传递给 [`Table.batch（） 的`](#happybase.Table.batch "happybase.Table.batch")批处理范围的值。

`delete`(_行_，_列 = 无_， _wal = 无_)[¶](#happybase.Batch.delete "Permalink to this definition")

从表中删除数据。

参见 [`Table.put（）`](#happybase.Table.put "happybase.Table.put")来了解行、数据和 wal 参数的描述。通常不应使用 wal 参数; 它的唯一用途是覆盖传递给 [`Table.batch（） 的`](#happybase.Table.batch "happybase.Table.batch")批处理范围的值。

连接池 [¶](#connection-pool "Permalink to this headline")
------------------------------------------------------

_类_`happybase.``ConnectionPool`(_大小_， _** 夸格斯_)[¶](#happybase.ConnectionPool "Permalink to this definition")

线程安全连接池。

版本 0.5 中的新功能。

size 参数指定此池管理的连接数。其他关键字参数未经修改地传递到 [`happybase。连接`](#happybase.Connection "happybase.Connection")构造函数（自动连接参数除外），因为维护连接是池的任务。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="1968525" _msttexthash="12292696">参数：</th><td><ul><li _msthash="2687971" _msttexthash="97992609"><strong _istranslated="1">size</strong> （<em _istranslated="1">int</em>） – 并发打开的最大连接数</li><li _msthash="2688101" _msttexthash="110668155"><strong _istranslated="1">kwargs</strong> – 传递给 <a href="#happybase.Connection" title="happybase.Connection" _istranslated="1"><code _istranslated="1">happybase 的关键字参数<span _istranslated="1">。连接</span></code></a></li></ul></td></tr></tbody></table>

`connection`(_超时 = 无_)[¶](#happybase.ConnectionPool.connection "Permalink to this definition")

从池中获取连接。

此方法_必须_用作上下文管理器，即 Python 的块。例：`with`

```
with pool.connection() as connection:
    pass  # do something with the connection
```

如果指定了超时，则这是在引发 [`NoConnections 可用`](#happybase.NoConnectionsAvailable "happybase.NoConnectionsAvailable")之前等待连接变为可用的秒数。如果省略，此方法将永久等待连接变为可用。

<table frame="void" rules="none"><colgroup><col> <col></colgroup><tbody valign="top"><tr><th _msthash="2657850" _msttexthash="12292696">参数：</th><td><strong _msthash="3407014" _msttexthash="6011447">超时</strong> (<font _mstmutation="1" _msthash="2657434" _msttexthash="81296254"><em _mstmutation="1" _istranslated="1">int</em>）– 等待的秒数（可选）</font></td></tr><tr><th _msthash="2658045" _msttexthash="13304174">返回：</th><td _msthash="2657629" _msttexthash="31224336">来自池的活动连接</td></tr><tr><th _msthash="2658240" _msttexthash="21643999">返回类型：</th><td><a href="#happybase.Connection" title="happybase.Connection"><code><span _msthash="2657824" _msttexthash="21670142">快乐基地。连接</span></code></a></td></tr></tbody></table>

_类_`happybase.``NoConnectionsAvailable`[¶](#happybase.NoConnectionsAvailable "Permalink to this definition")

在没有可用连接时引发异常。

如果在获取连接时指定了超时，并且在指定的超时内没有连接可用，则会发生这种情况。

版本 0.5 中的新功能。