kinetica.FilterByAreaRequest

A set of parameters for Kinetica.filterByArea. More…

Inheritance diagram for kinetica.FilterByAreaRequest:

Collaboration diagram for kinetica.FilterByAreaRequest:

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

Public Member Functions
	FilterByAreaRequest ()
	Constructs a FilterByAreaRequest object with default parameters.

	FilterByAreaRequest (string table_name, string view_name, string x_column_name, IList< double > x_vector, string y_column_name, IList< double > y_vector, IDictionary< string, string > options=null)
	Constructs a FilterByAreaRequest object with the specified parameters.

	FilterByAreaRequest ()
	Constructs a FilterByAreaRequest object with default parameters.

	FilterByAreaRequest (string table_name, string view_name, string x_column_name, IList< double > x_vector, string y_column_name, IList< double > y_vector, IDictionary< string, string > options=null)
	Constructs a FilterByAreaRequest 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	x_column_name `[get, set]`
	Name of the column containing the x values to be filtered.

IList< double >	x_vector = new List<double>() `[get, set]`
	List of x coordinates of the vertices of the polygon representing the area to be filtered.

string	y_column_name `[get, set]`
	Name of the column containing the y values to be filtered.

IList< double >	y_vector = new List<double>() `[get, set]`
	List of y coordinates of the vertices of the polygon representing the area to be filtered.

IDictionary< string, string >	options = new Dictionary<string, string>() `[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.filterByArea.

Calculates which objects from a table are within a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name FilterByAreaRequest.view_name passed in as part of the input.

Definition at line 22 of file FilterByArea.cs.

Constructor & Destructor Documentation

◆ FilterByAreaRequest() [1/4]

kinetica.FilterByAreaRequest.FilterByAreaRequest ( )

inline

Constructs a FilterByAreaRequest object with default parameters.

Definition at line 156 of file FilterByArea.cs.

◆ FilterByAreaRequest() [2/4]

kinetica.FilterByAreaRequest.FilterByAreaRequest	(	string	table_name,
		string	view_name,
		string	x_column_name,
		IList< double >	x_vector,
		string	y_column_name,
		IList< double >	y_vector,
		IDictionary< string, string >	options = null )

inline

Constructs a FilterByAreaRequest 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 ”.
x_column_name	Name of the column containing the x values to be filtered.
x_vector	List of x coordinates of the vertices of the polygon representing the area to be filtered.
y_column_name	Name of the column containing the y values to be filtered.
y_vector	List of y coordinates of the vertices of the polygon representing the area to be filtered.
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: TRUE FALSE 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. The default value is an empty Dictionary.

Definition at line 225 of file FilterByArea.cs.

◆ FilterByAreaRequest() [3/4]

kinetica.FilterByAreaRequest.FilterByAreaRequest ( )

inline

Constructs a FilterByAreaRequest object with default parameters.

Definition at line 156 of file FilterByArea.cs.

◆ FilterByAreaRequest() [4/4]

kinetica.FilterByAreaRequest.FilterByAreaRequest	(	string	table_name,
		string	view_name,
		string	x_column_name,
		IList< double >	x_vector,
		string	y_column_name,
		IList< double >	y_vector,
		IDictionary< string, string >	options = null )

inline

Constructs a FilterByAreaRequest 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 ”.
x_column_name	Name of the column containing the x values to be filtered.
x_vector	List of x coordinates of the vertices of the polygon representing the area to be filtered.
y_column_name	Name of the column containing the y values to be filtered.
y_vector	List of y coordinates of the vertices of the polygon representing the area to be filtered.
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: TRUE FALSE 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. The default value is an empty Dictionary.

Definition at line 225 of file FilterByArea.cs.

Property Documentation

◆ options

IDictionary< string, string > kinetica.FilterByAreaRequest.options = new Dictionary<string, string>()

getset

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 FilterByAreaRequest.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:
- TRUE
- FALSE
The default value is FALSE.
COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of FilterByAreaRequest.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.

The default value is an empty Dictionary.

Definition at line 152 of file FilterByArea.cs.

◆ table_name

string kinetica.FilterByAreaRequest.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 79 of file FilterByArea.cs.

◆ view_name

string kinetica.FilterByAreaRequest.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 89 of file FilterByArea.cs.

◆ x_column_name

string kinetica.FilterByAreaRequest.x_column_name

getset

Name of the column containing the x values to be filtered.

Definition at line 93 of file FilterByArea.cs.

◆ x_vector

IList< double > kinetica.FilterByAreaRequest.x_vector = new List<double>()

getset

List of x coordinates of the vertices of the polygon representing the area to be filtered.

Definition at line 97 of file FilterByArea.cs.

◆ y_column_name

string kinetica.FilterByAreaRequest.y_column_name

getset

Name of the column containing the y values to be filtered.

Definition at line 101 of file FilterByArea.cs.

◆ y_vector

IList< double > kinetica.FilterByAreaRequest.y_vector = new List<double>()

getset

List of y coordinates of the vertices of the polygon representing the area to be filtered.

Definition at line 105 of file FilterByArea.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/FilterByArea.cs
Kinetica/Protocol/FilterByArea.cs

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ FilterByAreaRequest() [1/4]

​◆ FilterByAreaRequest() [2/4]

​◆ FilterByAreaRequest() [3/4]

​◆ FilterByAreaRequest() [4/4]

​Property Documentation

​◆ options

​◆ table_name

​◆ view_name

​◆ x_column_name

​◆ x_vector

​◆ y_column_name

​◆ y_vector

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterByAreaRequest() [1/4]

◆ FilterByAreaRequest() [2/4]

◆ FilterByAreaRequest() [3/4]

◆ FilterByAreaRequest() [4/4]

Property Documentation

◆ options

◆ table_name

◆ view_name

◆ x_column_name

◆ x_vector

◆ y_column_name

◆ y_vector