diff options
| author | Wouter Bolsterlee <uws@xs4all.nl> | 2012-07-11 22:44:38 +0200 |
|---|---|---|
| committer | Wouter Bolsterlee <uws@xs4all.nl> | 2012-07-11 22:45:19 +0200 |
| commit | fea12e70c2d24a5a4072712a5008dbde2ce5fe2f (patch) | |
| tree | c92c6fffc218318d727cf989d1dac2a3ec86cd01 /doc | |
| parent | 9528b67c79946954b8c181ebbafa2590987f3df4 (diff) | |
| download | happybase-fea12e70c2d24a5a4072712a5008dbde2ce5fe2f.tar.gz | |
Mention 'transport' arg to Connection() in tutorial
See issue #6.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/tutorial.rst | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/tutorial.rst b/doc/tutorial.rst index d90ef3c..439307e 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -27,10 +27,14 @@ We'll get started by connecting to HBase. Just create a new 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') +In some setups, the :py:class:`Connection` class needs some additional +information about the HBase version it will be connecting to, and which Thrift +transport to use. If you're still using HBase 0.90.x, you need to set the +`compat` parameter to make sure HappyBase speaks the correct wire protocol. +Additionally, if you're using HBase 0.94 with a non-standard Thrift transport +mode, make sure to supply the right `transport` parameter. See the API +documentation for the :py:class:`Connection` class for more information about +these parameters and their supported values. When a :py:class:`Connection` is created, it automatically opens a socket connection to the HBase Thrift server. This behaviour can be disabled by |