kinetica.FilterByTableRequest Class Reference

A set of parameters for /filter/bytable. More...

Inheritance diagram for kinetica.FilterByTableRequest:

Collaboration diagram for kinetica.FilterByTableRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	FilterByTableRequest ()
	Constructs a FilterByTableRequest object with default parameters. More...
	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. More...
Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...
	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...
object	Get (int fieldPos)
	Retrieve a specific property from this object More...
void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name [get, set]
	Name of the table whose data will be filtered. More...
string	view_name [get, set]
	If provided, then this will be the name of the view containing the results. More...
string	column_name = "" [get, set]
	Name of the column by whose value the data will be filtered from the table designated by . More...
string	source_table_name [get, set]
	Name of the table whose data will be compared against in the table called . More...
string	source_table_column_name [get, set]
	Name of the column in the whose values will be used as the filter for table . More...
IDictionary< string, string >	options [get, set]
	Optional parameters. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

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. More...

Detailed Description

A set of parameters for /filter/bytable.

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 <member name="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 26 of file FilterByTable.cs.

Constructor & Destructor Documentation

kinetica.FilterByTableRequest.FilterByTableRequest ( )

inline

Constructs a FilterByTableRequest object with default parameters.

Definition at line 208 of file FilterByTable.cs.

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. Must be an existing table.
view_name	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
column_name	Name of the column by whose value the data will be filtered from the table designated by .
source_table_name	Name of the table whose data will be compared against in the table called . Must be an existing table.
source_table_column_name	Name of the column in the whose values will be used as the filter for table . Must match the type of the .
options	Optional parameters. filter_mode String indicating the filter mode, either in_table or not_in_table. Values: in_table, not_in_table. mode Mode - should be either spatial or normal. Values: normal, spatial. buffer Buffer size, in meters. Only relevant for spatial mode. buffer_method Method used to buffer polygons. Only relevant for spatial mode. Values: normal, geos. max_partition_size Maximum number of points in a partition. Only relevant for spatial mode. max_partition_score Maximum number of points * edges in a partition. Only relevant for spatial mode. x_column_name Name of column containing x value of point being filtered in spatial mode. y_column_name Name of column containing y value of point being filtered in spatial mode.

Definition at line 280 of file FilterByTable.cs.

Property Documentation

string kinetica.FilterByTableRequest.column_name = ""

getset

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

Definition at line 140 of file FilterByTable.cs.

IDictionary<string, string> kinetica.FilterByTableRequest.options

getset

Optional parameters.

• filter_mode String indicating the filter mode, either in_table or not_in_table. Values: in_table, not_in_table.
• mode Mode - should be either spatial or normal. Values: normal, spatial.
• buffer Buffer size, in meters. Only relevant for spatial mode.
• buffer_method Method used to buffer polygons. Only relevant for spatial mode. Values: normal, geos.
• max_partition_size Maximum number of points in a partition. Only relevant for spatial mode.
• max_partition_score Maximum number of points * edges in a partition. Only relevant for spatial mode.
• x_column_name Name of column containing x value of point being filtered in spatial mode.
• y_column_name Name of column containing y value of point being filtered in spatial mode.

Definition at line 203 of file FilterByTable.cs.

string kinetica.FilterByTableRequest.source_table_column_name

getset

Name of the column in the whose values will be used as the filter for table .

Must match the type of the .

Definition at line 153 of file FilterByTable.cs.

string kinetica.FilterByTableRequest.source_table_name

getset

Name of the table whose data will be compared against in the table called .

Must be an existing table.

Definition at line 145 of file FilterByTable.cs.

string kinetica.FilterByTableRequest.table_name

getset

Name of the table whose data will be filtered.

Must be an existing table.

Definition at line 129 of file FilterByTable.cs.

string kinetica.FilterByTableRequest.view_name

getset

If provided, then this will be the name of the view containing the results.

Has the same naming restrictions as tables.

Definition at line 135 of file FilterByTable.cs.

---

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

• Kinetica/Protocol/FilterByTable.cs