> ## 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.FilterRequest > kinetica.FilterRequest — Kinetica C# API

A set of parameters for Kinetica.filter. More...

Inheritance diagram for kinetica.FilterRequest:
Collaboration diagram for kinetica.FilterRequest:

Classes
struct   Options
  A set of string constants for the parameter FilterRequest.options. More...
 

Public Member Functions
  FilterRequest ()
  Constructs a FilterRequest object with default parameters.
 
  FilterRequest (string table\_name, string view\_name, string expression, IDictionary\< string, string > options=null)
  Constructs a FilterRequest object with the specified parameters.
 
  FilterRequest ()
  Constructs a FilterRequest object with default parameters.
 
  FilterRequest (string table\_name, string view\_name, string expression, IDictionary\< string, string > options=null)
  Constructs a FilterRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  table\_name \[get, set]
  Name of the table to filter, in \[schema\_name.
 
string  view\_name = "" \[get, set]
  If provided, then this will be the name of the view containing the results, in \[schema\_name.
 
string  expression \[get, set]
  The select expression to filter the specified table.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

Additional Inherited Members
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.filter.

Filters data based on the specified expression. The results are stored in a result set with the given FilterRequest.view\_name.

For details see Expressions.

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.

Definition at line 22 of file Filter.cs.

Constructor & Destructor Documentation

◆ FilterRequest() \[1/4]

kinetica.FilterRequest.FilterRequest ( )
inline

Constructs a FilterRequest object with default parameters.

Definition at line 161 of file Filter.cs.

◆ FilterRequest() \[2/4]

kinetica.FilterRequest.FilterRequest ( string table\_name,
string view\_name,
string expression,
IDictionary\< string, string > options = null )
inline

Constructs a FilterRequest object with the specified parameters.

Parameters
table\_name Name of the table to filter, in \[schema\_name.]table\_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view\_name If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
expression The select expression to filter the specified table. For details see Expressions.
options Optional parameters.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_VIEW\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use Kinetica.createSchema 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.
  • VIEW\_ID: View this filtered-view is part of. The default value is ''.
  • TTL: Sets the TTL of the view specified in view\_name .
The default value is an empty Dictionary.

Definition at line 234 of file Filter.cs.

◆ FilterRequest() \[3/4]

kinetica.FilterRequest.FilterRequest ( )
inline

Constructs a FilterRequest object with default parameters.

Definition at line 161 of file Filter.cs.

◆ FilterRequest() \[4/4]

kinetica.FilterRequest.FilterRequest ( string table\_name,
string view\_name,
string expression,
IDictionary\< string, string > options = null )
inline

Constructs a FilterRequest object with the specified parameters.

Parameters
table\_name Name of the table to filter, in \[schema\_name.]table\_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view\_name If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
expression The select expression to filter the specified table. For details see Expressions.
options Optional parameters.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_VIEW\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use Kinetica.createSchema 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.
  • VIEW\_ID: View this filtered-view is part of. The default value is ''.
  • TTL: Sets the TTL of the view specified in view\_name .
The default value is an empty Dictionary.

Definition at line 234 of file Filter.cs.

Property Documentation

◆ expression

string kinetica.FilterRequest.expression
getset

The select expression to filter the specified table.

For details see Expressions.

Definition at line 101 of file Filter.cs.

◆ options

IDictionary\< string, string > kinetica.FilterRequest.options = new Dictionary\()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 157 of file Filter.cs.

◆ table\_name

string kinetica.FilterRequest.table\_name
getset

Name of the table to filter, in \[schema\_name.

]table\_name format, using standard name resolution rules.

This may be the name of a table or a view (when chaining queries).

Definition at line 85 of file Filter.cs.

◆ view\_name

string kinetica.FilterRequest.view\_name = ""
getset

If provided, then this will be the name of the view containing the results, in \[schema\_name.

]view\_name format, using standard name resolution rules and meeting table naming criteria.

Must not be an already existing table or view. The default value is ''.

Definition at line 95 of file Filter.cs.

The documentation for this class was generated from the following files:
  • \_build/public-os\_ubuntu24.04-arch\_amd64-cc\_gcc\_13.3.0/install/Kinetica/Protocol/Filter.cs
  • Kinetica/Protocol/Filter.cs