If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
documents	—	specifies the documents to delete. Only documents whose version number is less than or equal to the specified version number will be deleted. If no version number is specified, then the specified documents are deleted regardless of their version number.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
output	—	specifies the output table in which to store results of the action.

Parameter Descriptions

commitOption="APPEND" | "COPY"

specifies how to update the compound store tables.

Default	COPY

APPEND

appends updated data to existing tables. This value is faster but keeps older, obsolete rows in the table.

COPY

for relevant tables in the compound store, copies existing data, deletes obsolete data, and adds new data.

compoundStore={compoundStore}

specifies the table names and CAS library to use for the compound store across sessions.

Long form	compoundStore={caslib="string"}
Shortcut form	compoundStore="string"

The compoundStore value can be one or more of the following:

caslib="string"

specifies the CAS library in which to create or find the tables. This library must be a global library.

compoundTable="string"

specifies the name of the CAS table in which to store compounds.

Default	"rtengCmpd"

copies=integer

specifies the number of redundant copies to keep. A value of 0 is fastest but disables failover when a worker fails.

Default	1
Minimum value	0

documentTable="string"

specifies the name of the CAS table in which to store documents.

Default	"rtengDoc"

entityTable="string"

specifies the name of the CAS table in which to store entities.

Default	"rtengEntity"

lockTable="string"

specifies the name of the CAS table to use for preventing access to the compound store by other sessions while an action is running. This table is used internally and should never be created by the user.

Default	"rtengLock"

metadataTable="string"

specifies the name of the CAS table in which to store the metadata, including the element, compound, and entity definitions.

Default	"rtengMeta"

documentLinks={{documentLinks-1} <, {documentLinks-2}, ...>}

specifies the document links to delete. Each link consists of two documents, and each document must be fully specified by its ID and type.

The documentLinks value can be one or more of the following:

* documentId1="string"

specifies the ID of the first document of the link.

* documentId2="string"

specifies the ID of the second document of the link.

* documentType1="string"

specifies the type of the first document of the link.

* documentType2="string"

specifies the type of the second document of the link.

documents={{docTypeIdVersion-1} <, {docTypeIdVersion-2}, ...>} | {castable}

specifies the documents to delete. Only documents whose version number is less than or equal to the specified version number will be deleted. If no version number is specified, then the specified documents are deleted regardless of their version number.

The docTypeIdVersion value is specified as follows:

* documentId="string"

specifies the ID of the document.

* documentType="string"

specifies the type of the document.

version=64-bit-integer

specifies the maximum version number of the document to delete.

Default	INT64_MAX

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	FALSE

computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias	compVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases	options
Aliases	dataSource

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

whereTable={groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

output={casouttable}

specifies the output table in which to store results of the action.

For more information about specifying the output parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputCompoundValue=TRUE | FALSE

when set to True, includes in the output table the compound_value column that contains a concatenation of the element values that make up the compound value.

Default	FALSE

outputSubEntityId=TRUE | FALSE

when set to True, includes the _subentity_id_ column in the output table that contains a subentity ID as determined by temporal splitting. By default, this is set to True if temporal splitting is enabled for an entity soft-delete, otherwise it is set to False.

Default	FALSE

splitConflictingEntities={{entitySplit-1} <, {entitySplit-2}, ...>}

specifies the conditions under which an entity should be split.

The entitySplit value can be one or more of the following:

* conflictingCompoundValue={conflictingCompound}

specifies the rules under which an entity should be split on the basis of compound values.

The conflictingCompound value can be one or more of the following:

compoundTypes={"string-1" <, "string-2", ...>}

specifies the types of compounds whose values must be consistent within an entity. If an entity contains different values for a compound type in this list, the entity will split into one or more entities such that each entity contains one value for each compound type in this list.

doNotSplit={{docAndCmpdType-1} <, {docAndCmpdType-2}, ...>}

specifies the pairs consisting of a document type and a compound type that should not be split during entity splitting.

The docAndCmpdType value can be one or more of the following:

* compoundType="string"

specifies the compound type.

* documentType="string"

specifies the document type.

* entityType="string"

specifies the type of entity to which the entity splitting rule applies.

deleteDocuments Action

Delete documents from a compound store.

Lua Syntax
Summary: Input and Output Tables
Parameter Descriptions

Lua Syntax

results, info = s:rteng_deleteDocuments{

commitOption="APPEND" | "COPY",

compoundStore={

caslib="string",

compoundTable="string",

copies=integer,

documentTable="string",

entityTable="string",

lockTable="string",

metadataTable="string"

documentLinks={{

documentId1="string",

documentId2="string",

documentType1="string",

documentType2="string"

}, {...}},

documents={{docTypeIdVersion-1} <, {docTypeIdVersion-2}, ...>} | {castable},

output={

caslib="string",

compress=true | false,

indexVars={"variable-name-1" <, "variable-name-2", ...>},

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=true | false,

replace=true | false,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

where={"string-1" <, "string-2", ...>}

outputCompoundValue=true | false,

outputSubEntityId=true | false,

splitConflictingEntities={{

conflictingCompoundValue={

compoundTypes={"string-1" <, "string-2", ...>}

doNotSplit={{

compoundType="string",

documentType="string"

}, {...}}

entityType="string"

}, {...}}

}

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
documents	—	specifies the documents to delete. Only documents whose version number is less than or equal to the specified version number will be deleted. If no version number is specified, then the specified documents are deleted regardless of their version number.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
output	—	specifies the output table in which to store results of the action.

Parameter Descriptions

commitOption="APPEND" | "COPY"

specifies how to update the compound store tables.

Default	COPY

APPEND

appends updated data to existing tables. This value is faster but keeps older, obsolete rows in the table.

COPY

for relevant tables in the compound store, copies existing data, deletes obsolete data, and adds new data.

compoundStore={compoundStore}

specifies the table names and CAS library to use for the compound store across sessions.

Long form	compoundStore={caslib="string"}
Shortcut form	compoundStore="string"

The compoundStore value can be one or more of the following:

caslib="string"

specifies the CAS library in which to create or find the tables. This library must be a global library.

compoundTable="string"

specifies the name of the CAS table in which to store compounds.

Default	"rtengCmpd"

copies=integer

specifies the number of redundant copies to keep. A value of 0 is fastest but disables failover when a worker fails.

Default	1
Minimum value	0

documentTable="string"

specifies the name of the CAS table in which to store documents.

Default	"rtengDoc"

entityTable="string"

specifies the name of the CAS table in which to store entities.

Default	"rtengEntity"

lockTable="string"

Default	"rtengLock"

metadataTable="string"

specifies the name of the CAS table in which to store the metadata, including the element, compound, and entity definitions.

Default	"rtengMeta"

documentLinks={{documentLinks-1} <, {documentLinks-2}, ...>}

specifies the document links to delete. Each link consists of two documents, and each document must be fully specified by its ID and type.

The documentLinks value can be one or more of the following:

* documentId1="string"

specifies the ID of the first document of the link.

* documentId2="string"

specifies the ID of the second document of the link.

* documentType1="string"

specifies the type of the first document of the link.

* documentType2="string"

specifies the type of the second document of the link.

documents={{docTypeIdVersion-1} <, {docTypeIdVersion-2}, ...>} | {castable}

The docTypeIdVersion value is specified as follows:

* documentId="string"

specifies the ID of the document.

* documentType="string"

specifies the type of the document.

version=64-bit-integer

specifies the maximum version number of the document to delete.

Default	INT64_MAX

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=true | false

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	false

computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

Alias	compVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases	options
Aliases	dataSource

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

whereTable={groupbytable}

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

output={casouttable}

specifies the output table in which to store results of the action.

For more information about specifying the output parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputCompoundValue=true | false

when set to True, includes in the output table the compound_value column that contains a concatenation of the element values that make up the compound value.

Default	false

outputSubEntityId=true | false

Default	false

splitConflictingEntities={{entitySplit-1} <, {entitySplit-2}, ...>}

specifies the conditions under which an entity should be split.

The entitySplit value can be one or more of the following:

* conflictingCompoundValue={conflictingCompound}

specifies the rules under which an entity should be split on the basis of compound values.

The conflictingCompound value can be one or more of the following:

compoundTypes={"string-1" <, "string-2", ...>}

doNotSplit={{docAndCmpdType-1} <, {docAndCmpdType-2}, ...>}

specifies the pairs consisting of a document type and a compound type that should not be split during entity splitting.

The docAndCmpdType value can be one or more of the following:

* compoundType="string"

specifies the compound type.

* documentType="string"

specifies the document type.

* entityType="string"

specifies the type of entity to which the entity splitting rule applies.

deleteDocuments Action

Delete documents from a compound store.

Python Syntax
Summary: Input and Output Tables
Parameter Descriptions

Python Syntax

results=s.rteng.deleteDocuments(

commitOption="APPEND" | "COPY",

compoundStore={

"caslib":"string",

"compoundTable":"string",

"copies":integer,

"documentTable":"string",

"entityTable":"string",

"lockTable":"string",

"metadataTable":"string"

documentLinks=[{

"documentId1":"string",

"documentId2":"string",

"documentType1":"string",

"documentType2":"string"

}<, {...}>],

documents=[{docTypeIdVersion-1} <, {docTypeIdVersion-2}, ...>] | {castable},

output={

"caslib":"string",

"compress":True | False,

"indexVars":["variable-name-1" <, "variable-name-2", ...>],

"label":"string",

"lifetime":64-bit-integer,

"maxMemSize":64-bit-integer,

"memoryFormat":"DVR" | "INHERIT" | "STANDARD",

"name":"table-name",

"promote":True | False,

"replace":True | False,

"replication":integer,

"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",

"threadBlockSize":64-bit-integer,

"timeStamp":"string",

"where":["string-1" <, "string-2", ...>]

outputCompoundValue=True | False,

outputSubEntityId=True | False,

splitConflictingEntities=[{

"conflictingCompoundValue":{

"compoundTypes":["string-1" <, "string-2", ...>]

"doNotSplit":[{

"compoundType":"string",

"documentType":"string"

}<, {...}>]

"entityType":"string"

}<, {...}>]

)

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
documents	—	specifies the documents to delete. Only documents whose version number is less than or equal to the specified version number will be deleted. If no version number is specified, then the specified documents are deleted regardless of their version number.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
output	—	specifies the output table in which to store results of the action.

Parameter Descriptions

commitOption="APPEND" | "COPY"

specifies how to update the compound store tables.

Default	COPY

APPEND

appends updated data to existing tables. This value is faster but keeps older, obsolete rows in the table.

COPY

for relevant tables in the compound store, copies existing data, deletes obsolete data, and adds new data.

compoundStore={compoundStore}

specifies the table names and CAS library to use for the compound store across sessions.

Long form	compoundStore={"caslib":"string"}
Shortcut form	compoundStore="string"

The compoundStore value can be one or more of the following:

"caslib":"string"

specifies the CAS library in which to create or find the tables. This library must be a global library.

"compoundTable":"string"

specifies the name of the CAS table in which to store compounds.

Default	"rtengCmpd"

"copies":integer

specifies the number of redundant copies to keep. A value of 0 is fastest but disables failover when a worker fails.

Default	1
Minimum value	0

"documentTable":"string"

specifies the name of the CAS table in which to store documents.

Default	"rtengDoc"

"entityTable":"string"

specifies the name of the CAS table in which to store entities.

Default	"rtengEntity"

"lockTable":"string"

Default	"rtengLock"

"metadataTable":"string"

specifies the name of the CAS table in which to store the metadata, including the element, compound, and entity definitions.

Default	"rtengMeta"

documentLinks=[{documentLinks-1} <, {documentLinks-2}, ...>]

specifies the document links to delete. Each link consists of two documents, and each document must be fully specified by its ID and type.

The documentLinks value can be one or more of the following:

* "documentId1":"string"

specifies the ID of the first document of the link.

* "documentId2":"string"

specifies the ID of the second document of the link.

* "documentType1":"string"

specifies the type of the first document of the link.

* "documentType2":"string"

specifies the type of the second document of the link.

documents=[{docTypeIdVersion-1} <, {docTypeIdVersion-2}, ...>] | {castable}

The docTypeIdVersion value is specified as follows:

* "documentId":"string"

specifies the ID of the document.

* "documentType":"string"

specifies the type of the document.

"version":64-bit-integer

specifies the maximum version number of the document to delete.

Default	INT64_MAX

The castable value can be one or more of the following:

"caslib":"string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

"computedOnDemand":True | False

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	False

"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

Alias	compVars

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"computedVarsProgram":"string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

specifies data source options.

Aliases	options
Aliases	dataSource

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import_

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the input table.

"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variables to use in the action.

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"where":"where-expression"

specifies an expression for subsetting the input data.

"whereTable":{groupbytable}

The groupbytable value can be one or more of the following:

"casLib":"string"

specifies the caslib for the filter table. By default, the active caslib is used.

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import_

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the filter table.

"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"where":"where-expression"

specifies an expression for subsetting the data from the filter table.

output={casouttable}

specifies the output table in which to store results of the action.

For more information about specifying the output parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputCompoundValue=True | False

when set to True, includes in the output table the compound_value column that contains a concatenation of the element values that make up the compound value.

Default	False

outputSubEntityId=True | False

Default	False

splitConflictingEntities=[{entitySplit-1} <, {entitySplit-2}, ...>]

specifies the conditions under which an entity should be split.

The entitySplit value can be one or more of the following:

* "conflictingCompoundValue":{conflictingCompound}

specifies the rules under which an entity should be split on the basis of compound values.

The conflictingCompound value can be one or more of the following:

"compoundTypes":["string-1" <, "string-2", ...>]

"doNotSplit":[{docAndCmpdType-1} <, {docAndCmpdType-2}, ...>]

specifies the pairs consisting of a document type and a compound type that should not be split during entity splitting.

The docAndCmpdType value can be one or more of the following:

* "compoundType":"string"

specifies the compound type.

* "documentType":"string"

specifies the document type.

* "entityType":"string"

specifies the type of entity to which the entity splitting rule applies.

deleteDocuments Action

Delete documents from a compound store.

R Syntax
Summary: Input and Output Tables
Parameter Descriptions

R Syntax

results <– cas.rteng.deleteDocuments(s,

commitOption="APPEND" | "COPY",

compoundStore=list(

caslib="string",

compoundTable="string",

copies=integer,

documentTable="string",

entityTable="string",

lockTable="string",

metadataTable="string"

documentLinks=list( list(

documentId1="string",

documentId2="string",

documentType1="string",

documentType2="string"

) <, list(...)>),

documents=list( list(docTypeIdVersion-1) <, list(docTypeIdVersion-2), ...>) | list(castable),

output=list(

caslib="string",

compress=TRUE | FALSE,

indexVars=list("variable-name-1" <, "variable-name-2", ...>),

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

where=list("string-1" <, "string-2", ...>)

outputCompoundValue=TRUE | FALSE,

outputSubEntityId=TRUE | FALSE,

splitConflictingEntities=list( list(

conflictingCompoundValue=list(

compoundTypes=list("string-1" <, "string-2", ...>)

doNotSplit=list( list(

compoundType="string",

documentType="string"

) <, list(...)>)

entityType="string"

) <, list(...)>)

)

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
documents	—	specifies the documents to delete. Only documents whose version number is less than or equal to the specified version number will be deleted. If no version number is specified, then the specified documents are deleted regardless of their version number.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
output	—	specifies the output table in which to store results of the action.

Parameter Descriptions

commitOption="APPEND" | "COPY"

specifies how to update the compound store tables.

Default	COPY

APPEND

appends updated data to existing tables. This value is faster but keeps older, obsolete rows in the table.

COPY

for relevant tables in the compound store, copies existing data, deletes obsolete data, and adds new data.

compoundStore=list(compoundStore)

specifies the table names and CAS library to use for the compound store across sessions.

Long form	compoundStore=list(caslib="string")
Shortcut form	compoundStore="string"

The compoundStore value can be one or more of the following:

caslib="string"

specifies the CAS library in which to create or find the tables. This library must be a global library.

compoundTable="string"

specifies the name of the CAS table in which to store compounds.

Default	"rtengCmpd"

copies=integer

specifies the number of redundant copies to keep. A value of 0 is fastest but disables failover when a worker fails.

Default	1
Minimum value	0

documentTable="string"

specifies the name of the CAS table in which to store documents.

Default	"rtengDoc"

entityTable="string"

specifies the name of the CAS table in which to store entities.

Default	"rtengEntity"

lockTable="string"

Default	"rtengLock"

metadataTable="string"

specifies the name of the CAS table in which to store the metadata, including the element, compound, and entity definitions.

Default	"rtengMeta"

documentLinks=list( list(documentLinks-1) <, list(documentLinks-2), ...>)

specifies the document links to delete. Each link consists of two documents, and each document must be fully specified by its ID and type.

The documentLinks value can be one or more of the following:

* documentId1="string"

specifies the ID of the first document of the link.

* documentId2="string"

specifies the ID of the second document of the link.

* documentType1="string"

specifies the type of the first document of the link.

* documentType2="string"

specifies the type of the second document of the link.

documents=list( list(docTypeIdVersion-1) <, list(docTypeIdVersion-2), ...>) | {castable}

The docTypeIdVersion value is specified as follows:

* documentId="string"

specifies the ID of the document.

* documentType="string"

specifies the type of the document.

version=64-bit-integer

specifies the maximum version number of the document to delete.

Default	INT64_MAX

The castable value can be one or more of the following:

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	FALSE

computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

Alias	compVars

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias	compPgm

dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)

specifies data source options.

Aliases	options
Aliases	dataSource

importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variables to use in the action.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

whereTable=list(groupbytable)

The groupbytable value can be one or more of the following:

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variable names to use from the filter table.

The casinvardesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

output=list(casouttable)

specifies the output table in which to store results of the action.

For more information about specifying the output parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputCompoundValue=TRUE | FALSE

when set to True, includes in the output table the compound_value column that contains a concatenation of the element values that make up the compound value.

Default	FALSE

outputSubEntityId=TRUE | FALSE

Default	FALSE

splitConflictingEntities=list( list(entitySplit-1) <, list(entitySplit-2), ...>)

specifies the conditions under which an entity should be split.

The entitySplit value can be one or more of the following:

* conflictingCompoundValue=list(conflictingCompound)

specifies the rules under which an entity should be split on the basis of compound values.

The conflictingCompound value can be one or more of the following:

compoundTypes=list("string-1" <, "string-2", ...>)

doNotSplit=list( list(docAndCmpdType-1) <, list(docAndCmpdType-2), ...>)

specifies the pairs consisting of a document type and a compound type that should not be split during entity splitting.

The docAndCmpdType value can be one or more of the following:

* compoundType="string"

specifies the compound type.

* documentType="string"

specifies the document type.

* entityType="string"

specifies the type of entity to which the entity splitting rule applies.

Last updated: November 23, 2025