summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWouter Bolsterlee <uws@xs4all.nl>2012-05-30 22:05:27 +0200
committerWouter Bolsterlee <uws@xs4all.nl>2012-05-30 22:05:27 +0200
commit59e9239be04726f309ac8bb19e82413dddfe4457 (patch)
tree7fc72e74caaf5a00fa21fa450dae1b8c5b2e9443 /doc
parent8306e6415e97018114daac6085034158959abdda (diff)
downloadhappybase-59e9239be04726f309ac8bb19e82413dddfe4457.tar.gz
Mention the 'compat' parameter to Connection() in the tutorial
Diffstat (limited to 'doc')
-rw-r--r--doc/tutorial.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/tutorial.rst b/doc/tutorial.rst
index e5cf801..7970996 100644
--- a/doc/tutorial.rst
+++ b/doc/tutorial.rst
@@ -20,12 +20,18 @@ documentation <api>`.
Opening a connection
====================
-We'll get started by connecting to HBase::
+We'll get started by connecting to HBase. Just create a new
+:py:class:`Connection`::
import happybase
connection = happybase.Connection('somehost')
+If you're using HBase 0.90.x, you need to set the `compat` parameter to make
+sure HappyBase speaks the correct wire protocol to HBase::
+
+ connection = happybase.Connection('somehost', compat='0.90')
+
When a :py:class:`Connection` instance is created, it automatically opens a
socket connection to the HBase Thrift server. This behaviour can be disabled by
setting the `autoconnect` argument to `False`, and opening the connection