> ## 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="adcf86d5d720328190e194f3da106ee12" />

  <h2 className="memtitle"><span className="permalink"><a href="#adcf86d5d720328190e194f3da106ee12">◆ </a></span>filterByValue() <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"><a className="el" href="/content/api/cs/classkinetica_1_1FilterByValueResponse">FilterByValueResponse</a> kinetica.Kinetica.filterByValue </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1FilterByValueRequest">FilterByValueRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></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>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="paramname">request\_</td>
              <td>Request 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">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L39966">39966</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a31cd20efad77b9a8ca93c71c17c58a85" />

  <h2 className="memtitle"><span className="permalink"><a href="#a31cd20efad77b9a8ca93c71c17c58a85">◆ </a></span>filterByValue() <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"><a className="el" href="/content/api/cs/classkinetica_1_1FilterByValueResponse">FilterByValueResponse</a> kinetica.Kinetica.filterByValue </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">table\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">view\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">bool</td>
                <td className="paramname"><span className="paramname"><span className="em">is\_string</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">double</td>
                <td className="paramname"><span className="paramname"><span className="em">\_value</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">value\_str</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">column\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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>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="paramname">table\_name</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="paramname">view\_name</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="paramname">is\_string</td>
              <td>Indicates whether the value being searched for is string or numeric.</td>
            </tr>

            <tr>
              <td className="paramname">\_value</td>
              <td>The value to search for. The default value is 0. </td>
            </tr>

            <tr>
              <td className="paramname">value\_str</td>
              <td>The string value to search for. The default value is ''.</td>
            </tr>

            <tr>
              <td className="paramname">column\_name</td>
              <td>Name of a column on which the filter by value would be applied.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#af3189d93dfd10dc65afa4c9e944198e7">CREATE\_TEMP\_TABLE</a>: If <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#a1cb4535691a4c9f9066b1ba7ea2ddf62">TRUE</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <span className="em">view\_name</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/cs/structkinetica_1_1FilterByValueResponse_1_1Info#ae35a726f6aaf31ccb061c98d8dc750a6">QUALIFIED\_VIEW\_NAME</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#a1cb4535691a4c9f9066b1ba7ea2ddf62">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#ade1c53804dadb5b4e659fc1cef1e03e0">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#ade1c53804dadb5b4e659fc1cef1e03e0">FALSE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#a007e2f304f3755ad06ad13e8efe9b1c6">COLLECTION\_NAME</a>: \[DEPRECATED–please specify the containing schema for the view as part of <span className="em">view\_name</span> and use <a className="el" href="#ac754b44062e7b90b8afa50ddfa8ccbf2">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 Dictionary.
              </td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L40078">40078</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a66e0da98412821d653fa0c653a01f2d7" />

  <h2 className="memtitle"><span className="permalink"><a href="#a66e0da98412821d653fa0c653a01f2d7">◆ </a></span>FilterByValueAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1FilterByValueResponse">FilterByValueResponse</a> > kinetica.Kinetica.FilterByValueAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_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">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Calculates which objects from a table has a particular value for a particular column. </p>
      <p>(async) </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="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L39992">39992</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="abe3f3a24aacaafce0108c1c0a4064204" />

  <h2 className="memtitle"><span className="permalink"><a href="#abe3f3a24aacaafce0108c1c0a4064204">◆ </a></span>FilterByValueAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1FilterByValueResponse">FilterByValueResponse</a> > kinetica.Kinetica.FilterByValueAsync </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">table\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">view\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">bool</td>
                <td className="paramname"><span className="paramname"><span className="em">is\_string</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">double</td>
                <td className="paramname"><span className="paramname"><span className="em">\_value</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">value\_str</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">column\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Calculates which objects from a table has a particular value for a particular column. </p>
      <p>(async) </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="paramname">table\_name</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="paramname">view\_name</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="paramname">is\_string</td>
              <td>Indicates whether the value being searched for is string or numeric.</td>
            </tr>

            <tr>
              <td className="paramname">\_value</td>
              <td>The value to search for. The default value is 0. </td>
            </tr>

            <tr>
              <td className="paramname">value\_str</td>
              <td>The string value to search for. The default value is ''.</td>
            </tr>

            <tr>
              <td className="paramname">column\_name</td>
              <td>Name of a column on which the filter by value would be applied.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#af3189d93dfd10dc65afa4c9e944198e7">CREATE\_TEMP\_TABLE</a>: If <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#a1cb4535691a4c9f9066b1ba7ea2ddf62">TRUE</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <span className="em">view\_name</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/cs/structkinetica_1_1FilterByValueResponse_1_1Info#ae35a726f6aaf31ccb061c98d8dc750a6">QUALIFIED\_VIEW\_NAME</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#a1cb4535691a4c9f9066b1ba7ea2ddf62">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#ade1c53804dadb5b4e659fc1cef1e03e0">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#ade1c53804dadb5b4e659fc1cef1e03e0">FALSE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByValueRequest_1_1Options#a007e2f304f3755ad06ad13e8efe9b1c6">COLLECTION\_NAME</a>: \[DEPRECATED–please specify the containing schema for the view as part of <span className="em">view\_name</span> and use <a className="el" href="#ac754b44062e7b90b8afa50ddfa8ccbf2">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 Dictionary.
              </td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L40171">40171</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>
</div>