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

# createTriggerByArea

<div className="kinetica-doxygen">
  <div id="a69d7d88cd6f9cdad1145d3ba6a4b575f" />

  <h2 className="memtitle"><span className="permalink"><a href="#a69d7d88cd6f9cdad1145d3ba6a4b575f">◆ </a></span>createTriggerByArea() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">CreateTriggerByAreaResponse</a> gpudb::GPUdb::createTriggerByArea </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaRequest">CreateTriggerByAreaRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Sets up an area trigger mechanism for two column\_names for one or more tables. </p>
      <p>(This function is essentially the two-dimensional version of <a className="el" href="#aa77f37d9c9d2aa51450c6831584aa942">createTriggerByRange</a>.) Once the trigger has been activated, any record added to the listed tables(s) via <a className="el" href="#ab6ab327611452cc777c159d202146997">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="#abe9a7d6ea3fe0b154d73b86955db53cb">showSystemStatus</a>) for any listening client to collect. Active triggers can be cancelled by using the <a className="el" href="#a158a4cbcafb96ac8832f7caeeb07e4b3">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>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a357880c27d0836142fb17b2369720716" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">CreateTriggerByAreaResponse</a> & gpudb::GPUdb::createTriggerByArea </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaRequest">CreateTriggerByAreaRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">CreateTriggerByAreaResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Sets up an area trigger mechanism for two column\_names for one or more tables. </p>
      <p>(This function is essentially the two-dimensional version of <a className="el" href="#aa77f37d9c9d2aa51450c6831584aa942">createTriggerByRange</a>.) Once the trigger has been activated, any record added to the listed tables(s) via <a className="el" href="#ab6ab327611452cc777c159d202146997">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="#abe9a7d6ea3fe0b154d73b86955db53cb">showSystemStatus</a>) for any listening client to collect. Active triggers can be cancelled by using the <a className="el" href="#a158a4cbcafb96ac8832f7caeeb07e4b3">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>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a3d85ea830f5909e01b6888e53167bbc7" />

  <h2 className="memtitle"><span className="permalink"><a href="#a3d85ea830f5909e01b6888e53167bbc7">◆ </a></span>createTriggerByArea() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">CreateTriggerByAreaResponse</a> gpudb::GPUdb::createTriggerByArea </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> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Sets up an area trigger mechanism for two column\_names for one or more tables. </p>
      <p>(This function is essentially the two-dimensional version of <a className="el" href="#aa331f41ea50603fee702f9606cffebb4">createTriggerByRange</a>.) Once the trigger has been activated, any record added to the listed tables(s) via <a className="el" href="#a1cbbfefa7a3d6b4570f1be6734a8d849">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="#a2cc190f96524c44227af5731319ad4e1">showSystemStatus</a>) for any listening client to collect. Active triggers can be cancelled by using the <a className="el" href="#a582553240e7015f44ae86078ec533a85">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>

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

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a31add72aae86cd249dfdd622c161bb37" />

  <h2 className="memtitle"><span className="permalink"><a href="#a31add72aae86cd249dfdd622c161bb37">◆ </a></span>createTriggerByArea() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">CreateTriggerByAreaResponse</a> & gpudb::GPUdb::createTriggerByArea </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>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">CreateTriggerByAreaResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Sets up an area trigger mechanism for two column\_names for one or more tables. </p>
      <p>(This function is essentially the two-dimensional version of <a className="el" href="#aa331f41ea50603fee702f9606cffebb4">createTriggerByRange</a>.) Once the trigger has been activated, any record added to the listed tables(s) via <a className="el" href="#a1cbbfefa7a3d6b4570f1be6734a8d849">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="#a2cc190f96524c44227af5731319ad4e1">showSystemStatus</a>) for any listening client to collect. Active triggers can be cancelled by using the <a className="el" href="#a582553240e7015f44ae86078ec533a85">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>

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

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateTriggerByAreaResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>