Skip to content

Commit

Permalink
Deployed 86c3df9 to master with MkDocs 1.6.0 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisChen2023 committed Apr 28, 2024
1 parent 7ba51ba commit eff3d9e
Show file tree
Hide file tree
Showing 25 changed files with 87 additions and 54 deletions.
6 changes: 3 additions & 3 deletions master/20.appendix/6.eco-tool-version/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8448,7 +8448,7 @@ <h2 id="nebulagraph_exchange">NebulaGraph Exchange<a class="headerlink" href="#n
<tbody>
<tr>
<td align="left">master</td>
<td align="left">v3.7.0</td>
<td align="left">v3.8.0</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -8496,7 +8496,7 @@ <h2 id="nebulagraph_spark_connector">NebulaGraph Spark Connector<a class="header
<tbody>
<tr>
<td align="left">master</td>
<td align="left">v3.6.0</td>
<td align="left">v3.8.0</td>
</tr>
</tbody>
</table>
Expand All @@ -8512,7 +8512,7 @@ <h2 id="nebulagraph_flink_connector">NebulaGraph Flink Connector<a class="header
<tbody>
<tr>
<td align="left">master</td>
<td align="left">v3.5.0</td>
<td align="left">v3.8.0</td>
</tr>
</tbody>
</table>
Expand Down
14 changes: 9 additions & 5 deletions master/connector/nebula-flink-connector/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8405,7 +8405,7 @@ <h2 id="use_cases">Use cases<a class="headerlink" href="#use_cases" title="Perma
<li>Migrate the data of NebulaGraph.</li>
</ul>
<h2 id="release_note">Release note<a class="headerlink" href="#release_note" title="Permanent link">&para;</a></h2>
<p><a href="https://github.com/vesoft-inc/nebula-flink-connector/releases/tag/v3.5.0">Release</a></p>
<p><a href="https://github.com/vesoft-inc/nebula-flink-connector/releases/tag/v3.8.0">Release</a></p>
<h2 id="version_compatibility">Version compatibility<a class="headerlink" href="#version_compatibility" title="Permanent link">&para;</a></h2>
<p>The correspondence between the NebulaGraph Flink Connector version and the NebulaGraph core version is as follows.</p>
<table>
Expand All @@ -8421,6 +8421,10 @@ <h2 id="version_compatibility">Version compatibility<a class="headerlink" href="
<td align="left">nightly</td>
</tr>
<tr>
<td align="left">3.8.0</td>
<td align="left">3.x.x</td>
</tr>
<tr>
<td align="left">3.5.0</td>
<td align="left">3.x.x</td>
</tr>
Expand Down Expand Up @@ -8461,15 +8465,15 @@ <h3 id="configure_maven_dependency">Configure Maven dependency<a class="headerli
<div class="highlight"><pre><span></span><code><span class="nt">&lt;dependency&gt;</span>
<span class="w"> </span><span class="nt">&lt;groupId&gt;</span>com.vesoft<span class="nt">&lt;/groupId&gt;</span>
<span class="w"> </span><span class="nt">&lt;artifactId&gt;</span>nebula-flink-connector<span class="nt">&lt;/artifactId&gt;</span>
<span class="w"> </span><span class="nt">&lt;version&gt;</span>3.5.0<span class="nt">&lt;/version&gt;</span>
<span class="w"> </span><span class="nt">&lt;version&gt;</span>3.8.0<span class="nt">&lt;/version&gt;</span>
<span class="nt">&lt;/dependency&gt;</span>
</code></pre></div>
<h3 id="compile_and_package">Compile and package<a class="headerlink" href="#compile_and_package" title="Permanent link">&para;</a></h3>
<p>Follow the steps below to compile and package the Flink Connector.</p>
<ol>
<li>
<p>Clone repository <code>nebula-flink-connector</code>.</p>
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>-b<span class="w"> </span>release-3.5<span class="w"> </span>https://github.com/vesoft-inc/nebula-flink-connector.git
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>-b<span class="w"> </span>release-3.8<span class="w"> </span>https://github.com/vesoft-inc/nebula-flink-connector.git
</code></pre></div>
</li>
<li>
Expand All @@ -8481,7 +8485,7 @@ <h3 id="compile_and_package">Compile and package<a class="headerlink" href="#com
</code></pre></div>
</li>
</ol>
<p>After compilation, a file similar to <code>nebula-flink-connector-3.5.0.jar</code> is generated in the directory <code>connector/target</code> of the folder.</p>
<p>After compilation, a file similar to <code>nebula-flink-connector-3.8.0.jar</code> is generated in the directory <code>connector/target</code> of the folder.</p>
<h2 id="how_to_use">How to use<a class="headerlink" href="#how_to_use" title="Permanent link">&para;</a></h2>
<h3 id="write_data_into_nebulagraph">Write data into NebulaGraph<a class="headerlink" href="#write_data_into_nebulagraph" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">StreamExecutionEnvironment</span><span class="w"> </span><span class="n">env</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">StreamExecutionEnvironment</span><span class="p">.</span><span class="na">getExecutionEnvironment</span><span class="p">();</span>
Expand Down Expand Up @@ -8837,7 +8841,7 @@ <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent l
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 10, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 28, 2024</span>


</small>
Expand Down
41 changes: 35 additions & 6 deletions master/connector/nebula-spark-connector/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8380,7 +8380,7 @@ <h1 id="nebulagraph_spark_connector">NebulaGraph Spark Connector<a class="header
<p>Provides a Spark SQL interface. This interface can be used to write DataFrames into NebulaGraph in a row-by-row or batch-import way.</p>
</li>
</ul>
<p>For more information, see <a href="https://github.com/vesoft-inc/nebula-spark-connector/blob/release-3.6/README_CN.md">NebulaGraph Spark Connector</a>.</p>
<p>For more information, see <a href="https://github.com/vesoft-inc/nebula-spark-connector/blob/release-3.8/README_CN.md">NebulaGraph Spark Connector</a>.</p>
<h2 id="version_compatibility">Version compatibility<a class="headerlink" href="#version_compatibility" title="Permanent link">&para;</a></h2>
<p>The correspondence between the NebulaGraph Spark Connector version, the NebulaGraph core version and the Spark version is as follows.</p>
<table>
Expand Down Expand Up @@ -8408,6 +8408,21 @@ <h2 id="version_compatibility">Version compatibility<a class="headerlink" href="
<td align="left">2.4.x</td>
</tr>
<tr>
<td align="left">nebula-spark-connector_3.0-3.8.0.jar</td>
<td align="left">3.x</td>
<td align="left">3.x</td>
</tr>
<tr>
<td align="left">nebula-spark-connector_2.2-3.8.0.jar</td>
<td align="left">3.x</td>
<td align="left">2.2.x</td>
</tr>
<tr>
<td align="left">nebula-spark-connector-3.8.0.jar</td>
<td align="left">3.x</td>
<td align="left">2.4.x</td>
</tr>
<tr>
<td align="left">nebula-spark-connector_3.0-3.6.0.jar</td>
<td align="left">3.x</td>
<td align="left">3.x</td>
Expand Down Expand Up @@ -8493,7 +8508,7 @@ <h2 id="use_cases">Use cases<a class="headerlink" href="#use_cases" title="Perma
<li>Graph computing with <a href="../../graph-computing/nebula-algorithm/">NebulaGraph Algorithm</a>.</li>
</ul>
<h2 id="benefits">Benefits<a class="headerlink" href="#benefits" title="Permanent link">&para;</a></h2>
<p>The features of NebulaGraph Spark Connector 3.6.0 are as follows:</p>
<p>The features of NebulaGraph Spark Connector 3.8.0 are as follows:</p>
<ul>
<li>Supports multiple connection settings, such as timeout period, number of connection retries, number of execution retries, etc.</li>
</ul>
Expand All @@ -8513,13 +8528,13 @@ <h2 id="benefits">Benefits<a class="headerlink" href="#benefits" title="Permanen
<li>Three write modes, <code>insert</code>, <code>update</code> and <code>delete</code>, are supported. <code>insert</code> mode will insert (overwrite) data, <code>update</code> mode will only update existing data, and <code>delete</code> mode will only delete data.</li>
</ul>
<h2 id="release_note">Release note<a class="headerlink" href="#release_note" title="Permanent link">&para;</a></h2>
<p><a href="https://github.com/vesoft-inc/nebula-spark-connector/releases/tag/v3.6.0">Release</a></p>
<p><a href="https://github.com/vesoft-inc/nebula-spark-connector/releases/tag/v3.8.0">Release</a></p>
<h2 id="get_nebulagraph_spark_connector">Get NebulaGraph Spark Connector<a class="headerlink" href="#get_nebulagraph_spark_connector" title="Permanent link">&para;</a></h2>
<h3 id="compile_and_package">Compile and package<a class="headerlink" href="#compile_and_package" title="Permanent link">&para;</a></h3>
<ol>
<li>
<p>Clone repository <code>nebula-spark-connector</code>.</p>
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>-b<span class="w"> </span>release-3.6<span class="w"> </span>https://github.com/vesoft-inc/nebula-spark-connector.git
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>-b<span class="w"> </span>release-3.8<span class="w"> </span>https://github.com/vesoft-inc/nebula-spark-connector.git
</code></pre></div>
</li>
<li>
Expand Down Expand Up @@ -8551,7 +8566,7 @@ <h3 id="compile_and_package">Compile and package<a class="headerlink" href="#com
```
</code></pre></div>

<p>After compilation, a file similar to <code>nebula-spark-connector-3.6.0-SHANPSHOT.jar</code> is generated in the directory <code>target</code> of the folder.</p>
<p>After compilation, a file similar to <code>nebula-spark-connector-3.8.0-SHANPSHOT.jar</code> is generated in the directory <code>target</code> of the folder.</p>
<h3 id="download_maven_remote_repository">Download maven remote repository<a class="headerlink" href="#download_maven_remote_repository" title="Permanent link">&para;</a></h3>
<p><a href="https://repo1.maven.org/maven2/com/vesoft/nebula-spark-connector/">Download</a></p>
<h2 id="how_to_use">How to use<a class="headerlink" href="#how_to_use" title="Permanent link">&para;</a></h2>
Expand Down Expand Up @@ -8583,6 +8598,8 @@ <h3 id="reading_data_from_nebulagraph">Reading data from NebulaGraph<a class="he

<span class="kd">val</span><span class="w"> </span><span class="n">nebulaReadVertexConfig</span><span class="p">:</span><span class="w"> </span><span class="nc">ReadNebulaConfig</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">ReadNebulaConfig</span>
<span class="w"> </span><span class="p">.</span><span class="n">builder</span><span class="p">()</span>
<span class="w"> </span><span class="p">.</span><span class="n">withUser</span><span class="p">(</span><span class="s">&quot;root&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="n">withPasswd</span><span class="p">(</span><span class="s">&quot;nebula&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="n">withSpace</span><span class="p">(</span><span class="s">&quot;test&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="n">withLabel</span><span class="p">(</span><span class="s">&quot;person&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="n">withNoColumn</span><span class="p">(</span><span class="kc">false</span><span class="p">)</span>
Expand All @@ -8594,6 +8611,8 @@ <h3 id="reading_data_from_nebulagraph">Reading data from NebulaGraph<a class="he

<span class="kd">val</span><span class="w"> </span><span class="n">nebulaReadEdgeConfig</span><span class="p">:</span><span class="w"> </span><span class="nc">ReadNebulaConfig</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">ReadNebulaConfig</span>
<span class="w"> </span><span class="p">.</span><span class="n">builder</span><span class="p">()</span>
<span class="w"> </span><span class="p">.</span><span class="n">withUser</span><span class="p">(</span><span class="s">&quot;root&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="n">withPasswd</span><span class="p">(</span><span class="s">&quot;nebula&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="n">withSpace</span><span class="p">(</span><span class="s">&quot;test&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="n">withLabel</span><span class="p">(</span><span class="s">&quot;knows&quot;</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="n">withNoColumn</span><span class="p">(</span><span class="kc">false</span><span class="p">)</span>
Expand Down Expand Up @@ -8652,6 +8671,16 @@ <h3 id="reading_data_from_nebulagraph">Reading data from NebulaGraph<a class="he
</thead>
<tbody>
<tr>
<td align="left"><code>withUser</code></td>
<td align="left">No</td>
<td align="left">NebulaGraph username. This parameter is required when the Storage services require authentication. This parameter is only supported in NebulaGraph Enterprise Edition.</td>
</tr>
<tr>
<td align="left"><code>withPasswd</code></td>
<td align="left">No</td>
<td align="left">The password for the NebulaGraph username. This parameter is required when the Storage services require authentication. This parameter is only supported in NebulaGraph Enterprise Edition.</td>
</tr>
<tr>
<td align="left"><code>withSpace</code></td>
<td align="left">Yes</td>
<td align="left">NebulaGraph space name.</td>
Expand Down Expand Up @@ -8934,7 +8963,7 @@ <h3 id="write_data_into_nebulagraph">Write data into NebulaGraph<a class="header
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 10, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 28, 2024</span>


</small>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8255,7 +8255,7 @@ <h2 id="software_dependencies">Software dependencies<a class="headerlink" href="
<p>Apache Spark. The requirements for Spark versions when using Exchange to export data from data sources are as follows. In the following table, Y means that the corresponding Spark version is supported, and N means not supported.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Use the correct Exchange JAR file based on the Spark version. For example, for Spark version 2.4, use nebula-exchange_spark_2.4-3.7.0.jar.</p>
<p>Use the correct Exchange JAR file based on the Spark version. For example, for Spark version 2.4, use nebula-exchange_spark_2.4-3.8.0.jar.</p>
</div>
<table>
<thead>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8473,7 +8473,7 @@ <h2 id="version_compatibility">Version compatibility<a class="headerlink" href="
</tbody>
</table>
<h2 id="data_source">Data source<a class="headerlink" href="#data_source" title="Permanent link">&para;</a></h2>
<p>Exchange 3.7.0 supports converting data from the following formats or sources into vertexes and edges that NebulaGraph can recognize, and then importing them into NebulaGraph in the form of nGQL statements:</p>
<p>Exchange 3.8.0 supports converting data from the following formats or sources into vertexes and edges that NebulaGraph can recognize, and then importing them into NebulaGraph in the form of nGQL statements:</p>
<ul>
<li>Data stored in HDFS or locally:<ul>
<li><a href="../../use-exchange/ex-ug-import-from-parquet/">Apache Parquet</a></li>
Expand Down Expand Up @@ -8520,7 +8520,7 @@ <h2 id="data_source">Data source<a class="headerlink" href="#data_source" title=
</ul>
<p>In addition to importing data as nGQL statements, Exchange supports generating SST files for data sources and then <a href="../../use-exchange/ex-ug-import-from-sst/">importing SST</a> files via Console.</p>
<h2 id="release_note">Release note<a class="headerlink" href="#release_note" title="Permanent link">&para;</a></h2>
<p><a href="https://github.com/vesoft-inc/nebula-exchange/releases/tag/v3.7.0">Release</a></p>
<p><a href="https://github.com/vesoft-inc/nebula-exchange/releases/tag/v3.8.0">Release</a></p>

<hr>
<div class="md-source-file">
Expand Down
4 changes: 2 additions & 2 deletions master/import-export/nebula-exchange/ex-ug-compile/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8320,7 +8320,7 @@ <h2 id="steps">Steps<a class="headerlink" href="#steps" title="Permanent link">&
<ol>
<li>
<p>Clone the repository <code>nebula-exchange</code> in the <code>/</code> directory.</p>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>-b<span class="w"> </span>release-3.7<span class="w"> </span>https://github.com/vesoft-inc/nebula-exchange.git
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>-b<span class="w"> </span>release-3.8<span class="w"> </span>https://github.com/vesoft-inc/nebula-exchange.git
</code></pre></div>
</li>
<li>
Expand Down Expand Up @@ -8356,7 +8356,7 @@ <h2 id="steps">Steps<a class="headerlink" href="#steps" title="Permanent link">&
</ul>
</li>
</ol>
<p>After the compilation is successful, you can find the <code>nebula-exchange_spark_x.x-release-3.7.jar</code> file in the <code>nebula-exchange_spark_x.x/target/</code> directory. <code>x.x</code> indicates the Spark version, for example, <code>2.4</code>.</p>
<p>After the compilation is successful, you can find the <code>nebula-exchange_spark_x.x-release-3.8.jar</code> file in the <code>nebula-exchange_spark_x.x/target/</code> directory. <code>x.x</code> indicates the Spark version, for example, <code>2.4</code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The JAR file version changes with the release of the NebulaGraph Java Client. Users can view the latest version on the <a href="https://github.com/vesoft-inc/nebula-java/releases">Releases page</a>.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8309,7 +8309,7 @@ <h2 id="import_data">Import data<a class="headerlink" href="#import_data" title=
--files<span class="w"> </span>application.conf<span class="w"> </span><span class="se">\</span>
--conf<span class="w"> </span>spark.driver.extraClassPath<span class="o">=</span>./<span class="w"> </span><span class="se">\</span>
--conf<span class="w"> </span>spark.executor.extraClassPath<span class="o">=</span>./<span class="w"> </span><span class="se">\</span>
nebula-exchange-3.7.0.jar<span class="w"> </span><span class="se">\</span>
nebula-exchange-3.8.0.jar<span class="w"> </span><span class="se">\</span>
-c<span class="w"> </span>application.conf
</code></pre></div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8458,7 +8458,7 @@ <h3 id="step_2_modify_configuration_files">Step 2: Modify configuration files<a
# Spark configuration
spark: {
app: {
name: NebulaGraph Exchange 3.7.0
name: NebulaGraph Exchange 3.8.0
}
driver: {
cores: 1
Expand Down Expand Up @@ -8702,7 +8702,7 @@ <h3 id="step_3_import_data_into_nebulagraph">Step 3: Import data into NebulaGrap
<p>JAR packages are available in two ways: <a href="../../ex-ug-compile/">compiled them yourself</a>, or <a href="https://repo1.maven.org/maven2/com/vesoft/nebula-exchange/">download</a> the compiled <code>.jar</code> file directly.</p>
</div>
<p>For example:</p>
<div class="highlight"><pre><span></span><code><span class="si">${</span><span class="nv">SPARK_HOME</span><span class="si">}</span>/bin/spark-submit<span class="w"> </span>--master<span class="w"> </span><span class="s2">&quot;local&quot;</span><span class="w"> </span>--class<span class="w"> </span>com.vesoft.nebula.exchange.Exchange<span class="w"> </span>/root/nebula-exchange/nebula-exchange/target/nebula-exchange_spark_2.4-3.7.0.jar<span class="w"> </span>-c<span class="w"> </span>/root/nebula-exchange/nebula-exchange/target/classes/clickhouse_application.conf
<div class="highlight"><pre><span></span><code><span class="si">${</span><span class="nv">SPARK_HOME</span><span class="si">}</span>/bin/spark-submit<span class="w"> </span>--master<span class="w"> </span><span class="s2">&quot;local&quot;</span><span class="w"> </span>--class<span class="w"> </span>com.vesoft.nebula.exchange.Exchange<span class="w"> </span>/root/nebula-exchange/nebula-exchange/target/nebula-exchange_spark_2.4-3.8.0.jar<span class="w"> </span>-c<span class="w"> </span>/root/nebula-exchange/nebula-exchange/target/classes/clickhouse_application.conf
</code></pre></div>
<p>You can search for <code>batchSuccess.&lt;tag_name/edge_name&gt;</code> in the command output to check the number of successes. For example, <code>batchSuccess.follow: 300</code>.</p>
<h3 id="step_4_optional_validate_data">Step 4: (optional) Validate data<a class="headerlink" href="#step_4_optional_validate_data" title="Permanent link">&para;</a></h3>
Expand Down
Loading

0 comments on commit eff3d9e

Please sign in to comment.