A set of parameters for Kinetica.filterByRange. More…
Classes | |
| struct | Options |
| A set of string constants for the parameter FilterByRangeRequest.options. More… | |
Public Member Functions | |
| FilterByRangeRequest () | |
| Constructs a FilterByRangeRequest object with default parameters. | |
| FilterByRangeRequest (string table_name, string view_name, string column_name, double lower_bound, double upper_bound, IDictionary< string, string > options=null) | |
| Constructs a FilterByRangeRequest object with the specified parameters. | |
| FilterByRangeRequest () | |
| Constructs a FilterByRangeRequest object with default parameters. | |
| FilterByRangeRequest (string table_name, string view_name, string column_name, double lower_bound, double upper_bound, IDictionary< string, string > options=null) | |
| Constructs a FilterByRangeRequest 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 filter by range 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 | column_name [get, set] |
| Name of a column on which the operation would be applied. | |
| double | lower_bound [get, set] |
| Value of the lower bound (inclusive). | |
| double | upper_bound [get, set] |
| Value of the upper bound (inclusive). | |
| 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.filterByRange.
Calculates which objects from a table have a column that is within the given bounds. An object from the table identified by FilterByRangeRequest.table_name is added to the view FilterByRangeRequest.view_name if its column is within [FilterByRangeRequest.lower_bound, FilterByRangeRequest.upper_bound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
Definition at line 27 of file FilterByRange.cs.
Constructor & Destructor Documentation
◆ FilterByRangeRequest() [1/4]
| inline |
Constructs a FilterByRangeRequest object with default parameters.
Definition at line 155 of file FilterByRange.cs.
◆ FilterByRangeRequest() [2/4]
| inline |
Constructs a FilterByRangeRequest object with the specified parameters.
| table_name | Name of the table on which the filter by range 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 ”. |
| column_name | Name of a column on which the operation would be applied. |
| lower_bound | Value of the lower bound (inclusive). |
| upper_bound | Value of the upper bound (inclusive). |
| options | Optional parameters.
|
Definition at line 220 of file FilterByRange.cs.
◆ FilterByRangeRequest() [3/4]
| inline |
Constructs a FilterByRangeRequest object with default parameters.
Definition at line 155 of file FilterByRange.cs.
◆ FilterByRangeRequest() [4/4]
| inline |
Constructs a FilterByRangeRequest object with the specified parameters.
| table_name | Name of the table on which the filter by range 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 ”. |
| column_name | Name of a column on which the operation would be applied. |
| lower_bound | Value of the lower bound (inclusive). |
| upper_bound | Value of the upper bound (inclusive). |
| options | Optional parameters.
|
Definition at line 220 of file FilterByRange.cs.
Property Documentation
◆ column_name
| getset |
Name of a column on which the operation would be applied.
Definition at line 98 of file FilterByRange.cs.
◆ lower_bound
| getset |
Value of the lower bound (inclusive).
Definition at line 101 of file FilterByRange.cs.
◆ options
| 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 FilterByRangeRequest.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:The default value is FALSE.
- COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of FilterByRangeRequest.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 151 of file FilterByRange.cs.
◆ table_name
| getset |
Name of the table on which the filter by range operation will be performed, in [schema_name.
]table_name format, using standard name resolution rules.
Must be an existing table.
Definition at line 84 of file FilterByRange.cs.
◆ upper_bound
| getset |
Value of the upper bound (inclusive).
Definition at line 104 of file FilterByRange.cs.
◆ 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 94 of file FilterByRange.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/FilterByRange.cs
- Kinetica/Protocol/FilterByRange.cs