.. ultipa python sdk documentation master file, created by
   sphinx-quickstart on Mon Jul 24 09:43:06 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Introduction
============
This Python SDK is a part of Ultipa Drivers, a set of specifications for developing software and applications using Java, Python, Go and NodeJs. This SDK provides instructions on introducing query and management operations of Ultipa Graph Database into Python programs, both by calling command through interfaces and sending assembled UQLs to an Ultipa server. A basic understanding of UQL query commands and the returned data structures is needed to guarantee a proper usage of the SDK.

.. toctree::
   :maxdepth: 2

.. topic:: Requirements

   - Python version: >=3.6 <=3.10
   - Ultipa Server Version: >= 4.3.x

.. topic:: Installation

   Package is uploaded on `PyPI`_.

.. code:: python

   python3 -m pip install ultipa


.. topic:: Documentation

   Documentation is available online: `documentLink`_.

   .. _PyPI: https://pypi.org/project/ultipa/
   .. _documentLink: https://www.ultipa.com/document/ultipa-drivers/python-installation/v4.3


.. line-block:: Example

.. code:: python

   from ultipa import Connection, UltipaConfig
   ultipaConfig = UltipaConfig()
   ultipaConfig.hosts = ["192.168.1.85:60061", "192.168.1.86:60061", "192.168.1.87:60061"]
   ultipaConfig.username = "***"
   ultipaConfig.password = "***"
   ultipaConfig.defaultGraph = "amz"
   conn = Connection.NewConnection(defaultConfig=ultipaConfig)
   conn.test().Print()
   req = conn.uql("show().graph()")
   req.Print()


If you have any questions please contact: support@ultipa.com