Delete Command¶
The CityDB Tool provides a delete command to remove features from the 3DCityDB database.
The delete command offers flexible options for filtering, committing changes, managing indexes, and metadata logging.
Usage¶
General Options¶
| Option | Description | Default Value |
|---|---|---|
[@<filename>...] |
Specify one or more argument files containing options. | |
--temp-dir=<dir> |
Directory to store temporary files during the delete operation. | |
-m, --delete-mode=<mode> |
Delete mode: delete (hard delete) or terminate (logical delete). |
terminate |
--index-mode=<mode> |
Index mode: keep, drop, or drop_create. Dropping indexes can improve performance for large deletes. |
keep |
--preview |
Run the command in preview mode. Features will not actually be deleted. | |
-c, --commit=<number> |
Commit changes after deleting this number of features. | None |
--config-file=<file> |
Load configuration options from the specified file. | |
-L, --log-level=<level> |
Set the logging level: fatal, error, warn, info, debug, trace. |
info |
--log-file=<file> |
Write log messages to the specified file. | |
--pid-file=<file> |
Create a file containing the process ID. | |
--plugins=<dir> |
Load plugins from the specified directory. | |
--use-plugins=<plugin> |
Enable/disable specific plugins using their fully qualified class names. | true |
Metadata Options¶
| Option | Description | Default Value |
|---|---|---|
--lineage=<lineage> |
Specify the lineage information for the deleted features. | None |
--updating-person=<name> |
Name of the user responsible for the delete operation. | Database user |
--reason-for-update=<reason> |
Provide a reason for deleting the data. | None |
Query and Filter Options¶
| Option | Description | Default Value |
|---|---|---|
-t, --type-name=<name> |
Specify feature names to process. Example: CityFurniture. |
None |
-f, --filter=<cql2-text> |
Apply a CQL2 filter to retrieve specific features. | None |
--filter-crs=<crs> |
SRID or CRS identifier for the filter geometries. | Storage CRS |
--sql-filter=<sql> |
Use an SQL query to filter features. | None |
--limit=<count> |
Limit the number of features to process. Example: 1000. |
None |
--start-index=<index> |
Start processing features from a specific index. Example: 10. |
0 |
Database Connection Options¶
The CityDB Tool requires a connection to a 3DCityDB database for all operations, including the delete command. Database connection details, such as host, port, schema, and credentials, must be provided to ensure the tool can interact with the database successfully.
These options are shared across all commands in the CityDB Tool, as a connection is essential every time data is queried, deleted, imported, or exported.
For details on how to configure database connections, including host, port, schema, and credentials, refer to the Database Connection Options documentation This section provides a comprehensive explanation of all available connection parameters.
Examples¶
Basic Delete¶
Delete features using default settings:
Preview Delete Operation¶
Run the delete command in preview mode to check which features would be deleted without performing the actual operation:
Delete Specific Features¶
Delete specific features using a CQL2 filter:
Delete with Metadata¶
Delete features and provide lineage information and a reason for the operation:
Delete with Commit¶
Delete features and commit changes after deleting 1000 features:
Delete with Custom Temporary Directory¶
Specify a custom directory for storing temporary files during the delete operation:
Delete with SQL Filter¶
Delete features using an SQL query to filter specific records:
Limit the Number of Features to Process¶
Delete a limited number of features, starting from index 10: