Kinetica C# API
Version 7.1.10.0
|
A set of parameters for Kinetica.filterByBox(string,string,string,double,double,string,double,double,IDictionary{string, string}). More...
Classes | |
struct | Options |
Optional parameters. More... | |
Public Member Functions | |
FilterByBoxRequest () | |
Constructs a FilterByBoxRequest object with default parameters. More... | |
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. More... | |
![]() | |
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 on which the bounding box operation will be performed, in [schema_name. More... | |
string | view_name [get, set] |
If provided, then this will be the name of the view containing the results, in [schema_name. More... | |
string | x_column_name = "" [get, set] |
Name of the column on which to perform the bounding box query. More... | |
double | min_x [get, set] |
Lower bound for the column chosen by . More... | |
double | max_x [get, set] |
Upper bound for . More... | |
string | y_column_name [get, set] |
Name of a column on which to perform the bounding box query. More... | |
double | min_y [get, set] |
Lower bound for . More... | |
double | max_y [get, set] |
Upper bound for . More... | |
IDictionary< string, string > | options [get, set] |
Optional parameters. More... | |
![]() | |
Schema | Schema [get] |
Avro Schema for this class More... | |
Additional Inherited Members | |
![]() | |
static RecordSchema | SchemaFromType (System.Type t, KineticaType ktype=null) |
Create an Avro Schema from a System.Type and a KineticaType. More... | |
A set of parameters for Kinetica.filterByBox(string,string,string,double,double,string,double,double,IDictionary{string, string}).
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 view_name is passed in as part of the input payload.
Definition at line 28 of file FilterByBox.cs.
|
inline |
Constructs a FilterByBoxRequest object with default parameters.
Definition at line 192 of file FilterByBox.cs.
|
inline |
Constructs a FilterByBoxRequest object with the specified 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 . Must be less than or equal to . |
max_x | Upper bound for . Must be greater than or equal to . |
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 . Must be less than or equal to . |
max_y | Upper bound for . Must be greater than or equal to . |
options | Optional parameters.
|
Definition at line 265 of file FilterByBox.cs.
|
getset |
|
getset |
|
getset |
Lower bound for the column chosen by .
Must be less than or equal to .
Definition at line 128 of file FilterByBox.cs.
|
getset |
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 187 of file FilterByBox.cs.
|
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 110 of file FilterByBox.cs.
|
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 119 of file FilterByBox.cs.
|
getset |
Name of the column on which to perform the bounding box query.
Must be a valid numeric column.
Definition at line 123 of file FilterByBox.cs.
|
getset |
Name of a column on which to perform the bounding box query.
Must be a valid numeric column.
Definition at line 138 of file FilterByBox.cs.