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

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

Inheritance diagram for kinetica.FilterByListRequest:
Collaboration diagram for kinetica.FilterByListRequest:

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

Public Member Functions
  FilterByListRequest ()
  Constructs a FilterByListRequest object with default parameters.
 
  FilterByListRequest (string table\_name, string view\_name, IDictionary\< string, IList\< string > > column\_values\_map, IDictionary\< string, string > options=null)
  Constructs a FilterByListRequest object with the specified parameters.
 
  FilterByListRequest ()
  Constructs a FilterByListRequest object with default parameters.
 
  FilterByListRequest (string table\_name, string view\_name, IDictionary\< string, IList\< string > > column\_values\_map, IDictionary\< string, string > options=null)
  Constructs a FilterByListRequest 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.
 
IDictionary\< string, IList\< string > >  column\_values\_map = new Dictionary\>() \[get, set]
  List of values for the corresponding column in the 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.filterByList.

Calculates which records from a table have values in the given list for the corresponding column. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a FilterByListRequest.view\_name is passed in as part of the request.

For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"{"}"x":\["10.1", "2.3"], "y":\["0.0", "-31.5", "42.0"]{"}"} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.

Definition at line 29 of file FilterByList.cs.

Constructor & Destructor Documentation

◆ FilterByListRequest() \[1/4]

kinetica.FilterByListRequest.FilterByListRequest ( )
inline

Constructs a FilterByListRequest object with default parameters.

Definition at line 210 of file FilterByList.cs.

◆ FilterByListRequest() \[2/4]

kinetica.FilterByListRequest.FilterByListRequest ( string table\_name,
string view\_name,
IDictionary\< string, IList\< string > > column\_values\_map,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByListRequest 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 ''.
column\_values\_map List of values for the corresponding column in the table.
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 provided is non-existent, it will be automatically created.
  • FILTER\_MODE: String indicating the filter mode, either 'in\_list' or 'not\_in\_list'. Supported values:
    • IN\_LIST: The filter will match all items that are in the provided list(s).
    • NOT\_IN\_LIST: The filter will match all items that are not in the provided list(s).
    The default value is IN\_LIST.
The default value is an empty Dictionary.

Definition at line 300 of file FilterByList.cs.

◆ FilterByListRequest() \[3/4]

kinetica.FilterByListRequest.FilterByListRequest ( )
inline

Constructs a FilterByListRequest object with default parameters.

Definition at line 210 of file FilterByList.cs.

◆ FilterByListRequest() \[4/4]

kinetica.FilterByListRequest.FilterByListRequest ( string table\_name,
string view\_name,
IDictionary\< string, IList\< string > > column\_values\_map,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByListRequest 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 ''.
column\_values\_map List of values for the corresponding column in the table.
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 provided is non-existent, it will be automatically created.
  • FILTER\_MODE: String indicating the filter mode, either 'in\_list' or 'not\_in\_list'. Supported values:
    • IN\_LIST: The filter will match all items that are in the provided list(s).
    • NOT\_IN\_LIST: The filter will match all items that are not in the provided list(s).
    The default value is IN\_LIST.
The default value is an empty Dictionary.

Definition at line 300 of file FilterByList.cs.

Property Documentation

◆ column\_values\_map

IDictionary\< string, IList\< string > > kinetica.FilterByListRequest.column\_values\_map = new Dictionary\>()
getset

List of values for the corresponding column in the table.

Definition at line 132 of file FilterByList.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 206 of file FilterByList.cs.

◆ table\_name

string kinetica.FilterByListRequest.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 118 of file FilterByList.cs.

◆ view\_name

string kinetica.FilterByListRequest.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 128 of file FilterByList.cs.

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