> ## 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#a2ded1766fc243936b22304aeb0f75613" 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">
            <div id="pub-static-attribs" />

            Static Public Attributes
          </h2>
        </td>
      </tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      <tr className="memitem:a5815a2e1e686072b55318b3931375c43" id="r_a5815a2e1e686072b55318b3931375c43">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a5815a2e1e686072b55318b3931375c43">SEARCH\_STATS</a> = "search\_stats"</td>
      </tr>

      <tr className="memdesc:a5815a2e1e686072b55318b3931375c43">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Cross-shard BM25 corpus statistics for one (column, query) pair. <br /></td>
      </tr>

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

    <div id="details" />

    <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#a2ded1766fc243936b22304aeb0f75613" 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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs#L28">28</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs">FilterByString.cs</a>.</p>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>

    <div id="aa8bbf825eae9993c96effa7540043a54" />

    <h2 className="memtitle"><span className="permalink"><a href="#aa8bbf825eae9993c96effa7540043a54">◆ </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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs#L44">44</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs">FilterByString.cs</a>.</p>
      </div>
    </div>

    <div id="a71cc1c714a18e6b6411530d2671788a6" />

    <h2 className="memtitle"><span className="permalink"><a href="#a71cc1c714a18e6b6411530d2671788a6">◆ </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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs#L39">39</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs">FilterByString.cs</a>.</p>
      </div>
    </div>

    <div id="a7a2dadf8ca8289bf10adeddd094ea439" />

    <h2 className="memtitle"><span className="permalink"><a href="#a7a2dadf8ca8289bf10adeddd094ea439">◆ </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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs#L56">56</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs">FilterByString.cs</a>.</p>
      </div>
    </div>

    <div id="a292958ea73f47b1907d92f9687ce46d6" />

    <h2 className="memtitle"><span className="permalink"><a href="#a292958ea73f47b1907d92f9687ce46d6">◆ </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#a664381b4716b2a023ef4654d5a1145a0" 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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs#L36">36</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs">FilterByString.cs</a>.</p>
      </div>
    </div>

    <div id="a5815a2e1e686072b55318b3931375c43" />

    <h2 className="memtitle"><span className="permalink"><a href="#a5815a2e1e686072b55318b3931375c43">◆ </a></span>SEARCH\_STATS</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\_STATS = "search\_stats"</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>Cross-shard BM25 corpus statistics for one (column, query) pair. </p>
        <p>Returns the merged BM25 statistics (max\_doc, doc\_count, sum\_total\_term\_freq, per-term doc\_freq / total\_term\_freq) needed by callers that score documents themselves (e.g. text\_match\_bm25\_global SQL function pre-pass). Requires <code>COLUMN\_NAMES</code> to contain exactly one column with text search enabled. The <code>VIEW\_NAME</code> field is ignored — this mode does not produce a result table.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs#L67">67</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs">FilterByString.cs</a>.</p>
      </div>
    </div>

    <div id="a74ad74d5197229d3c52a83e70f0d2dac" />

    <h2 className="memtitle"><span className="permalink"><a href="#a74ad74d5197229d3c52a83e70f0d2dac">◆ </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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs#L50">50</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs">FilterByString.cs</a>.</p>
      </div>
    </div>

    <hr />

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

    <ul>
      <li>Kinetica/Protocol/<a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/FilterByString.cs">FilterByString.cs</a></li>
    </ul>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.