Kinetica C# API  Version 6.2.0.1
kinetica.FilterByStringRequest.Mode Struct Reference

The string filtering mode to apply. More...

Public Attributes

const string SEARCH = "search"
 Full text search query with wildcards and boolean operators. More...
 
const string EQUALS = "equals"
 Exact whole-string match (accelerated). More...
 
const string CONTAINS = "contains"
 Partial substring match (not accelerated). More...
 
const string STARTS_WITH = "starts_with"
 Strings that start with the given expression (not accelerated). More...
 
const string REGEX = "regex"
 Full regular expression search (not accelerated). More...
 

Detailed Description

The string filtering mode to apply.

See below for details. Supported values:

  • SEARCH: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in ; all string columns of the table that have text search enabled will be searched.
  • EQUALS: Exact whole-string match (accelerated).
  • CONTAINS: 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.
  • STARTS_WITH: 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.
  • REGEX: 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.

A set of string constants for the parameter mode.

Definition at line 69 of file FilterByString.cs.

Member Data Documentation

◆ CONTAINS

const string kinetica.FilterByStringRequest.Mode.CONTAINS = "contains"

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 84 of file FilterByString.cs.

◆ EQUALS

const string kinetica.FilterByStringRequest.Mode.EQUALS = "equals"

Exact whole-string match (accelerated).

Definition at line 79 of file FilterByString.cs.

◆ REGEX

const string kinetica.FilterByStringRequest.Mode.REGEX = "regex"

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 94 of file FilterByString.cs.

◆ SEARCH

const string kinetica.FilterByStringRequest.Mode.SEARCH = "search"

Full text search query with wildcards and boolean operators.

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

Definition at line 76 of file FilterByString.cs.

◆ STARTS_WITH

const string kinetica.FilterByStringRequest.Mode.STARTS_WITH = "starts_with"

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 89 of file FilterByString.cs.


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