complexType "etl:TargetObjectType"

Namespace:	http://labkey.org/etl/xml
Content:	complex, 14 attributes, 3 elements
Defined:	globally in etl.xsd, see XML source
Includes:	definitions of 14 attributes and 3 elements
Used:	at 1 location

XML Representation Summary

<...

batchColumn

string

batchSize

nonNegativeInteger : "0"

boolean

string

string

string

string

string

string

string

string

("merge" | "append" | "truncate") : "append"

type

("query" | "file") : "query"

useTransaction

boolean : "true"

Content:

etl:alternateKeys? × etl:columnTransforms? × etl:constants?

</...>

Content Model Elements (3):

etl:alternateKeys (in etl:destination),

etl:columnTransforms (in etl:destination),

etl:constants (type etl:ConstantsType)

All Direct / Indirect Based Elements (1):

etl:destination (in etl:transform)

Known Usage Locations

As direct type of elements (1):

etl:destination (in etl:transform)

Annotation

Targets will be of type 'query' (the default), or 'file'. For query, the schemaName and queryName attributes are required. For file, the fileBaseName and fileExtension attributes are required.

XML Source (see within schema source)

Targets will be of type 'query' (the default), or 'file'. For query, the schemaName and queryName attributes are required. For file, the fileBaseName and fileExtension attributes are required.

</documentation>

</annotation>

<all>

</all>

Bulk loads minimize the logging for auditing purposes and other overhead.

</documentation>

</annotation>

</attribute>

The base name to use for an output target file. Special substitutions:
'${TransformRunId}' will be substituted with the transformRunId.
'${Timestamp}' will be substituted with the timestamp at file creation.

</documentation>

</annotation>

</attribute>

Optional (required for pipeline usage), the extension for the output target file. A leading dot is optional; there will always be a dot separator between the file basename and extension

</documentation>

</annotation>

</attribute>

Character to qualify text when a field contains the column or row delimiter

</documentation>

</annotation>

</attribute>

Wrap writing to target query in a transaction. Not used when target is a file.

</documentation>

</annotation>

</attribute>

Formerly called "transactionSize". For query targets, incrementally commit target transaction every n rows instead of in a single wrapping transaction.
For file targets, instead of writing a single file, create a new file every n rows. Each will be the fileBaseName + "-1", "-2", etc, + fileExtension

</documentation>

</annotation>

</attribute>

If specified, rather than count individual rows for the batchSize, use this as a sentinel field, and only increment the count of a current batch when the value in this field changes.
If the name of the relevant column is being mapped via columnTransforms, use the target name, not the source name.

</documentation>

</annotation>

</attribute>

</complexType>

Attribute Detail

batchColumn

Type:	string, predefined
Use:	optional
Defined:	locally, within (this) etl:TargetObjectType complexType

If specified, rather than count individual rows for the batchSize, use this as a sentinel field, and only increment the count of a current batch when the value in this field changes. If the name of the relevant column is being mapped via columnTransforms, use the target name, not the source name.

XML Source (see within schema source)

</documentation>

</annotation>

</attribute>

batchSize

Type:	nonNegativeInteger, predefined
Use:	optional
Default:	"0"
Defined:	locally, within (this) etl:TargetObjectType complexType

Formerly called "transactionSize". For query targets, incrementally commit target transaction every n rows instead of in a single wrapping transaction. For file targets, instead of writing a single file, create a new file every n rows. Each will be the fileBaseName + "-1", "-2", etc, + fileExtension

XML Source (see within schema source)

</documentation>

</annotation>

</attribute>

bulkLoad

Type:	boolean, predefined
Use:	optional
Defined:	locally, within (this) etl:TargetObjectType complexType

Bulk loads minimize the logging for auditing purposes and other overhead.

XML Source (see within schema source)

Bulk loads minimize the logging for auditing purposes and other overhead.

</documentation>

</annotation>

</attribute>

columnDelimiter

Type:	string, predefined
Use:	optional
Defined:	locally, within (this) etl:TargetObjectType complexType

XML Source (see within schema source)

dir

Type:	string, predefined
Use:	optional
Defined:	locally, within (this) etl:TargetObjectType complexType

XML Source (see within schema source)

fileBaseName

Type:	string, predefined
Use:	optional
Defined:	locally, within (this) etl:TargetObjectType complexType

The base name to use for an output target file. Special substitutions: '${TransformRunId}' will be substituted with the transformRunId. '${Timestamp}' will be substituted with the timestamp at file creation.

XML Source (see within schema source)

</documentation>

</annotation>

</attribute>

fileExtension

Type:	string, predefined
Use:	optional
Defined:	locally, within (this) etl:TargetObjectType complexType

Optional (required for pipeline usage), the extension for the output target file. A leading dot is optional; there will always be a dot separator between the file basename and extension

XML Source (see within schema source)

Optional (required for pipeline usage), the extension for the output target file. A leading dot is optional; there will always be a dot separator between the file basename and extension

</documentation>

</annotation>

</attribute>

queryName

Type:	string, predefined
Use:	optional
Defined:	locally, within (this) etl:TargetObjectType complexType

XML Source (see within schema source)

quote

Type:	string, predefined
Use:	optional
Defined:	locally, within (this) etl:TargetObjectType complexType

Character to qualify text when a field contains the column or row delimiter

XML Source (see within schema source)

Character to qualify text when a field contains the column or row delimiter

</documentation>

</annotation>

</attribute>

rowDelimiter

Type:	string, predefined
Use:	optional
Defined:	locally, within (this) etl:TargetObjectType complexType

XML Source (see within schema source)

schemaName

Type:	string, predefined
Use:	optional
Defined:	locally, within (this) etl:TargetObjectType complexType

XML Source (see within schema source)

targetOption

Type:	etl:TargetOptionType
Use:	optional
Default:	"append"
Defined:	locally, within (this) etl:TargetObjectType complexType

XML Source (see within schema source)

type

Type:	etl:TargetTypeType
Use:	optional
Default:	"query"
Defined:	locally, within (this) etl:TargetObjectType complexType

XML Source (see within schema source)

useTransaction

Type:	boolean, predefined
Use:	optional
Default:	"true"
Defined:	locally, within (this) etl:TargetObjectType complexType

Wrap writing to target query in a transaction. Not used when target is a file.

XML Source (see within schema source)

Wrap writing to target query in a transaction. Not used when target is a file.

</documentation>

</annotation>

</attribute>

Content Element Detail

etl:alternateKeys

Type:	etl:AlternateKeysType, complex content
Defined:	locally, within (this) etl:TargetObjectType complexType

XML Source (see within schema source)

etl:columnTransforms

Type:	etl:ColumnTransformsType, complex content
Defined:	locally, within (this) etl:TargetObjectType complexType

XML Source (see within schema source)

etl:constants

Type:	etl:ConstantsType, complex content
Defined:	locally, within (this) etl:TargetObjectType complexType

XML Source (see within schema source)

This XML schema documentation has been generated with DocFlex/XML RE 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set.

DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.

DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).

A commercial license for "DocFlex/XML XSDDoc" will allow you:

To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
To use certain features disabled in the free mode (such as the full documenting of substitution groups).
To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
To document local element components both globally and locally (similar to attributes).
To enable/disable reproducing of namespace prefixes.
To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
To use the same template to generate the incredible quality RTF documentation.
To document only selected XML schema components specified by name.
To remove this very advertisement text

Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!

But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!

Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!

To buy a license, please follow this link: http://www.filigris.com/shop/