> ## 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::CreateTriggerByAreaRequest

> gpudb::CreateTriggerByAreaRequest — 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#a69d7d88cd6f9cdad1145d3ba6a4b575f">GPUdb::createTriggerByArea</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">gpudb/protocol/create\_trigger\_by\_area.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:aa255564405ee397fce018e559a504f3c" id="r_aa255564405ee397fce018e559a504f3c">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa255564405ee397fce018e559a504f3c">CreateTriggerByAreaRequest</a> ()</td>
      </tr>

      <tr className="memdesc:aa255564405ee397fce018e559a504f3c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaRequest" title="A set of parameters for GPUdb::createTriggerByArea.">CreateTriggerByAreaRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:af2b4efbc7260b0e241536876647dc13b" id="r_af2b4efbc7260b0e241536876647dc13b">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af2b4efbc7260b0e241536876647dc13b">CreateTriggerByAreaRequest</a> (const std::string \&requestId\_, const std::vector\< std::string > \&tableNames\_, const std::string \&xColumnName\_, const std::vector\< double > \&xVector\_, const std::string \&yColumnName\_, const std::vector\< double > \&yVector\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:af2b4efbc7260b0e241536876647dc13b">
        <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:af6e6bec74bb473a4fbc1ed5b8518b9d6" id="r_af6e6bec74bb473a4fbc1ed5b8518b9d6">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af6e6bec74bb473a4fbc1ed5b8518b9d6">requestId</a></td>
      </tr>

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

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

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

      <tr className="memdesc:aa2caffdee991f0b15752cdece492499e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Names of the tables on which the trigger will be activated and maintained, each in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. <br /></td>
      </tr>

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

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

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

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

      <tr className="memitem:afdc3f700027e4bca9d65212f1c21aa13" id="r_afdc3f700027e4bca9d65212f1c21aa13">
        <td className="memItemLeft" align="right" valign="top">std::vector\< double > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#afdc3f700027e4bca9d65212f1c21aa13">xVector</a></td>
      </tr>

      <tr className="memdesc:afdc3f700027e4bca9d65212f1c21aa13">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The respective coordinate values for the region on which the trigger is activated. <br /></td>
      </tr>

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

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

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

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

      <tr className="memitem:a4b52589e8d78c3e7bbb3231614ee8580" id="r_a4b52589e8d78c3e7bbb3231614ee8580">
        <td className="memItemLeft" align="right" valign="top">std::vector\< double > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4b52589e8d78c3e7bbb3231614ee8580">yVector</a></td>
      </tr>

      <tr className="memdesc:a4b52589e8d78c3e7bbb3231614ee8580">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The respective coordinate values for the region on which the trigger is activated. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a690706931d644b1912c6efa59f84ade5">
        <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#a69d7d88cd6f9cdad1145d3ba6a4b575f">GPUdb::createTriggerByArea</a>. </p>
      <p>Sets up an area trigger mechanism for two column\_names for one or more tables. (This function is essentially the two-dimensional version of <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aa77f37d9c9d2aa51450c6831584aa942">GPUdb::createTriggerByRange</a>.) 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 columns' values falling within the specified region 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__area_8h_source#l00035">35</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">create\_trigger\_by\_area.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#aa255564405ee397fce018e559a504f3c">◆ </a></span>CreateTriggerByAreaRequest() <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::CreateTriggerByAreaRequest::CreateTriggerByAreaRequest </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_1CreateTriggerByAreaRequest" title="A set of parameters for GPUdb::createTriggerByArea.">CreateTriggerByAreaRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source#l00041">41</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">create\_trigger\_by\_area.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af2b4efbc7260b0e241536876647dc13b">◆ </a></span>CreateTriggerByAreaRequest() <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::CreateTriggerByAreaRequest::CreateTriggerByAreaRequest </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">xColumnName\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::vector\< double > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">xVector\_</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">yColumnName\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::vector\< double > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">yVector\_</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_1CreateTriggerByAreaRequest" title="A set of parameters for GPUdb::createTriggerByArea.">CreateTriggerByAreaRequest</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>Names of the tables on which the trigger will be activated and maintained, 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">xColumnName\_</td>
                <td>Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">xVector\_</td>
                <td>The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">yColumnName\_</td>
                <td>Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">yVector\_</td>
                <td>The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals. </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__area_8h_source#l00082">82</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">create\_trigger\_by\_area.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::CreateTriggerByAreaRequest::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__area_8h_source#l00136">136</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">create\_trigger\_by\_area.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateTriggerByAreaRequest::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__area_8h_source#l00097">97</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">create\_trigger\_by\_area.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Names of the tables on which the trigger will be activated and maintained, each in \[ schema\_name. ]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__area_8h_source#l00105">105</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">create\_trigger\_by\_area.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a79510fe4367b3ccee6227009882d54b7">◆ </a></span>xColumnName</h2>

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

      <div className="memdoc">
        <p>Name of a numeric column on which the trigger is activated. </p>
        <p>Usually 'x' for geospatial data points. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source#l00111">111</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">create\_trigger\_by\_area.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#afdc3f700027e4bca9d65212f1c21aa13">◆ </a></span>xVector</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<double> gpudb::CreateTriggerByAreaRequest::xVector</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The respective coordinate values for the region on which the trigger is activated. </p>
        <p>This usually translates to the x-coordinates of a geospatial region. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source#l00118">118</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">create\_trigger\_by\_area.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a39c8326182c609eeaa7c1c4c84d82bc6">◆ </a></span>yColumnName</h2>

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

      <div className="memdoc">
        <p>Name of a second numeric column on which the trigger is activated. </p>
        <p>Usually 'y' for geospatial data points. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source#l00124">124</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">create\_trigger\_by\_area.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4b52589e8d78c3e7bbb3231614ee8580">◆ </a></span>yVector</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<double> gpudb::CreateTriggerByAreaRequest::yVector</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The respective coordinate values for the region on which the trigger is activated. </p>
        <p>This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source#l00131">131</a> of file <a className="el" href="/content/api/cpp/create__trigger__by__area_8h_source">create\_trigger\_by\_area.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__area_8h_source">create\_trigger\_by\_area.h</a></li>
    </ul>
  </div>
</div>