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

# filter

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

  <h2 className="memtitle"><span className="permalink"><a href="#a326cdfc4d55f37794297bbc0dd77c4ee">◆ </a></span>filter() <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_1FilterResponse">FilterResponse</a> kinetica.Kinetica.filter </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1FilterRequest">FilterRequest</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>Filters data based on the specified expression. </p>
      <p>The results are stored in a <a href="/content/concepts/filtered_views/" target="_top">result set</a> with the given <a className="el" href="/content/api/cs/classkinetica_1_1FilterRequest#a0b4235e28ca87259ecf0f98667659539">view\_name</a>.</p>
      <p>For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>.</p>
      <p>The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.</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#L36260">36260</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="ab4e5657ab214c077e0526b5b36a09f35" />

  <h2 className="memtitle"><span className="permalink"><a href="#ab4e5657ab214c077e0526b5b36a09f35">◆ </a></span>filter() <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_1FilterResponse">FilterResponse</a> kinetica.Kinetica.filter </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">string</td>
                <td className="paramname"><span className="paramname"><span className="em">expression</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>Filters data based on the specified expression. </p>
      <p>The results are stored in a <a href="/content/concepts/filtered_views/" target="_top">result set</a> with the given <span className="em">view\_name</span> .</p>
      <p>For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>.</p>
      <p>The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.</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 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="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">expression</td>
              <td>The select expression to filter the specified table. For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>.</td>
            </tr>

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

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#aa604805273ad6b64725f2d22ff09c3bd">CREATE\_TEMP\_TABLE</a>: If <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#a3bd8a699f74f408b49267fc618216263">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_1FilterResponse_1_1Info#aa41a5482e96714f99d503bb5fa811505">QUALIFIED\_VIEW\_NAME</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#a3bd8a699f74f408b49267fc618216263">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#af7abb627ab5b64b791e849ce8df0b27b">FALSE</a> </li>
                    </ul>

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

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#a13d7d3e50e7df384c293bf9e24470b86">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>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#a22ad05926d2861b6bdfe9280e49c4bcc">VIEW\_ID</a>: View this filtered-view is part of. The default value is ''. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#acfb81f75a8168965a40c0235383d70c2">TTL</a>: Sets the <a href="/content/concepts/ttl/" target="_top">TTL</a> of the view specified in <span className="em">view\_name</span> . </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#L36373">36373</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="ab702901321c386a653d562ca8817efb5" />

  <h2 className="memtitle"><span className="permalink"><a href="#ab702901321c386a653d562ca8817efb5">◆ </a></span>FilterAsync() <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_1FilterResponse">FilterResponse</a> > kinetica.Kinetica.FilterAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1FilterRequest">FilterRequest</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>Filters data based on the specified expression. </p>
      <p>(async)</p>
      <p>The results are stored in a <a href="/content/concepts/filtered_views/" target="_top">result set</a> with the given <a className="el" href="/content/api/cs/classkinetica_1_1FilterRequest#a0b4235e28ca87259ecf0f98667659539">view\_name</a>.</p>
      <p>For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>.</p>
      <p>The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.</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#L36285">36285</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="a9f8dce9f833005b15c3cfc008df187f6" />

  <h2 className="memtitle"><span className="permalink"><a href="#a9f8dce9f833005b15c3cfc008df187f6">◆ </a></span>FilterAsync() <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_1FilterResponse">FilterResponse</a> > kinetica.Kinetica.FilterAsync </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">string</td>
                <td className="paramname"><span className="paramname"><span className="em">expression</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>Filters data based on the specified expression. </p>
      <p>(async)</p>
      <p>The results are stored in a <a href="/content/concepts/filtered_views/" target="_top">result set</a> with the given <span className="em">view\_name</span> .</p>
      <p>For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>.</p>
      <p>The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.</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 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="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">expression</td>
              <td>The select expression to filter the specified table. For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>.</td>
            </tr>

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

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#aa604805273ad6b64725f2d22ff09c3bd">CREATE\_TEMP\_TABLE</a>: If <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#a3bd8a699f74f408b49267fc618216263">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_1FilterResponse_1_1Info#aa41a5482e96714f99d503bb5fa811505">QUALIFIED\_VIEW\_NAME</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#a3bd8a699f74f408b49267fc618216263">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#af7abb627ab5b64b791e849ce8df0b27b">FALSE</a> </li>
                    </ul>

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

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#a13d7d3e50e7df384c293bf9e24470b86">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>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#a22ad05926d2861b6bdfe9280e49c4bcc">VIEW\_ID</a>: View this filtered-view is part of. The default value is ''. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterRequest_1_1Options#acfb81f75a8168965a40c0235383d70c2">TTL</a>: Sets the <a href="/content/concepts/ttl/" target="_top">TTL</a> of the view specified in <span className="em">view\_name</span> . </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#L36464">36464</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>