blob: 29a3caf3b861567191b2eb2af08bf5f0bdafafe6 [file] [log] [blame]
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-1.1.0 plugin-docs plugin-id-default docs-doc-id-user-guide/linkis-datasource-client">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.2.0">
<title data-rh="true">DataSource Client SDK | Apache Linkis</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://linkis.apache.org/docs/1.1.0/user-guide/linkis-datasource-client"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="1.1.0"><meta data-rh="true" name="docusaurus_tag" content="docs-default-1.1.0"><meta data-rh="true" name="docsearch:version" content="1.1.0"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-1.1.0"><meta data-rh="true" property="og:title" content="DataSource Client SDK | Apache Linkis"><meta data-rh="true" name="description" content="`"><meta data-rh="true" property="og:description" content="`"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://linkis.apache.org/docs/1.1.0/user-guide/linkis-datasource-client"><link data-rh="true" rel="alternate" href="https://linkis.apache.org/docs/1.1.0/user-guide/linkis-datasource-client" hreflang="en"><link data-rh="true" rel="alternate" href="https://linkis.apache.org/zh-CN/docs/1.1.0/user-guide/linkis-datasource-client" hreflang="zh-CN"><link data-rh="true" rel="alternate" href="https://linkis.apache.org/docs/1.1.0/user-guide/linkis-datasource-client" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://AE29KQB3IA-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache Linkis RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache Linkis Atom Feed">
<link rel="alternate" type="application/json" href="/blog/feed.json" title="Apache Linkis JSON Feed">
<link rel="search" type="application/opensearchdescription+xml" title="Apache Linkis" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.fee819ac.css">
<link rel="preload" href="/assets/js/runtime~main.36b81271.js" as="script">
<link rel="preload" href="/assets/js/main.f09c65a0.js" as="script">
</head>
<body class="navigation-with-keyboard">
<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 role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><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="/"><div class="navbar__logo"><img src="/img/logo.png" alt="Apache Linkis Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.png" alt="Apache Linkis Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache Linkis</b></a><a class="navbar__item navbar__link" href="/download/main">Download</a><a class="navbar__item navbar__link" href="/community/how-to-subscribe">Community</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/team">Team</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/user">Users</a><a href="https://docs.qq.com/doc/DUkdTTGhVSlZ0VXVt" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">FAQ</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://privacy.apache.org/policies/privacy-policy-public.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">Thanks</a></li></ul></div></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Doc</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/latest/about/introduction">1.5.0</a></li><li><a class="dropdown__link" href="/docs/1.4.0/about/introduction">1.4.0</a></li><li><a class="dropdown__link" href="/docs/1.3.2/about/introduction">1.3.2</a></li><li><a class="dropdown__link" href="/docs/1.6.0/about/introduction">Next(1.6.0)</a></li><li><a class="dropdown__link" href="/versions">All Version</a></li></ul></div><a href="https://github.com/apache/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="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/docs/1.1.0/user-guide/linkis-datasource-client" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/zh-CN/docs/1.1.0/user-guide/linkis-datasource-client" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh-CN">简体中文</a></li></ul></div><div class="searchBox_ZlJk"><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 id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/1.1.0/introduction">Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/1.1.0/release">Version Overview</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/deployment/quick-deploy">Deployment</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/1.1.0/user-guide/overview">User Guide</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.1.0/user-guide/overview">Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.1.0/user-guide/how-to-use">How to Use</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.1.0/user-guide/sdk-manual">JAVA SDK Manual</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.1.0/user-guide/linkiscli-manual">Linkis-Cli Manual</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.1.0/user-guide/console-manual">Console User Manual</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/1.1.0/user-guide/linkis-datasource-client">DataSource Client SDK</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/engine-usage/overview">Engine Usage</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/api/overview">API Docs</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/architecture/overview">Architecture</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/development/linkis-compile-and-package">Development</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/upgrade/upgrade-from-0.X-to-1.0-guide">Upgrade Guide</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/tuning-and-troubleshooting/overview">Tuning And Troubleshooting</a></div></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><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>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/latest/about/introduction">latest version</a></b> (<!-- -->1.5.0<!-- -->).</div></div><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">User Guide</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">DataSource Client SDK</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: 1.1.0</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>DataSource Client SDK</h1></header><blockquote><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">Linkis DataSource provides a convenient interface for JAVA and SCALA calls, which can be used only by introducing the module of linkis-datasource-client</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></blockquote><h2 class="anchor anchorWithStickyNavbar_LWe7" id="1-import-dependent-modules">1. import dependent modules<a class="hash-link" href="#1-import-dependent-modules" title="Direct link to heading"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> &lt;dependency&gt;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> &lt;groupId&gt;org.apache.linkis&lt;/groupId&gt;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> &lt;artifactId&gt;linkis-datasource-client&lt;/artifactId&gt;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> &lt;version&gt;${linkis.version}&lt;/version&gt;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> &lt;/dependency&gt;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">如:</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> &lt;dependency&gt;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> &lt;groupId&gt;org.apache.linkis&lt;/groupId&gt;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> &lt;artifactId&gt;linkis-datasource-client&lt;/artifactId&gt;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> &lt;version&gt;1.1.0&lt;/version&gt;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> &lt;/dependency&gt;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="2-scala-test-code">2. Scala Test Code<a class="hash-link" href="#2-scala-test-code" title="Direct link to heading"></a></h2><p>Create a Scala test class LinkisDataSourceClientTest, the specific interface meaning can be seen in the comments:</p><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import com.fasterxml.jackson.databind.ObjectMapper</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import org.apache.linkis.common.utils.JsonUtils</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import org.apache.linkis.datasource.client.impl.{LinkisDataSourceRemoteClient, LinkisMetaDataRemoteClient}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import org.apache.linkis.datasource.client.request.{CreateDataSourceAction, GetAllDataSourceTypesAction, MetadataGetDatabasesAction, UpdateDataSourceParameterAction}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import org.apache.linkis.datasourcemanager.common.domain.{DataSource, DataSourceType}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import org.apache.linkis.httpclient.dws.authentication.StaticAuthenticationStrategy</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import org.apache.linkis.httpclient.dws.config.{DWSClientConfig, DWSClientConfigBuilder}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import java.io.StringWriter</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import java.util</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import java.util.concurrent.TimeUnit</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">object LinkisDataSourceClientTest {</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> def main(args: Array[String]): Unit = {</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val clientConfig =DWSClientConfigBuilder.newBuilder</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .addServerUrl(&quot;http://127.0.0.1:9001&quot;) //set linkis-mg-gateway url: http://{ip}:{port}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .connectionTimeout(30000) //connection timtout</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .discoveryEnabled(false) //disable discovery</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .discoveryFrequency(1, TimeUnit.MINUTES) // discovery frequency</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .loadbalancerEnabled(true) // enable loadbalance</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .maxConnectionSize(5) // set max Connection</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .retryEnabled(false) // set retry</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .readTimeout(30000) //set read timeout</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setAuthenticationStrategy(new StaticAuthenticationStrategy) //AuthenticationStrategy Linkis authen suppory static and Token</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setAuthTokenKey(&quot;hadoop&quot;) // set submit user</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setAuthTokenValue(&quot;xxx&quot;) // set passwd or token</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .setDWSVersion(&quot;v1&quot;) //linkis rest version v1</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> .build</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> //init datasource remote client </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val dataSourceClient = new LinkisDataSourceRemoteClient(clientConfig)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> //init metadata remote client</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val metaDataClient = new LinkisMetaDataRemoteClient(clientConfig)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> //get all datasource type</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> testGetAllDataSourceTypes(dataSourceClient)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> //create kafka datasource</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> testCreateDataSourceForKafka(dataSourceClient)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> //create es datasource</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> testCreateDataSourceForEs(dataSourceClient)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> //update datasource parameter for kafka</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> testUpdateDataSourceParameterForKafka(dataSourceClient)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> //update datasource parameter for es</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> testUpdateDataSourceParameterForEs(dataSourceClient)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> //get hive metadata database list</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> testMetadataGetDatabases(metaDataClient)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">def testGetAllDataSourceTypes(client:LinkisDataSourceRemoteClient): Unit ={</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val getAllDataSourceTypesResult = client.getAllDataSourceTypes(GetAllDataSourceTypesAction.builder().setUser(&quot;hadoop&quot;).build()).getAllDataSourceType</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> System.out.println(getAllDataSourceTypesResult)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">def testCreateDataSourceForKafka(client:LinkisDataSourceRemoteClient): Unit ={</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val dataSource = new DataSource();</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val dataSourceType = new DataSourceType</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSourceType.setName(&quot;kafka&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSourceType.setId(&quot;2&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSourceType.setLayers(2)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSourceType.setClassifier(&quot;message queue&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSourceType.setDescription(&quot;kafka&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSource.setDataSourceType(dataSourceType)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSource.setDataSourceName(&quot;kafka-test&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSource.setCreateSystem(&quot;client&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSource.setDataSourceTypeId(2l);</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val dsJsonWriter = new StringWriter</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val mapper = new ObjectMapper</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> JsonUtils.jackson.writeValue(dsJsonWriter, dataSource)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val map = mapper.readValue(dsJsonWriter.toString,new util.HashMap[String,Any]().getClass)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val id = client.createDataSource(CreateDataSourceAction.builder().setUser(&quot;hadoop&quot;).addRequestPayloads(map).build()).getInsert_id</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> System.out.println(id)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">def testCreateDataSourceForEs(client:LinkisDataSourceRemoteClient): Unit ={</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val dataSource = new DataSource();</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSource.setDataSourceName(&quot;es-test&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSource.setCreateSystem(&quot;client&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dataSource.setDataSourceTypeId(7l);</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val dsJsonWriter = new StringWriter</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val mapper = new ObjectMapper</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> JsonUtils.jackson.writeValue(dsJsonWriter, dataSource)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val map = mapper.readValue(dsJsonWriter.toString,new util.HashMap[String,Any]().getClass)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val id = client.createDataSource(CreateDataSourceAction.builder().setUser(&quot;hadoop&quot;).addRequestPayloads(map).build()).getInsert_id</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> System.out.println(id)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">def testUpdateDataSourceParameterForKafka(client:LinkisDataSourceRemoteClient): Unit ={</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val params = new util.HashMap[String,Any]()</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val connParams = new util.HashMap[String,Any]()</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> connParams.put(&quot;brokers&quot;,&quot;127.0.0.1:9092&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> params.put(&quot;connectParams&quot;,connParams)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> params.put(&quot;comment&quot;,&quot;kafka data source&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> client.updateDataSourceParameter(UpdateDataSourceParameterAction.builder().setUser(&quot;hadoop&quot;).setDataSourceId(&quot;7&quot;).addRequestPayloads(params).build())</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">def testUpdateDataSourceParameterForEs(client:LinkisDataSourceRemoteClient): Unit ={</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val params = new util.HashMap[String,Any]()</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val connParams = new util.HashMap[String,Any]()</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> val elasticUrls = new util.ArrayList[String]()</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> elasticUrls.add(&quot;http://127.0.0.1:9200&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> connParams.put(&quot;elasticUrls&quot;,elasticUrls)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> params.put(&quot;connectParams&quot;,connParams)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> params.put(&quot;comment&quot;,&quot;es data source&quot;)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> client.updateDataSourceParameter(UpdateDataSourceParameterAction.builder().setUser(&quot;hadoop&quot;).setDataSourceId(&quot;8&quot;).addRequestPayloads(params).build())</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> def testMetadataGetDatabases(client:LinkisMetaDataRemoteClient): Unit ={</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> client.getDatabases(MetadataGetDatabasesAction.builder().setUser(&quot;hadoop&quot;).setDataSourceId(9l).setUser(&quot;hadoop&quot;).setSystem(&quot;client&quot;).build()).getDbs</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></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/linkis-website/edit/dev/versioned_docs/version-1.1.0/user-guide/linkis-datasource-client.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_Z9Sw" 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>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.1.0/user-guide/console-manual"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Console User Manual</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.1.0/engine-usage/overview"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Overview</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#1-import-dependent-modules" class="table-of-contents__link toc-highlight">1. import dependent modules</a></li><li><a href="#2-scala-test-code" class="table-of-contents__link toc-highlight">2. Scala Test Code</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Linkis</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/latest/about/introduction">Document</a></li><li class="footer__item"><a class="footer__link-item" href="/faq/main">FAQ</a></li><li class="footer__item"><a href="https://github.com/apache/linkis/releases" target="_blank" rel="noopener noreferrer" class="footer__link-item">Releases</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/apache/linkis" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li><li class="footer__item"><a href="https://github.com/apache/linkis/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">Issue Tracker</a></li><li class="footer__item"><a href="https://github.com/apache/linkis/pulls" target="_blank" rel="noopener noreferrer" class="footer__link-item">Pull Requests</a></li></ul></div><div class="col footer__col"><div class="footer__title">Subscribe Mailing List</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/community/how-to-subscribe">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">Subscribe Mail</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">Mail Archive</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright"><div><img style="height:50px" alt="Apache Software Foundation" src="/img/incubator-logo.svg"><p style="color: #999999; padding: 0 20px 30px;font-weight:400;text-align:left">Apache Linkis is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache 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><p></p>
<p style="padding: 0 20px 30px;color: #999999;font-weight: 400;"> Copyright © 2024 The Apache Software Foundation. Licensed under the Apache License, Version 2.0. Apache Linkis, Apache Incubator, Apache, the Apache feather logo, the Apache Linkis logo and the Apache Incubator project logo are trademarks of The Apache Software Foundation.</p>
<div></div></div></div></div></div></footer></div>
<script src="/assets/js/runtime~main.36b81271.js"></script>
<script src="/assets/js/main.f09c65a0.js"></script>
</body>
</html>