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

# kinetica.FilterByStringRequest.Mode

> kinetica.FilterByStringRequest.Mode — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1FilterByStringRequest#a2c48b312f406b570e808c16e13f5e78b" title="The string filtering mode to apply.">FilterByStringRequest.mode</a>. <a href="#details">More...</a></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Static Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a7fce636527540755c7155a7d07de9c71" id="r_a7fce636527540755c7155a7d07de9c71">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7fce636527540755c7155a7d07de9c71">SEARCH</a> = "search"</td>
      </tr>

      <tr className="memdesc:a7fce636527540755c7155a7d07de9c71">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Full text search query with wildcards and boolean operators. <br /></td>
      </tr>

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

      <tr className="memitem:a740e8fa833b2f849c203cc82a0199710" id="r_a740e8fa833b2f849c203cc82a0199710">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a740e8fa833b2f849c203cc82a0199710">EQUALS</a> = "equals"</td>
      </tr>

      <tr className="memdesc:a740e8fa833b2f849c203cc82a0199710">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Exact whole-string match (accelerated). <br /></td>
      </tr>

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

      <tr className="memitem:a4ab2ab0c9e963f6b12aaee34481ef533" id="r_a4ab2ab0c9e963f6b12aaee34481ef533">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4ab2ab0c9e963f6b12aaee34481ef533">CONTAINS</a> = "contains"</td>
      </tr>

      <tr className="memdesc:a4ab2ab0c9e963f6b12aaee34481ef533">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Partial substring match (not accelerated). <br /></td>
      </tr>

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

      <tr className="memitem:a72cc7275415bbe4c816067a6c25bbe76" id="r_a72cc7275415bbe4c816067a6c25bbe76">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a72cc7275415bbe4c816067a6c25bbe76">STARTS\_WITH</a> = "starts\_with"</td>
      </tr>

      <tr className="memdesc:a72cc7275415bbe4c816067a6c25bbe76">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Strings that start with the given expression (not accelerated). <br /></td>
      </tr>

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

      <tr className="memitem:a401390a132a16a9dafbf231ea6d170da" id="r_a401390a132a16a9dafbf231ea6d170da">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a401390a132a16a9dafbf231ea6d170da">REGEX</a> = "regex"</td>
      </tr>

      <tr className="memdesc:a401390a132a16a9dafbf231ea6d170da">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Full regular expression search (not accelerated). <br /></td>
      </tr>

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

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1FilterByStringRequest#a2c48b312f406b570e808c16e13f5e78b" title="The string filtering mode to apply.">FilterByStringRequest.mode</a>. </p>
      <p>The string filtering mode to apply. See below for details.</p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source#l00028">28</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source">FilterByString.cs</a>.</p>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.FilterByStringRequest.Mode.CONTAINS = "contains"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Partial substring match (not accelerated). </p>
        <p>If the column is a string type (non-charN) and the number of records is too large, it will return 0.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source#l00044">44</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source">FilterByString.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a740e8fa833b2f849c203cc82a0199710">◆ </a></span>EQUALS</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.FilterByStringRequest.Mode.EQUALS = "equals"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Exact whole-string match (accelerated). </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source#l00039">39</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source">FilterByString.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a401390a132a16a9dafbf231ea6d170da">◆ </a></span>REGEX</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.FilterByStringRequest.Mode.REGEX = "regex"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Full regular expression search (not accelerated). </p>
        <p>If the column is a string type (non-charN) and the number of records is too large, it will return 0.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source#l00056">56</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source">FilterByString.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a7fce636527540755c7155a7d07de9c71">◆ </a></span>SEARCH</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.FilterByStringRequest.Mode.SEARCH = "search"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Full text search query with wildcards and boolean operators. </p>
        <p>Note that for this mode, no column can be specified in <a className="el" href="/content/api/cs/classkinetica_1_1FilterByStringRequest#ad869d46f4839cd6d882d2080e58dfadc" title="List of columns on which to apply the filter.">FilterByStringRequest.column\_names</a>; all string columns of the table that have text search enabled will be searched.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source#l00036">36</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source">FilterByString.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a72cc7275415bbe4c816067a6c25bbe76">◆ </a></span>STARTS\_WITH</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.FilterByStringRequest.Mode.STARTS\_WITH = "starts\_with"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Strings that start with the given expression (not accelerated). </p>
        <p>If the column is a string type (non-charN) and the number of records is too large, it will return 0.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source#l00050">50</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source">FilterByString.cs</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following files:

    <ul>
      <li>\_build/public-os\_ubuntu24.04-arch\_amd64-cc\_gcc\_13.3.0/install/Kinetica/Protocol/<a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2FilterByString_8cs_source">FilterByString.cs</a></li>
      <li>Kinetica/Protocol/<a className="el" href="/content/api/cs/Kinetica_2Protocol_2FilterByString_8cs_source">FilterByString.cs</a></li>
    </ul>
  </div>
</div>