diff --git a/.github/workflows/test_runner.yml b/.github/workflows/test_runner.yml index 82495021a5..7390a9ad8d 100644 --- a/.github/workflows/test_runner.yml +++ b/.github/workflows/test_runner.yml @@ -80,4 +80,4 @@ jobs: - name: Generate documentation working-directory: docs run: | - make html SPHINXOPTS="-W --keep-going" + make html SPHINXOPTS="-W --keep-going -b linkcheck" diff --git a/README.rst b/README.rst index f6999ed9ac..b1865cfbb1 100644 --- a/README.rst +++ b/README.rst @@ -16,13 +16,13 @@ Hazelcast Python Client ---- -`Hazelcast `__ is an open-source distributed +`Hazelcast `__ is an open-source distributed in-memory data store and computation platform that provides a wide variety of distributed data structures and concurrency primitives. -Hazelcast Python client is a way to communicate to Hazelcast IMDG -clusters and access the cluster data. The client provides a -Future-based asynchronous API suitable for wide ranges of use cases. +Hazelcast Python client is a way to communicate to Hazelcast clusters +and access the cluster data. The client provides a Future-based +asynchronous API suitable for wide ranges of use cases. Installation ------------ @@ -30,15 +30,15 @@ Installation Hazelcast ~~~~~~~~~ -Hazelcast Python client requires a working Hazelcast IMDG cluster to -run. This cluster handles the storage and manipulation of the user data. +Hazelcast Python client requires a working Hazelcast cluster to run. +This cluster handles the storage and manipulation of the user data. -A Hazelcast IMDG cluster consists of one or more cluster members. These +A Hazelcast cluster consists of one or more cluster members. These members generally run on multiple virtual or physical machines and are connected to each other via the network. Any data put on the cluster is partitioned to multiple members transparent to the user. It is therefore very easy to scale the system by adding new members as the data grows. -Hazelcast IMDG cluster also offers resilience. Should any hardware or +Hazelcast cluster also offers resilience. Should any hardware or software problem causes a crash to any member, the data on that member is recovered from backups and the cluster continues to operate without any downtime. @@ -49,12 +49,12 @@ images `__. .. code:: bash - docker run -p 5701:5701 hazelcast/hazelcast:4.2 + docker run -p 5701:5701 hazelcast/hazelcast:5.0 You can also use our ZIP or TAR -`distributions `__. +`distributions `__. Once you have downloaded, you can start the Hazelcast member using -the ``bin/start.sh`` script. +the ``bin/hz-start`` script. Client ~~~~~~ @@ -100,8 +100,8 @@ Usage client.shutdown() -If you are using Hazelcast IMDG and the Python client on the same -machine, the default configuration should work out-of-the-box. However, +If you are using Hazelcast and the Python client on the same machine, +the default configuration should work out-of-the-box. However, you may need to configure the client to connect to cluster nodes that are running on different machines or to customize client properties. @@ -149,7 +149,7 @@ Features - Ability to listen to client lifecycle, cluster state, and distributed data structure events - and `many - more `__ + more `__ Getting Help ------------ @@ -177,7 +177,7 @@ Issue Reports For issue reports, please share the following information with us to quickly resolve the problems: -- Hazelcast IMDG and the client version that you use +- Hazelcast and the client version that you use - General information about the environment and the architecture you use like Python version, cluster size, number of clients, Java version, JVM parameters, operating system etc. @@ -195,7 +195,7 @@ Development ^^^^^^^^^^^ 1. Clone the `GitHub repository - `__. + `__. 2. Run ``python setup.py install`` to install the Python client. If you are planning to contribute: @@ -223,7 +223,7 @@ Following commands starts the tests: python run_tests.py Test script automatically downloads ``hazelcast-remote-controller`` and -Hazelcast IMDG. The script uses Maven to download those. +Hazelcast. The script uses Maven to download those. License ------- @@ -235,5 +235,5 @@ Copyright Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved. -Visit `www.hazelcast.com `__ for more +Visit `hazelcast.com `__ for more information. diff --git a/docs/copyright.rst b/docs/copyright.rst index 46568e2d06..ea57a08bc0 100644 --- a/docs/copyright.rst +++ b/docs/copyright.rst @@ -3,5 +3,5 @@ Copyright Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved. -Visit `www.hazelcast.com `__ for more +Visit `hazelcast.com `__ for more information. \ No newline at end of file diff --git a/docs/development_and_testing.rst b/docs/development_and_testing.rst index 009ce03f20..f630464eda 100644 --- a/docs/development_and_testing.rst +++ b/docs/development_and_testing.rst @@ -11,8 +11,8 @@ Building and Using Client From Sources Follow the below steps to build and install Hazelcast Python client from its source: -1. Clone the GitHub repository - (https://github.com/hazelcast/hazelcast-python-client.git). +1. Clone the `GitHub repository + `__. 2. Run ``python setup.py install`` to install the Python client. If you are planning to contribute: @@ -40,4 +40,4 @@ Following commands starts the tests: python run_tests.py Test script automatically downloads ``hazelcast-remote-controller`` and -Hazelcast IMDG. The script uses Maven to download those. +Hazelcast. The script uses Maven to download those. diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 1d4b5b9b96..0c3243f71c 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -12,61 +12,68 @@ Requirements - Windows, Linux/UNIX or Mac OS X - Python 2.7 or Python 3.4 or newer - Java 8 or newer -- Hazelcast IMDG 4.0 or newer +- Hazelcast 4.0 or newer - Latest Hazelcast Python client -Working with Hazelcast IMDG Clusters ------------------------------------- +Working with Hazelcast Clusters +------------------------------- -Hazelcast Python client requires a working Hazelcast IMDG cluster to +Hazelcast Python client requires a working Hazelcast cluster to run. This cluster handles storage and manipulation of the user data. -Clients are a way to connect to the Hazelcast IMDG cluster and access +Clients are a way to connect to the Hazelcast cluster and access such data. -Hazelcast IMDG cluster consists of one or more cluster members. These +Hazelcast cluster consists of one or more cluster members. These members generally run on multiple virtual or physical machines and are connected to each other via network. Any data put on the cluster is partitioned to multiple members transparent to the user. It is therefore very easy to scale the system by adding new members as the data grows. -Hazelcast IMDG cluster also offers resilience. Should any hardware or +Hazelcast cluster also offers resilience. Should any hardware or software problem causes a crash to any member, the data on that member is recovered from backups and the cluster continues to operate without any downtime. Hazelcast clients are an easy way to connect to a -Hazelcast IMDG cluster and perform tasks on distributed data structures +Hazelcast cluster and perform tasks on distributed data structures that live on the cluster. In order to use Hazelcast Python client, we first need to setup a -Hazelcast IMDG cluster. +Hazelcast cluster. -Setting Up a Hazelcast IMDG Cluster -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Setting Up a Hazelcast Cluster +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -There are following options to start a Hazelcast IMDG cluster easily: +There are following options to start a Hazelcast cluster easily: -- You can run standalone members by downloading and running JAR files - from the website. -- You can embed members to your Java projects. - You can use our `Docker images `__. -We are going to download JARs from the website and run a standalone -member for this guide. + .. code:: bash + + docker run -p 5701:5701 hazelcast/hazelcast:5.0 + +- You can use `Hazelcast CLI + `__. +- You can run standalone members by downloading and running distribution + files from the website. +- You can embed members to your Java projects. + +We are going to download distribution files from the website and run +a standalone member for this guide. Running Standalone JARs ^^^^^^^^^^^^^^^^^^^^^^^ -Follow the instructions below to create a Hazelcast IMDG cluster: +Follow the instructions below to create a Hazelcast cluster: -1. Go to Hazelcast’s download `page `__ - and download either the ``.zip`` or ``.tar`` distribution of - Hazelcast IMDG. +1. Go to Hazelcast’s download `page + `__ + and download either the ``.zip`` or ``.tar`` distribution of Hazelcast. 2. Decompress the contents into any directory that you want to run members from. 3. Change into the directory that you decompressed the Hazelcast content and then into the ``bin`` directory. -4. Use either ``start.sh`` or ``start.bat`` depending on your operating +4. Use either ``hz-start`` or ``hz-start.bat`` depending on your operating system. Once you run the start script, you should see the Hazelcast - IMDG logs in the terminal. + logs in the terminal. You should see a log similar to the following, which means that your 1-member cluster is ready to be used: @@ -126,8 +133,8 @@ If you want to add a ``Portable`` class, you should use ```` instead of ```` in the above configuration. -See the `Hazelcast IMDG Reference -Manual `__ +See the `Hazelcast Reference Manual +`__ for more information on setting up the clusters. Downloading and Installing @@ -151,13 +158,13 @@ command: Basic Configuration ------------------- -If you are using Hazelcast IMDG and Python client on the same computer, +If you are using Hazelcast and Python client on the same computer, generally the default configuration should be fine. This is great for trying out the client. However, if you run the client on a different computer than any of the cluster members, you may need to do some simple configurations such as specifying the member addresses. -The Hazelcast IMDG members and clients have their own configuration +The Hazelcast members and clients have their own configuration options. You may need to reflect some of the member side configurations on the client side to properly connect to the cluster. @@ -165,27 +172,27 @@ This section describes the most common configuration elements to get you started in no time. It discusses some member side configuration options to ease the understanding of Hazelcast’s ecosystem. Then, the client side configuration options regarding the cluster connection are -discussed. The configurations for the Hazelcast IMDG data structures +discussed. The configurations for the Hazelcast data structures that can be used in the Python client are discussed in the following sections. -See the `Hazelcast IMDG Reference -Manual `__ +See the `Hazelcast Reference Manual +`__ and :ref:`configuration_overview:configuration overview` section for more information. -Configuring Hazelcast IMDG -~~~~~~~~~~~~~~~~~~~~~~~~~~ +Configuring Hazelcast +~~~~~~~~~~~~~~~~~~~~~ -Hazelcast IMDG aims to run out-of-the-box for most common scenarios. +Hazelcast aims to run out-of-the-box for most common scenarios. However if you have limitations on your network such as multicast being -disabled, you may have to configure your Hazelcast IMDG members so that +disabled, you may have to configure your Hazelcast members so that they can find each other on the network. Also, since most of the distributed data structures are configurable, you may want to configure them according to your needs. We will show you the basics about network configuration here. -You can use the following options to configure Hazelcast IMDG: +You can use the following options to configure Hazelcast: - Using the ``hazelcast.xml`` configuration file. - Programmatically configuring the member before starting it from the @@ -297,7 +304,7 @@ default settings. client = hazelcast.HazelcastClient() -If you run the Hazelcast IMDG members on a different server than the +If you run the Hazelcast members on a different server than the client, you most probably have configured the members’ ports and cluster names as explained in the previous section. If you did, then you need to make match those changes to the network settings of your client. diff --git a/docs/index.rst b/docs/index.rst index 70a268ea6f..8a2352f8e9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,13 +16,13 @@ Hazelcast Python Client ---- -`Hazelcast `__ is an open-source distributed +`Hazelcast `__ is an open-source distributed in-memory data store and computation platform that provides a wide variety of distributed data structures and concurrency primitives. -Hazelcast Python client is a way to communicate to Hazelcast IMDG -clusters and access the cluster data. The client provides a -Future-based asynchronous API suitable for wide ranges of use cases. +Hazelcast Python client is a way to communicate to Hazelcast clusters +and access the cluster data. The client provides a Future-based +asynchronous API suitable for wide ranges of use cases. Overview @@ -62,8 +62,8 @@ Usage client.shutdown() -If you are using Hazelcast IMDG and the Python client on the same -machine, the default configuration should work out-of-the-box. However, +If you are using Hazelcast and the Python client on the same machine, +the default configuration should work out-of-the-box. However, you may need to configure the client to connect to cluster nodes that are running on different machines or to customize client properties. @@ -124,7 +124,7 @@ Features serialization setting_up_client_network client_connection_strategy - using_python_client_with_hazelcast_imdg + using_python_client_with_hazelcast securing_client_connection development_and_testing getting_help diff --git a/docs/securing_client_connection.rst b/docs/securing_client_connection.rst index 124abe78b6..bbf2825b6b 100644 --- a/docs/securing_client_connection.rst +++ b/docs/securing_client_connection.rst @@ -5,7 +5,7 @@ This chapter describes the security features of Hazelcast Python client. These include using TLS/SSL for connections between members and between clients and members, mutual authentication, username/password authentication, token authentication and Kerberos authentication. These security features -require **Hazelcast IMDG Enterprise** edition. +require **Hazelcast Enterprise** edition. TLS/SSL ------- @@ -32,8 +32,8 @@ TLS/SSL for Hazelcast Members Hazelcast allows you to encrypt socket level communication between Hazelcast members and between Hazelcast clients and members, for end to -end encryption. To use it, see the `TLS/SSL for Hazelcast Members -section `__. +end encryption. To use it, see the `TLS/SSL for Hazelcast Members section +`__. TLS/SSL for Hazelcast Python Clients ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -252,8 +252,8 @@ property on the server side in the ``hazelcast.xml`` file: You can see the details of setting mutual authentication on the server side in the `Mutual Authentication -section `__ -of the Hazelcast IMDG Reference Manual. +section `__ +of the Hazelcast Reference Manual. On the client side, you have to provide ``ssl_cafile``, ``ssl_certfile`` and ``ssl_keyfile`` on top of the other TLS/SSL configurations. See the @@ -289,7 +289,7 @@ Then, on the client-side, set ``creds_username`` and ``creds_password`` in the c ) Check out the documentation on `Password Credentials -`__ +`__ of the Hazelcast Documentation. Token-Based Authentication diff --git a/docs/setting_up_client_network.rst b/docs/setting_up_client_network.rst index 9b11e58710..430f9cfde3 100644 --- a/docs/setting_up_client_network.rst +++ b/docs/setting_up_client_network.rst @@ -48,7 +48,7 @@ Setting Smart Routing Smart routing defines whether the client mode is smart or unisocket. See the -:ref:`using_python_client_with_hazelcast_imdg:python client operation modes` +:ref:`using_python_client_with_hazelcast:python client operation modes` section for the description of smart and unisocket modes. .. code:: python @@ -134,7 +134,7 @@ External Smart Client Discovery .. warning:: - This feature requires Hazelcast IMDG 4.2 or higher version. + This feature requires Hazelcast 4.2 or higher version. The client sends requests directly to cluster members in the smart client mode (default) in order to reduce hops to accomplish operations. Because of that, diff --git a/docs/using_python_client_with_hazelcast_imdg.rst b/docs/using_python_client_with_hazelcast.rst similarity index 95% rename from docs/using_python_client_with_hazelcast_imdg.rst rename to docs/using_python_client_with_hazelcast.rst index e7908a91a6..2b55bc418c 100644 --- a/docs/using_python_client_with_hazelcast_imdg.rst +++ b/docs/using_python_client_with_hazelcast.rst @@ -1,7 +1,7 @@ -Using Python Client with Hazelcast IMDG -======================================= +Using Python Client with Hazelcast +================================== -This chapter provides information on how you can use Hazelcast IMDG’s +This chapter provides information on how you can use Hazelcast data structures in the Python client, after giving some basic information including an overview to the client API, operation modes of the client and how it handles the failures. @@ -163,8 +163,8 @@ Using Map Hazelcast Map is a distributed dictionary. Through the Python client, you can perform operations like reading and writing from/to a Hazelcast Map with the well known get and put methods. For details, see the `Map -section `__ -in the Hazelcast IMDG Reference Manual. +section `__ +in the Hazelcast Reference Manual. A Map usage example is shown below. @@ -186,8 +186,8 @@ Using MultiMap Hazelcast MultiMap is a distributed and specialized map where you can store multiple values under a single key. For details, see the `MultiMap -section `__ -in the Hazelcast IMDG Reference Manual. +section `__ +in the Hazelcast Reference Manual. A MultiMap usage example is shown below. @@ -216,8 +216,8 @@ Hazelcast Replicated Map is a distributed key-value data structure where the data is replicated to all members in the cluster. It provides full replication of entries to all members for high speed access. For details, see the `Replicated Map -section `__ -in the Hazelcast IMDG Reference Manual. +section `__ +in the Hazelcast Reference Manual. A Replicated Map usage example is shown below. @@ -243,8 +243,8 @@ Using Queue Hazelcast Queue is a distributed queue which enables all cluster members to interact with it. For details, see the `Queue -section `__ -in the Hazelcast IMDG Reference Manual. +section `__ +in the Hazelcast Reference Manual. A Queue usage example is shown below. @@ -273,8 +273,8 @@ Using Set Hazelcast Set is a distributed set which does not allow duplicate elements. For details, see the `Set -section `__ -in the Hazelcast IMDG Reference Manual. +section `__ +in the Hazelcast Reference Manual. A Set usage example is shown below. @@ -300,8 +300,8 @@ Using List Hazelcast List is a distributed list which allows duplicate elements and preserves the order of elements. For details, see the `List -section `__ -in the Hazelcast IMDG Reference Manual. +section `__ +in the Hazelcast Reference Manual. A List usage example is shown below. @@ -334,8 +334,8 @@ items are overwritten or expired. You can reach each element in a Ringbuffer using a sequence ID, which is mapped to the elements between the head and tail (inclusive) of the Ringbuffer. For details, see the `Ringbuffer -section `__ -in the Hazelcast IMDG Reference Manual. +section `__ +in the Hazelcast Reference Manual. A Ringbuffer usage example is shown below. @@ -359,10 +359,11 @@ A Ringbuffer usage example is shown below. Using ReliableTopic ~~~~~~~~~~~~~~~~~~~ -Hazelcast ReliableTopic is a distributed topic implementation backed up by the Ringbuffer -data structure. For details, see the -`Reliable Topic section `__ -in the Hazelcast IMDG Reference Manual. +Hazelcast ReliableTopic is a distributed topic implementation backed up by +the Ringbuffer data structure. For details, see the +`Reliable Topic section +`__ +in the Hazelcast Reference Manual. A Reliable Topic usage example is shown below. @@ -409,9 +410,9 @@ Using Topic ~~~~~~~~~~~ Hazelcast Topic is a distribution mechanism for publishing messages that -are delivered to multiple subscribers. For details, see the `Topic -section `__ -in the Hazelcast IMDG Reference Manual. +are delivered to multiple subscribers. For details, see the `Topic section +`__ +in the Hazelcast Reference Manual. A Topic usage example is shown below. @@ -443,9 +444,9 @@ You can create a ``Transaction`` object using the Python client to begin, commit and rollback a transaction. You can obtain transaction-aware instances of queues, maps, sets, lists and multimaps via the ``Transaction`` object, work with them and commit or rollback in -one shot. For details, see the `Transactions -section `__ -in the Hazelcast IMDG Reference Manual. +one shot. For details, see the `Transactions section +`__ +in the Hazelcast Reference Manual. .. code:: python @@ -519,10 +520,10 @@ Using PN Counter Hazelcast ``PNCounter`` (Positive-Negative Counter) is a CRDT positive-negative counter implementation. It is an eventually consistent -counter given there is no member failure. For details, see the `PN -Counter -section `__ -in the Hazelcast IMDG Reference Manual. +counter given there is no member failure. For details, see the +`PN Counter section +`__ +in the Hazelcast Reference Manual. A PN Counter usage example is shown below. @@ -550,9 +551,9 @@ Using Flake ID Generator Hazelcast ``FlakeIdGenerator`` is used to generate cluster-wide unique identifiers. Generated identifiers are long primitive values and are k-ordered (roughly ordered). IDs are in the range from ``0`` to ``2^63-1`` -(maximum signed long value). For details, see the `FlakeIdGenerator -section `__ -in the Hazelcast IMDG Reference Manual. +(maximum signed long value). For details, see the `FlakeIdGenerator section +`__ +in the Hazelcast Reference Manual. .. code:: python @@ -598,9 +599,9 @@ attributes: CP Subsystem ~~~~~~~~~~~~ -Hazelcast IMDG 4.0 introduces CP concurrency primitives with respect to -the `CAP -principle `__, +Hazelcast 4.0 introduces CP concurrency primitives with respect to +the `CAP principle +`__, i.e., they always maintain `linearizability `__ and prefer consistency to availability during network partitions and @@ -610,8 +611,8 @@ All data structures within CP Subsystem are available through ``client.cp_subsystem`` component of the client. Before using Atomic Long, Lock, and Semaphore, CP Subsystem has to be -enabled on cluster-side. Refer to `CP -Subsystem `__ +enabled on cluster-side. Refer to `CP Subsystem +`__ documentation for more information. Data structures in CP Subsystem run in CP groups. Each CP group elects @@ -658,8 +659,8 @@ AtomicLong implementation does not offer exactly-once / effectively-once execution semantics. It goes with at-least-once execution semantics by default and can cause an API call to be committed multiple times in case of CP member failures. It can be tuned to offer at-most-once execution -semantics. Please see -`fail-on-indeterminate-operation-state `__ +semantics. Please see `fail-on-indeterminate-operation-state +`__ server-side setting. Using Lock @@ -688,8 +689,8 @@ A basic Lock usage example is shown below. lock.unlock() FencedLock works on top of CP sessions. It keeps a CP session open while -the lock is acquired. Please refer to `CP -Session `__ +the lock is acquired. Please refer to `CP Session +`__ documentation for more information. By default, FencedLock is reentrant. Once a caller acquires the lock, it @@ -737,7 +738,7 @@ After that, once Client-1 comes back alive, its write request will be rejected by the external service, and only Client-2 will be able to safely talk to it. -.. figure:: https://docs.hazelcast.org/docs/latest/manual/html-single/images/FencedLock.png +.. figure:: https://docs.hazelcast.com/hazelcast/latest/_images/FencedLock.png :alt: CP Fenced Lock diagram CP Fenced Lock diagram @@ -823,8 +824,8 @@ Semaphore data structure has two variations: If a Hazelcast server or a client fails while holding some permits, they will not be automatically released. You can use the sessionless CP Semaphore implementation by enabling JDK compatibility - ``jdk-compatible`` server-side setting. Refer to `Semaphore - configuration `__ + ``jdk-compatible`` server-side setting. Refer to `Semaphore configuration + `__ documentation for more details. Using CountDownLatch @@ -926,8 +927,8 @@ AtomicReference does not offer exactly-once / effectively-once execution semantics. It goes with at-least-once execution semantics by default and can cause an API call to be committed multiple times in case of CP member failures. It can be tuned to offer at-most-once execution -semantics. Please see -`fail-on-indeterminate-operation-state `__ +semantics. Please see `fail-on-indeterminate-operation-state +`__ server-side setting. Distributed Events @@ -1168,7 +1169,7 @@ See the following example. Distributed Computing --------------------- -This chapter explains how you can use Hazelcast IMDG’s entry processor +This chapter explains how you can use Hazelcast entry processor implementation in the Python client. Using EntryProcessor @@ -1329,9 +1330,9 @@ shown below. The code that runs on the entries is implemented in Java on the server side. The client side entry processor is used to specify which entry processor should be called. For more details about the Java -implementation of the entry processor, see the `Entry Processor -section `__ -in the Hazelcast IMDG Reference Manual. +implementation of the entry processor, see the `Entry Processor section +`__ +in the Hazelcast Reference Manual. After the above implementations and configuration are done and you start the server where your library is added to its ``CLASSPATH``, you can use @@ -1403,7 +1404,7 @@ for reference. Query different datasets such as Kafka topics and Hazelcast maps, using a single query. Normally, querying in SQL is database or dataset-specific. However, with :ref:`mappings -`, you can pull information +`, you can pull information from different sources to present a more complete picture. See the `Get Started with SQL Over Files @@ -1892,7 +1893,7 @@ method sends the predicate to all cluster members and merges the results coming from them. .. Note:: Predicates can also be applied to ``key_set`` and - ``entry_set`` of the Hazelcast IMDG’s distributed map. + ``entry_set`` of a map. Querying with SQL ^^^^^^^^^^^^^^^^^ @@ -2451,9 +2452,9 @@ Near Cache Invalidation Invalidation is the process of removing an entry from the Near Cache when its value is updated or it is removed from the original map (to -prevent stale reads). See the `Near Cache Invalidation -section `__ -in the Hazelcast IMDG Reference Manual. +prevent stale reads). See the `Near Cache Invalidation section +`__ +in the Hazelcast Reference Manual. Monitoring and Logging ---------------------- @@ -2513,8 +2514,8 @@ client as follows: pip install -e .[stats] After enabling the client statistics, you can monitor your clients using -Hazelcast Management Center. Please refer to the `Monitoring Clients -section `__ +Hazelcast Management Center. Please refer to the `Monitoring Clients section +`__ in the Hazelcast Management Center Reference Manual for more information on the client statistics. @@ -2623,8 +2624,8 @@ connections. You can also group your clients using the client labels. These client groups can be blacklisted in Hazelcast Management Center so that they -can be prevented from connecting to a cluster. See the `related -section `__ +can be prevented from connecting to a cluster. See the `related section +`__ in the Hazelcast Management Center Reference Manual for more information on this topic. @@ -2664,7 +2665,7 @@ Configuring Load Balancer Load Balancer configuration allows you to specify which cluster member to send next operation when queried. -If it is a :ref:`using_python_client_with_hazelcast_imdg:smart client`, +If it is a :ref:`using_python_client_with_hazelcast:smart client`, only the operations that are not key-based are routed to the member that is returned by the ``LoadBalancer``. If it is not a smart client, ``LoadBalancer`` is ignored. diff --git a/examples/README.md b/examples/README.md index 2e30750c43..684c1cc6d7 100644 --- a/examples/README.md +++ b/examples/README.md @@ -14,9 +14,9 @@ How to try these examples * If not, you can use our official Docker images to start a member. ```bash - docker run -p 5701:5701 hazelcast/hazelcast:4.2 + docker run -p 5701:5701 hazelcast/hazelcast:5.0 ``` To see the other ways to start Hazelcast members, see - [Working with Hazelcast IMDG Clusters](https://hazelcast.readthedocs.io/en/stable/getting_started.html#working-with-hazelcast-imdg-clusters) + [Working with Hazelcast Clusters](https://hazelcast.readthedocs.io/en/stable/getting_started.html#working-with-hazelcast-clusters) section of our documentation. diff --git a/hazelcast/core.py b/hazelcast/core.py index ee29d8d68f..62e46e11b7 100644 --- a/hazelcast/core.py +++ b/hazelcast/core.py @@ -398,7 +398,6 @@ class HazelcastJsonValue(object): JSON strings. HazelcastJsonValue is queried using Hazelcast's querying language. - See `Distributed Query section `_. In terms of querying, numbers in JSON strings are treated as either Long or Double in the Java side. str, bool and None diff --git a/hazelcast/proxy/cp/fenced_lock.py b/hazelcast/proxy/cp/fenced_lock.py index e2889ca1fd..a1e33c714b 100644 --- a/hazelcast/proxy/cp/fenced_lock.py +++ b/hazelcast/proxy/cp/fenced_lock.py @@ -30,7 +30,7 @@ class FencedLock(SessionAwareCPProxy): available on at most one side of the partition. FencedLock works on top of CP sessions. Please refer to CP Session - IMDG documentation section for more information. + documentation section for more information. By default, FencedLock is reentrant. Once a caller acquires the lock, it can acquire the lock reentrantly as many times as it wants diff --git a/tests/unit/metrics/README.md b/tests/unit/metrics/README.md index edbef644b2..6115861295 100644 --- a/tests/unit/metrics/README.md +++ b/tests/unit/metrics/README.md @@ -1,5 +1,5 @@ The metrics binary compatibility file is autogenerated using the following -file from Hazelcast IMDG repository. +file from Hazelcast repository. https://github.com/hazelcast/hazelcast/blob/master/hazelcast/src/test/java/com/hazelcast/internal/metrics/impl/MetricsCompatibilityFileGenerator.java diff --git a/tests/unit/serialization/binary_compatibility/README.md b/tests/unit/serialization/binary_compatibility/README.md index 44d5e1faf8..96a8fcc6be 100644 --- a/tests/unit/serialization/binary_compatibility/README.md +++ b/tests/unit/serialization/binary_compatibility/README.md @@ -1,5 +1,5 @@ The serialization binary compatibility file is autogenerated using -the following file from the Hazelcast IMDG repository. +the following file from the Hazelcast repository. https://github.com/hazelcast/hazelcast/blob/master/hazelcast/src/test/java/com/hazelcast/nio/serialization/compatibility/BinaryCompatibilityFileGenerator.java