This class is the main client side API class implementing most of the functionalities. Implementing table monitor functions means that this class creates the server side table monitors in Kinetica and also starts listening for different events on those monitors like inserts, deletes and updates. Once the notifications (inserted records, deletions and updates) are received this class will call the different callback methods passed in the constructor.

The intended use of this class is to derive from this and define the different callback methods and pass the callback methods wrapped in different callback objects of the types defined by the class Callback.Type. The callback objects thus created must be passed as a list to the constructor of this class.

A usage that will suffice for most cases has been given in the examples/table_monitor_example.py file. The user is requested to go through the example to get a thorough understanding of how to use this class.

The readme contains the relevant links to navigate directly to the examples provided.

Parameters

Encapsulates the various options used to create a table monitor. The class is initialized with sensible defaults which can be overridden by the users of the class. The following options are supported:

• inactivity_timeout

  This option controls the time interval to set the timeout to determine when the program would do idle time processing like checking for the table existence, server HA failover, etc., if needed. It is specified in minutes as a float so that seconds can be accommodated as well. The default value is set to 20 minutes, which is converted internally to seconds.

Example usage:

options = GPUdbTableMonitor.Options(_dict=dict(
    inactivity_timeout=0.1
))

Constructor for GPUdbTableMonitor.Options class

Parameters

Returns

Use this class to indicate which type of table monitor is desired.

When the Client is constructed, a list of objects of this class has to be supplied to the constructor of the class.

If the list of callbacks is empty or the list does not contain at least one of the callbacks of types (Callback.Type) INSERT_DECODED, INSERT_RAW, DELETED, or UPDATED, no table monitor would be created internally and the program would raise a gpudb.GPUdbException and exit. So, a list of objects of this class is mandatory for the table monitor to function.

An example of using this class and passing on to the constructor of Client is as follows:

class GPUdbTableMonitorExample(GPUdbTableMonitor.Client):

    def __init__(self, db, table_name, options=None):

        # Create the list of callbacks objects which are to be passed to the
        # GPUdbTableMonitor.Client class constructor

        # This example shows only two callbacks being created so
        # only an insert type table monitor will be created. For other
        # types callback objects could be created similarly to receive
        # notifications about other events.
        callbacks = [
            GPUdbTableMonitor.Callback(GPUdbTableMonitor.Callback.Type.INSERT_RAW,
                                      self.on_insert_raw,
                                      self.on_error),

            GPUdbTableMonitor.Callback(GPUdbTableMonitor.Callback.Type.INSERT_DECODED,
                                      self.on_insert_decoded,
                                      self.on_error,
                                      GPUdbTableMonitor.Callback.InsertDecodedOptions( GPUdbTableMonitor.Callback.InsertDecodedOptions.DecodeFailureMode.ABORT ))

        ]

        # Invoke the base class constructor and pass in the list of callback
        # objects created earlier.  This invocation is mandatory for the table
        # monitor to be actually functional.
        super(GPUdbTableMonitorExample, self).__init__(
            db, table_name,
            callbacks, options=options)

Constructor for this class.

Parameters