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

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

Inheritance diagram for kinetica.FilterByTableRequest:
Collaboration diagram for kinetica.FilterByTableRequest:

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

Public Member Functions
  FilterByTableRequest ()
  Constructs a FilterByTableRequest object with default parameters.
 
  FilterByTableRequest (string table\_name, string view\_name, string column\_name, string source\_table\_name, string source\_table\_column\_name, IDictionary\< string, string > options=null)
  Constructs a FilterByTableRequest object with the specified parameters.
 
  FilterByTableRequest ()
  Constructs a FilterByTableRequest object with default parameters.
 
  FilterByTableRequest (string table\_name, string view\_name, string column\_name, string source\_table\_name, string source\_table\_column\_name, IDictionary\< string, string > options=null)
  Constructs a FilterByTableRequest 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 whose data will be filtered, 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  column\_name \[get, set]
  Name of the column by whose value the data will be filtered from the table designated by FilterByTableRequest.table\_name.
 
string  source\_table\_name \[get, set]
  Name of the table whose data will be compared against in the table called FilterByTableRequest.table\_name, in \[schema\_name.
 
string  source\_table\_column\_name \[get, set]
  Name of the column in the FilterByTableRequest.source\_table\_name whose values will be used as the filter for table FilterByTableRequest.table\_name.
 
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.filterByTable.

Filters objects in one table based on objects in another table. The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a FilterByTableRequest.view\_name is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

Definition at line 24 of file FilterByTable.cs.

Constructor & Destructor Documentation

◆ FilterByTableRequest() \[1/4]

kinetica.FilterByTableRequest.FilterByTableRequest ( )
inline

Constructs a FilterByTableRequest object with default parameters.

Definition at line 395 of file FilterByTable.cs.

◆ FilterByTableRequest() \[2/4]

kinetica.FilterByTableRequest.FilterByTableRequest ( string table\_name,
string view\_name,
string column\_name,
string source\_table\_name,
string source\_table\_column\_name,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByTableRequest object with the specified parameters.

Parameters
table\_name Name of the table whose data will be filtered, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
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\_name Name of the column by whose value the data will be filtered from the table designated by table\_name .
source\_table\_name Name of the table whose data will be compared against in the table called table\_name , in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
source\_table\_column\_name Name of the column in the source\_table\_name whose values will be used as the filter for table table\_name . Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the column\_name .
options Optional parameters. The default value is an empty Dictionary.

Definition at line 587 of file FilterByTable.cs.

◆ FilterByTableRequest() \[3/4]

kinetica.FilterByTableRequest.FilterByTableRequest ( )
inline

Constructs a FilterByTableRequest object with default parameters.

Definition at line 395 of file FilterByTable.cs.

◆ FilterByTableRequest() \[4/4]

kinetica.FilterByTableRequest.FilterByTableRequest ( string table\_name,
string view\_name,
string column\_name,
string source\_table\_name,
string source\_table\_column\_name,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByTableRequest object with the specified parameters.

Parameters
table\_name Name of the table whose data will be filtered, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
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\_name Name of the column by whose value the data will be filtered from the table designated by table\_name .
source\_table\_name Name of the table whose data will be compared against in the table called table\_name , in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
source\_table\_column\_name Name of the column in the source\_table\_name whose values will be used as the filter for table table\_name . Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the column\_name .
options Optional parameters. The default value is an empty Dictionary.

Definition at line 587 of file FilterByTable.cs.

Property Documentation

◆ column\_name

string kinetica.FilterByTableRequest.column\_name
getset

Name of the column by whose value the data will be filtered from the table designated by FilterByTableRequest.table\_name.

Definition at line 210 of file FilterByTable.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 391 of file FilterByTable.cs.

◆ source\_table\_column\_name

string kinetica.FilterByTableRequest.source\_table\_column\_name
getset

Name of the column in the FilterByTableRequest.source\_table\_name whose values will be used as the filter for table FilterByTableRequest.table\_name.

Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the FilterByTableRequest.column\_name.

Definition at line 227 of file FilterByTable.cs.

◆ source\_table\_name

string kinetica.FilterByTableRequest.source\_table\_name
getset

Name of the table whose data will be compared against in the table called FilterByTableRequest.table\_name, in \[schema\_name.

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

Must be an existing table.

Definition at line 218 of file FilterByTable.cs.

◆ table\_name

string kinetica.FilterByTableRequest.table\_name
getset

Name of the table whose data will be filtered, in \[schema\_name.

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

Must be an existing table.

Definition at line 195 of file FilterByTable.cs.

◆ view\_name

string kinetica.FilterByTableRequest.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 205 of file FilterByTable.cs.

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