A set of parameters for Kinetica.filterByBoxGeometry. More…
Classes | |
| struct | Options |
| A set of string constants for the parameter FilterByBoxGeometryRequest.options. More… | |
Public Member Functions | |
| FilterByBoxGeometryRequest () | |
| Constructs a FilterByBoxGeometryRequest object with default parameters. | |
| FilterByBoxGeometryRequest (string table_name, string view_name, string column_name, double min_x, double max_x, double min_y, double max_y, IDictionary< string, string > options=null) | |
| Constructs a FilterByBoxGeometryRequest object with the specified parameters. | |
| FilterByBoxGeometryRequest () | |
| Constructs a FilterByBoxGeometryRequest object with default parameters. | |
| FilterByBoxGeometryRequest (string table_name, string view_name, string column_name, double min_x, double max_x, double min_y, double max_y, IDictionary< string, string > options=null) | |
| Constructs a FilterByBoxGeometryRequest 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 | column_name [get, set] |
| Name of the geospatial geometry column to be filtered. | |
| double | min_x [get, set] |
| Lower bound for the x-coordinate of the rectangular box. | |
| double | max_x [get, set] |
| Upper bound for the x-coordinate of the rectangular box. | |
| double | min_y [get, set] |
| Lower bound for the y-coordinate of the rectangular box. | |
| double | max_y [get, set] |
| Upper bound for the y-coordinate of the rectangular box. | |
| 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.filterByBoxGeometry.
Calculates which geospatial geometry objects from a table intersect 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 FilterByBoxGeometryRequest.view_name is passed in as part of the input payload.
Definition at line 21 of file FilterByBoxGeometry.cs.
Constructor & Destructor Documentation
◆ FilterByBoxGeometryRequest() [1/4]
| inline |
Constructs a FilterByBoxGeometryRequest object with default parameters.
Definition at line 168 of file FilterByBoxGeometry.cs.
◆ FilterByBoxGeometryRequest() [2/4]
| inline |
Constructs a FilterByBoxGeometryRequest 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 ”. |
| column_name | Name of the geospatial geometry column to be filtered. |
| min_x | Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to max_x . |
| max_x | Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to min_x . |
| min_y | Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to max_y . |
| max_y | Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to min_y . |
| options | Optional parameters.
|
Definition at line 241 of file FilterByBoxGeometry.cs.
◆ FilterByBoxGeometryRequest() [3/4]
| inline |
Constructs a FilterByBoxGeometryRequest object with default parameters.
Definition at line 168 of file FilterByBoxGeometry.cs.
◆ FilterByBoxGeometryRequest() [4/4]
| inline |
Constructs a FilterByBoxGeometryRequest 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 ”. |
| column_name | Name of the geospatial geometry column to be filtered. |
| min_x | Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to max_x . |
| max_x | Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to min_x . |
| min_y | Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to max_y . |
| max_y | Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to min_y . |
| options | Optional parameters.
|
Definition at line 241 of file FilterByBoxGeometry.cs.
Property Documentation
◆ column_name
| getset |
Name of the geospatial geometry column to be filtered.
Definition at line 93 of file FilterByBoxGeometry.cs.
◆ max_x
| getset |
Upper bound for the x-coordinate of the rectangular box.
Must be greater than or equal to FilterByBoxGeometryRequest.min_x.
Definition at line 105 of file FilterByBoxGeometry.cs.
◆ max_y
| getset |
Upper bound for the y-coordinate of the rectangular box.
Must be greater than or equal to FilterByBoxGeometryRequest.min_y.
Definition at line 117 of file FilterByBoxGeometry.cs.
◆ min_x
| getset |
Lower bound for the x-coordinate of the rectangular box.
Must be less than or equal to FilterByBoxGeometryRequest.max_x.
Definition at line 99 of file FilterByBoxGeometry.cs.
◆ min_y
| getset |
Lower bound for the y-coordinate of the rectangular box.
Must be less than or equal to FilterByBoxGeometryRequest.max_y.
Definition at line 111 of file FilterByBoxGeometry.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 FilterByBoxGeometryRequest.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 FilterByBoxGeometryRequest.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 164 of file FilterByBoxGeometry.cs.
◆ 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 79 of file FilterByBoxGeometry.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 89 of file FilterByBoxGeometry.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/FilterByBoxGeometry.cs
- Kinetica/Protocol/FilterByBoxGeometry.cs