Fast/Unload with an external sort package - Revision history

JAL: add template

2015-03-11T19:45:23Z

add template

← Older revision		Revision as of 19:45, 11 March 2015
Line 168:		Line 168:

	==See also==		==See also==
	[[Fast/Unload ~~overview#WIKFUN$$topics\|Fast/Unload topics]]~~		{{Template:Fast/Unload topic list}}

JAL: /* Using SORT FIELDS */ add usable special vars and remove exception special vars

2015-03-10T20:29:36Z

Using SORT FIELDS: add usable special vars and remove exception special vars

← Older revision		Revision as of 20:29, 10 March 2015
Line 87:		Line 87:
	In addition to the standard form of the <var>SORT FIELDS</var> statement		In addition to the standard form of the <var>SORT FIELDS</var> statement
	(explicitly specifying start position, length, and format),		(explicitly specifying start position, length, and format),
	<var class="product">Fast/Unload</var> provides a shorthand for specifying field positions in an		<var class="product">Fast/Unload</var> provides a shorthand for specifying field positions in an output record:
	output record:
	If you specify a field name as part of the <var>SORT FIELDS</var>		If you specify a field name as part of the <var>SORT FIELDS</var>
	statement, <var class="product">Fast/Unload</var> will replace the name(s) of the field(s) with the		statement, <var class="product">Fast/Unload</var> will replace the name(s) of the field(s) with the
	starting position, length, and format in the output record.		starting position, length, and format in the output record.

	In addition, you can specify a %variable or a special variable ~~(except~~		In addition, you can specify a %variable or the special variables listed below as a shorthand for specifying the position of that %variable or special variable in an output record.
	~~for~~ <var>#~~RECOUT~~</var>, <var>#~~OUTPOS~~</var>, <var>#~~OUTLEN~~</var>~~, and~~ <var>#~~UPARM~~</var>~~) as a shorthand for specifying the position of that %variable or special variable in an output record.~~		The special variables usable in <var>SORT FIELDS</var> are:
	<p class="note"><b>Note:</b> ~~This~~ shorthand is designed for relatively simple FUEL programs.		<ul>
			<li><var>#ERROR</var> </li>
			<li><var>#RECIN</var> </li>
			<li><var>#GRPMEM</var> </li>
			<li><var>#GRPSIZ</var> </li>
			</ul>
			<p class="note"><b>Note:</b> Such a shorthand is designed for relatively simple FUEL programs.
	It is <b>not</b> available if the FUEL program		It is <b>not</b> available if the FUEL program
	contains more than one <var>OUT TO</var> stream.		contains more than one <var>OUT TO</var> stream.
Line 121:		Line 126:

	<div id="srtrec"></div>		<div id="srtrec"></div>

	==Using SORT RECORD==		==Using SORT RECORD==
	<!--Caution: <div> above-->		<!--Caution: <div> above-->

JAL: more conversion cleanup

2015-02-23T21:16:49Z

more conversion cleanup

Show changes

DmeWiccan: Automatically generated page update

2015-01-15T19:40:12Z

Automatically generated page update

← Older revision		Revision as of 19:40, 15 January 2015
Line 26:		Line 26:
	==Specifying the sort==		==Specifying the sort==
	For a UAI stream, you indicate that the output is to be sorted by using the		For a UAI stream, you indicate that the output is to be sorted by using the
	SORT keyword on the UAI statement (see [[#uai\|UNLOAD ALL INFORMATION or UAI]]).		SORT keyword on the UAI statement (see [[Fast/Unload Extraction Language (FUEL)#uai\|UNLOAD ALL INFORMATION or UAI]]).
	The only independent SORT directives you may use are the		The only independent SORT directives you may use are the
	OPTION statement (at most one per stream) and the PGM statement		OPTION statement (at most one per stream) and the PGM statement
Line 71:		Line 71:
	once in a FUEL program.		once in a FUEL program.
	You can also customize <var class="product">Fast/Unload</var> to change the default SORT program name (see		You can also customize <var class="product">Fast/Unload</var> to change the default SORT program name (see
	[[#dfspgm\|Default SORT program name]]).		[[Fast/Unload customization of defaults#dfspgm\|Default SORT program name]]).
	</ul>		</ul>

DmeWiccan: Automatically generated page update

2015-01-14T00:49:14Z

Automatically generated page update

New page

Instead of having data for a particular output stream go directly to
an output data set, it can be passed first to a SORT routine.
This has the following advantages over sorting that data in a separate step:
<ul>
<li>A total time savings, because sort processing and record extraction
processing are overlapped.
<li>A disk space savings, because the intermediate output data set that
would be used to pass data from <var class="product">Fast/Unload</var> to your sort package is eliminated.
</ul>

Prior to version 4.1, any SORT
directives apply to the single output stream, FUNOUT, and there is no
"TO destination" qualifier on such directives.

As of version 4.1 and the advent of multiple output streams in a single
FUEL program, a SORT directive may indicate the output stream to which it
applies:
<nowiki>SORT TO destination ...
</nowiki>

The destination ties the SORT directive to the output stream
that has the same destination declared in an OUT TO or UAI TO directive.
These directives can occur in any order in your FUEL program.
==Specifying the sort==
For a UAI stream, you indicate that the output is to be sorted by using the
SORT keyword on the UAI statement (see [[#uai|UNLOAD ALL INFORMATION or UAI]]).
The only independent SORT directives you may use are the
OPTION statement (at most one per stream) and the PGM statement
(at most one per program).

For a non-UAI stream (one declared with an "OUT TO destination" directive),
to pass data to a SORT routine you must code two or more SORT statements
before the start of the FOR EACH RECORD loop in your FUEL program.
<var class="product">Fast/Unload</var> interprets the information on a SORT directive as a control statement to
be passed to your SORT package (not including the TO destination qualifier).

The SORT FIELDS ([[#srtflds|Using SORT FIELDS]]) and SORT RECORD ([[#srtrec|Using SORT RECORD]])
statements are required for <var class="product">Fast/Unload</var>
to pass data to a SORT routine.
In addition to these required SORT statements, <var class="product">Fast/Unload</var> also supports
the following statements:
<ul>
<li>MODS
<li>DEBUG
<li>ALTSEQ
<li>SUM
<li>INCLUDE
<li>OMIT
<li>OPTION
<li>OUTREC
<li>INREC
</ul>

In addition:
<ul>
<li>When using a 31-bit extended parameter list to pass data to the
sort package,
any other sort statement accepted by your sort package can be used.
For more information on using 31-bit parameter lists
see the documentation on the SORTP parameter and also see [[Fast/Unload customization of defaults]].
<li>You can identify your sort program
by using the following form of the SORT statement:
<nowiki>SORT PGM=pgmname
</nowiki>
where pgmname is the name of your sort program
(the default name is SORT).
This form of the SORT statement does not allow
the "TO destination" qualifier, and it may occur at most
once in a FUEL program.
You can also customize <var class="product">Fast/Unload</var> to change the default SORT program name (see
[[#dfspgm|Default SORT program name]]).
</ul>

<div id="srtflds"></div>
==Using SORT FIELDS==


Since SORT FIELDS is a sort statement,
one would expect to have to
code the <var class="product">Fast/Unload</var> version of this as &oq.SORT [TO destination] SORT FIELDS,&cq.
where the first &oq.SORT&cq.
indicates to <var class="product">Fast/Unload</var> that what follows is a sort statement, and the second
&oq.SORT&cq. is part of the actual sort statement.
While this is, in fact, permitted,
<var class="product">Fast/Unload</var> will also allow you to specify simply &oq.SORT FIELDS&cq. as a shorthand.

In addition to the standard form of the SORT FIELDS statement
(explicitly specifying start position, length, and format),
<var class="product">Fast/Unload</var> provides a shorthand for specifying field positions in an
output record:
If you specify a fieldname as part of the SORT FIELDS
statement, <var class="product">Fast/Unload</var> will replace the name(s) of the field(s) with the
starting position, length, and format in the output record.

In addition, you can specify a %variable or a special variable (except
for #RECOUT, #OUTPOS, #OUTLEN, and #UPARM) as a shorthand for specifying
the position of that %variable or special variable in an output record.
<blockquote class="note">Note: This shorthand is designed for relatively simple FUEL programs.
It is not available if the FUEL program
contains more than one OUT TO stream.
In that case, you must use the standard form of SORT FIELDS.
</blockquote>


For example, if you code
<nowiki>SORT FIELDS=(FIELD1,A)
</nowiki>
and later in your program you code
<nowiki>PUT FIELD1 AT 15 AS STRING(10)
</nowiki>
<var class="product">Fast/Unload</var> will pass
<nowiki>SORT FIELDS=(15,10,CH,A)
</nowiki>
to the sort package if the record format is fixed, or
<nowiki>SORT FIELDS=(19,10,CH,A)
</nowiki>
if the format is variable.
The <code>19</code> position in the statement above also illustrates the fact
that <var class="product">Fast/Unload</var> does not
consider the RDW (Record Descriptor Word) as part of the output record, while
sorts do consider the RDW as part of the input record.

Constant occurrence
numbers are valid with the field names in the SORT FIELDS statement, while
(loop control variable or %variable) variable occurrences are not.

<div id="srtrec"></div>
==Using SORT RECORD==


<var class="product">Fast/Unload</var> uses the SORT RECORD statement to determine the output record format
and length.

For example,
<var class="product">Fast/Unload</var> produces fixed length records with a length of 300
if you code:
<nowiki>SORT RECORD TYPE=F,LENGTH=(300)
</nowiki>

The blocksize
used is the largest valid blocksize less than or equal to 4096,
or it is the record length, if the record length exceeds 4096.
For example, if <code>TYPE=F,LENGTH=(300)</code>,
the blocksize is 3900.
If <code>TYPE=V,LENGTH=(300)</code>, the blocksize
is 4096.
If <code>TYPE=V,LENGTH=8000</code>, the blocksize is 8000.

Data passed between <var class="product">Fast/Unload</var> and the sort package is
buffered, and the number of buffers used is set by the value of NOBUFF.
==Sample code==
The following program is an example of the use of an external sort package with
<var class="product">Fast/Unload</var>.
<nowiki>OPEN BIGFILE
SORT TO SBIGFILE FIELDS=(KEY1,A,KEY3,D),EQUALS
SORT TO SBIGFILE RECORD TYPE=F,LENGTH=(100)
SORT TO SBIGFILE ALTSEQ -
CODE=(F0B0,F1B1,F2B2,F3B3,F4B4,F5B5,F6B6,F7B7,F8B8,F9B9)
OUT TO SBIGFILE DEFAULT
FOR EACH RECORD
PUT KEY1 AS STRING 10
PUT KEY2 AS STRING 10
PUT KEY3 AS FIXED 4
PUT DATA(*) AS STRING(10)
OUTPUT
END FOR
</nowiki>
In this example, the SORT FIELDS statement passed to the sort would be
<nowiki>SORT FIELDS=(1,10,CH,A,21,4,BI,D),EQUALS
</nowiki>
==See also==
[[Fast/Unload overview#WIKFUN$$topics|Fast/Unload topics]]