A set of parameters for Kinetica.filterByTable(string,string,string,string,string,IDictionary<string, string>). 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 Kinetica.filterByTable(string,string,string,string,string,IDictionary<string, string>).

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 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 28 of file FilterByTable.cs.

Constructor & Destructor Documentation

◆ FilterByTableRequest() [1/2]

kinetica.FilterByTableRequest.FilterByTableRequest ( )

inline

Constructs a FilterByTableRequest object with default parameters.

Definition at line 371 of file FilterByTable.cs.

◆ FilterByTableRequest() [2/2]

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. The default value is ''.
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 be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the .
options	Optional parameters. COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level. FILTER_MODE: String indicating the filter mode, either in_table or not_in_table. Supported values: IN_TABLE NOT_IN_TABLE The default value is IN_TABLE. MODE: Mode - should be either spatial or normal. Supported values: NORMAL SPATIAL The default value is NORMAL. BUFFER: Buffer size, in meters. Only relevant for spatial mode. The default value is '0'. BUFFER_METHOD: Method used to buffer polygons. Only relevant for spatial mode. Supported values: NORMAL GEOS: Use geos 1 edge per corner algorithm The default value is NORMAL. MAX_PARTITION_SIZE: Maximum number of points in a partition. Only relevant for spatial mode. The default value is '0'. MAX_PARTITION_SCORE: Maximum number of points * edges in a partition. Only relevant for spatial mode. The default value is '8000000'. X_COLUMN_NAME: Name of column containing x value of point being filtered in spatial mode. The default value is 'x'. Y_COLUMN_NAME: Name of column containing y value of point being filtered in spatial mode. The default value is 'y'. The default value is an empty Dictionary.

Definition at line 502 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 .

Definition at line 245 of file FilterByTable.cs.

◆ options

IDictionary<string, string> kinetica.FilterByTableRequest.options

getset

Optional parameters.

COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
FILTER_MODE: String indicating the filter mode, either in_table or not_in_table. Supported values:
- IN_TABLE
- NOT_IN_TABLE
The default value is IN_TABLE.
MODE: Mode - should be either spatial or normal. Supported values:
- NORMAL
- SPATIAL
The default value is NORMAL.
BUFFER: Buffer size, in meters. Only relevant for spatial mode. The default value is '0'.
BUFFER_METHOD: Method used to buffer polygons. Only relevant for spatial mode. Supported values:
- NORMAL
- GEOS: Use geos 1 edge per corner algorithm
The default value is NORMAL.
MAX_PARTITION_SIZE: Maximum number of points in a partition. Only relevant for spatial mode. The default value is '0'.
MAX_PARTITION_SCORE: Maximum number of points * edges in a partition. Only relevant for spatial mode. The default value is '8000000'.
X_COLUMN_NAME: Name of column containing x value of point being filtered in spatial mode. The default value is 'x'.
Y_COLUMN_NAME: Name of column containing y value of point being filtered in spatial mode. The default value is 'y'.

The default value is an empty Dictionary.

Definition at line 366 of file FilterByTable.cs.

◆ source_table_column_name

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 be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the .

Definition at line 259 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 .

Must be an existing table.

Definition at line 250 of file FilterByTable.cs.

◆ table_name

string kinetica.FilterByTableRequest.table_name

getset

Name of the table whose data will be filtered.

Must be an existing table.

Definition at line 234 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.

Has the same naming restrictions as tables. The default value is ''.

Definition at line 240 of file FilterByTable.cs.

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

Kinetica/Protocol/FilterByTable.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterByTableRequest() [1/2]

◆ FilterByTableRequest() [2/2]

Property Documentation

◆ column_name

◆ options

◆ source_table_column_name

◆ source_table_name

◆ table_name

◆ view_name