| <!doctype html> |
| <html class="docs-version-0.11.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">0.X SDK的使用 | 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/0.11.0/user_guide/X_sdk_manual"><meta data-react-helmet="true" name="docsearch:language" content="zh-CN"><meta data-react-helmet="true" name="docsearch:version" content="0.11.0"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-0.11.0"><meta data-react-helmet="true" property="og:title" content="0.X SDK的使用 | Apache Linkis"><meta data-react-helmet="true" name="description" content="Linkis 提供了方便的JAVA和SCALA调用的接口，只需要引入ujes-client的模块就可以进行使用"><meta data-react-helmet="true" property="og:description" content="Linkis 提供了方便的JAVA和SCALA调用的接口，只需要引入ujes-client的模块就可以进行使用"><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/0.11.0/user_guide/X_sdk_manual"><link data-react-helmet="true" rel="alternate" href="https://linkis.incubator.apache.org/docs/0.11.0/user_guide/X_sdk_manual" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://linkis.incubator.apache.org/zh-CN/docs/0.11.0/user_guide/X_sdk_manual" hreflang="zh-CN"><link data-react-helmet="true" rel="alternate" href="https://linkis.incubator.apache.org/docs/0.11.0/user_guide/X_sdk_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/0.11.0/user_guide/X_sdk_manual" target="_self" rel="noopener noreferrer" class="dropdown__link" style="text-transform:capitalize">English</a></li><li><a href="/zh-CN/docs/0.11.0/user_guide/X_sdk_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/0.11.0/introduction">Linkis 简述</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 menu__link--active" aria-current="page" tabindex="0" href="/zh-CN/docs/0.11.0/user_guide/X_sdk_manual">0.X SDK的使用</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/0.11.0/user_guide/1.0_sdk_manual">1.0 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></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>0.11.0</b>, 非最新版本。</div><div class="margin-top--md">有关最新文档，请参阅最新稳定版本<b><a href="/zh-CN/docs/latest/introduction">latest version</a></b> (<!-- -->1.1.2<!-- -->).</div></div><div class="docItemContainer_oiyr"><article><span class="theme-doc-version-badge badge badge--secondary">Version: <!-- -->0.11.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>0.X SDK的使用</h1></header><blockquote><p>Linkis 提供了方便的JAVA和SCALA调用的接口，只需要引入ujes-client的模块就可以进行使用</p></blockquote><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><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"><dependency></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> <groupId>com.webank.wedatasphere.linkis</groupId></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> <artifactId>linkis-ujes-client</artifactId></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> <version>0.9.3</version></span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></dependency></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="2-java测试代码"></a>2 Java测试代码<a class="hash-link" href="#2-java测试代码" title="Direct link to heading">#</a></h2><p>建立Java的测试类UJESClientImplTestJ，具体接口含义可以见注释：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI java"><pre tabindex="0" class="prism-code language-java 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">package com.wedatasphere.linkis.ujes.test;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.common.utils.Utils;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.httpclient.dws.authentication.StaticAuthenticationStrategy;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.httpclient.dws.authentication.TokenAuthenticationStrategy;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.httpclient.dws.config.DWSClientConfig;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.httpclient.dws.config.DWSClientConfigBuilder;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.ujes.client.UJESClient;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.ujes.client.UJESClientImpl;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.ujes.client.request.JobExecuteAction;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.ujes.client.request.ResultSetAction;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.ujes.client.response.JobExecuteResult;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.ujes.client.response.JobInfoResult;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.ujes.client.response.JobProgressResult;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import org.apache.commons.io.IOUtils;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import java.util.HashMap;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import java.util.Map;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import java.util.concurrent.TimeUnit;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">public class UJESClientTest {</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> public static void main(String[] args){</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> String user = "hadoop";</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> String executeCode = "show databases;";</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 1. 配置DWSClientBuilder，通过DWSClientBuilder获取一个DWSClientConfig</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> DWSClientConfig clientConfig = ((DWSClientConfigBuilder) (DWSClientConfigBuilder.newBuilder()</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .addUJESServerUrl("http://${ip}:${port}") //指定ServerUrl，linkis服务器端网关的地址,如http://{ip}:{port}</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .connectionTimeout(30000) //connectionTimeOut 客户端连接超时时间</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .discoveryEnabled(false).discoveryFrequency(1, TimeUnit.MINUTES) //是否启用注册发现，如果启用，会自动发现新启动的Gateway </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .loadbalancerEnabled(true) // 是否启用负载均衡，如果不启用注册发现，则负载均衡没有意义</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .maxConnectionSize(5) //指定最大连接数，即最大并发数</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .retryEnabled(false).readTimeout(30000) //执行失败，是否允许重试</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setAuthenticationStrategy(new StaticAuthenticationStrategy()) //AuthenticationStrategy Linkis认证方式</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setAuthTokenKey("${username}").setAuthTokenValue("${password}"))) //认证key，一般为用户名; 认证value，一般为用户名对应的密码</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setDWSVersion("v1").build(); //linkis后台协议的版本，当前版本为v1</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 2. 通过DWSClientConfig获取一个UJESClient</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> UJESClient client = new UJESClientImpl(clientConfig);</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> try {</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 3. 开始执行代码</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> System.out.println("user : " + user + ", code : [" + executeCode + "]");</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> Map<String, Object> startupMap = new HashMap<String, Object>();</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> startupMap.put("wds.linkis.yarnqueue", "default"); // 在startupMap可以存放多种启动参数，参见linkis管理台配置</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> JobExecuteResult jobExecuteResult = client.execute(JobExecuteAction.builder()</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setCreator("linkisClient-Test") //creator，请求linkis的客户端的系统名，用于做系统级隔离</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .addExecuteCode(executeCode) //ExecutionCode 请求执行的代码</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setEngineType((JobExecuteAction.EngineType) JobExecuteAction.EngineType$.MODULE$.HIVE()) // 希望请求的linkis的执行引擎类型，如Spark hive等</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setUser(user) //User，请求用户；用于做用户级多租户隔离</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setStartupParams(startupMap)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .build());</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> System.out.println("execId: " + jobExecuteResult.getExecID() + ", taskId: " + jobExecuteResult.taskID());</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 4. 获取脚本的执行状态</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> JobInfoResult jobInfoResult = client.getJobInfo(jobExecuteResult);</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> int sleepTimeMills = 1000;</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> while(!jobInfoResult.isCompleted()) {</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 5. 获取脚本的执行进度</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> JobProgressResult progress = client.progress(jobExecuteResult);</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> Utils.sleepQuietly(sleepTimeMills);</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> jobInfoResult = client.getJobInfo(jobExecuteResult);</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 6. 获取脚本的Job信息</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> JobInfoResult jobInfo = client.getJobInfo(jobExecuteResult);</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 7. 获取结果集列表（如果用户一次提交多个SQL，会产生多个结果集）</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> String resultSet = jobInfo.getResultSetList(client)[0];</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 8. 通过一个结果集信息，获取具体的结果集</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> Object fileContents = client.resultSet(ResultSetAction.builder().setPath(resultSet).setUser(jobExecuteResult.getUser()).build()).getFileContent();</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> System.out.println("fileContents: " + fileContents);</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> } catch (Exception e) {</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> e.printStackTrace();</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> IOUtils.closeQuietly(client);</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> IOUtils.closeQuietly(client);</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</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>运行上述的代码即可以和Linkis进行交互</p><h2><a aria-hidden="true" tabindex="-1" class="anchor anchor__h2 anchorWithStickyNavbar_y2LR" id="3-scala测试代码"></a>3 Scala测试代码<a class="hash-link" href="#3-scala测试代码" title="Direct link to heading">#</a></h2><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI scala"><pre tabindex="0" class="prism-code language-scala 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">package com.wedatasphere.linkis.ujes.test</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import java.util.concurrent.TimeUnit</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.common.utils.Utils</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.httpclient.dws.authentication.StaticAuthenticationStrategy</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.httpclient.dws.config.DWSClientConfigBuilder</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.ujes.client.UJESClient</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.ujes.client.request.JobExecuteAction.EngineType</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.webank.wedatasphere.linkis.ujes.client.request.{JobExecuteAction, ResultSetAction}</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import org.apache.commons.io.IOUtils</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">object UJESClientImplTest extends App {</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> var executeCode = "show databases;"</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> var user = "hadoop"</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 1. 配置DWSClientBuilder，通过DWSClientBuilder获取一个DWSClientConfig</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val clientConfig = DWSClientConfigBuilder.newBuilder()</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .addUJESServerUrl("http://${ip}:${port}") //指定ServerUrl，Linkis服务器端网关的地址,如http://{ip}:{port}</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .connectionTimeout(30000) //connectionTimeOut 客户端连接超时时间</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .discoveryEnabled(false).discoveryFrequency(1, TimeUnit.MINUTES) //是否启用注册发现，如果启用，会自动发现新启动的Gateway</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .loadbalancerEnabled(true) // 是否启用负载均衡，如果不启用注册发现，则负载均衡没有意义</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .maxConnectionSize(5) //指定最大连接数，即最大并发数</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .retryEnabled(false).readTimeout(30000) //执行失败，是否允许重试</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setAuthenticationStrategy(new StaticAuthenticationStrategy()) //AuthenticationStrategy Linkis认证方式</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setAuthTokenKey("${username}").setAuthTokenValue("${password}") //认证key，一般为用户名; 认证value，一般为用户名对应的密码</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setDWSVersion("v1").build() //Linkis后台协议的版本，当前版本为v1</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 2. 通过DWSClientConfig获取一个UJESClient</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val client = UJESClient(clientConfig)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> try {</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 3. 开始执行代码</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> println("user : " + user + ", code : [" + executeCode + "]")</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val startupMap = new java.util.HashMap[String, Any]()</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> startupMap.put("wds.linkis.yarnqueue", "default") //启动参数配置</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val jobExecuteResult = client.execute(JobExecuteAction.builder()</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setCreator("LinkisClient-Test") //creator，请求Linkis的客户端的系统名，用于做系统级隔离</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .addExecuteCode(executeCode) //ExecutionCode 请求执行的代码</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setEngineType(EngineType.SPARK) // 希望请求的Linkis的执行引擎类型，如Spark hive等</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setStartupParams(startupMap)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setUser(user).build()) //User，请求用户；用于做用户级多租户隔离</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> println("execId: " + jobExecuteResult.getExecID + ", taskId: " + jobExecuteResult.taskID)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 4. 获取脚本的执行状态</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> var jobInfoResult = client.getJobInfo(jobExecuteResult)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val sleepTimeMills : Int = 1000</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> while (!jobInfoResult.isCompleted) {</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 5. 获取脚本的执行进度 </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val progress = client.progress(jobExecuteResult)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val progressInfo = if (progress.getProgressInfo != null) progress.getProgressInfo.toList else List.empty</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> println("progress: " + progress.getProgress + ", progressInfo: " + progressInfo)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> Utils.sleepQuietly(sleepTimeMills)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> jobInfoResult = client.getJobInfo(jobExecuteResult)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> if (!jobInfoResult.isSucceed) {</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> println("Failed to execute job: " + jobInfoResult.getMessage)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> throw new Exception(jobInfoResult.getMessage)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"> |
| </span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 6. 获取脚本的Job信息</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val jobInfo = client.getJobInfo(jobExecuteResult)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 7. 获取结果集列表（如果用户一次提交多个SQL，会产生多个结果集）</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val resultSetList = jobInfoResult.getResultSetList(client)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> println("All result set list:")</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> resultSetList.foreach(println)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val oneResultSet = jobInfo.getResultSetList(client).head</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> // 8. 通过一个结果集信息，获取具体的结果集</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val fileContents = client.resultSet(ResultSetAction.builder().setPath(oneResultSet).setUser(jobExecuteResult.getUser).build()).getFileContent</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> println("First fileContents: ")</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> println(fileContents)</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> } catch {</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> case e: Exception => {</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> e.printStackTrace()</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> IOUtils.closeQuietly(client)</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></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-0.11.0/user_guide/0.X_sdk_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/0.11.0/deployment/sourcecode_hierarchical_structure"><div class="pagination-nav__sublabel">上一篇</div><div class="pagination-nav__label">« <!-- -->源码目录结构</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/zh-CN/docs/0.11.0/user_guide/1.0_sdk_manual"><div class="pagination-nav__sublabel">下一篇</div><div class="pagination-nav__label">1.0 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-java测试代码" class="table-of-contents__link">2 Java测试代码</a></li><li><a href="#3-scala测试代码" class="table-of-contents__link">3 Scala测试代码</a></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> |
