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.

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-33344 Remove references to Javascript from docs #19497

Open
wants to merge 1 commit into
base: candidate-9.10.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 7 additions & 9 deletions docs/EN_US/ECLLanguageReference/ECLR_mods/BltInFunc-IMPORT.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<informaltable colsep="1" frame="all" rowsep="1">
<tgroup cols="2">
<colspec colwidth="110" />
<colspec colwidth="110"/>

<tbody>
<row>
Expand Down Expand Up @@ -43,10 +43,10 @@
<entry>Specifies the name of the external programming language whose
code you wish to embed in your ECL. A language support module for
that language must have been installed in your plugins directory.
Modules are provided for languages such as Java, R, Javascript, and
Python. You can write your own pluggable language support module for
any language not already supported by using the supplied ones as
examples or starting points.</entry>
Modules are provided for languages such as Java and Python. You can
write your own pluggable language support module for any language
not already supported by using the supplied ones as examples or
starting points.</entry>
</row>

<row>
Expand Down Expand Up @@ -75,10 +75,8 @@

<para>The <emphasis role="bold">IMPORT</emphasis> declaration allows you to
call existing code written in the external <emphasis>language</emphasis>.
This may be used to call Java or Python code, but is not usable with
Javascript or R code (use the EMBED structure instead). Java code must be
placed in a .java file and compiled using the javac compiler in the usual
way. All Java classes used must be thread safe.</para>
Java code must be placed in a .java file and compiled using the javac
compiler in the usual way. All Java classes used must be thread safe.</para>

<para><emphasis role="bold">WARNING: This feature could create memory
corruption and/or security issues, so great care and forethought are
Expand Down
14 changes: 7 additions & 7 deletions docs/EN_US/ECLLanguageReference/ECLR_mods/SpecStruc-EMBED.xml
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@
<entry>The name of the programming language being embedded. A
language support module for that language must have been installed
in your plugins directory. Modules are provided for languages such
as Java, R, Javascript, and Python. You can write your own pluggable
language support module for any language not already supported by
using the supplied ones as examples or starting points.</entry>
as Java and Python. You can write your own pluggable language
support module for any language not already supported by using the
supplied ones as examples or starting points.</entry>
</row>

<row>
Expand Down Expand Up @@ -94,10 +94,10 @@
to add in-line <emphasis>language</emphasis> code to your ECL. This is
similar to the BEGINC++ structure, but available for any
<emphasis>language</emphasis> with a pluggable language support module
installed, such as Javascript and Python. Others may follow or people can
write their own using the supplied ones as templates/examples/starting
points. This may be used to write Javascript or Python code, but is not
usable with Java code (use the IMPORT function for Java code).</para>
installed, such as Java and Python. Others may follow or people can write
their own using the supplied ones as templates/examples/starting points.
This is not usable with Java code (use the IMPORT function for Java
code).</para>

<para>The parameter types that can be passed and returned will vary by
<emphasis>language</emphasis>, but in general the simple scalar types
Expand Down
9 changes: 4 additions & 5 deletions docs/EN_US/HPCCClientTools/CT_Mods/ECLCC.xml
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@

<entry>Allow use of named feature. (e.g., cpp, pipe,
all)<para><emphasis role="bold">cpp</emphasis>: Allow embedded
code within ECL (e.g., c++, JAVA, Javascript, Python, R,
code within ECL (e.g., c++, JAVA, Python,
etc.)</para><para><emphasis role="bold">pipe</emphasis>: Allow
the PIPE command to send data to an external
program.</para><para><emphasis role="bold">userECL</emphasis>:
Expand Down Expand Up @@ -517,10 +517,9 @@

<entry>Disallow use of named feature<para><emphasis
role="bold">cpp</emphasis>: Disallow embedded code within ECL
(e.g., c++, JAVA, Javascript, Python, R,
etc.)</para><para><emphasis role="bold">pipe</emphasis>:
Disallow the PIPE command to send data to an external
program.</para></entry>
(e.g., c++, JAVA, Python, etc.)</para><para><emphasis
role="bold">pipe</emphasis>: Disallow the PIPE command to send
data to an external program.</para></entry>
</row>

<row>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2180,10 +2180,6 @@ sudo /etc/init.d/hpcc-init -c esp start
<para>Java</para>
</listitem>

<listitem>
<para>JavaScript</para>
</listitem>

<listitem>
<para>Python (full support is already built-in)</para>
</listitem>
Expand All @@ -2194,9 +2190,9 @@ sudo /etc/init.d/hpcc-init -c esp start

<para>In addition to these languages, you can add support for additional
languages by creating your own plugin. This is not very difficult to do.
For example the JavaScript plugin is about 500 lines of C++ code. You
can use that as a template to write your own and, if desired, you can
contribute it back to the open source initiative.</para>
For example the Java plugin is about 500 lines of C++ code. You can use
that as a template to write your own and, if desired, you can contribute
it back to the open source initiative.</para>

<sect2 id="Add_On_Java" role="brk">
<title>Java</title>
Expand Down Expand Up @@ -2304,63 +2300,6 @@ add1(10);
url="https://github.com/hpcc-systems/HPCC-Platform/tree/master/testing/ecl/embedjava.ecl">https://github.com/hpcc-systems/HPCC-Platform/blob/master/testing/regress/ecl/embedjava.ecl</ulink></para>
</sect2>

<sect2 id="Add_On_Javascript" role="brk">
<title>JavaScript</title>

<para>To enable JavaScript support within the HPCC
Systems<superscript>®</superscript> Platform:</para>

<orderedlist>
<listitem>
<para>Install the appropriate dependencies for your
platform.</para>

<para><emphasis role="bold">RPM-based systems:</emphasis></para>

<para>On an RPM-based system (CentOS/Red Hat) install <emphasis
role="bold">v8embed.</emphasis></para>

<para><emphasis role="bold">Debian-based
systems:</emphasis></para>

<para>For a Debian-based system (Ubuntu) install the <emphasis
role="bold">libv8-dev</emphasis> package.</para>
</listitem>

<listitem>
<para>Test the JavaScript integration.</para>

<para>JavaScript does multi-thread, as a result this can be the
fastest of the currently supported embedded languages.</para>

<para>You can now execute some JavaScript code either in your ECL
IDE or the ECL Playground.</para>

<para>For example:</para>

<para><programlisting format="linespecific">//nothor

IMPORT javascript;

javascript.Language.syntaxcheck('1+2');

integer add1(integer val) := EMBED(javascript) val+1; ENDEMBED;

data testData(data val) := EMBED(javascript) val[0] = val[0] + 1; val; ENDEMBED;
set of integer testSet(set of integer val) := EMBED(javascript)
t = val [1];
val[1] = val[2];
val[2] = t;
val;
ENDEMBED;

add1(10);
</programlisting>If this successfully executes, you have correctly set up
JavaScript to work with your HPCC Systems platform.</para>
</listitem>
</orderedlist>
</sect2>

<sect2 id="Add_Python_support" role="brk">
<title>Python</title>

Expand Down
19 changes: 0 additions & 19 deletions initfiles/examples/embed/javascript-catch.ecl

This file was deleted.

109 changes: 0 additions & 109 deletions initfiles/examples/embed/javascript-simple.ecl

This file was deleted.

21 changes: 0 additions & 21 deletions initfiles/examples/embed/javascript-simple2.ecl

This file was deleted.

Loading