kinetica.FilterByGeometryRequest

A set of parameters for Kinetica.filterByGeometry. More…

Inheritance diagram for kinetica.FilterByGeometryRequest:

Collaboration diagram for kinetica.FilterByGeometryRequest:

Classes
struct	Operation
	A set of string constants for the parameter FilterByGeometryRequest.operation. More…

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

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

	FilterByGeometryRequest (string table_name, string view_name, string column_name, string input_wkt, string operation, IDictionary< string, string > options=null)
	Constructs a FilterByGeometryRequest object with the specified parameters.

	FilterByGeometryRequest ()
	Constructs a FilterByGeometryRequest object with default parameters.

	FilterByGeometryRequest (string table_name, string view_name, string column_name, string input_wkt, string operation, IDictionary< string, string > options=null)
	Constructs a FilterByGeometryRequest 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 geometry 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 column to be used in the filter.

string	input_wkt = "" `[get, set]`
	A geometry in WKT format that will be used to filter the objects in FilterByGeometryRequest.table_name.

string	operation `[get, set]`
	The geometric filtering operation to perform.

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

Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by FilterByGeometryRequest.input_wkt.

Definition at line 17 of file FilterByGeometry.cs.

Constructor & Destructor Documentation

◆ FilterByGeometryRequest() [1/4]

kinetica.FilterByGeometryRequest.FilterByGeometryRequest ( )

inline

Constructs a FilterByGeometryRequest object with default parameters.

Definition at line 244 of file FilterByGeometry.cs.

◆ FilterByGeometryRequest() [2/4]

kinetica.FilterByGeometryRequest.FilterByGeometryRequest	(	string	table_name,
		string	view_name,
		string	column_name,
		string	input_wkt,
		string	operation,
		IDictionary< string, string >	options = null )

inline

Constructs a FilterByGeometryRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the filter by geometry will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.
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 column to be used in the filter. Must be a geospatial geometry column.
input_wkt	A geometry in WKT format that will be used to filter the objects in table_name . The default value is ”.
operation	The geometric filtering operation to perform. Supported values: CONTAINS: Matches records that contain the given WKT in input_wkt , i.e. the given WKT is within the bounds of a record’s geometry. CROSSES: Matches records that cross the given WKT. DISJOINT: Matches records that are disjoint from the given WKT. EQUALS: Matches records that are the same as the given WKT. INTERSECTS: Matches records that intersect the given WKT. OVERLAPS: Matches records that overlap the given WKT. TOUCHES: Matches records that touch the given WKT. WITHIN: Matches records that are within the given WKT.
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 371 of file FilterByGeometry.cs.

◆ FilterByGeometryRequest() [3/4]

kinetica.FilterByGeometryRequest.FilterByGeometryRequest ( )

inline

Constructs a FilterByGeometryRequest object with default parameters.

Definition at line 244 of file FilterByGeometry.cs.

◆ FilterByGeometryRequest() [4/4]

kinetica.FilterByGeometryRequest.FilterByGeometryRequest	(	string	table_name,
		string	view_name,
		string	column_name,
		string	input_wkt,
		string	operation,
		IDictionary< string, string >	options = null )

inline

Constructs a FilterByGeometryRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the filter by geometry will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.
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 column to be used in the filter. Must be a geospatial geometry column.
input_wkt	A geometry in WKT format that will be used to filter the objects in table_name . The default value is ”.
operation	The geometric filtering operation to perform. Supported values: CONTAINS: Matches records that contain the given WKT in input_wkt , i.e. the given WKT is within the bounds of a record’s geometry. CROSSES: Matches records that cross the given WKT. DISJOINT: Matches records that are disjoint from the given WKT. EQUALS: Matches records that are the same as the given WKT. INTERSECTS: Matches records that intersect the given WKT. OVERLAPS: Matches records that overlap the given WKT. TOUCHES: Matches records that touch the given WKT. WITHIN: Matches records that are within the given WKT.
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 371 of file FilterByGeometry.cs.

Property Documentation

◆ column_name

string kinetica.FilterByGeometryRequest.column_name

getset

Name of the column to be used in the filter.

Must be a geospatial geometry column.

Definition at line 125 of file FilterByGeometry.cs.

◆ input_wkt

string kinetica.FilterByGeometryRequest.input_wkt = ""

getset

A geometry in WKT format that will be used to filter the objects in FilterByGeometryRequest.table_name.

The default value is ”.

Definition at line 130 of file FilterByGeometry.cs.

◆ operation

string kinetica.FilterByGeometryRequest.operation

getset

The geometric filtering operation to perform.

Supported values:

CONTAINS: Matches records that contain the given WKT in FilterByGeometryRequest.input_wkt, i.e. the given WKT is within the bounds of a record’s geometry.
CROSSES: Matches records that cross the given WKT.
DISJOINT: Matches records that are disjoint from the given WKT.
EQUALS: Matches records that are the same as the given WKT.
INTERSECTS: Matches records that intersect the given WKT.
OVERLAPS: Matches records that overlap the given WKT.
TOUCHES: Matches records that touch the given WKT.
WITHIN: Matches records that are within the given WKT.

Definition at line 193 of file FilterByGeometry.cs.

◆ options

IDictionary< string, string > kinetica.FilterByGeometryRequest.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 FilterByGeometryRequest.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 FilterByGeometryRequest.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 240 of file FilterByGeometry.cs.

◆ table_name

string kinetica.FilterByGeometryRequest.table_name

getset

Name of the table on which the filter by geometry will be performed, in [schema_name.

]table_name format, using standard name resolution rules.

Must be an existing table or view containing a geospatial geometry column.

Definition at line 111 of file FilterByGeometry.cs.

◆ view_name

string kinetica.FilterByGeometryRequest.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 121 of file FilterByGeometry.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/FilterByGeometry.cs
Kinetica/Protocol/FilterByGeometry.cs

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ FilterByGeometryRequest() [1/4]

​◆ FilterByGeometryRequest() [2/4]

​◆ FilterByGeometryRequest() [3/4]

​◆ FilterByGeometryRequest() [4/4]

​Property Documentation

​◆ column_name

​◆ input_wkt

​◆ operation

​◆ options

​◆ table_name

​◆ view_name

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterByGeometryRequest() [1/4]

◆ FilterByGeometryRequest() [2/4]

◆ FilterByGeometryRequest() [3/4]

◆ FilterByGeometryRequest() [4/4]

Property Documentation

◆ column_name

◆ input_wkt

◆ operation

◆ options

◆ table_name

◆ view_name