filterByGeometry - Kinetica Docs

◆ filterByGeometry() [1/4]

FilterByGeometryResponse gpudb::GPUdb::filterByGeometry ( const FilterByGeometryRequest & request_ ) const

Applies a geometry filter against a geospatial geometry column in a given table or view.

The filtering geometry is provided by inputWkt.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

◆ filterByGeometry() [2/4]

FilterByGeometryResponse & gpudb::GPUdb::filterByGeometry	(	const FilterByGeometryRequest &	request_,
		FilterByGeometryResponse &	response_ ) const

Applies a geometry filter against a geospatial geometry column in a given table or view.

The filtering geometry is provided by inputWkt.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

◆ filterByGeometry() [3/4]

FilterByGeometryResponse gpudb::GPUdb::filterByGeometry	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	columnName,
		const std::string &	inputWkt,
		const std::string &	operation,
		const std::map< std::string, std::string > &	options ) const

Applies a geometry filter against a geospatial geometry column in a given table or view.

The filtering geometry is provided by inputWkt.

Parameters

[in]	tableName	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.
[in]	viewName	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 ”.
[in]	columnName	Name of the column to be used in the filter. Must be a geospatial geometry column.
[in]	inputWkt	A geometry in WKT format that will be used to filter the objects in tableName. The default value is ”.
[in]	operation	The geometric filtering operation to perform. Supported values: filter_by_geometry_contains: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record’s geometry. filter_by_geometry_crosses: Matches records that cross the given WKT. filter_by_geometry_disjoint: Matches records that are disjoint from the given WKT. filter_by_geometry_equals: Matches records that are the same as the given WKT. filter_by_geometry_intersects: Matches records that intersect the given WKT. filter_by_geometry_overlaps: Matches records that overlap the given WKT. filter_by_geometry_touches: Matches records that touch the given WKT. filter_by_geometry_within: Matches records that are within the given WKT.
[in]	options	Optional parameters. filter_by_geometry_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. 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: filter_by_geometry_true filter_by_geometry_false The default value is filter_by_geometry_false. filter_by_geometry_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use 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 map.

Returns

Response object containing the result of the operation.

◆ filterByGeometry() [4/4]

FilterByGeometryResponse & gpudb::GPUdb::filterByGeometry	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	columnName,
		const std::string &	inputWkt,
		const std::string &	operation,
		const std::map< std::string, std::string > &	options,
		FilterByGeometryResponse &	response_ ) const

Applies a geometry filter against a geospatial geometry column in a given table or view.

The filtering geometry is provided by inputWkt.

Parameters

[in]	tableName	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.
[in]	viewName	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 ”.
[in]	columnName	Name of the column to be used in the filter. Must be a geospatial geometry column.
[in]	inputWkt	A geometry in WKT format that will be used to filter the objects in tableName. The default value is ”.
[in]	operation	The geometric filtering operation to perform. Supported values: filter_by_geometry_contains: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record’s geometry. filter_by_geometry_crosses: Matches records that cross the given WKT. filter_by_geometry_disjoint: Matches records that are disjoint from the given WKT. filter_by_geometry_equals: Matches records that are the same as the given WKT. filter_by_geometry_intersects: Matches records that intersect the given WKT. filter_by_geometry_overlaps: Matches records that overlap the given WKT. filter_by_geometry_touches: Matches records that touch the given WKT. filter_by_geometry_within: Matches records that are within the given WKT.
[in]	options	Optional parameters. filter_by_geometry_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. 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: filter_by_geometry_true filter_by_geometry_false The default value is filter_by_geometry_false. filter_by_geometry_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use 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 map.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

​◆ filterByGeometry() [1/4]

​◆ filterByGeometry() [2/4]

​◆ filterByGeometry() [3/4]

​◆ filterByGeometry() [4/4]

◆ filterByGeometry() [1/4]

◆ filterByGeometry() [2/4]

◆ filterByGeometry() [3/4]

◆ filterByGeometry() [4/4]