Skip to main content

A set of string constants for the parameter FilterByStringRequest.mode. More…

​
Static Public Attributes

const string SEARCH = “search”
 Full text search query with wildcards and boolean operators.
 
const string EQUALS = “equals”
 Exact whole-string match (accelerated).
 
const string CONTAINS = “contains”
 Partial substring match (not accelerated).
 
const string STARTS_WITH = “starts_with”
 Strings that start with the given expression (not accelerated).
 
const string REGEX = “regex”
 Full regular expression search (not accelerated).
 
const string SEARCH_STATS = “search_stats”
 Cross-shard BM25 corpus statistics for one (column, query) pair.
 

​
Detailed Description

A set of string constants for the parameter FilterByStringRequest.mode.

The string filtering mode to apply. See below for details.

Definition at line 28 of file FilterByString.cs.

​
Member Data Documentation

​
◆ CONTAINS

const string kinetica.FilterByStringRequest.Mode.CONTAINS = “contains”
 static

Partial substring match (not accelerated).

If the column is a string type (non-charN) and the number of records is too large, it will return 0.

Definition at line 44 of file FilterByString.cs.

​
◆ EQUALS

const string kinetica.FilterByStringRequest.Mode.EQUALS = “equals”
 static

Exact whole-string match (accelerated).

Definition at line 39 of file FilterByString.cs.

​
◆ REGEX

const string kinetica.FilterByStringRequest.Mode.REGEX = “regex”
 static

Full regular expression search (not accelerated).

If the column is a string type (non-charN) and the number of records is too large, it will return 0.

Definition at line 56 of file FilterByString.cs.

const string kinetica.FilterByStringRequest.Mode.SEARCH = “search”
 static

Full text search query with wildcards and boolean operators.

Note that for this mode, no column can be specified in FilterByStringRequest.column_names; all string columns of the table that have text search enabled will be searched.

Definition at line 36 of file FilterByString.cs.

​
◆ SEARCH_STATS

const string kinetica.FilterByStringRequest.Mode.SEARCH_STATS = “search_stats”
 static

Cross-shard BM25 corpus statistics for one (column, query) pair.

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 COLUMN_NAMES to contain exactly one column with text search enabled. The VIEW_NAME field is ignored — this mode does not produce a result table.

Definition at line 67 of file FilterByString.cs.

​
◆ STARTS_WITH

const string kinetica.FilterByStringRequest.Mode.STARTS_WITH = “starts_with”
 static

Strings that start with the given expression (not accelerated).

If the column is a string type (non-charN) and the number of records is too large, it will return 0.

Definition at line 50 of file FilterByString.cs.

The documentation for this struct was generated from the following files:
  • _build/public-os_centos8-arch_amd64-cc_gcc_8.5.0/install/Kinetica/Protocol/FilterByString.cs
  • Kinetica/Protocol/FilterByString.cs