Delete Features

CARIS Batch : HPD Processes : Delete Features

Delete Features

The DeleteFeatures process deletes features in the output with the same primary key as features in the input. By default, a feature object identifier (FOID) is used as the primary key, but an attribute value can also be used.

The process uses a one-to-one match between feature identifiers or attributes. DeleteFeatures will fail with a many-to-one or a one-to-many match.

This process cannot delete collection objects.

Input

HOB file, HPD workspace or product, feature layer. Also, any chart that is opened through OGR.

Output

HOB file or HPD URI. The HPD URI must specify the usage to be updated and the project that is used to update the usage.

If output is an HPD URI, a check is initiated to ensure that the user running the process has privileges to certify data as deleted. Only users with the following roles can run this process if the output is an HPD URI:

• Product Editor

• Paper Chart Editor

• QA (self-check)

Syntax

carisbatch --run DeleteFeatures [options] <input> <output>

Parameters

Key

Parameter

Description

Can Repeat

Notes

-m

--match-by

The primary key. A feature object identifier is used as the primary key but an attribute acronym can also be used.

The process deletes features in the output with the same primary keys as the input features.

FALSE

Optional

-P

--proposed-deletion

A flag to indicate that features are marked for deletion (rather than actually deleted). This parameter is for formats that support proposed deletion, such as HPD features.

FALSE

Optional

Example

To use this process, refer to the following example.

Example
Objective	Mark features in an HPD usage for deletion that match the sor_id value in the LIGHTS.shp file.
Description		Command Line Syntax
Input file		`LIGHTS.shp`
HPD URI		hpd://username:password@OracleDB/UsageId/5/ProjectId/3
Primary key		sor_id
Command Line	carisbatch --run DeleteFeatures --proposed-deletion --match-by sor_id D:\LIGHTS.shp hpd://username:password@OracleDB/UsageId/5/ProjectId/3
Result	The features in the HPD usage that match features with the same sor_id value in the Shapefie are marked for deletion (but not actually deleted).