Documentation cleanup for release 1.0.37

Author: rbotzer

README.rst

@@ -45,13 +45,21 @@ The following are dependencies for:
     sudo apt-get install python-dev
     sudo apt-get install libssl-dev
 
-Mac OS X
+OS X
 ~~~~~~~~
 
-We recommend building Lua from source. To download the source code and
-build the library, follow the instruction provided in the *Lua* section
-of the `Aerospike C Client Installation
-Guide <http://aerospike.com/docs/client/c/install/macosx.html#lua>`__
+By default OS X will be missing command line tools. On Mavericks (OS X 10.9)
+and higher those `can be installed without Xcode <http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/>`__.
+
+::
+
+    xcode-select --install # install the command line tools, if missing
+
+The dependencies can be installed through the OS X package manager `Homebrew <http://brew.sh/>`__.
+
+::
+
+    brew install openssl
 
 Install
 -------

VERSION

@@ -1 +1 @@
-1.0.36
+1.0.37

doc/aggregate.md

@@ -1,7 +1,7 @@
 
 # aggregate
 
-aggregate - applies a stream UDF to a secondary index query.
+aggregate - applies a stream UDF to the results of a secondary index query.
 
 ## Description
 
@@ -70,12 +70,7 @@ We expect to see:
 5
 ```
 
-
-
 ### See Also
 
-
-
-- [Glossary](http://www.aerospike.com/docs/guide/glossary.html)
-
 - [Aerospike Data Model](http://www.aerospike.com/docs/architecture/data-model.html)
+- [Key-Value Store](http://www.aerospike.com/docs/guide/kvs.html)

doc/append.md

@@ -1,77 +1,53 @@
 
-# aerospike.Client.append
-
-aerospike.Client.append - Appends a string to the string value in a bin
+# aerospike.client.append
 
 ## Description
 
 ```
-status = aerospike.Client.append ( key, bin, value [, policies ] )
-
+aerospike.client.append(key, bin, val[, meta[, policy]])
 ```
 
-**aerospike.Client.append()** will append a string *value* to the string value
+**aerospike.client.append()** will append a string *value* to the string value
 in a *bin*.
 
 ## Parameters
 
-**key**, the key for the record. A tuple with keys
-['ns','set','key'] or ['ns','set','digest'].   
-
-```
-Tuple:
-    key = ( <namespace>, 
-            <set name>, 
-            <the primary index key>, 
-            <a RIPEMD-160 hash of the key, and always present> )
-
-```
+**key** the tuple (namespace, set, key) representing the key associated with the record
 
-**bin**, the name of the bin.
+**bin** the name of the bin.
 
-**value**, the string to append to the string value in the bin.
+**val**, the string to append to the string value in the bin.
 
-**policies**, the dictionary of policies to be given while append.   
+**meta** optional record metadata to be set. A dictionary with fields
+- **ttl** the [time-to-live](http://www.aerospike.com/docs/client/c/usage/kvs/write.html#change-record-time-to-live-ttl) in seconds
 
-## Return Values
-Returns an integer status. 0(Zero) is success value. In case of error, appropriate exceptions will be raised.
+**policy** optional write policies. A dictionary with optional fields
+- **timeout** write timeout in milliseconds
+- **key** one of the [aerospike.POLICY_KEY_*](http://www.aerospike.com/apidocs/c/db/d65/group__client__policies.html#gaa9c8a79b2ab9d3812876c3ec5d1d50ec) values
+- **gen** one of the [aerospike.POLICY_GEN_*](http://www.aerospike.com/apidocs/c/db/d65/group__client__policies.html#ga38c1a40903e463e5d0af0141e8c64061) values
+- **retry** one of the [aerospike.POLICY_RETRY_*](http://www.aerospike.com/apidocs/c/db/d65/group__client__policies.html#gaa9730980a8b0eda8ab936a48009a6718) values
+- **commit_level** one of the [aerospike.POLICY_COMMIT_LEVEL_*](http://www.aerospike.com/apidocs/c/db/d65/group__client__policies.html#ga17faf52aeb845998e14ba0f3745e8f23) values
+- **consistency_level** one of the [aerospike.POLICY_CONSISTENCY_LEVEL_*](http://www.aerospike.com/apidocs/c/db/d65/group__client__policies.html#ga34dbe8d01c941be845145af643f9b5ab) values
+- **replica** one of the [aerospike_POLICY_REPLICA_*](http://www.aerospike.com/apidocs/c/db/d65/group__client__policies.html#gabce1fb468ee9cbfe54b7ab834cec79ab) values
 
 ## Examples
 
 ```python
-
 # -*- coding: utf-8 -*-
 import aerospike
-config = {
-            'hosts': [('127.0.0.1', 3000)]
-         }
+config = { 'hosts': [('127.0.0.1', 3000)] }
 client = aerospike.client(config).connect()
 
-key = ('test', 'demo', 1)
-
-options = {
-    'timeout' : 5000
-}
-
-status = client.append( key, bin, value, options)
-
-print status
-
-
-```
-
-We expect to see:
-
-```python
-0
+try:
+  key = ('test', 'demo', 1)
+  client.append(key, 'name', ' jr.', policy={'timeout': 1200})
+except Exception as e:
+  print("error: {0}".format(e), file=sys.stderr)
+  sys.exit(1)
 ```
 
-
-
 ### See Also
 
-
-
-- [Glossary](http://www.aerospike.com/docs/guide/glossary.html)
-
 - [Aerospike Data Model](http://www.aerospike.com/docs/architecture/data-model.html)
+- [Key-Value Store](http://www.aerospike.com/docs/guide/kvs.html)
+

doc/close.md

@@ -1,41 +1,26 @@
 
-# aerospike.Client.close
+# aerospike.client.close
 
-aerospike.Client.close - closes already opened connection to the database.
 
 ## Description
 
 ```
-aerospike.Client.close()
-
+aerospike.client.close()
 ```
 
-**aerospike.Client.close()** will close already opened connection to the Aerospike database.
+**aerospike.client.close()** will close already opened connection to the Aerospike database.
 Returns *None* on successful connection close.
 
-
-## Return Values
-Returns *None*
-
 ## Examples
 
 ```python
 
 # -*- coding: utf-8 -*-
 import aerospike
-config = {
-            'hosts': [('127.0.0.1', 3000)]
-         }
-client = aerospike.client(config).close()
 
+config = { 'hosts': [('127.0.0.1', 3000)] }
+client = aerospike.client(config).close()
 client.close()
 
 ```
 
-### See Also
-
-
-
-- [Glossary](http://www.aerospike.com/docs/guide/glossary.html)
-
-- [Aerospike Data Model](http://www.aerospike.com/docs/architecture/data-model.html)

doc/connect.md

@@ -1,57 +1,51 @@
 
-# aerospike.Client.connect
-
-aerospike.Client.connect - establishes a connection to the Aerospike database instance.
+# aerospike.client.connect
 
 ## Description
 
 ```
-client = aerospike.Client(config).connect(<username>, <password>)
+client = aerospike.client(config).connect([username[, password]])
 
 ```
-**config**, is configuration parameter used while creating aerospike.Client's instance.
+**config** is a dictionary holding configuration info for the client
 ```
-Dict: 
-    {
-        'hosts': [
-                ('127.0.0.1', 3000)
-                ],
-        'policies': {
-                'timeout' : 0
-                }
-    }
-
+Dict:
+    'hosts': a list of (address, port) tuples identifying the cluster
+    'policies': a dictionary of policies
+        'timeout'          : default timeout in milliseconds
+        'key'              : default key policy for this client
+        'exists'           : default exists policy for this client
+        'gen'              : default generation policy for this client
+        'retry'            : default retry policy for this client
+        'consistency_level': default consistency level policy for this client
+        'replica'          : default replica policy for this client
+        'commit_level'     : default commit level policy for this client
 ```
 
-
-**aerospike.Client.connect()** will open a new connection to the Aerospike database and returns
-aerospike.Client's object.   
+**aerospike.client.connect()** will connect the client to the cluster described
+by the *hosts* configuration.
 
 ##Parameters
 
-**username** and **password** are self explanatory. They are used for establishing connection with security enabled Aerospike database instance.
-Skip them while connecting to security disabled Aerospike database instance.
-
-## Return Values
-Returns an instance of aeropspike.Client, which can be used later to do usual database operations.
+**username** and **password** are self explanatory. They are used for
+establishing connection to a security enabled Aerospike cluster
+(enterprise edition feature). Skip these when connecting to a community
+edition cluster.
 
 ## Examples
 
 ```python
-
 # -*- coding: utf-8 -*-
 import aerospike
+
 config = {
-            'hosts': [('127.0.0.1', 3000)]
-         }
+  'hosts':    [ ('127.0.0.1', 3000) ],
+  'policies': { 'timeout': 1000}}
 client = aerospike.client(config).connect()
 
 ```
 
 ### See Also
 
+- [Client Policies](http://www.aerospike.com/apidocs/c/db/d65/group__client__policies.html)
 
-
-- [Glossary](http://www.aerospike.com/docs/guide/glossary.html)
-
-- [Aerospike Data Model](http://www.aerospike.com/docs/architecture/data-model.html)