Class %iKnow.Model.listQuery

deprecatedclass %iKnow.Model.listQuery extends %iKnow.Model.list

For details on using this class, see NLP Domains.

Subclass of %iKnow.Model.list dedicated to represent lists for the SQL Lister. This class has its own set of properties representing the specific Lister parameters of the SQL Lister and hence is easier to use than the generic list class. Any <parameter> elements nested within this element will be overwritten with the values specified for the corresponding shorthand attributes.

See also %iKnow.Source.SQL.Lister for more details on these Lister Parameters.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	7

Summary

Properties
batchMode	configuration	converter	data
dataFields	disabled	groupField	idField
listerClass	listname	metadataColumns	metadataFields
metadataValues	parameters	processor	sql

Methods
%AddToSaveSet	%BindExport	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Extends	%GetParameter	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified	%OriginalNamespace
%PackageName	%QuoteList	%QuoteValue	%QuoteValueL10N
%RemoveFromSaveSet	%SerializeObject	%SetModified	%Validate
%ValidateObject	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType

Parameters

• parameter XMLNAME = "query";

This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

• property dataFields as %String(MAXLEN=250,XMLPROJECTION="attribute");

The column names selected by query containing the actual data to be indexed.

• property groupField as %String(MAXLEN=250,XMLPROJECTION="attribute");

The column name selected by query containing the group name to use for constructing the external ID for a loaded source.

• property idField as %String(MAXLEN=250,XMLPROJECTION="attribute");

The column name selected by query containing the local reference to use for constructing the external ID for a loaded source.

• property listerClass as %String(MAXLEN=250,XMLPROJECTION="attribute") [ InitialExpression = "%iKnow.Source.SQL.Lister",ReadOnly ];

The Lister class to use for loading data defined in this list element. This class should extend %iKnow.Source.Lister. The Lister class defined here dictates the contents of the parameters property.

• property metadataColumns as %String(MAXLEN=1000,XMLPROJECTION="attribute");

The column names selected by query containing any metadata values to be stored with loaded sources.

• property metadataFields as %String(MAXLEN=1000,XMLPROJECTION="attribute");

The names of the metadata fields positionally corresponding to the columns identified in metadataColumns. If left empty, the column names in metadataColumns are expected to correspond to metadata field names themselves.

• property sql as %String(MAXLEN=2000,XMLPROJECTION="attribute");

The query to run for retrieving sources to process.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search