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

> gpudb::FilterByAreaGeometryRequest — 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#aa47be462dde2c9491093a82f7ace9315">GPUdb::filterByAreaGeometry</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source">gpudb/protocol/filter\_by\_area\_geometry.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:ab516abb36196769f2d8800d8d355a973" id="r_ab516abb36196769f2d8800d8d355a973">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ab516abb36196769f2d8800d8d355a973">FilterByAreaGeometryRequest</a> ()</td>
      </tr>

      <tr className="memdesc:ab516abb36196769f2d8800d8d355a973">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByAreaGeometryRequest" title="A set of parameters for GPUdb::filterByAreaGeometry.">FilterByAreaGeometryRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:adf56f30bda0f72d797f1efa8f2b7b289" id="r_adf56f30bda0f72d797f1efa8f2b7b289">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#adf56f30bda0f72d797f1efa8f2b7b289">FilterByAreaGeometryRequest</a> (const std::string \&tableName\_, const std::string \&viewName\_, const std::string \&columnName\_, const std::vector\< double > \&xVector\_, const std::vector\< double > \&yVector\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:adf56f30bda0f72d797f1efa8f2b7b289">
        <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:a99f2cb094053f6acaf04d909245eb3a5" id="r_a99f2cb094053f6acaf04d909245eb3a5">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a99f2cb094053f6acaf04d909245eb3a5">tableName</a></td>
      </tr>

      <tr className="memdesc:a99f2cb094053f6acaf04d909245eb3a5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the table to filter, 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:a99f2cb094053f6acaf04d909245eb3a5">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:ad88de38a16bc23672a2fceb47c02b20c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If provided, then this will be the name of the view containing the results, in \[ schema\_name. ]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. <br /></td>
      </tr>

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

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

      <tr className="memdesc:ac0d2133a2a6d97eb65da4616d3cf57fd">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the geospatial geometry column to be filtered. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a0b4dbe6ec82c2d8b885de0130c4dd596">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">List of x coordinates of the vertices of the polygon representing the area to be filtered. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a9c5cedb8363cdfcadf6eb6b513cd3899">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">List of y coordinates of the vertices of the polygon representing the area to be filtered. <br /></td>
      </tr>

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

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

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

      <tr className="separator:aa35f14dd64dac9ae7cfe0672bb7c39a3">
        <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#aa47be462dde2c9491093a82f7ace9315">GPUdb::filterByAreaGeometry</a>. </p>
      <p>Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name <a className="el" href="#ad88de38a16bc23672a2fceb47c02b20c">viewName</a> passed in as part of the input. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source#l00024">24</a> of file <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source">filter\_by\_area\_geometry.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ab516abb36196769f2d8800d8d355a973">◆ </a></span>FilterByAreaGeometryRequest() <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::FilterByAreaGeometryRequest::FilterByAreaGeometryRequest </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_1FilterByAreaGeometryRequest" title="A set of parameters for GPUdb::filterByAreaGeometry.">FilterByAreaGeometryRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source#l00030">30</a> of file <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source">filter\_by\_area\_geometry.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#adf56f30bda0f72d797f1efa8f2b7b289">◆ </a></span>FilterByAreaGeometryRequest() <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::FilterByAreaGeometryRequest::FilterByAreaGeometryRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tableName\_</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">viewName\_</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 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::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_1FilterByAreaGeometryRequest" title="A set of parameters for GPUdb::filterByAreaGeometry.">FilterByAreaGeometryRequest</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">tableName\_</td>
                <td>Name of the table to filter, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. This may be the name of a table or a view (when chaining queries). </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">viewName\_</td>
                <td>If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. Must not be an already existing table or view. The default value is ''. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">columnName\_</td>
                <td>Name of the geospatial geometry column to be filtered. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">xVector\_</td>
                <td>List of x coordinates of the vertices of the polygon representing the area to be filtered. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">yVector\_</td>
                <td>List of y coordinates of the vertices of the polygon representing the area to be filtered. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a67c71f0594bf18fd38f271fcaf0e1dc7">filter\_by\_area\_geometry\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a359d4dfbdf710597f995711e7fb137a6">true</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <span className="em arg">viewName\_</span>. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a className="el" href="/content/api/cpp/namespacegpudb#a2c04b9ff03256a37a96e70cc0a7bf5e0">qualified\_view\_name</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a359d4dfbdf710597f995711e7fb137a6">filter\_by\_area\_geometry\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5837c3f0b4bdc2aff34f43ce5df6a1cb">filter\_by\_area\_geometry\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a5837c3f0b4bdc2aff34f43ce5df6a1cb">filter\_by\_area\_geometry\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a934fd6d1c8e177fa13c71fef657b8381">filter\_by\_area\_geometry\_collection\_name</a>: \[DEPRECATED–please specify the containing schema for the view as part of <span className="em arg">viewName\_</span> and use <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a4aa5990ebebfab30b5961654f546cfd0">GPUdb::createSchema</a> to create the schema if non-existent] The schema for the newly created view. If the schema is non-existent, it will be automatically created. </li>
                  </ul>

                  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/filter__by__area__geometry_8h_source#l00111">111</a> of file <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source">filter\_by\_area\_geometry.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the geospatial geometry column to be filtered. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source#l00144">144</a> of file <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source">filter\_by\_area\_geometry.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Optional parameters. </p>

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a67c71f0594bf18fd38f271fcaf0e1dc7">filter\_by\_area\_geometry\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a359d4dfbdf710597f995711e7fb137a6">true</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a className="el" href="#ad88de38a16bc23672a2fceb47c02b20c">viewName</a>. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a className="el" href="/content/api/cpp/namespacegpudb#a2c04b9ff03256a37a96e70cc0a7bf5e0">qualified\_view\_name</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a359d4dfbdf710597f995711e7fb137a6">filter\_by\_area\_geometry\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5837c3f0b4bdc2aff34f43ce5df6a1cb">filter\_by\_area\_geometry\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a5837c3f0b4bdc2aff34f43ce5df6a1cb">filter\_by\_area\_geometry\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a934fd6d1c8e177fa13c71fef657b8381">filter\_by\_area\_geometry\_collection\_name</a>: \[DEPRECATED–please specify the containing schema for the view as part of <a className="el" href="#ad88de38a16bc23672a2fceb47c02b20c">viewName</a> and use <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a4aa5990ebebfab30b5961654f546cfd0">GPUdb::createSchema</a> to create the schema if non-existent] The schema for the newly created view. If the schema is non-existent, it will be automatically created. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source#l00191">191</a> of file <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source">filter\_by\_area\_geometry.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a99f2cb094053f6acaf04d909245eb3a5">◆ </a></span>tableName</h2>

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

      <div className="memdoc">
        <p>Name of the table to filter, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p>This may be the name of a table or a view (when chaining queries). </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source#l00128">128</a> of file <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source">filter\_by\_area\_geometry.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ad88de38a16bc23672a2fceb47c02b20c">◆ </a></span>viewName</h2>

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

      <div className="memdoc">
        <p>If provided, then this will be the name of the view containing the results, in \[ schema\_name. ]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. </p>
        <p>Must not be an already existing table or view. The default value is ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source#l00139">139</a> of file <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source">filter\_by\_area\_geometry.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>List of x coordinates of the vertices of the polygon representing the area to be filtered. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source#l00150">150</a> of file <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source">filter\_by\_area\_geometry.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>List of y coordinates of the vertices of the polygon representing the area to be filtered. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source#l00156">156</a> of file <a className="el" href="/content/api/cpp/filter__by__area__geometry_8h_source">filter\_by\_area\_geometry.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/filter__by__area__geometry_8h_source">filter\_by\_area\_geometry.h</a></li>
    </ul>
  </div>
</div>