Delete configuration

The configuration settings for the delete command are shown below.

Tip

The names and purposes of the JSON properties align closely with their counterparts in the command-line options. Where applicable, the description of each JSON property links to the command-line option for more details.

{
  "deleteOptions": {
    "mode": "terminate",
    "terminateWithSubFeatures": true,
    "terminationDate": "2018-07-01T00:00:00",
    "lineage": "myLineage",
    "updatingPerson": "myUpdatingPerson",
    "reasonForUpdate": "myReasonForUpdate",
    "query": {...},
    "validityOptions": {...}
  }
}

General delete options

Property	Description	Default value
"mode"	Delete mode: delete, terminate.	terminate
"terminateWithSub Features"	Also terminate sub-features.	true
"terminationDate"	Time in <YYYY-MM-DD> or <YYYY-MM-DDThh:mm:ss[(+|-)hh:mm]> format to use as termination date.	now
"lineage"	Lineage to use for the features.
"updatingPerson"	Name of the user responsible for the import.	database user
"reasonForUpdate"	Reason for importing the data.

Query options

The "query" property is a container object for the following query and filtering options.

{
  "query": {
    "featureTypes": [ // (1)!
      {
        "name": "bldg:Building"
      },
      {
        "name": "Road",
        "namespace": "http://3dcitydb.org/3dcitydb/transportation/5.0"
      }
    ],
    "filter": {
      "op": "s_intersects",
      "args": [
        {
          "property": "core:envelope"
        },
        {
          "bbox": [10.0,10.0,20.0,20.0]
        }
      ]
    },
    "filterSrs": { // (2)!
      "srid": 4326,
      "identifier": "http://www.opengis.net/def/crs/EPSG/0/4326"
    },
    "countLimit": {
      "limit": 1000,
      "startIndex": 20
    }
  }
}

1. The "name" property is mandatory. To avoid ambiguity, use the format "prefix:name" with a namespace alias as prefix or specify the full namespace using the "namespace" property.
2. Use either "srid", "identifier", or both to define the target CRS.

Property	Description	Default value
"featureTypes"	Array of JSON objects specifying the features to process. Each object must include the "name" of the feature type. To avoid ambiguity, use the format "prefix:name" with a namespace alias or specify the full namespace using the "namespace" property.
"filter"	A CQL2 filter expression, encoded as CQL2 text or JSON.
"filterSrs"	Specifies a CRS for filter geometries that differs from the 3DCityDB CRS. Use the "srid" or "identifier" property to define the filter CRS.
"countLimit"	The "limit" property sets the maximum number of features to export, and the "startIndex" property defines the 0-based index within the result set to export.

Validity options

The "validityOptions" property is a container object for filtering features based on their validity.

{
  "validityOptions": {
    "mode": "valid",
    "reference": "database",
    "at": "2018-07-01",
    "lenient": false
  }
}

Property	Description	Default value
"mode"	Process features by validity: valid, invalid, all.	valid
"at"	Check validity at a specific point in time. If provided, the time must be in <YYYY-MM-DD> or <YYYY-MM-DDThh:mm:ss[(+|-)hh:mm]> format.
"reference"	Validity time reference: database, realWorld.	database
"lenient"	Ignore incomplete validity intervals of features.	false