Python Thin Client

❗️
This is a legacy Apache Ignite documentation
The new documentation is hosted here: https://ignite.apache.org/docs/latest/

Overview

Python thin client allows your Python applications to work with Apache Ignite clusters via Binary Client Protocol. This thin client is abbreviated as pyignite.

A thin client is a lightweight Ignite client that connects to the cluster via a standard socket connection. It does not start in JVM process (Java is not required at all), does not become a part of the cluster topology, never holds any data or used as a destination of compute grid calculations.

What it does is it simply establishes a socket connection to a standard Ignite node and performs all operations through that node.

For more information, visit:

Initialization and Configuration to learn how to configure and obtain references of the thin client APIs currently supported.
Key-Value Operations to learn which JCache APIs are supported.
SQL Queries to learn how to use SQL with the Java thin client API.
Binary Types to learn how to use the Ignite Binary Objects API with the Python thin client API.
Security to see the thin client has enough protection to connect to an enterprise Ignite cluster over Internet.

Quick Start

Prerequisites

Python 3.4 or above.
Latest version of Apache Ignite.

Installation

You can install pyignite from PyPI:

$ pip install pyignite

🚧
Mac OS Installation
You might need to use pip3 install pyignite command to complete the installation on Mac OS

Running an Example

After installing pyignite, let's run an example using existing Python examples that are delivered with every Ignite distribution for the sake of quick getting started.

Run Apache Ignite server.
To start a cluster node with the default configuration, open the terminal and, assuming you are in IGNITE_HOME (Ignite installation folder), just type this:

$ bin/ignite.sh

$ bin\ignite.bat

In another command shell tab or window, go to IGNITE_HOME/platforms/python/examples and run an example by calling python <example_file_name>.py, like so:

$ cd IGNITE_HOME/platforms/python/examples
$ python get_and_put.py

📘
Python example files
Python thin client contains fully workable examples to demonstrate the behavior of the client.