Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HPCC-32470 Document OUTPUT and BUILD support for PLANE option #19078

Merged
merged 1 commit into from
Sep 25, 2024
Merged

HPCC-32470 Document OUTPUT and BUILD support for PLANE option #19078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 36 additions & 10 deletions docs/EN_US/ECLLanguageReference/ECLR_mods/BltInFunc-BUILD.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,12 @@
<para>The following options are available on all three INDEX forms of
BUILD (only):</para>

<para><emphasis role="bold">[, CLUSTER<indexterm>
<para><emphasis role="bold">[, CLUSTER <indexterm>
<primary>CLUSTER</primary>
</indexterm>(</emphasis><emphasis> target </emphasis><emphasis
role="bold">) ] | [ , PLANE <indexterm>
<primary>PLANE</primary>
</indexterm>(</emphasis><emphasis> targetPlane </emphasis><emphasis
role="bold">)] [, SORTED<indexterm>
<primary>SORTED</primary>
</indexterm>] [, DISTRIBUTE<indexterm>
Expand Down Expand Up @@ -253,20 +256,43 @@
written to disk is always determined by the number of nodes in
the cluster on which the workunit executes, regardless of the
number of nodes on the target cluster(s) unless the WIDTH option
is also specified.</entry>
is also specified. Use this option for bare-metal deployments.
</entry>
</row>

<row>
<entry><emphasis>target</emphasis></entry>

<entry>A comma-delimited list of string constants containing the
names of the clusters to write the
<emphasis>indexfile</emphasis> to. The names must be listed as
they appear on the ECL Watch Activity page or returned by the
Std.System.Thorlib.Group() function, optionally with square
brackets containing a comma-delimited list of node-numbers
(1-based) and/or ranges (specified with a dash, as in n-m) to
indicate the specific set of nodes to write to.</entry>
names of the clusters to write the indexfile to. The names must
be listed as they appear on the ECL Watch Activity page or
returned by the Std.System.Thorlib.Group() function, optionally
with square brackets containing a comma-delimited list of
node-numbers (1-based) and/or ranges (specified with a dash, as
in n-m) to indicate the specific set of nodes to write
to.</entry>
</row>

<row>
<entry><emphasis role="bold">PLANE</emphasis></entry>

<entry>Specifies writing the <emphasis>indexfile</emphasis> to
the specified list of target planes. If omitted, the
<emphasis>indexfile</emphasis> is written to the default plane.
Planes are used by containerized systems, but since bare-metal
clusters are implicitly backed with a plane with the same name,
you can use PLANE('clustername') for bare-metal
deployments.</entry>
</row>

<row>
<entry><emphasis>targetPlane</emphasis></entry>

<entry>A comma-delimited list of string constants containing the
names of the plane(s) to write the
<emphasis>indexfile</emphasis> to. The
<emphasis>targetPlane</emphasis> names must be listed as they
are defined in the deployment. </entry>
</row>

<row>
Expand Down Expand Up @@ -700,7 +726,7 @@ BUILD(Vehicles,SearchTerms,Payload,'vkey::st.city2');
);</emphasis></para>

<para>Form 3 creates an index file by using a previously defined INDEX
definition. </para>
definition.</para>

<para>You can also use this form to build an index based upon two MERGEd
indexes. To write a MERGEd index to disk, you must use the BUILD action
Expand Down
120 changes: 107 additions & 13 deletions docs/EN_US/ECLLanguageReference/ECLR_mods/BltInFunc-OUTPUT.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,10 +433,13 @@
</indexterm>(</emphasis><emphasis>recordset</emphasis><emphasis
role="bold"> [, [</emphasis><emphasis> format </emphasis><emphasis
role="bold">] [</emphasis><emphasis>,file </emphasis><emphasis
role="bold">[, CLUSTER<indexterm>
role="bold">[, CLUSTER <indexterm>
<primary>CLUSTER</primary>
</indexterm>(</emphasis><emphasis> target </emphasis><emphasis
role="bold">) ]</emphasis><emphasis role="bold"> [,ENCRYPT<indexterm>
</indexterm>(</emphasis><emphasis> target</emphasis><emphasis
role="bold">) ] | [ , PLANE <indexterm>
<primary>PLANE</primary>
</indexterm>(</emphasis><emphasis> targetPlane </emphasis><emphasis
role="bold">)]</emphasis><emphasis role="bold"> [,ENCRYPT<indexterm>
<primary>ENCRYPT</primary>
</indexterm>(</emphasis><emphasis> key </emphasis><emphasis
role="bold">) ] </emphasis></para>
Expand Down Expand Up @@ -486,6 +489,26 @@
to.</entry>
</row>

<row>
<entry><emphasis role="bold">PLANE</emphasis></entry>

<entry>Optional. Specifies writing the file to the specified
list of target planes. If omitted, the file is written to the
default plane. Planes are used by containerized systems, but
since bare-metal clusters are implicitly backed with a plane
with the same name, you can use PLANE('clustername') for
bare-metal deployments.</entry>
</row>

<row>
<entry><emphasis>targetPlane</emphasis></entry>

<entry>A comma-delimited list of string constants containing the
names of the plane(s) to write the file to. The
<emphasis>targetPlane</emphasis> names must be listed as they
are defined in the deployment.</entry>
</row>

<row>
<entry><emphasis role="bold">ENCRYPT</emphasis></entry>

Expand Down Expand Up @@ -594,10 +617,14 @@ OUTPUT(People(Attr1=FALSE));
<primary>CSV</primary>
</indexterm>[ (</emphasis><emphasis>csvoptions</emphasis><emphasis
role="bold">) ]</emphasis><emphasis role="bold"> </emphasis><emphasis
role="bold">[, CLUSTER<indexterm>
role="bold">[, CLUSTER <indexterm>
<primary>CLUSTER</primary>
</indexterm>(</emphasis><emphasis> target </emphasis><emphasis
role="bold">)] <emphasis role="bold">[,ENCRYPT<indexterm>
</indexterm>(</emphasis><emphasis> target</emphasis><emphasis
role="bold">)] | [, PLANE <indexterm>
<primary>PLANE</primary>
</indexterm>(</emphasis><emphasis> targetPlane </emphasis><emphasis
role="bold">)]</emphasis><emphasis role="bold"> <emphasis
role="bold">[,ENCRYPT<indexterm>
<primary>ENCRYPT</primary>
</indexterm>(</emphasis><emphasis>key</emphasis><emphasis role="bold">)
]</emphasis> [,COMPRESSED]</emphasis></para>
Expand Down Expand Up @@ -645,6 +672,26 @@ OUTPUT(People(Attr1=FALSE));
to.</entry>
</row>

<row>
<entry><emphasis role="bold">PLANE</emphasis></entry>

<entry>Optional. Specifies writing the file to the specified
list of target planes. If omitted, the file is written to the
default plane. Planes are used by containerized systems, but
since bare-metal clusters are implicitly backed with a plane
with the same name, you can use PLANE('clustername') for
bare-metal deployments.</entry>
</row>

<row>
<entry><emphasis>targetPlane</emphasis></entry>

<entry>A comma-delimited list of string constants containing the
names of the plane(s) to write the file to. The
<emphasis>targetPlane</emphasis> names must be listed as they
are defined in the deployment.</entry>
</row>

<row>
<entry><emphasis role="bold">ENCRYPT</emphasis></entry>

Expand Down Expand Up @@ -884,11 +931,14 @@ OUTPUT(ds,,'~thor::outdata.csv',CSV(HEADING(FORMAT(STD.Str.ToUpperCase))));
role="bold">) ]</emphasis><emphasis role="bold"> [,ENCRYPT<indexterm>
<primary>ENCRYPT</primary>
</indexterm>(</emphasis><emphasis> key </emphasis><emphasis
role="bold">) ] [, CLUSTER<indexterm>
role="bold">) ] <emphasis role="bold">[, CLUSTER <indexterm>
<primary>CLUSTER</primary>
</indexterm>(</emphasis><emphasis> target </emphasis><emphasis
role="bold">) ] [</emphasis><emphasis>,</emphasis><emphasis role="bold">
OVERWRITE<indexterm>
</indexterm>(</emphasis><emphasis> target</emphasis><emphasis
role="bold">)] | [, PLANE <indexterm>
<primary>PLANE</primary>
</indexterm>(</emphasis><emphasis> targetPlane </emphasis><emphasis
role="bold">)]</emphasis> [</emphasis><emphasis>,</emphasis><emphasis
role="bold"> OVERWRITE<indexterm>
<primary>OVERWRITE</primary>
</indexterm> ]</emphasis><emphasis role="bold"><emphasis role="bold">[,
UPDATE<indexterm>
Expand Down Expand Up @@ -930,6 +980,26 @@ OUTPUT(ds,,'~thor::outdata.csv',CSV(HEADING(FORMAT(STD.Str.ToUpperCase))));
to.</entry>
</row>

<row>
<entry><emphasis role="bold">PLANE</emphasis></entry>

<entry>Optional. Specifies writing the file to the specified
list of target planes. If omitted, the file is written to the
default plane. Planes are used by containerized systems, but
since bare-metal clusters are implicitly backed with a plane
with the same name, you can use PLANE('clustername') for
bare-metal deployments.</entry>
</row>

<row>
<entry><emphasis>targetPlane</emphasis></entry>

<entry>A comma-delimited list of string constants containing the
names of the plane(s) to write the file to. The
<emphasis>targetPlane</emphasis> names must be listed as they
are defined in the deployment.</entry>
</row>

<row>
<entry><emphasis role="bold">ENCRYPT</emphasis></entry>

Expand Down Expand Up @@ -1109,10 +1179,14 @@ OUTPUT(B,,'fred3.xml',XML('MyRow',TRIM,OPT));
role="bold">) ]</emphasis><emphasis role="bold"> [,ENCRYPT<indexterm>
<primary>ENCRYPT</primary>
</indexterm>(</emphasis><emphasis> key </emphasis><emphasis
role="bold">) ] [, CLUSTER<indexterm>
role="bold">)] [, CLUSTER <indexterm>
<primary>CLUSTER</primary>
</indexterm>(</emphasis><emphasis> target </emphasis><emphasis
role="bold">) ] [</emphasis><emphasis>,</emphasis><emphasis role="bold">
</indexterm>(</emphasis><emphasis> target</emphasis><emphasis
role="bold">)] | [, PLANE <indexterm>
<primary>PLANE</primary>
</indexterm>(</emphasis><emphasis> targetPlane </emphasis><emphasis
role="bold">)]</emphasis><emphasis role="bold">
[</emphasis><emphasis>,</emphasis><emphasis role="bold">
OVERWRITE<indexterm>
<primary>OVERWRITE</primary>
</indexterm> ]</emphasis><emphasis role="bold"><emphasis role="bold">[,
Expand Down Expand Up @@ -1155,6 +1229,26 @@ OUTPUT(B,,'fred3.xml',XML('MyRow',TRIM,OPT));
to.</entry>
</row>

<row>
<entry><emphasis role="bold">PLANE</emphasis></entry>

<entry>Optional. Specifies writing the file to the specified
list of target planes. If omitted, the file is written to the
default plane. Planes are used by containerized systems, but
since bare-metal clusters are implicitly backed with a plane
with the same name, you can use PLANE('clustername') for
bare-metal deployments.</entry>
</row>

<row>
<entry><emphasis>targetPlane</emphasis></entry>

<entry>A comma-delimited list of string constants containing the
names of the plane(s) to write the file to. The
<emphasis>targetPlane</emphasis> names must be listed as they
are defined in the deployment.</entry>
</row>

<row>
<entry><emphasis role="bold">ENCRYPT</emphasis></entry>

Expand Down
Loading