kinetica.FilterByBoxRequest

A set of parameters for Kinetica.filterByBox. More…

Inheritance diagram for kinetica.FilterByBoxRequest:

Collaboration diagram for kinetica.FilterByBoxRequest:

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

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

	FilterByBoxRequest (string table_name, string view_name, string x_column_name, double min_x, double max_x, string y_column_name, double min_y, double max_y, IDictionary< string, string > options=null)
	Constructs a FilterByBoxRequest object with the specified parameters.

	FilterByBoxRequest ()
	Constructs a FilterByBoxRequest object with default parameters.

	FilterByBoxRequest (string table_name, string view_name, string x_column_name, double min_x, double max_x, string y_column_name, double min_y, double max_y, IDictionary< string, string > options=null)
	Constructs a FilterByBoxRequest 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 on which the bounding box operation will be performed, 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 on which to perform the bounding box query.

double	min_x `[get, set]`
	Lower bound for the column chosen by FilterByBoxRequest.x_column_name.

double	max_x `[get, set]`
	Upper bound for FilterByBoxRequest.x_column_name.

string	y_column_name `[get, set]`
	Name of a column on which to perform the bounding box query.

double	min_y `[get, set]`
	Lower bound for FilterByBoxRequest.y_column_name.

double	max_y `[get, set]`
	Upper bound for FilterByBoxRequest.y_column_name.

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

Calculates how many objects within the given table lie in a rectangular box. 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 which satisfies the input NAI restriction specification is also created when a FilterByBoxRequest.view_name is passed in as part of the input payload.

Definition at line 21 of file FilterByBox.cs.

Constructor & Destructor Documentation

◆ FilterByBoxRequest() [1/4]

kinetica.FilterByBoxRequest.FilterByBoxRequest ( )

inline

Constructs a FilterByBoxRequest object with default parameters.

Definition at line 171 of file FilterByBox.cs.

◆ FilterByBoxRequest() [2/4]

kinetica.FilterByBoxRequest.FilterByBoxRequest	(	string	table_name,
		string	view_name,
		string	x_column_name,
		double	min_x,
		double	max_x,
		string	y_column_name,
		double	min_y,
		double	max_y,
		IDictionary< string, string >	options = null )

inline

Constructs a FilterByBoxRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the bounding box operation will be performed, 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 ”.
x_column_name	Name of the column on which to perform the bounding box query. Must be a valid numeric column.
min_x	Lower bound for the column chosen by x_column_name . Must be less than or equal to max_x .
max_x	Upper bound for x_column_name . Must be greater than or equal to min_x .
y_column_name	Name of a column on which to perform the bounding box query. Must be a valid numeric column.
min_y	Lower bound for y_column_name . Must be less than or equal to max_y .
max_y	Upper bound for y_column_name . Must be greater than or equal to min_y .
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 is non-existent, it will be automatically created. The default value is an empty Dictionary.

Definition at line 245 of file FilterByBox.cs.

◆ FilterByBoxRequest() [3/4]

kinetica.FilterByBoxRequest.FilterByBoxRequest ( )

inline

Constructs a FilterByBoxRequest object with default parameters.

Definition at line 171 of file FilterByBox.cs.

◆ FilterByBoxRequest() [4/4]

kinetica.FilterByBoxRequest.FilterByBoxRequest	(	string	table_name,
		string	view_name,
		string	x_column_name,
		double	min_x,
		double	max_x,
		string	y_column_name,
		double	min_y,
		double	max_y,
		IDictionary< string, string >	options = null )

inline

Constructs a FilterByBoxRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the bounding box operation will be performed, 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 ”.
x_column_name	Name of the column on which to perform the bounding box query. Must be a valid numeric column.
min_x	Lower bound for the column chosen by x_column_name . Must be less than or equal to max_x .
max_x	Upper bound for x_column_name . Must be greater than or equal to min_x .
y_column_name	Name of a column on which to perform the bounding box query. Must be a valid numeric column.
min_y	Lower bound for y_column_name . Must be less than or equal to max_y .
max_y	Upper bound for y_column_name . Must be greater than or equal to min_y .
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 is non-existent, it will be automatically created. The default value is an empty Dictionary.

Definition at line 245 of file FilterByBox.cs.

Property Documentation

◆ max_x

double kinetica.FilterByBoxRequest.max_x

getset

Upper bound for FilterByBoxRequest.x_column_name.

Must be greater than or equal to FilterByBoxRequest.min_x.

Definition at line 103 of file FilterByBox.cs.

◆ max_y

double kinetica.FilterByBoxRequest.max_y

getset

Upper bound for FilterByBoxRequest.y_column_name.

Must be greater than or equal to FilterByBoxRequest.min_y.

Definition at line 120 of file FilterByBox.cs.

◆ min_x

double kinetica.FilterByBoxRequest.min_x

getset

Lower bound for the column chosen by FilterByBoxRequest.x_column_name.

Must be less than or equal to FilterByBoxRequest.max_x.

Definition at line 97 of file FilterByBox.cs.

◆ min_y

double kinetica.FilterByBoxRequest.min_y

getset

Lower bound for FilterByBoxRequest.y_column_name.

Must be less than or equal to FilterByBoxRequest.max_y.

Definition at line 114 of file FilterByBox.cs.

◆ options

IDictionary< string, string > kinetica.FilterByBoxRequest.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 FilterByBoxRequest.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 FilterByBoxRequest.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 is non-existent, it will be automatically created.

The default value is an empty Dictionary.

Definition at line 167 of file FilterByBox.cs.

◆ table_name

string kinetica.FilterByBoxRequest.table_name

getset

Name of the table on which the bounding box operation will be performed, in [schema_name.

]table_name format, using standard name resolution rules.

Must be an existing table.

Definition at line 76 of file FilterByBox.cs.

◆ view_name

string kinetica.FilterByBoxRequest.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 86 of file FilterByBox.cs.

◆ x_column_name

string kinetica.FilterByBoxRequest.x_column_name

getset

Name of the column on which to perform the bounding box query.

Must be a valid numeric column.

Definition at line 91 of file FilterByBox.cs.

◆ y_column_name

string kinetica.FilterByBoxRequest.y_column_name

getset

Name of a column on which to perform the bounding box query.

Must be a valid numeric column.

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

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ FilterByBoxRequest() [1/4]

​◆ FilterByBoxRequest() [2/4]

​◆ FilterByBoxRequest() [3/4]

​◆ FilterByBoxRequest() [4/4]

​Property Documentation

​◆ max_x

​◆ max_y

​◆ min_x

​◆ min_y

​◆ options

​◆ table_name

​◆ view_name

​◆ x_column_name

​◆ y_column_name

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterByBoxRequest() [1/4]

◆ FilterByBoxRequest() [2/4]

◆ FilterByBoxRequest() [3/4]

◆ FilterByBoxRequest() [4/4]

Property Documentation

◆ max_x

◆ max_y

◆ min_x

◆ min_y

◆ options

◆ table_name

◆ view_name

◆ x_column_name

◆ y_column_name