.. toctree::

nosqlapi key-value
==================

In this package we find abstract classes and ODM classes concerning the **Key-Value** database types.

client module
-------------

The **client** module contains the specific classes for *key-value* databases and they are based on the `core <nosqlapi_common.html#core-module>`_ classes.

.. automodule:: nosqlapi.kvdb.client
    :members:
    :special-members:
    :show-inheritance:

client example
**************

This is an example of a library for connecting to a `redis <https://redis.io/>`_ server.

.. code-block:: python

    # mykvdb.py
    import nosqlapi

    # this module is my library of NOSQL key-value database, like Redis database

    class Connection(nosqlapi.kvdb.KVConnection):
        def __init__(host='localhost', port=6379, database=0, username=None, password=None, ssl=None, tls=None,
                     cert=None, ca_cert=None, ca_bundle=None): ...
        def close(self): ...
        def connect(self, *args, **kwargs): ...
        def create_database(self):
            raise nosqlapi.DatabaseCreationError('See your server configuration file.')
        def has_database(self, database): ...
        def databases(self): ...
        def delete_database(self): ...
        def show_database(self, database): ...


    class Session(nosqlapi.kvdb.KVSession):
        # define here all methods
        pass

    conn = Connection('myredis.local', password='pa$$w0rd')
    print(conn.databases())                 # (0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
    sess = conn.connect()                   # Session object
    ...

odm module
----------

The **odm** module contains the specific object for *key-value* databases.

.. automodule:: nosqlapi.kvdb.odm
    :members:
    :special-members:
    :show-inheritance:

odm example
***********

These objects represent the respective *key-value* in databases.

.. code-block:: python

    import nosqlapi

    transaction = nosqlapi.kvdb.odm.Transaction()       # in short -> nosqlapi.kvdb.Transaction()
    # Add commands
    transaction.add('ACL LIST')
    transaction.add('ACL DELUSER test')
    # Remove commands
    transaction.delete(1)

    item = nosqlapi.kvdb.Item('key', 'value')            # item key=value