Module `taos.subscription`

Expand source code

from taos.result import TaosResult
from .cinterface import *
from .error import *


class TaosSubscription(object):
    """TDengine subscription object"""

    def __init__(self, sub, with_callback = False):
        self._sub = sub
        self._with_callback = with_callback

    def consume(self):
        """Consume rows of a subscription"""
        if self._sub is None:
            raise OperationalError("Invalid use of consume")
        if self._with_callback:
            raise OperationalError("DONOT use consume method in an subscription with callback")
        result = taos_consume(self._sub)
        return TaosResult(result)

    def close(self, keepProgress=True):
        """Close the Subscription."""
        if self._sub is None:
            return False

        taos_unsubscribe(self._sub, keepProgress)
        self._sub = None
        return True

    def __del__(self):
        self.close()

Classes

class TaosSubscription (sub, with_callback=False)

TDengine subscription object

Expand source code

class TaosSubscription(object):
    """TDengine subscription object"""

    def __init__(self, sub, with_callback = False):
        self._sub = sub
        self._with_callback = with_callback

    def consume(self):
        """Consume rows of a subscription"""
        if self._sub is None:
            raise OperationalError("Invalid use of consume")
        if self._with_callback:
            raise OperationalError("DONOT use consume method in an subscription with callback")
        result = taos_consume(self._sub)
        return TaosResult(result)

    def close(self, keepProgress=True):
        """Close the Subscription."""
        if self._sub is None:
            return False

        taos_unsubscribe(self._sub, keepProgress)
        self._sub = None
        return True

    def __del__(self):
        self.close()

Methods

def close(self, keepProgress=True)

Close the Subscription.

Expand source code

def close(self, keepProgress=True):
    """Close the Subscription."""
    if self._sub is None:
        return False

    taos_unsubscribe(self._sub, keepProgress)
    self._sub = None
    return True

def consume(self)

Consume rows of a subscription

Expand source code

def consume(self):
    """Consume rows of a subscription"""
    if self._sub is None:
        raise OperationalError("Invalid use of consume")
    if self._with_callback:
        raise OperationalError("DONOT use consume method in an subscription with callback")
    result = taos_consume(self._sub)
    return TaosResult(result)