> ## 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.

# gpudb::CreateTriggerByRangeRequest

> gpudb::CreateTriggerByRangeRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aa77f37d9c9d2aa51450c6831584aa942">GPUdb::createTriggerByRange</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">gpudb/protocol/create\_trigger\_by\_range.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a0e45aeac921731d973fd86bf41c55e9b" id="r_a0e45aeac921731d973fd86bf41c55e9b">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a0e45aeac921731d973fd86bf41c55e9b">CreateTriggerByRangeRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a0e45aeac921731d973fd86bf41c55e9b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByRangeRequest" title="A set of parameters for GPUdb::createTriggerByRange.">CreateTriggerByRangeRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a0e45aeac921731d973fd86bf41c55e9b">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ae331109927e7022611030bd6d250602c" id="r_ae331109927e7022611030bd6d250602c">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae331109927e7022611030bd6d250602c">CreateTriggerByRangeRequest</a> (const std::string \&requestId\_, const std::vector\< std::string > \&tableNames\_, const std::string \&columnName\_, const double min\_, const double max\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:ae331109927e7022611030bd6d250602c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByRangeRequest" title="A set of parameters for GPUdb::createTriggerByRange.">CreateTriggerByRangeRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:ae331109927e7022611030bd6d250602c">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a44a540a2ab3c95a416f9bc7b538bad69" id="r_a44a540a2ab3c95a416f9bc7b538bad69">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a44a540a2ab3c95a416f9bc7b538bad69">requestId</a></td>
      </tr>

      <tr className="memdesc:a44a540a2ab3c95a416f9bc7b538bad69">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">User-created ID for the trigger. <br /></td>
      </tr>

      <tr className="separator:a44a540a2ab3c95a416f9bc7b538bad69">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a5fb549d967df06eabf8484034d179be6" id="r_a5fb549d967df06eabf8484034d179be6">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a5fb549d967df06eabf8484034d179be6">tableNames</a></td>
      </tr>

      <tr className="memdesc:a5fb549d967df06eabf8484034d179be6">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Tables on which the trigger will be active, each in \[ schema\_name. <br /></td>
      </tr>

      <tr className="separator:a5fb549d967df06eabf8484034d179be6">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a4e158fb5e1560ce727dd4ee027222283" id="r_a4e158fb5e1560ce727dd4ee027222283">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4e158fb5e1560ce727dd4ee027222283">columnName</a></td>
      </tr>

      <tr className="memdesc:a4e158fb5e1560ce727dd4ee027222283">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of a numeric column\_name on which the trigger is activated. <br /></td>
      </tr>

      <tr className="separator:a4e158fb5e1560ce727dd4ee027222283">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a20496ca41663d71c098a117c58faa4be" id="r_a20496ca41663d71c098a117c58faa4be">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a20496ca41663d71c098a117c58faa4be">min</a></td>
      </tr>

      <tr className="memdesc:a20496ca41663d71c098a117c58faa4be">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The lower bound (inclusive) for the trigger range. <br /></td>
      </tr>

      <tr className="separator:a20496ca41663d71c098a117c58faa4be">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ac3f4d0ca0b738a36b471aad93d0546e6" id="r_ac3f4d0ca0b738a36b471aad93d0546e6">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ac3f4d0ca0b738a36b471aad93d0546e6">max</a></td>
      </tr>

      <tr className="memdesc:ac3f4d0ca0b738a36b471aad93d0546e6">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The upper bound (inclusive) for the trigger range. <br /></td>
      </tr>

      <tr className="separator:ac3f4d0ca0b738a36b471aad93d0546e6">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:af4169b7ded03e344e452756ad9a37f7d" id="r_af4169b7ded03e344e452756ad9a37f7d">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af4169b7ded03e344e452756ad9a37f7d">options</a></td>
      </tr>

      <tr className="memdesc:af4169b7ded03e344e452756ad9a37f7d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:af4169b7ded03e344e452756ad9a37f7d">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aa77f37d9c9d2aa51450c6831584aa942">GPUdb::createTriggerByRange</a>. </p>
      <p>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 <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ab6ab327611452cc777c159d202146997">GPUdb::insertRecords</a> 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 <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#abe9a7d6ea3fe0b154d73b86955db53cb">GPUdb::showSystemStatus</a>) for any listening client to collect. Active triggers can be cancelled by using the <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a158a4cbcafb96ac8832f7caeeb07e4b3">GPUdb::clearTrigger</a> endpoint or by clearing all relevant tables.</p>
      <p>The output returns the trigger handle as well as indicating success or failure of the trigger activation. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source#l00033">33</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">create\_trigger\_by\_range.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a0e45aeac921731d973fd86bf41c55e9b">◆ </a></span>CreateTriggerByRangeRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CreateTriggerByRangeRequest::CreateTriggerByRangeRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByRangeRequest" title="A set of parameters for GPUdb::createTriggerByRange.">CreateTriggerByRangeRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source#l00039">39</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">create\_trigger\_by\_range.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ae331109927e7022611030bd6d250602c">◆ </a></span>CreateTriggerByRangeRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CreateTriggerByRangeRequest::CreateTriggerByRangeRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">requestId\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tableNames\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">columnName\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const double</td>
                  <td className="paramname"><span className="paramname"><span className="em">min\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const double</td>
                  <td className="paramname"><span className="paramname"><span className="em">max\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></span> )</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByRangeRequest" title="A set of parameters for GPUdb::createTriggerByRange.">CreateTriggerByRangeRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">requestId\_</td>
                <td>User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">tableNames\_</td>
                <td>Tables on which the trigger will be active, each in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">columnName\_</td>
                <td>Name of a numeric column\_name on which the trigger is activated. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">min\_</td>
                <td>The lower bound (inclusive) for the trigger range. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">max\_</td>
                <td>The upper bound (inclusive) for the trigger range. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>
                <td>Optional parameters. The default value is an empty map. </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source#l00068">68</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">create\_trigger\_by\_range.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a4e158fb5e1560ce727dd4ee027222283">◆ </a></span>columnName</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateTriggerByRangeRequest::columnName</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of a numeric column\_name on which the trigger is activated. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source#l00095">95</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">create\_trigger\_by\_range.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ac3f4d0ca0b738a36b471aad93d0546e6">◆ </a></span>max</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">double gpudb::CreateTriggerByRangeRequest::max</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The upper bound (inclusive) for the trigger range. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source#l00105">105</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">create\_trigger\_by\_range.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a20496ca41663d71c098a117c58faa4be">◆ </a></span>min</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">double gpudb::CreateTriggerByRangeRequest::min</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The lower bound (inclusive) for the trigger range. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source#l00100">100</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">create\_trigger\_by\_range.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af4169b7ded03e344e452756ad9a37f7d">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::CreateTriggerByRangeRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>
        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source#l00110">110</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">create\_trigger\_by\_range.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a44a540a2ab3c95a416f9bc7b538bad69">◆ </a></span>requestId</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateTriggerByRangeRequest::requestId</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>User-created ID for the trigger. </p>
        <p>The ID can be alphanumeric, contain symbols, and must contain at least one character. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source#l00082">82</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">create\_trigger\_by\_range.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a5fb549d967df06eabf8484034d179be6">◆ </a></span>tableNames</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> gpudb::CreateTriggerByRangeRequest::tableNames</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Tables on which the trigger will be active, each in \[ schema\_name. </p>
        <p>\ ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source#l00090">90</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">create\_trigger\_by\_range.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/create__trigger__by__range_8h_source">create\_trigger\_by\_range.h</a></li>
    </ul>
  </div>
</div>
