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

# filterByValue

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

  <h2 className="memtitle"><span className="permalink"><a href="#adf1643ba8a5fb03eaf47c8991c004a4c">◆ </a></span>filterByValue() <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_1FilterByValueResponse">FilterByValueResponse</a> gpudb::GPUdb::filterByValue </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByValueRequest">FilterByValueRequest</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>Calculates which objects from a table has a particular value for a particular column. </p>
      <p>The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.</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_1FilterByValueRequest">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_1FilterByValueResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a5e7b729ac26c2847bb2d3d59d332d9e3" />

  <h2 className="memtitle"><span className="permalink"><a href="#a5e7b729ac26c2847bb2d3d59d332d9e3">◆ </a></span>filterByValue() <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_1FilterByValueResponse">FilterByValueResponse</a> & gpudb::GPUdb::filterByValue </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByValueRequest">FilterByValueRequest</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_1FilterByValueResponse">FilterByValueResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Calculates which objects from a table has a particular value for a particular column. </p>
      <p>The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.</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_1FilterByValueRequest">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_1FilterByValueResponse">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_1FilterByValueResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a38c7ac75e711488e45d6480b5081587b" />

  <h2 className="memtitle"><span className="permalink"><a href="#a38c7ac75e711488e45d6480b5081587b">◆ </a></span>filterByValue() <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_1FilterByValueResponse">FilterByValueResponse</a> gpudb::GPUdb::filterByValue </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 bool</td>
          <td className="paramname"><span className="paramname"><span className="em">isString</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const double</td>
          <td className="paramname"><span className="paramname"><span className="em">value</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">valueStr</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::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>Calculates which objects from a table has a particular value for a particular column. </p>
      <p>The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.</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 an existing table on which to perform the calculation, 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">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">isString</td>
              <td>Indicates whether the value being searched for is string or numeric. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">value</td>
              <td>The value to search for. The default value is 0. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">valueStr</td>
              <td>The string value to search for. The default value is ''. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">columnName</td>
              <td>Name of a column on which the filter by value would be applied. </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#ad8d0e2db24b84f13c1b6a4cf1da8344a">filter\_by\_value\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a0c9fc58a0c48f653739b15c9edee8e98">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#a6a03ad0d8c3320605cb7561f596a4cc7">qualified\_view\_name</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0c9fc58a0c48f653739b15c9edee8e98">filter\_by\_value\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a77a87ad5044068fc0073e5c3d2fcab75">filter\_by\_value\_false</a> </li>
                    </ul>

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

                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#aaa6f5bdc2db2936498af3101c7d30809">filter\_by\_value\_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="#a33d9a0a8e738d14b688f9f869f9640ad">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>
                </ul>

                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_1FilterByValueResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a7037257854419f4cd849349c908358af" />

  <h2 className="memtitle"><span className="permalink"><a href="#a7037257854419f4cd849349c908358af">◆ </a></span>filterByValue() <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_1FilterByValueResponse">FilterByValueResponse</a> & gpudb::GPUdb::filterByValue </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 bool</td>
          <td className="paramname"><span className="paramname"><span className="em">isString</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const double</td>
          <td className="paramname"><span className="paramname"><span className="em">value</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">valueStr</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::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_1FilterByValueResponse">FilterByValueResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Calculates which objects from a table has a particular value for a particular column. </p>
      <p>The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.</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 an existing table on which to perform the calculation, 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">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">isString</td>
              <td>Indicates whether the value being searched for is string or numeric. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">value</td>
              <td>The value to search for. The default value is 0. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">valueStr</td>
              <td>The string value to search for. The default value is ''. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">columnName</td>
              <td>Name of a column on which the filter by value would be applied. </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#ad8d0e2db24b84f13c1b6a4cf1da8344a">filter\_by\_value\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a0c9fc58a0c48f653739b15c9edee8e98">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#a6a03ad0d8c3320605cb7561f596a4cc7">qualified\_view\_name</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0c9fc58a0c48f653739b15c9edee8e98">filter\_by\_value\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a77a87ad5044068fc0073e5c3d2fcab75">filter\_by\_value\_false</a> </li>
                    </ul>

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

                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#aaa6f5bdc2db2936498af3101c7d30809">filter\_by\_value\_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="#a33d9a0a8e738d14b688f9f869f9640ad">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>
                </ul>

                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_1FilterByValueResponse">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_1FilterByValueResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>