Merge pull request #187 from aerospike/2.2.0-candidate

2.2.0 candidate

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "modules/aerospike-lua-core"]
+	path = modules/aerospike-lua-core
+	url = https://github.com/aerospike/aerospike-lua-core

.travis.yml

@@ -2,6 +2,7 @@ language: python
 python:
 - 2.7
 - 3.5
+- 3.6
 sudo: false
 os:
 - linux
@@ -32,7 +33,7 @@ install:
 - ../../scripts/wait-for-node.sh var/log/aerospike.log
 - cd ../..
 script:
-- python setup.py install --lua-system-path=./
+- python setup.py install
 - cd test
 - ./run -v
 notifications:

BUILD.md

@@ -2,7 +2,7 @@
 
 ## Dependencies
 
-The Python client for Aerospike works with Python 2.6, 2.7, 3.4, 3.5 running on
+The Python client for Aerospike works with Python 2.7, 3.4, 3.5, 3.6 running on
 **64-bit** OS X 10.9+ and Linux.
 
 The client depends on:
@@ -59,8 +59,10 @@ The dependencies can be installed through the OS X package manager [Homebrew](ht
 
 To build the library:
 
+    git submodule update --init
     python setup.py build --force
 
+
 The helper `scripts/aerospike-client-c.sh` is triggered by `setup.py` to
 download the appropriate C client. However, if one is present this will not
 happen, and a build may fail against an old client. At that point you should
@@ -134,13 +136,13 @@ error similar to: `error: could not create '/usr/local/aerospike/lua': Permissio
 ### Lua System Modules
 
 Stream UDF functionality requires a local copy of the system Lua modules.
-By default, those Lua files are copied to `/usr/local/aerospike/lua`.
-A different directory can be created, then set:
+By default, those Lua files are copied to an `aerospike` directory inside of Python's' installation path for system dependent packages. This directory can be viewed by running  `python -c "import sys; print(sys.prefix);" `
+To store the files in an additional location: specify the additional location with the `--lua-system-path` option to setup.py
 
     python setup.py install --lua-system-path=/path/to/lua
 
 
-**Note** If you do not use the default location, and you wish to perform Stream UDF operations it will be necessary to specify the locations of the system modules as a configuration parameter to the Aerospike client constructor:
+**Note** If the .lua files are stored somewhere besides `/usr/local/aerospike/lua`. and you wish to perform Stream UDF operations it will be necessary to specify the locations of the system modules as a configuration parameter to the Aerospike client constructor:
 
 	config = {'hosts': [('127.0.0.1', 3000)], 'lua': {'system_path': '/path/to/lua'} ...}
 	my_client = aerospike.client(config)

MANIFEST.in

@@ -3,4 +3,4 @@ include LICENSE
 include VERSION
 recursive-include scripts *
 recursive-include src *
-include aerospike-client-c/lua/*.lua
+include modules/aerospike-lua-core/src/*.lua

README.rst

@@ -11,7 +11,7 @@ Aerospike Python Client
 Dependencies
 ------------
 
-The Python client for Aerospike works with Python 2.6, 2.7, 3.4, 3.5 running on
+The Python client for Aerospike works with Python 2.7, 3.4, 3.5, 3.6 running on
 **64-bit** OS X 10.9+ and Linux.
 
 The client depends on:
@@ -80,14 +80,38 @@ Aerospike Python Client can be installed using ``pip``:
     # to trouleshoot installation on OS X El-Capitan (10.11) or OS X Sierra (10.12)
     pip install --no-cache-dir --user aerospike
 
-    # to have pip copy the Lua system files to a dir other than /usr/local/aerospike/lua
-    pip install aerospike --install-option="--lua-system-path=/opt/aerospike/lua"
-
 If you run into trouble installing the client on a supported OS, you may be
 using an outdated ``pip``.
 Versions of ``pip`` older than 7.0.0 should be upgraded, as well as versions of
 ``setuptools`` older than 18.0.0.
 
+Lua files
+~~~~~~~~~~
+
+The system .lua files used for client side aggregation will be installed.
+By default pip will install the .lua files in a subdirectory named `aerospike/lua/` inside of the Python
+installations directory for platform specific files. The location of the files can be found by running:
+
+``pip show -f aerospike``
+
+
+If you would like the aerospike directory files to be placed into a different location during installation, specify
+a ``--lua-system-path`` option when running setup.py:
+
+``python setup.py install --lua-system-path=/path/to/lua/install``
+
+or when running pip:
+
+``pip install aerospike --install-option="--lua-system-path=/path/to/lua/install``"
+
+**Note** Specifying an ``--install-option`` will prevent binary wheels from being used, and will require the extension to be compiled
+
+**Note** If the .lua files are stored somewhere besides `/usr/local/aerospike/lua`. and you wish to perform Stream UDF operations it will be necessary to specify the locations of the system modules as a configuration parameter to the Aerospike client constructor:
+
+    config = {'hosts': [('127.0.0.1', 3000)], 'lua': {'system_path': '/path/to/lua'} ...}
+    my_client = aerospike.client(config)
+
+
 OS X Installation
 ~~~~~~~~~~~~~~~~~~
 Upgrading ``pip`` on OS X El-Capitan (10.11) or OS X Sierra(10.12)

VERSION

@@ -1 +1 @@
-2.1.3
+2.2.0

aerospike-client-c.ini

@@ -0,0 +1,4 @@
+# Version number of the Aerospike C Client package
+AEROSPIKE_C_VERSION="4.1.8"
+
+

doc/aerospike.rst

@@ -80,10 +80,15 @@ in an in-memory primary index.
                 * **crl_check** :class:`bool` Enable CRL checking for the certificate chain leaf certificate. An error occurs if a suitable CRL cannot be found. By default CRL checking is disabled.
                 * **crl_check_all** :class:`bool` Enable CRL checking for the entire certificate chain. An error occurs if a suitable CRL cannot be found. By default CRL checking is disabled.
                 * **log_session_info** :class:`bool` Log session information for each connection.
-                * **max_socket_idle** :class:`int` Maximum socket idle in seconds for TLS connections. TLS Socket connection pools will discard sockets that have been idle longer than the maximum. The value is limited to 24 hours (86400). It's important to set this value to a few seconds less than the server's proto-fd-idle-ms (default 60000 milliseconds or 1 minute), so the client does not attempt to use a socket that has already been reaped by the server. Default: 55 seconds
             * **serialization** an optional instance-level :py:func:`tuple` of (serializer, deserializer). Takes precedence over a class serializer registered with :func:`~aerospike.set_serializer`.
             * **thread_pool_size** number of threads in the pool that is used in batch/scan/query commands (default: 16)
             * **max_threads** size of the synchronous connection pool for each server node (default: 300) *DEPRECATED*
+            * **max_socket_idle** Maximum socket idle time in seconds.  Connection pools will discard sockets that have
+			been idle longer than the maximum.  The value is limited to 24 hours (86400).
+	 		It's important to set this value to a few seconds less than the server's proto-fd-idle-ms
+			(default 60000 milliseconds or 1 minute), so the client does not attempt to use a socket
+			that has already been reaped by the server.
+			Default: 0 seconds (disabled) for non-TLS connections, 55 seconds for TLS connections.
             * **max_conns_per_node** maximum number of pipeline connections allowed for each node 
             * **batch_direct** whether to use the batch-direct protocol (default: ``False``, so will use batch-index if available)
             * **tend_interval** polling interval in milliseconds for tending the cluster (default: 1000)

doc/conf.py

@@ -29,7 +29,7 @@
 
 # General information about the project.
 project = u'aerospike'
-copyright = u'2014-2016, Aerospike'
+copyright = u'2014-2017, Aerospike'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

examples/admin/change_password.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/create_role.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/create_user.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/drop_role.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/drop_user.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/grant_privileges.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/grant_roles.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/query_role.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/query_roles.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/query_user.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/query_users.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/revoke_privileges.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/revoke_roles.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/admin/set_password.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ################################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/aggregate.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/append.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/apply.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/bin_ops.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/exists.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/exists_many.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/get.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/get_key_digest.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/get_many.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/get_nodes.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/increment.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/index_create.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/index_remove.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/info.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/info_node.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/is_connected.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

examples/client/kvs.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 ##########################################################################
-# Copyright 2013-2016 Aerospike, Inc.
+# Copyright 2013-2017 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.