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

> gpudb::FilterByTableRequest — 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#a5c433b2d7eecc3b3942dfa4b3a8a8439">GPUdb::filterByTable</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/filter__by__table_8h_source">gpudb/protocol/filter\_by\_table.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:ab0dca773d7d6940dbce07c091485a7a6" id="r_ab0dca773d7d6940dbce07c091485a7a6">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ab0dca773d7d6940dbce07c091485a7a6">FilterByTableRequest</a> ()</td>
      </tr>

      <tr className="memdesc:ab0dca773d7d6940dbce07c091485a7a6">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByTableRequest" title="A set of parameters for GPUdb::filterByTable.">FilterByTableRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a9be168b4cd6eff85d4f217fc61520e3a" id="r_a9be168b4cd6eff85d4f217fc61520e3a">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9be168b4cd6eff85d4f217fc61520e3a">FilterByTableRequest</a> (const std::string \&tableName\_, const std::string \&viewName\_, const std::string \&columnName\_, const std::string \&sourceTableName\_, const std::string \&sourceTableColumnName\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

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

      <tr className="memdesc:a1ad3709a70edda4860a008b15a1d4d8c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the table whose data will be filtered, in \[ schema\_name. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a777a10b176303c8048abf4659ac05416">
        <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:a777a10b176303c8048abf4659ac05416">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:ad2ed920a2ad549814c55fef6d56e8d3c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the column by whose value the data will be filtered from the table designated by <a className="el" href="#a1ad3709a70edda4860a008b15a1d4d8c">tableName</a>. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a4bf1f5b5ac28971ea45ab6e5014ca4c0">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the table whose data will be compared against in the table called <a className="el" href="#a1ad3709a70edda4860a008b15a1d4d8c">tableName</a>, 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:a4bf1f5b5ac28971ea45ab6e5014ca4c0">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:adf31b4af16736fee439c69a2b7683f00">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the column in the <a className="el" href="#a4bf1f5b5ac28971ea45ab6e5014ca4c0">sourceTableName</a> whose values will be used as the filter for table <a className="el" href="#a1ad3709a70edda4860a008b15a1d4d8c">tableName</a>. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a8278803c37c0aa73edc393f85bf5c3d1">
        <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#a5c433b2d7eecc3b3942dfa4b3a8a8439">GPUdb::filterByTable</a>. </p>
      <p>Filters objects in one table based on objects in another table. The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a <a className="el" href="#a777a10b176303c8048abf4659ac05416">viewName</a> is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__table_8h_source#l00026">26</a> of file <a className="el" href="/content/api/cpp/filter__by__table_8h_source">filter\_by\_table.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ab0dca773d7d6940dbce07c091485a7a6">◆ </a></span>FilterByTableRequest() <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::FilterByTableRequest::FilterByTableRequest </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_1FilterByTableRequest" title="A set of parameters for GPUdb::filterByTable.">FilterByTableRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__table_8h_source#l00031">31</a> of file <a className="el" href="/content/api/cpp/filter__by__table_8h_source">filter\_by\_table.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a9be168b4cd6eff85d4f217fc61520e3a">◆ </a></span>FilterByTableRequest() <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::FilterByTableRequest::FilterByTableRequest </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::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">sourceTableName\_</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">sourceTableColumnName\_</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_1FilterByTableRequest" title="A set of parameters for GPUdb::filterByTable.">FilterByTableRequest</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 whose data will be filtered, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table. </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 column by whose value the data will be filtered from the table designated by <span className="em arg">tableName\_</span>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">sourceTableName\_</td>
                <td>Name of the table whose data will be compared against in the table called <span className="em arg">tableName\_</span>, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">sourceTableColumnName\_</td>
                <td>Name of the column in the <span className="em arg">sourceTableName\_</span> whose values will be used as the filter for table <span className="em arg">tableName\_</span>. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the <span className="em arg">columnName\_</span>. </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#a3a8fb532ba3fe3c29cd192f503ab1087">filter\_by\_table\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5b373ba022dd21dd1624974a76acefb0">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#ae404b86fed68bc649b0fcff3021833eb">qualified\_view\_name</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5b373ba022dd21dd1624974a76acefb0">filter\_by\_table\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#adb191d9d88cb8b0d883734d1a9d04694">filter\_by\_table\_false</a> </li>
                      </ul>

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

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#af82aee30e270aaa9d2ce7bc808367624">filter\_by\_table\_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] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a690a30af1513b7aef7a7775841a7218c">filter\_by\_table\_filter\_mode</a>: String indicating the filter mode, either <a className="el" href="/content/api/cpp/namespacegpudb#a9637b8977703beafcd73031ec343cd91">in\_table</a> or <a className="el" href="/content/api/cpp/namespacegpudb#ad33ac55cc0461fddfe3361641f6389c6">not\_in\_table</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9637b8977703beafcd73031ec343cd91">filter\_by\_table\_in\_table</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad33ac55cc0461fddfe3361641f6389c6">filter\_by\_table\_not\_in\_table</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a9637b8977703beafcd73031ec343cd91">filter\_by\_table\_in\_table</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a6d7967e0e760808f519ed4409d0a48d6">filter\_by\_table\_mode</a>: Mode - should be either <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a308d741e5a8a1e9ac7a44f266e6373a8">normal</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a308d741e5a8a1e9ac7a44f266e6373a8">filter\_by\_table\_normal</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">filter\_by\_table\_spatial</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a308d741e5a8a1e9ac7a44f266e6373a8">filter\_by\_table\_normal</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad7ef57907ab11653841405892df0f973">filter\_by\_table\_buffer</a>: Buffer size, in meters. Only relevant for <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. The default value is '0'. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a6266c0eb68d3ad24e6e4377cab638498">filter\_by\_table\_buffer\_method</a>: Method used to buffer polygons. Only relevant for <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a308d741e5a8a1e9ac7a44f266e6373a8">filter\_by\_table\_normal</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab7ce4aba83f8d4a040076f51df67efde">filter\_by\_table\_geos</a>: Use geos 1 edge per corner algorithm. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a308d741e5a8a1e9ac7a44f266e6373a8">filter\_by\_table\_normal</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6013afea4dddb4146a429a9be0f97e49">filter\_by\_table\_max\_partition\_size</a>: Maximum number of points in a partition. Only relevant for <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. The default value is '0'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa968db7e3522bc707588a12333f0f058">filter\_by\_table\_max\_partition\_score</a>: Maximum number of points \* edges in a partition. Only relevant for <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. The default value is '8000000'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a89aa1556b2d39a31454ecf4a3d94e704">filter\_by\_table\_x\_column\_name</a>: Name of column containing x value of point being filtered in <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. The default value is 'x'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad4b29869b86aa82a7f25e972855b567a">filter\_by\_table\_y\_column\_name</a>: Name of column containing y value of point being filtered in <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. The default value is 'y'. </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__table_8h_source#l00217">217</a> of file <a className="el" href="/content/api/cpp/filter__by__table_8h_source">filter\_by\_table.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the column by whose value the data will be filtered from the table designated by <a className="el" href="#a1ad3709a70edda4860a008b15a1d4d8c">tableName</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__table_8h_source#l00250">250</a> of file <a className="el" href="/content/api/cpp/filter__by__table_8h_source">filter\_by\_table.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a3a8fb532ba3fe3c29cd192f503ab1087">filter\_by\_table\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5b373ba022dd21dd1624974a76acefb0">true</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a className="el" href="#a777a10b176303c8048abf4659ac05416">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#ae404b86fed68bc649b0fcff3021833eb">qualified\_view\_name</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5b373ba022dd21dd1624974a76acefb0">filter\_by\_table\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#adb191d9d88cb8b0d883734d1a9d04694">filter\_by\_table\_false</a> </li>
            </ul>

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

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#af82aee30e270aaa9d2ce7bc808367624">filter\_by\_table\_collection\_name</a>: \[DEPRECATED–please specify the containing schema for the view as part of <a className="el" href="#a777a10b176303c8048abf4659ac05416">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] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a690a30af1513b7aef7a7775841a7218c">filter\_by\_table\_filter\_mode</a>: String indicating the filter mode, either <a className="el" href="/content/api/cpp/namespacegpudb#a9637b8977703beafcd73031ec343cd91">in\_table</a> or <a className="el" href="/content/api/cpp/namespacegpudb#ad33ac55cc0461fddfe3361641f6389c6">not\_in\_table</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9637b8977703beafcd73031ec343cd91">filter\_by\_table\_in\_table</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad33ac55cc0461fddfe3361641f6389c6">filter\_by\_table\_not\_in\_table</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a9637b8977703beafcd73031ec343cd91">filter\_by\_table\_in\_table</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a6d7967e0e760808f519ed4409d0a48d6">filter\_by\_table\_mode</a>: Mode - should be either <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a308d741e5a8a1e9ac7a44f266e6373a8">normal</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a308d741e5a8a1e9ac7a44f266e6373a8">filter\_by\_table\_normal</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">filter\_by\_table\_spatial</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a308d741e5a8a1e9ac7a44f266e6373a8">filter\_by\_table\_normal</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad7ef57907ab11653841405892df0f973">filter\_by\_table\_buffer</a>: Buffer size, in meters. Only relevant for <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. The default value is '0'. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a6266c0eb68d3ad24e6e4377cab638498">filter\_by\_table\_buffer\_method</a>: Method used to buffer polygons. Only relevant for <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a308d741e5a8a1e9ac7a44f266e6373a8">filter\_by\_table\_normal</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab7ce4aba83f8d4a040076f51df67efde">filter\_by\_table\_geos</a>: Use geos 1 edge per corner algorithm. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a308d741e5a8a1e9ac7a44f266e6373a8">filter\_by\_table\_normal</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6013afea4dddb4146a429a9be0f97e49">filter\_by\_table\_max\_partition\_size</a>: Maximum number of points in a partition. Only relevant for <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. The default value is '0'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa968db7e3522bc707588a12333f0f058">filter\_by\_table\_max\_partition\_score</a>: Maximum number of points \* edges in a partition. Only relevant for <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. The default value is '8000000'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a89aa1556b2d39a31454ecf4a3d94e704">filter\_by\_table\_x\_column\_name</a>: Name of column containing x value of point being filtered in <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. The default value is 'x'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad4b29869b86aa82a7f25e972855b567a">filter\_by\_table\_y\_column\_name</a>: Name of column containing y value of point being filtered in <a className="el" href="/content/api/cpp/namespacegpudb#a52edb480eb110814e63f827430a8af20">spatial</a> mode. The default value is 'y'. </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__table_8h_source#l00363">363</a> of file <a className="el" href="/content/api/cpp/filter__by__table_8h_source">filter\_by\_table.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#adf31b4af16736fee439c69a2b7683f00">◆ </a></span>sourceTableColumnName</h2>

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

      <div className="memdoc">
        <p>Name of the column in the <a className="el" href="#a4bf1f5b5ac28971ea45ab6e5014ca4c0">sourceTableName</a> whose values will be used as the filter for table <a className="el" href="#a1ad3709a70edda4860a008b15a1d4d8c">tableName</a>. </p>
        <p>Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the <a className="el" href="#ad2ed920a2ad549814c55fef6d56e8d3c">columnName</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__table_8h_source#l00266">266</a> of file <a className="el" href="/content/api/cpp/filter__by__table_8h_source">filter\_by\_table.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4bf1f5b5ac28971ea45ab6e5014ca4c0">◆ </a></span>sourceTableName</h2>

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

      <div className="memdoc">
        <p>Name of the table whose data will be compared against in the table called <a className="el" href="#a1ad3709a70edda4860a008b15a1d4d8c">tableName</a>, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p>Must be an existing table. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__table_8h_source#l00258">258</a> of file <a className="el" href="/content/api/cpp/filter__by__table_8h_source">filter\_by\_table.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the table whose data will be filtered, in \[ schema\_name. </p>
        <p>\ ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__table_8h_source#l00233">233</a> of file <a className="el" href="/content/api/cpp/filter__by__table_8h_source">filter\_by\_table.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::FilterByTableRequest::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__table_8h_source#l00244">244</a> of file <a className="el" href="/content/api/cpp/filter__by__table_8h_source">filter\_by\_table.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__table_8h_source">filter\_by\_table.h</a></li>
    </ul>
  </div>
</div>