Delete Records component

Delete Records component icon

The Delete Records component uses the Data Ingest Web Service (DIWS) to delete complete records from the Endeca data domain. The component can delete multiple records in a single transaction. Two options are available to select the records to delete:

You can input a data array that defines the assignments to use to select the records to delete.
You can enter an Endeca Query Language (EQL) record specifier (WHERE clause) to select the records to delete.

These options are mutually exclusive. If you choose to use an EQL record specifier to select the records to delete, you cannot also use an input array.

Using an input array to select records to delete

An input array is only necessary if you choose not to use an EQL query. You can also use an input array to support an EQL query. For details, see "Using EQL" below.

The metadata schema of the input array for the Delete Records component is an arbitrary array of property names and values that specify the records to delete. The first row of the input array is the record header row and defines the names of the properties to use to select the records to delete.

Attributes are joined using an AND operator. Thus, the fewer properties included in the input array, the more general the selection and the more records will be deleted. Conversely, the more properties included in the input array, the more specific the selection and the fewer records will be deleted.

For the examples below, assume the following schema has been defined in the data domain:

DimGeography_GeographyKey|DimGeography_City|DimGeography_StateProvinceCode|DimGeography_StateProvinceName|DimGeography_CountryRegionCode|DimGeography_CountryRegionName|DimGeography_PostalCode

If the following array is input, Integrator deletes all records where the value of the DimGeography_StateProvinceName property is Alabama:
```
DimGeography_StateProvinceName
Alabama
```
If the following array is input, Integrator deletes records where the value of the DimGeography_City property is Newton and the value of the DimGeography_StateProvinceName is British Columbia
```
DimGeography_City|DimGeography_StateProvinceName
Newton|British Columbia
```
If the following array is input, Integrator deletes records where the value of the DimGeography_City property is Newton and the value of the DimGeography_StateProvinceName is British Columbia and the value of the DimGeography_PostalCode is V2M1P1
```
DimGeography_City|DimGeography_StateProvinceName|DimGeography_PostalCode
Newton|British Columbia|V2M1P1
```

Using EQL to select records to delete

You can use an Endeca Query Language ( EQL) record specifier (the WHERE clause of an EQL query) to select the records to delete. For example: "DimGeography_City"='Newton' AND "DimGeography_StateProvinceName"='British Columbia' selects records where the value of the DimGeography_City property is Newton and the value of the DimGeography_StateProvinceName is British Columbia.

Note: Standard practice in EQL is to use double quotation marks around attribute names and single quotation marks around attribute values.

You can also use an input array to support an EQL record specifier. Use variables to specify the input properties. For example, if you input the following array:

City|StateProvince
Newton|British Columbia
Townsville|Queensland
Longmont|Coloradoe

You could enter the following EQL:"DimGeography_City"=$input.City and "DimGeography_StateProvinceName"=$input.StateProvince.

For full details about Endeca Query Language, see the Oracle Endeca Server EQL Guide.

Configuration properties

Note: For details about visual properties for all connectors, see Visual properties of components. For details about configuration properties common to all connectors, see Common configuration properties of components.

The following table describes the configuration properties available for the Delete Records component.

Table 1. Delete Records component properties
Name	Description	Valid Values	Example
Endeca Server Host	Identifies the machine on which the Endeca Server is running.	The name or IP address of the machine. You can use `localhost`.	`MyEndecaServer` `255.255.255.0`
Endeca Server Port	Identifies the port on which the Endeca Server is listening.	Valid ports. The default Endeca Server port is 7001, but it can be changed to another port.	`7001`
Endeca Server Context Root	Identifies the WebLogic application root context of the Endeca Server	Valid root context names in WebLogic	`/endeca-server`
Data Domain Name	Name of the data domain that will be modified. The data domain should be running when the graph containing the connector is run.	Valid data domain names	`quickstart`
Record Set Specifier Attributes	Specifies the input attributes to use to select the records on which to operate	Attributes available from the input metadata
Use EQL Record Set Specifier	Specifies whether to use an EQL expression to select the records on which to operate. Standard EQL practice is to use double quotation marks around attribute names and single quotation marks around attribute values.	Unchecked (false) Checked (true)	`"DimGeography_City"='Newton' AND "DimGeography_StateProvinceName"='British Columbia'`
EQL Record Set Specifier	The EQL expression to use to select the records on which to operate.	A valid EQL expression
SSL Enabled	Enables or disables SSL for the component. SSL should only be enabled when the Endeca Server to which you are connecting has SSL enabled.	Checked (True) Unchecked (False)
Batch Size	Specifies the batch size (in bytes) for the ingest operation. A batch consists of one or more complete records. See also Batch size adjustments by connectors.	A positive integer equal to or greater than 1 defines the batch size. If the batch size is too small to fit the last record in the batch, the size is reset to accommodate that record. The batch size then returns to the specified batch size. Specifying zero (0) or a negative integer turns off batching. When batching is turned off, records are submitted to the data domain one at a time.	`1000000` `0`
Multi-assign delimiter	Sets the character that separates multi-assign values in a property in a source record. Keep in mind that this delimiter is different from the delimiter that separates property fields on the source record. See also Multi-assign delimiter.	A single character that is the multi-assign delimiter. The default is the Unicode DELETE character (\U007F). You do not have to use this field if your data does not include multi-assign properties.
Maximum number of failed batches	Sets the maximum number of batches that can fail before the ingest operation is ended.	Either a 0 (allows no failed batches) or a positive integer.	15

Output Ports

Each Information Discovery component that modifies record data in the data domain (adding or removing records or key/value pairs) has two output ports:

Port 0 returns status information describing batches of records that were successfully ingested.
Port 1 returns error information describing batches of records that the data domain failed to ingest. Each output record to the port corresponds to a failed batch, not to individual records.

Table 2. Port 0 metadata
Port Field Name	Data Type	Description	Example
Start Row	Long	ID of starting row of the batch	00001
End Row	Long	ID of ending row of the batch	99999
Number of Records Deleted	Long	Number of records deleted from the data domain as a whole	42683
Number of Records Affected	Long	Number of records from which key/value pairs (assignments) have been removed, while retaining the rest of the record	19834
Time Taken in Seconds	Numeric	Total time to process the batch, in seconds	127

Table 3. Port 1 metadata
Port Field Name	Data Type	Description	Example
Start Row	Long	ID of starting row of the batch	00001
End Row	Long	ID of ending row of the batch	99999
Fault Message	String	Error message returned by the Endeca Server