| <!doctype html> |
| <html class="docs-version-1.1.0" lang="zh-CN" dir="ltr"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="generator" content="Docusaurus v2.0.0-beta.14"> |
| <link rel="alternate" type="application/rss+xml" href="/zh-CN/blog/rss.xml" title="Apache Linkis Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/zh-CN/blog/atom.xml" title="Apache Linkis Blog Atom Feed"> |
| <link rel="search" type="application/opensearchdescription+xml" title="Apache Linkis" href="/zh-CN/opensearch.xml"><title data-react-helmet="true">Linkis-Cli 方式使用 | Apache Linkis</title><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:url" content="https://linkis.incubator.apache.org/zh-CN/docs/1.1.0/user_guide/linkiscli_manual"><meta data-react-helmet="true" name="docsearch:language" content="zh-CN"><meta data-react-helmet="true" name="docsearch:version" content="1.1.0"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-1.1.0"><meta data-react-helmet="true" property="og:title" content="Linkis-Cli 方式使用 | Apache Linkis"><meta data-react-helmet="true" name="description" content="1. 介绍"><meta data-react-helmet="true" property="og:description" content="1. 介绍"><link data-react-helmet="true" rel="shortcut icon" href="/zh-CN/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://linkis.incubator.apache.org/zh-CN/docs/1.1.0/user_guide/linkiscli_manual"><link data-react-helmet="true" rel="alternate" href="https://linkis.incubator.apache.org/docs/1.1.0/user_guide/linkiscli_manual" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://linkis.incubator.apache.org/zh-CN/docs/1.1.0/user_guide/linkiscli_manual" hreflang="zh-CN"><link data-react-helmet="true" rel="alternate" href="https://linkis.incubator.apache.org/docs/1.1.0/user_guide/linkiscli_manual" hreflang="x-default"><link data-react-helmet="true" rel="preconnect" href="https://AE29KQB3IA-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/zh-CN/assets/css/styles.e9faf9bb.css"> |
| <link rel="preload" href="/zh-CN/assets/js/runtime~main.14d5df0c.js" as="script"> |
| <link rel="preload" href="/zh-CN/assets/js/main.5a9c4743.js" as="script"> |
| </head> |
| <body> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
| <div><a href="#" class="skipToContent_OuoZ">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/zh-CN/"><img src="/zh-CN/img/logo.png" alt="Apache Linkis Logo" class="themedImage_TMUO themedImage--light_4Vu1 navbar__logo"><img src="/zh-CN/img/logo.png" alt="Apache Linkis Logo" class="themedImage_TMUO themedImage--dark_uzRr navbar__logo"><b class="navbar__title">Apache Linkis(Incubating)</b></a><a class="navbar__item navbar__link" href="/zh-CN/">首页</a><a class="navbar__item navbar__link" href="/zh-CN/faq/main">FAQ</a><a class="navbar__item navbar__link" href="/zh-CN/download/main">下载</a><a class="navbar__item navbar__link" href="/zh-CN/community/how-to-subscribe">社区</a><a class="navbar__item navbar__link" href="/zh-CN/blog">博客</a><a class="navbar__item navbar__link" href="/zh-CN/team">团队</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/zh-CN/user">用户</a><div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__link">Apache</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">基金会</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">证书</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">事件</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">安全</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">赞助</a></li><li><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">致谢</a></li></ul></div></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link">文档</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/zh-CN/docs/1.1.3/introduction">Next(1.1.3)</a></li><li><a class="dropdown__link" href="/zh-CN/docs/latest/introduction">1.1.2</a></li><li><a class="dropdown__link" href="/zh-CN/docs/1.1.1/introduction">1.1.1</a></li><li><a class="dropdown__link" href="/zh-CN/docs/1.1.0/introduction">1.1.0</a></li><li><a class="dropdown__link" href="/zh-CN/docs/1.0.3/introduction">1.0.3</a></li><li><a class="dropdown__link" href="/zh-CN/docs/1.0.2/introduction">1.0.2</a></li><li><a class="dropdown__link" href="/zh-CN/docs/0.11.0/introduction">0.11.0</a></li><li><a class="dropdown__link" href="/zh-CN/versions">All Version</a></li></ul></div><a href="https://github.com/apache/incubator-linkis" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub"></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" class="navbar__link"><span><svg t="1631348384596" class="iconLanguage_EbrZ" viewBox="0 0 1024 1024" version="1.1" p-id="557" width="20" height="20"><path d="M547.797333 638.208l-104.405333-103.168 1.237333-1.28a720.170667 720.170667 0 0 0 152.490667-268.373333h120.448V183.082667h-287.744V100.906667H347.605333v82.218666H59.818667V265.386667h459.178666a648.234667 648.234667 0 0 1-130.304 219.946666 643.242667 643.242667 0 0 1-94.976-137.728H211.541333a722.048 722.048 0 0 0 122.453334 187.434667l-209.194667 206.378667 58.368 58.368 205.525333-205.525334 127.872 127.829334 31.232-83.84m231.424-208.426667h-82.218666l-184.96 493.312h82.218666l46.037334-123.306667h195.242666l46.464 123.306667h82.218667l-185.002667-493.312m-107.690666 287.744l66.56-178.005333 66.602666 178.005333z" fill="currentColor" p-id="558"></path></svg><span>简体中文</span></span></a><ul class="dropdown__menu"><li><a href="/docs/1.1.0/user_guide/linkiscli_manual" target="_self" rel="noopener noreferrer" class="dropdown__link" style="text-transform:capitalize">English</a></li><li><a href="/zh-CN/docs/1.1.0/user_guide/linkiscli_manual" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" style="text-transform:capitalize">简体中文</a></li></ul></div><div class="searchBox_Bc3W"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper docs-doc-page"><div class="docPage_lDyR"><button class="clean-btn backToTopButton_i9tI" type="button"><svg viewBox="0 0 24 24" width="28"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z" fill="currentColor"></path></svg></button><aside class="docSidebarContainer_0YBq"><div class="sidebar_a3j0"><nav class="menu thin-scrollbar menu_cyFh menuWithAnnouncementBar_+O1J"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" href="/zh-CN/docs/1.1.0/introduction">Linkis 简述</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" href="/zh-CN/docs/1.1.0/release">版本总览</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">安装部署</a></li><li class="theme-doc-sidebar-item-category menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#">用户手册</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/1.1.0/user_guide/overview">总览</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/1.1.0/user_guide/how_to_use">如何使用 Linkis1.0</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/zh-CN/docs/1.1.0/user_guide/linkiscli_manual">Linkis-Cli 方式使用</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/1.1.0/user_guide/sdk_manual">JAVA SDK 方式使用</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/1.1.0/user_guide/console_manual">Linkis 管理台的使用</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/1.1.0/user_guide/linkis-datasource-client">DataSource Client SDK 的使用</a></li></ul></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">引擎使用</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">API文档</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">架构分析</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">开发文档</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">版本升级</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">调优排障</a></li></ul></nav></div></aside><main class="docMainContainer_r8cw"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_zHA2"><div class="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for <!-- -->Apache Linkis<!-- --> <b>1.1.0</b>, 非最新版本。</div><div class="margin-top--md">有关最新文档，请参阅最新稳定版本<b><a href="/zh-CN/docs/latest/user_guide/linkiscli_manual">latest version</a></b> (<!-- -->1.1.2<!-- -->).</div></div><div class="docItemContainer_oiyr"><article><span class="theme-doc-version-badge badge badge--secondary">Version: <!-- -->1.1.0</span><div class="tocCollapsible_aw-L theme-doc-toc-mobile tocMobile_Tx6Y"><button type="button" class="clean-btn tocCollapsibleButton_zr6a">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Linkis-Cli 方式使用</h1></header><h2><a aria-hidden="true" tabindex="-1" class="anchor anchor__h2 anchorWithStickyNavbar_y2LR" id="1-介绍"></a>1. 介绍<a class="hash-link" href="#1-介绍" title="Direct link to heading">#</a></h2><p>Linkis-Cli 是一个用于向Linkis提交任务的Shell命令行程序。</p><h2><a aria-hidden="true" tabindex="-1" class="anchor anchor__h2 anchorWithStickyNavbar_y2LR" id="2-基础案例"></a>2. 基础案例<a class="hash-link" href="#2-基础案例" title="Direct link to heading">#</a></h2><p>您可以参照下面的例子简单地向Linkis提交任务</p><p>第一步，检查conf/目录下是否存在默认配置文件<code>linkis-cli.properties</code>，且包含以下配置：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI properties"><pre tabindex="0" class="prism-code language-properties codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.common.gatewayUrl=http://127.0.0.1:9001</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.common.authStrategy=token</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.common.tokenKey=Validation-Code</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.common.tokenValue=BML-AUTH</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>第二步，进入linkis安装目录，输入指令：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI bash"><pre tabindex="0" class="prism-code language-bash codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> ./bin/linkis-cli -engineType spark-2.4.3 -codeType sql -code </span><span class="token string" style="color:rgb(255, 121, 198)">"select count(*) from testdb.test;"</span><span class="token plain"> -submitUser hadoop -proxyUser hadoop </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>第三步，您会在控制台看到任务被提交到linkis并开始执行的信息。</p><p>linkis-cli目前仅支持同步提交，即向linkis提交任务后，不断询问任务状态、拉取任务日志，直至任务结束。任务结束时状态如果为成功，linkis-cli还会主动拉取结果集并输出。</p><h2><a aria-hidden="true" tabindex="-1" class="anchor anchor__h2 anchorWithStickyNavbar_y2LR" id="3-使用方式"></a>3. 使用方式<a class="hash-link" href="#3-使用方式" title="Direct link to heading">#</a></h2><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI bash"><pre tabindex="0" class="prism-code language-bash codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> ./bin/linkis-cli </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token plain">参数</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token plain">cli参数</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h2><a aria-hidden="true" tabindex="-1" class="anchor anchor__h2 anchorWithStickyNavbar_y2LR" id="4-支持的参数列表"></a>4. 支持的参数列表<a class="hash-link" href="#4-支持的参数列表" title="Direct link to heading">#</a></h2><ul><li><p>cli参数</p><table><thead><tr><th>参数</th><th>说明</th><th>数据类型</th><th>是否必填</th></tr></thead><tbody><tr><td>--gwUrl</td><td>手动指定linkis gateway地址</td><td>String</td><td>否</td></tr><tr><td>--authStg</td><td>指定认证策略</td><td>String</td><td>否</td></tr><tr><td>--authKey</td><td>指定认证key</td><td>String</td><td>否</td></tr><tr><td>--authVal</td><td>指定认证value</td><td>String</td><td>否</td></tr><tr><td>--userConf</td><td>指定配置文件位置</td><td>String</td><td>否</td></tr></tbody></table></li><li><p>参数</p><table><thead><tr><th>参数</th><th>说明</th><th>数据类型</th><th>是否必填</th></tr></thead><tbody><tr><td>-engType</td><td>引擎类型</td><td>String</td><td>是</td></tr><tr><td>-runType</td><td>执行类型</td><td>String</td><td>是</td></tr><tr><td>-code</td><td>执行代码</td><td>String</td><td>否</td></tr><tr><td>-codePath</td><td>本地执行代码文件路径</td><td>String</td><td>否</td></tr><tr><td>-smtUsr</td><td>指定提交用户</td><td>String</td><td>否</td></tr><tr><td>-pxyUsr</td><td>指定执行用户</td><td>String</td><td>否</td></tr><tr><td>-creator</td><td>指定creator</td><td>String</td><td>否</td></tr><tr><td>-scriptPath</td><td>scriptPath</td><td>String</td><td>否</td></tr><tr><td>-outPath</td><td>输出结果集到文件的路径</td><td>String</td><td>否</td></tr><tr><td>-confMap</td><td>configuration map</td><td>Map</td><td>否</td></tr><tr><td>-varMap</td><td>变量替换的variable map</td><td>Map</td><td>否</td></tr><tr><td>-labelMap</td><td>linkis labelMap</td><td>Map</td><td>否</td></tr><tr><td>-sourceMap</td><td>指定linkis sourceMap</td><td>Map</td><td>否</td></tr></tbody></table></li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor anchor__h2 anchorWithStickyNavbar_y2LR" id="5-详细示例"></a>5. 详细示例<a class="hash-link" href="#5-详细示例" title="Direct link to heading">#</a></h2><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="51-添加cli参数"></a>5.1 添加cli参数<a class="hash-link" href="#51-添加cli参数" title="Direct link to heading">#</a></h3><p>Cli参数可以通过手动指定的方式传入，此方式下会覆盖默认配置文件中的冲突配置项</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI bash"><pre tabindex="0" class="prism-code language-bash codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> ./bin/linkis-cli -engineType spark-2.4.3 -codeType sql -code </span><span class="token string" style="color:rgb(255, 121, 198)">"select count(*) from testdb.test;"</span><span class="token plain"> -submitUser hadoop -proxyUser hadoop --gwUrl http://127.0.0.1:9001 --authStg token --authKey </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token plain">tokenKey</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token plain"> --authVal </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token plain">tokenValue</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token plain"> </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="52-添加引擎初始参数"></a>5.2 添加引擎初始参数<a class="hash-link" href="#52-添加引擎初始参数" title="Direct link to heading">#</a></h3><p>引擎的初始参数可以通过<code>-confMap</code>参数添加，注意参数的数据类型是Map，命令行的输入格式如下：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> -confMap key1=val1,key2=val2,...</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>例如：以下示例设置了引擎启动的yarn队列、spark executor个数等启动参数：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI bash"><pre tabindex="0" class="prism-code language-bash codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> ./bin/linkis-cli -engineType spark-2.4.3 -codeType sql -confMap wds.linkis.yarnqueue</span><span class="token operator">=</span><span class="token plain">q02,spark.executor.instances</span><span class="token operator">=</span><span class="token number">3</span><span class="token plain"> -code </span><span class="token string" style="color:rgb(255, 121, 198)">"select count(*) from testdb.test;"</span><span class="token plain"> -submitUser hadoop -proxyUser hadoop </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>当然，这些参数也支持以配置文件的方式读取，我们稍后会讲到</p><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="53-添加标签"></a>5.3 添加标签<a class="hash-link" href="#53-添加标签" title="Direct link to heading">#</a></h3><p>标签可以通过<code>-labelMap</code>参数添加，与<code>-confMap</code>一样，<code>-labelMap</code>参数的类型也是Map:</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI bash"><pre tabindex="0" class="prism-code language-bash codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> /bin/linkis-cli -engineType spark-2.4.3 -codeType sql -labelMap </span><span class="token assign-left variable" style="color:rgb(189, 147, 249);font-style:italic">labelKey</span><span class="token operator">=</span><span class="token plain">labelVal -code </span><span class="token string" style="color:rgb(255, 121, 198)">"select count(*) from testdb.test;"</span><span class="token plain"> -submitUser hadoop -proxyUser hadoop </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="54-变量替换"></a>5.4 变量替换<a class="hash-link" href="#54-变量替换" title="Direct link to heading">#</a></h3><p>Linkis-cli的变量替换通过<code>${}</code>符号和<code>-varMap</code>共同实现</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI bash"><pre tabindex="0" class="prism-code language-bash codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> ./bin/linkis-cli -engineType spark-2.4.3 -codeType sql -code </span><span class="token string" style="color:rgb(255, 121, 198)">"select count(*) from \</span><span class="token string variable" style="color:rgb(189, 147, 249);font-style:italic">${key}</span><span class="token string" style="color:rgb(255, 121, 198)">;"</span><span class="token plain"> -varMap </span><span class="token assign-left variable" style="color:rgb(189, 147, 249);font-style:italic">key</span><span class="token operator">=</span><span class="token plain">testdb.test -submitUser hadoop -proxyUser hadoop </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>执行过程中sql语句会被替换为：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI mysql-sql"><pre tabindex="0" class="prism-code language-mysql-sql codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> select count(*) from testdb.test</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>注意<code>'\$'</code>中的转义符是为了防止参数被linux提前解析，如果是<code>-codePath</code>指定本地脚本方式，则不需要转义符</p><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="55-使用用户配置"></a>5.5 使用用户配置<a class="hash-link" href="#55-使用用户配置" title="Direct link to heading">#</a></h3><ol><li>linkis-cli支持加载用户自定义配置文件，配置文件路径通过<code>--userConf</code>参数指定，配置文件需要是<code>.properties</code>文件格式</li></ol><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI bash"><pre tabindex="0" class="prism-code language-bash codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> ./bin/linkis-cli -engineType spark-2.4.3 -codeType sql -code </span><span class="token string" style="color:rgb(255, 121, 198)">"select count(*) from testdb.test;"</span><span class="token plain"> -submitUser hadoop -proxyUser hadoop --userConf </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token plain">配置文件路径</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><ol start="2"><li>哪些参数可以配置？</li></ol><p>所有参数都可以配置化，例如：</p><p>cli参数：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI properties"><pre tabindex="0" class="prism-code language-properties codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.common.gatewayUrl=http://127.0.0.1:9001</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.common.authStrategy=static</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.common.tokenKey=[静态认证key]</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.common.tokenValue=[静态认证value]</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>参数：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI properties"><pre tabindex="0" class="prism-code language-properties codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.label.engineType=spark-2.4.3</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.label.codeType=sql</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>Map类参数配置化时，key的格式为</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> [Map前缀] + [key]</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>Map前缀包括：</p><ul><li>executionMap前缀: wds.linkis.client.exec</li><li>sourceMap前缀: wds.linkis.client.source</li><li>configurationMap前缀: wds.linkis.client.param.conf</li><li>runtimeMap前缀: wds.linkis.client.param.runtime</li><li>labelMap前缀: wds.linkis.client.label |
| </li></ul><p>注意： </p><ol><li><p>variableMap不支持配置化</p></li><li><p>当配置的key和指令参数中已输入的key存在冲突时，优先级如下：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain">指令参数 > 指令Map类型参数中的key > 用户配置 > 默认配置</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div></li></ol><p>示例：</p><p>配置引擎启动参数：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI properties"><pre tabindex="0" class="prism-code language-properties codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.param.conf.spark.executor.instances=3</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.param.conf.wds.linkis.yarnqueue=q02</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>配置labelMap参数：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI properties"><pre tabindex="0" class="prism-code language-properties codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> wds.linkis.client.label.myLabel=label123</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="56-输出结果集到文件"></a>5.6 输出结果集到文件<a class="hash-link" href="#56-输出结果集到文件" title="Direct link to heading">#</a></h3><p>使用<code>-outPath</code>参数指定一个输出目录，linkis-cli会将结果集输出到文件，每个结果集会自动创建一个文件，输出形式如下：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> task-[taskId]-result-[idx].txt</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>例如：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> task-906-result-1.txt</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> task-906-result-2.txt</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> task-906-result-3.txt</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/incubator-linkis-website/edit/dev/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/user_guide/linkiscli_manual.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_mS5F" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>编辑</a></div><div class="col lastUpdated_mt2f"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/zh-CN/docs/1.1.0/user_guide/how_to_use"><div class="pagination-nav__sublabel">上一篇</div><div class="pagination-nav__label">« <!-- -->如何使用 Linkis1.0</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/zh-CN/docs/1.1.0/user_guide/sdk_manual"><div class="pagination-nav__sublabel">下一篇</div><div class="pagination-nav__label">JAVA SDK 方式使用<!-- --> »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_vrFS thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#1-介绍" class="table-of-contents__link">1. 介绍</a></li><li><a href="#2-基础案例" class="table-of-contents__link">2. 基础案例</a></li><li><a href="#3-使用方式" class="table-of-contents__link">3. 使用方式</a></li><li><a href="#4-支持的参数列表" class="table-of-contents__link">4. 支持的参数列表</a></li><li><a href="#5-详细示例" class="table-of-contents__link">5. 详细示例</a><ul><li><a href="#51-添加cli参数" class="table-of-contents__link">5.1 添加cli参数</a></li><li><a href="#52-添加引擎初始参数" class="table-of-contents__link">5.2 添加引擎初始参数</a></li><li><a href="#53-添加标签" class="table-of-contents__link">5.3 添加标签</a></li><li><a href="#54-变量替换" class="table-of-contents__link">5.4 变量替换</a></li><li><a href="#55-使用用户配置" class="table-of-contents__link">5.5 使用用户配置</a></li><li><a href="#56-输出结果集到文件" class="table-of-contents__link">5.6 输出结果集到文件</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Linkis</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/zh-CN/docs/latest/introduction">文档</a></li><li class="footer__item"><a class="footer__link-item" href="/zh-CN/faq/main">FAQ</a></li><li class="footer__item"><a href="https://github.com/apache/incubator-linkis/releases" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>版本<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div><div class="col footer__col"><div class="footer__title">社区</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/apache/incubator-linkis" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://github.com/apache/incubator-linkis/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Issue Tracker<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://github.com/apache/incubator-linkis/pulls" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Pull Requests<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div><div class="col footer__col"><div class="footer__title">订阅邮件组</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/zh-CN/community/how-to-subscribe">如何订阅</a></li><li class="footer__item"><a href="mailto:dev-subscribe@linkis.apache.org" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>订阅邮件<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://lists.apache.org/list.html?dev@linkis.apache.org" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>邮件归档<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright"><div style="text-align: left;"> |
| <div> |
| <p style="font-family: Avenir-Medium;font-size: 14px;color: #999;line-height: 20px;">Apache Linkis (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p> |
| </div> |
| <div style="border-top: 1px solid #ccc;min-height: 60px;line-height: 20px;text-align: center;font-family: Avenir-Medium;font-size: 14px;color: #999;display: flex;align-items: center;"><span>Copyright © 2019-2020 The Apache Software Foundation. Apache Linkis, Linkis, and its feather logo are trademarks of The Apache Software Foundation.</span></div> |
| </div></div></div></div></footer></div> |
| <script src="/zh-CN/assets/js/runtime~main.14d5df0c.js"></script> |
| <script src="/zh-CN/assets/js/main.5a9c4743.js"></script> |
| </body> |
| </html> |
