> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.CreateTriggerByRangeRequest > kinetica.CreateTriggerByRangeRequest — Kinetica C# API

A set of parameters for Kinetica.createTriggerByRange. More...

Inheritance diagram for kinetica.CreateTriggerByRangeRequest:
Collaboration diagram for kinetica.CreateTriggerByRangeRequest:

Public Member Functions
  CreateTriggerByRangeRequest ()
  Constructs a CreateTriggerByRangeRequest object with default parameters.
 
  CreateTriggerByRangeRequest (string request\_id, IList\< string > table\_names, string column\_name, double min, double max, IDictionary\< string, string > options=null)
  Constructs a CreateTriggerByRangeRequest object with the specified parameters.
 
  CreateTriggerByRangeRequest ()
  Constructs a CreateTriggerByRangeRequest object with default parameters.
 
  CreateTriggerByRangeRequest (string request\_id, IList\< string > table\_names, string column\_name, double min, double max, IDictionary\< string, string > options=null)
  Constructs a CreateTriggerByRangeRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  request\_id \[get, set]
  User-created ID for the trigger.
 
IList\< string >  table\_names = new List\() \[get, set]
  Tables on which the trigger will be active, each in \[schema\_name.
 
string  column\_name \[get, set]
  Name of a numeric column\_name on which the trigger is activated.
 
double  min \[get, set]
  The lower bound (inclusive) for the trigger range.
 
double  max \[get, set]
  The upper bound (inclusive) for the trigger range.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

Additional Inherited Members
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.createTriggerByRange.

Sets up a simple range trigger for a column\_name for one or more tables. Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecords with the chosen column\_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via Kinetica.showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Definition at line 28 of file CreateTriggerByRange.cs.

Constructor & Destructor Documentation

◆ CreateTriggerByRangeRequest() \[1/4]

kinetica.CreateTriggerByRangeRequest.CreateTriggerByRangeRequest ( )
inline

Constructs a CreateTriggerByRangeRequest object with default parameters.

Definition at line 58 of file CreateTriggerByRange.cs.

◆ CreateTriggerByRangeRequest() \[2/4]

kinetica.CreateTriggerByRangeRequest.CreateTriggerByRangeRequest ( string request\_id,
IList\< string > table\_names,
string column\_name,
double min,
double max,
IDictionary\< string, string > options = null )
inline

Constructs a CreateTriggerByRangeRequest object with the specified parameters.

Parameters
request\_id User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
table\_names Tables on which the trigger will be active, each in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_name Name of a numeric column\_name on which the trigger is activated.
min The lower bound (inclusive) for the trigger range.
max The upper bound (inclusive) for the trigger range.
options Optional parameters. The default value is an empty Dictionary.

Definition at line 78 of file CreateTriggerByRange.cs.

◆ CreateTriggerByRangeRequest() \[3/4]

kinetica.CreateTriggerByRangeRequest.CreateTriggerByRangeRequest ( )
inline

Constructs a CreateTriggerByRangeRequest object with default parameters.

Definition at line 58 of file CreateTriggerByRange.cs.

◆ CreateTriggerByRangeRequest() \[4/4]

kinetica.CreateTriggerByRangeRequest.CreateTriggerByRangeRequest ( string request\_id,
IList\< string > table\_names,
string column\_name,
double min,
double max,
IDictionary\< string, string > options = null )
inline

Constructs a CreateTriggerByRangeRequest object with the specified parameters.

Parameters
request\_id User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
table\_names Tables on which the trigger will be active, each in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_name Name of a numeric column\_name on which the trigger is activated.
min The lower bound (inclusive) for the trigger range.
max The upper bound (inclusive) for the trigger range.
options Optional parameters. The default value is an empty Dictionary.

Definition at line 78 of file CreateTriggerByRange.cs.

Property Documentation

◆ column\_name

string kinetica.CreateTriggerByRangeRequest.column\_name
getset

Name of a numeric column\_name on which the trigger is activated.

Definition at line 43 of file CreateTriggerByRange.cs.

◆ max

double kinetica.CreateTriggerByRangeRequest.max
getset

The upper bound (inclusive) for the trigger range.

Definition at line 49 of file CreateTriggerByRange.cs.

◆ min

double kinetica.CreateTriggerByRangeRequest.min
getset

The lower bound (inclusive) for the trigger range.

Definition at line 46 of file CreateTriggerByRange.cs.

◆ options

IDictionary\< string, string > kinetica.CreateTriggerByRangeRequest.options = new Dictionary\()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 54 of file CreateTriggerByRange.cs.

◆ request\_id

string kinetica.CreateTriggerByRangeRequest.request\_id
getset

User-created ID for the trigger.

The ID can be alphanumeric, contain symbols, and must contain at least one character.

Definition at line 33 of file CreateTriggerByRange.cs.

◆ table\_names

IList\< string > kinetica.CreateTriggerByRangeRequest.table\_names = new List\()
getset

Tables on which the trigger will be active, each in \[schema\_name.

]table\_name format, using standard name resolution rules.

Definition at line 39 of file CreateTriggerByRange.cs.

The documentation for this class was generated from the following files: