[Doc] Ref docs (#50111)

> Note:
>
> - [ ] Merge this PR
> - [ ] Backport to 3.3, 3.2, 3.1
> - [ ] then, merge https://github.com/StarRocks/docs-site/pull/213
> - [ ] then, build staging
> - [ ] then build prod
> - [ ] then have Algolia crawl
> - [ ] then have Google crawl (submit sitemap.xml)

Our docs require too much micro-management of the navigation because we have all of the hundreds of reference pages in a very small number of folders. By creating a dir structure that matches the nav, we can let the static site generator (Docusaurus) auto generate the nav. This means that when we drop a file into a dir it gets added to the nav.

For example, if you look at the live site today and search for the word `SYNC` you will see that we have a reference page for the SQL statement SYNC. Unfortunately, it is not in the nav, and this causes the reader to wonder where they are in the docs. This is because we forgot to add an entry in the sidebars.js for this file.

Signed-off-by: DanRoscigno <dan@roscigno.com>
Signed-off-by: Dan Roscigno <dan@roscigno.com>
This commit is contained in:
Dan Roscigno 2024-08-27 20:24:06 -04:00 committed by GitHub
parent 7946174130
commit e06217c368
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1958 changed files with 6891 additions and 9288 deletions

View File

@ -1,12 +1,14 @@
# Dependencies
oldsidebars.json
/node_modules
# Production
/build
/docs
**/versioned_docs/**
**/docusaurus-plugin-content-docs/**
**/docusaurus-plugin-content-docs/current/**
i18n/zh/docusaurus-plugin-content-docs-releasenotes/current/*.md
i18n/zh/docusaurus-plugin-content-blog/**
/static/releasenotes
/releasenotes
/common

View File

@ -1,7 +1,7 @@
FROM node:18.18.2
FROM node:21
WORKDIR /app/docusaurus
ENV NODE_OPTIONS="--max-old-space-size=4096"
ENV NODE_OPTIONS="--max-old-space-size=8192"
RUN apt update && apt install -y neovim

View File

@ -131,7 +131,7 @@ const config = {
items: [
{
type: 'docSidebar',
sidebarId: 'English',
sidebarId: 'docs',
position: 'left',
label: 'Documentation',
},

View File

@ -0,0 +1,420 @@
{
"theme.ErrorPageContent.title": {
"message": "页面已崩溃。",
"description": "The title of the fallback page when the page crashed"
},
"theme.BackToTopButton.buttonAriaLabel": {
"message": "回到顶部",
"description": "The ARIA label for the back to top button"
},
"theme.blog.archive.title": {
"message": "历史博文",
"description": "The page & hero title of the blog archive page"
},
"theme.blog.archive.description": {
"message": "历史博文",
"description": "The page & hero description of the blog archive page"
},
"theme.blog.paginator.navAriaLabel": {
"message": "博文列表分页导航",
"description": "The ARIA label for the blog pagination"
},
"theme.blog.paginator.newerEntries": {
"message": "较新的博文",
"description": "The label used to navigate to the newer blog posts page (previous page)"
},
"theme.blog.paginator.olderEntries": {
"message": "较旧的博文",
"description": "The label used to navigate to the older blog posts page (next page)"
},
"theme.blog.post.paginator.navAriaLabel": {
"message": "博文分页导航",
"description": "The ARIA label for the blog posts pagination"
},
"theme.blog.post.paginator.newerPost": {
"message": "较新一篇",
"description": "The blog post button label to navigate to the newer/previous post"
},
"theme.blog.post.paginator.olderPost": {
"message": "较旧一篇",
"description": "The blog post button label to navigate to the older/next post"
},
"theme.blog.post.plurals": {
"message": "{count} 篇博文",
"description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
},
"theme.blog.tagTitle": {
"message": "{nPosts} 含有标签「{tagName}」",
"description": "The title of the page for a blog tag"
},
"theme.tags.tagsPageLink": {
"message": "查看所有标签",
"description": "The label of the link targeting the tag list page"
},
"theme.colorToggle.ariaLabel": {
"message": "切换浅色/暗黑模式(当前为{mode}",
"description": "The ARIA label for the navbar color mode toggle"
},
"theme.colorToggle.ariaLabel.mode.dark": {
"message": "暗黑模式",
"description": "The name for the dark color mode"
},
"theme.colorToggle.ariaLabel.mode.light": {
"message": "浅色模式",
"description": "The name for the light color mode"
},
"theme.docs.breadcrumbs.navAriaLabel": {
"message": "页面路径",
"description": "The ARIA label for the breadcrumbs"
},
"theme.docs.DocCard.categoryDescription": {
"message": "{count} 个项目",
"description": "The default description for a category card in the generated index about how many items this category includes"
},
"theme.docs.paginator.navAriaLabel": {
"message": "文件选项卡",
"description": "The ARIA label for the docs pagination"
},
"theme.docs.paginator.previous": {
"message": "上一页",
"description": "The label used to navigate to the previous doc"
},
"theme.docs.paginator.next": {
"message": "下一页",
"description": "The label used to navigate to the next doc"
},
"theme.docs.tagDocListPageTitle.nDocsTagged": {
"message": "{count} 篇文档带有标签",
"description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
},
"theme.docs.tagDocListPageTitle": {
"message": "{nDocsTagged}「{tagName}」",
"description": "The title of the page for a docs tag"
},
"theme.docs.versionBadge.label": {
"message": "版本:{versionLabel}"
},
"theme.docs.versions.unreleasedVersionLabel": {
"message": "此为 {siteTitle} {versionLabel} 版尚未发行的文档。",
"description": "The label used to tell the user that he's browsing an unreleased doc version"
},
"theme.docs.versions.unmaintainedVersionLabel": {
"message": "此为 {siteTitle} {versionLabel} 版的文档,现已不再积极维护。",
"description": "The label used to tell the user that he's browsing an unmaintained doc version"
},
"theme.docs.versions.latestVersionSuggestionLabel": {
"message": "最新的文档请参阅 {latestVersionLink} ({versionLabel})。",
"description": "The label used to tell the user to check the latest version"
},
"theme.docs.versions.latestVersionLinkLabel": {
"message": "最新版本",
"description": "The label used for the latest version suggestion link label"
},
"theme.common.editThisPage": {
"message": "编辑此页",
"description": "The link label to edit the current page"
},
"theme.common.headingLinkTitle": {
"message": "{heading}的直接链接",
"description": "Title for link to heading"
},
"theme.lastUpdated.atDate": {
"message": "于 {date} ",
"description": "The words used to describe on which date a page has been last updated"
},
"theme.lastUpdated.byUser": {
"message": "由 {user} ",
"description": "The words used to describe by who the page has been last updated"
},
"theme.lastUpdated.lastUpdatedAtBy": {
"message": "最后{byUser}{atDate}更新",
"description": "The sentence used to display when a page has been last updated, and by who"
},
"theme.navbar.mobileVersionsDropdown.label": {
"message": "选择版本",
"description": "The label for the navbar versions dropdown on mobile view"
},
"theme.NotFound.title": {
"message": "找不到页面",
"description": "The title of the 404 page"
},
"theme.tags.tagsListLabel": {
"message": "标签:",
"description": "The label alongside a tag list"
},
"theme.admonition.caution": {
"message": "警告",
"description": "The default label used for the Caution admonition (:::caution)"
},
"theme.admonition.danger": {
"message": "危险",
"description": "The default label used for the Danger admonition (:::danger)"
},
"theme.admonition.info": {
"message": "信息",
"description": "The default label used for the Info admonition (:::info)"
},
"theme.admonition.note": {
"message": "备注",
"description": "The default label used for the Note admonition (:::note)"
},
"theme.admonition.tip": {
"message": "提示",
"description": "The default label used for the Tip admonition (:::tip)"
},
"theme.admonition.warning": {
"message": "注意",
"description": "The default label used for the Warning admonition (:::warning)"
},
"theme.AnnouncementBar.closeButtonAriaLabel": {
"message": "关闭",
"description": "The ARIA label for close button of announcement bar"
},
"theme.blog.sidebar.navAriaLabel": {
"message": "最近博文导航",
"description": "The ARIA label for recent posts in the blog sidebar"
},
"theme.CodeBlock.copied": {
"message": "复制成功",
"description": "The copied button label on code blocks"
},
"theme.CodeBlock.copyButtonAriaLabel": {
"message": "复制代码到剪贴板",
"description": "The ARIA label for copy code blocks button"
},
"theme.CodeBlock.copy": {
"message": "复制",
"description": "The copy button label on code blocks"
},
"theme.CodeBlock.wordWrapToggle": {
"message": "切换自动换行",
"description": "The title attribute for toggle word wrapping button of code block lines"
},
"theme.DocSidebarItem.expandCategoryAriaLabel": {
"message": "展开侧边栏分类 '{label}'",
"description": "The ARIA label to expand the sidebar category"
},
"theme.DocSidebarItem.collapseCategoryAriaLabel": {
"message": "折叠侧边栏分类 '{label}'",
"description": "The ARIA label to collapse the sidebar category"
},
"theme.NavBar.navAriaLabel": {
"message": "主导航",
"description": "The ARIA label for the main navigation"
},
"theme.navbar.mobileLanguageDropdown.label": {
"message": "选择语言",
"description": "The label for the mobile language switcher dropdown"
},
"theme.TOCCollapsible.toggleButtonLabel": {
"message": "本页总览",
"description": "The label used by the button on the collapsible TOC component"
},
"theme.NotFound.p1": {
"message": "我们找不到您要找的页面。",
"description": "The first paragraph of the 404 page"
},
"theme.NotFound.p2": {
"message": "请联系原始链接来源网站的所有者,并告知他们链接已损坏。",
"description": "The 2nd paragraph of the 404 page"
},
"theme.blog.post.readMore": {
"message": "阅读更多",
"description": "The label used in blog post item excerpts to link to full blog posts"
},
"theme.blog.post.readMoreLabel": {
"message": "阅读 {title} 的全文",
"description": "The ARIA label for the link to full blog posts from excerpts"
},
"theme.blog.post.readingTime.plurals": {
"message": "阅读需 {readingTime} 分钟",
"description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
},
"theme.docs.breadcrumbs.home": {
"message": "主页面",
"description": "The ARIA label for the home page in the breadcrumbs"
},
"theme.docs.sidebar.collapseButtonTitle": {
"message": "收起侧边栏",
"description": "The title attribute for collapse button of doc sidebar"
},
"theme.docs.sidebar.collapseButtonAriaLabel": {
"message": "收起侧边栏",
"description": "The title attribute for collapse button of doc sidebar"
},
"theme.docs.sidebar.navAriaLabel": {
"message": "文档侧边栏",
"description": "The ARIA label for the sidebar navigation"
},
"theme.docs.sidebar.closeSidebarButtonAriaLabel": {
"message": "关闭导航栏",
"description": "The ARIA label for close button of mobile sidebar"
},
"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": {
"message": "← 回到主菜单",
"description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"
},
"theme.docs.sidebar.toggleSidebarButtonAriaLabel": {
"message": "切换导航栏",
"description": "The ARIA label for hamburger menu button of mobile navigation"
},
"theme.docs.sidebar.expandButtonTitle": {
"message": "展开侧边栏",
"description": "The ARIA label and title attribute for expand button of doc sidebar"
},
"theme.docs.sidebar.expandButtonAriaLabel": {
"message": "展开侧边栏",
"description": "The ARIA label and title attribute for expand button of doc sidebar"
},
"theme.SearchBar.seeAll": {
"message": "查看全部 {count} 个结果"
},
"theme.SearchPage.documentsFound.plurals": {
"message": "找到 {count} 份文件",
"description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
},
"theme.SearchPage.existingResultsTitle": {
"message": "「{query}」的搜索结果",
"description": "The search page title for non-empty query"
},
"theme.SearchPage.emptyResultsTitle": {
"message": "在文档中搜索",
"description": "The search page title for empty query"
},
"theme.SearchPage.inputPlaceholder": {
"message": "在此输入搜索字词",
"description": "The placeholder for search page input"
},
"theme.SearchPage.inputLabel": {
"message": "搜索",
"description": "The ARIA label for search page input"
},
"theme.SearchPage.algoliaLabel": {
"message": "通过 Algolia 搜索",
"description": "The ARIA label for Algolia mention"
},
"theme.SearchPage.noResultsText": {
"message": "未找到任何结果",
"description": "The paragraph for empty search result"
},
"theme.SearchPage.fetchingNewResults": {
"message": "正在获取新的搜索结果...",
"description": "The paragraph for fetching new search results"
},
"theme.SearchBar.label": {
"message": "搜索",
"description": "The ARIA label and placeholder for search button"
},
"theme.SearchModal.searchBox.resetButtonTitle": {
"message": "清除查询",
"description": "The label and ARIA label for search box reset button"
},
"theme.SearchModal.searchBox.cancelButtonText": {
"message": "取消",
"description": "The label and ARIA label for search box cancel button"
},
"theme.SearchModal.startScreen.recentSearchesTitle": {
"message": "最近搜索",
"description": "The title for recent searches"
},
"theme.SearchModal.startScreen.noRecentSearchesText": {
"message": "没有最近搜索",
"description": "The text when no recent searches"
},
"theme.SearchModal.startScreen.saveRecentSearchButtonTitle": {
"message": "保存这个搜索",
"description": "The label for save recent search button"
},
"theme.SearchModal.startScreen.removeRecentSearchButtonTitle": {
"message": "从历史记录中删除这个搜索",
"description": "The label for remove recent search button"
},
"theme.SearchModal.startScreen.favoriteSearchesTitle": {
"message": "收藏",
"description": "The title for favorite searches"
},
"theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": {
"message": "从收藏列表中删除这个搜索",
"description": "The label for remove favorite search button"
},
"theme.SearchModal.errorScreen.titleText": {
"message": "无法获取结果",
"description": "The title for error screen of search modal"
},
"theme.SearchModal.errorScreen.helpText": {
"message": "你可能需要检查网络连接。",
"description": "The help text for error screen of search modal"
},
"theme.SearchModal.footer.selectText": {
"message": "选中",
"description": "The explanatory text of the action for the enter key"
},
"theme.SearchModal.footer.selectKeyAriaLabel": {
"message": "Enter 键",
"description": "The ARIA label for the Enter key button that makes the selection"
},
"theme.SearchModal.footer.navigateText": {
"message": "导航",
"description": "The explanatory text of the action for the Arrow up and Arrow down key"
},
"theme.SearchModal.footer.navigateUpKeyAriaLabel": {
"message": "向上键",
"description": "The ARIA label for the Arrow up key button that makes the navigation"
},
"theme.SearchModal.footer.navigateDownKeyAriaLabel": {
"message": "向下键",
"description": "The ARIA label for the Arrow down key button that makes the navigation"
},
"theme.SearchModal.footer.closeText": {
"message": "关闭",
"description": "The explanatory text of the action for Escape key"
},
"theme.SearchModal.footer.closeKeyAriaLabel": {
"message": "Esc 键",
"description": "The ARIA label for the Escape key button that close the modal"
},
"theme.SearchModal.footer.searchByText": {
"message": "搜索提供",
"description": "The text explain that the search is making by Algolia"
},
"theme.SearchModal.noResultsScreen.noResultsText": {
"message": "没有结果:",
"description": "The text explains that there are no results for the following search"
},
"theme.SearchModal.noResultsScreen.suggestedQueryText": {
"message": "试试搜索",
"description": "The text for the suggested query when no results are found for the following search"
},
"theme.SearchModal.noResultsScreen.reportMissingResultsText": {
"message": "认为这个查询应该有结果?",
"description": "The text for the question where the user thinks there are missing results"
},
"theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": {
"message": "请告知我们。",
"description": "The text for the link to report missing results"
},
"theme.SearchModal.placeholder": {
"message": "搜索文档",
"description": "The placeholder of the input of the DocSearch pop-up modal"
},
"theme.ErrorPageContent.tryAgain": {
"message": "重试",
"description": "The label of the button to try again rendering when the React error boundary captures an error"
},
"theme.common.skipToMainContent": {
"message": "跳到主要内容",
"description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation"
},
"theme.tags.tagsPageTitle": {
"message": "标签",
"description": "The title of the tag list page"
},
"theme.unlistedContent.title": {
"message": "未列出页",
"description": "The unlisted content banner title"
},
"theme.unlistedContent.message": {
"message": "此页面未列出。搜索引擎不会对其索引,只有拥有直接链接的用户才能访问。",
"description": "The unlisted content banner message"
}
}

View File

@ -0,0 +1,554 @@
{
"version.label": {
"message": "current",
"description": "The label for version current"
},
"sidebar.docs.category.Introduction to StarRocks": {
"message": "产品简介",
"description": "The label for category Introduction to StarRocks in sidebar docs"
},
"sidebar.docs.category.Quick Start": {
"message": "快速开始",
"description": "The label for category Quick Start in sidebar docs"
},
"sidebar.docs.category.Project Help": {
"message": "技术支持",
"description": "The label for category Project Help in sidebar docs"
},
"sidebar.docs.category.Deployment": {
"message": "部署 StarRocks",
"description": "The label for category Deployment in sidebar docs"
},
"sidebar.docs.category.Preparation": {
"message": "前期准备",
"description": "The label for category Preparation in sidebar docs"
},
"sidebar.docs.category.Shared-nothing deployment": {
"message": "存算一体模式部署",
"description": "The label for category Shared-nothing deployment in sidebar docs"
},
"sidebar.docs.category.Shared-data deployment": {
"message": "存算分离模式部署",
"description": "The label for category Shared-data deployment in sidebar docs"
},
"sidebar.docs.category.Manage your deployment": {
"message": "后期管理",
"description": "The label for category Manage your deployment in sidebar docs"
},
"sidebar.docs.category.Table Design": {
"message": "表设计",
"description": "The label for category Table Design in sidebar docs"
},
"sidebar.docs.category.Table types": {
"message": "表类型",
"description": "The label for category Table types in sidebar docs"
},
"sidebar.docs.category.Data distribution": {
"message": "数据分布",
"description": "The label for category Data distribution in sidebar docs"
},
"sidebar.docs.category.Indexes": {
"message": "索引",
"description": "The label for category Indexes in sidebar docs"
},
"sidebar.docs.category.Data Loading": {
"message": "导入数据",
"description": "The label for category Data Loading in sidebar docs"
},
"sidebar.docs.category.Loading overview": {
"message": "导入概览",
"description": "The label for category Loading overview in sidebar docs"
},
"sidebar.docs.category.Load from Object Storage": {
"message": "从对象存储导入",
"description": "The label for category Load from Object Storage in sidebar docs"
},
"sidebar.docs.category.Load data from Apache Kafka": {
"message": "从 Apache Kafka® 导入",
"description": "The label for category Load data from Apache Kafka in sidebar docs"
},
"sidebar.docs.category.Load data from Apache Spark": {
"message": "从 Apache Spark™ 导入",
"description": "The label for category Load data from Apache Spark in sidebar docs"
},
"sidebar.docs.category.Data Unloading": {
"message": "导出数据",
"description": "The label for category Data Unloading in sidebar docs"
},
"sidebar.docs.category.Data Lakes": {
"message": "数据湖",
"description": "The label for category Data Lakes in sidebar docs"
},
"sidebar.docs.category.Catalog": {
"message": "数据目录",
"description": "The label for category Catalog in sidebar docs"
},
"sidebar.docs.category.Data cache": {
"message": "Data cache",
"description": "The label for category Data cache in sidebar docs"
},
"sidebar.docs.category.Query Acceleration": {
"message": "查询加速",
"description": "The label for category Query Acceleration in sidebar docs"
},
"sidebar.docs.category.Asynchronous materialized views": {
"message": "异步物化视图",
"description": "The label for category Asynchronous materialized views in sidebar docs"
},
"sidebar.docs.category.Use cases": {
"message": "使用场景",
"description": "The label for category Use cases in sidebar docs"
},
"sidebar.docs.category.Computing the number of distinct values": {
"message": "数据去重",
"description": "The label for category Computing the number of distinct values in sidebar docs"
},
"sidebar.docs.category.Integrations": {
"message": "外部系统集成",
"description": "The label for category Integrations in sidebar docs"
},
"sidebar.docs.category.Cloud Authentication": {
"message": "CSP 认证鉴权",
"description": "The label for category Cloud Authentication in sidebar docs"
},
"sidebar.docs.category.Streaming Data": {
"message": "实时导入",
"description": "The label for category Streaming Data in sidebar docs"
},
"sidebar.docs.category.Apache Kafka": {
"message": "Apache Kafka",
"description": "The label for category Apache Kafka in sidebar docs"
},
"sidebar.docs.category.StarRocks Pipe": {
"message": "StarRocks Pipe",
"description": "The label for category StarRocks Pipe in sidebar docs"
},
"sidebar.docs.category.Batch Loading Data": {
"message": "批量导入",
"description": "The label for category Batch Loading Data in sidebar docs"
},
"sidebar.docs.category.Loading Tools": {
"message": "导入工具",
"description": "The label for category Loading Tools in sidebar docs"
},
"sidebar.docs.category.BI Tools": {
"message": "BI 工具",
"description": "The label for category BI Tools in sidebar docs"
},
"sidebar.docs.category.IDE Tools": {
"message": "IDE 工具",
"description": "The label for category IDE Tools in sidebar docs"
},
"sidebar.docs.category.Administration": {
"message": "管理手册",
"description": "The label for category Administration in sidebar docs"
},
"sidebar.docs.category.Configuration": {
"message": "配置项",
"description": "The label for category Configuration in sidebar docs"
},
"sidebar.docs.category.Management": {
"message": "运维集群",
"description": "The label for category Management in sidebar docs"
},
"sidebar.docs.category.Monitor and Alert": {
"message": "监控报警",
"description": "The label for category Monitor and Alert in sidebar docs"
},
"sidebar.docs.category.Resource management": {
"message": "管理资源",
"description": "The label for category Resource management in sidebar docs"
},
"sidebar.docs.category.User Privileges and Authentication": {
"message": "管理用户权限",
"description": "The label for category User Privileges and Authentication in sidebar docs"
},
"sidebar.docs.category.Performance Tuning": {
"message": "性能调优",
"description": "The label for category Performance Tuning in sidebar docs"
},
"sidebar.docs.category.Query Profile": {
"message": "Query Profile",
"description": "The label for category Query Profile in sidebar docs"
},
"sidebar.docs.category.Reference": {
"message": "参考手册",
"description": "The label for category Reference in sidebar docs"
},
"sidebar.docs.category.Data Types": {
"message": "数据类型",
"description": "The label for category Data Types in sidebar docs"
},
"sidebar.docs.category.Numeric": {
"message": "数值类型",
"description": "The label for category Numeric in sidebar docs"
},
"sidebar.docs.category.String": {
"message": "字符串类型",
"description": "The label for category String in sidebar docs"
},
"sidebar.docs.category.Date and Time": {
"message": "日期类型",
"description": "The label for category Date and Time in sidebar docs"
},
"sidebar.docs.category.Semi-structured": {
"message": "半结构化类型",
"description": "The label for category Semi-structured in sidebar docs"
},
"sidebar.docs.category.Other": {
"message": "其他类型",
"description": "The label for category Other in sidebar docs"
},
"sidebar.docs.category.SQL Statements": {
"message": "SQL 参考",
"description": "The label for category SQL Statements in sidebar docs"
},
"sidebar.docs.category.SQL Statements.link.generated-index.title": {
"message": "SQL Statements",
"description": "The generated-index page title for category SQL Statements in sidebar docs"
},
"sidebar.docs.category.User account management": {
"message": "用户账户管理",
"description": "The label for category User account management in sidebar docs"
},
"sidebar.docs.category.Cluster management": {
"message": "集群管理",
"description": "The label for category Cluster management in sidebar docs"
},
"sidebar.docs.category.Nodes and processes": {
"message": "节点和进程",
"description": "The label for category Nodes and processes in sidebar docs"
},
"sidebar.docs.category.Configuration variables": {
"message": "系统配置和变量",
"description": "The label for category Configuration variables in sidebar docs"
},
"sidebar.docs.category.Resource group": {
"message": "资源组",
"description": "The label for category Resource group in sidebar docs"
},
"sidebar.docs.category.Storage volume": {
"message": "存储卷",
"description": "The label for category Storage volume in sidebar docs"
},
"sidebar.docs.category.Tablet and replica": {
"message": "TabletReplica 检查修复",
"description": "The label for category Tablet and replica in sidebar docs"
},
"sidebar.docs.category.File": {
"message": "文件",
"description": "The label for category File in sidebar docs"
},
"sidebar.docs.category.SQL blacklist": {
"message": "SQL 黑名单",
"description": "The label for category SQL blacklist in sidebar docs"
},
"sidebar.docs.category.Plugin": {
"message": "插件",
"description": "The label for category Plugin in sidebar docs"
},
"sidebar.docs.category.Execution plan and profile": {
"message": "执行计划和 Profile",
"description": "The label for category Execution plan and profile in sidebar docs"
},
"sidebar.docs.category.Loading and unloading": {
"message": "导入导出",
"description": "The label for category Loading and unloading in sidebar docs"
},
"sidebar.docs.category.ETL": {
"message": "ETL",
"description": "The label for category ETL in sidebar docs"
},
"sidebar.docs.category.pipe": {
"message": "pipe",
"description": "The label for category pipe in sidebar docs"
},
"sidebar.docs.category.routine_load": {
"message": "routine_load",
"description": "The label for category routine_load in sidebar docs"
},
"sidebar.docs.category.unloading": {
"message": "导入导出",
"description": "The label for category unloading in sidebar docs"
},
"sidebar.docs.category.Database": {
"message": "Database",
"description": "The label for category Database in sidebar docs"
},
"sidebar.docs.category.Resource": {
"message": "资源组",
"description": "The label for category Resource in sidebar docs"
},
"sidebar.docs.category.Table, bucket, partition, and index": {
"message": "表,分区,分桶,索引",
"description": "The label for category Table, bucket, partition, and index in sidebar docs"
},
"sidebar.docs.category.View": {
"message": "视图",
"description": "The label for category View in sidebar docs"
},
"sidebar.docs.category.Materialized View": {
"message": "物化视图",
"description": "The label for category Materialized View in sidebar docs"
},
"sidebar.docs.category.Function": {
"message": "函数",
"description": "The label for category Function in sidebar docs"
},
"sidebar.docs.category.CBO statistics": {
"message": "CBO 统计信息",
"description": "The label for category CBO statistics in sidebar docs"
},
"sidebar.docs.category.Backup and restore": {
"message": "备份与恢复",
"description": "The label for category Backup and restore in sidebar docs"
},
"sidebar.docs.category.SQL Functions": {
"message": "函数参考",
"description": "The label for category SQL Functions in sidebar docs"
},
"sidebar.docs.category.aggregate-functions": {
"message": "聚合函数",
"description": "The label for category aggregate-functions in sidebar.docs"
},
"sidebar.docs.category.array-functions": {
"message": "Array 函数",
"description": "The label for category array-functions in sidebar.docs"
},
"sidebar.docs.category.binary-functions": {
"message": "Binary 函数",
"description": "The label for category binary-functions in sidebar.docs"
},
"sidebar.docs.category.bit-functions": {
"message": "Bit 函数",
"description": "The label for category bit-functions in sidebar.docs"
},
"sidebar.docs.category.bitmap-functions": {
"message": "Bitmap 函数",
"description": "The label for category bitmap-functions in sidebar.docs"
},
"sidebar.docs.category.condition-functions": {
"message": "条件函数",
"description": "The label for category condition-functions in sidebar.docs"
},
"sidebar.docs.category.crytographic-functions": {
"message": "加密函数",
"description": "The label for category crytographic-functions in sidebar.docs"
},
"sidebar.docs.category.date-time-functions": {
"message": "时间日期函数",
"description": "The label for category date-time-functions in sidebar.docs"
},
"sidebar.docs.category.dict-functions": {
"message": "字典函数",
"description": "The label for category dict-functions in sidebar.docs"
},
"sidebar.docs.category.hash-functions": {
"message": "Hash 函数",
"description": "The label for category hash-functions in sidebar.docs"
},
"sidebar.docs.category.json-functions": {
"message": "JSON 函数",
"description": "The label for category json-functions in sidebar.docs"
},
"sidebar.docs.category.json-constructor-functions": {
"message": "JSON 构造函数",
"description": "The label for category json-constructor-functions in sidebar.docs"
},
"sidebar.docs.category.json-query-and-processing-functions": {
"message": "JSON 查询和处理函数",
"description": "The label for category json-query-and-processing-functions in sidebar.docs"
},
"sidebar.docs.category.like-predicate-functions": {
"message": "模糊/正则匹配函数",
"description": "The label for category like-predicate-functions in sidebar.docs"
},
"sidebar.docs.category.map-functions": {
"message": "Map 函数",
"description": "The label for category map-functions in sidebar.docs"
},
"sidebar.docs.category.math-functions": {
"message": "数学函数",
"description": "The label for category math-functions in sidebar.docs"
},
"sidebar.docs.category.percentile-functions": {
"message": "百分位函数",
"description": "The label for category percentile-functions in sidebar.docs"
},
"sidebar.docs.category.scalar-functions": {
"message": "标量函数",
"description": "The label for category scalar-functions in sidebar.docs"
},
"sidebar.docs.category.spatial-functions": {
"message": "地理位置函数",
"description": "The label for category spatial-functions in sidebar.docs"
},
"sidebar.docs.category.string-functions": {
"message": "字符串函数",
"description": "The label for category string-functions in sidebar.docs"
},
"sidebar.docs.category.struct-functions": {
"message": "Struct 函数",
"description": "The label for category struct-functions in sidebar.docs"
},
"sidebar.docs.category.table-functions": {
"message": "table-functions",
"description": "The label for category table-functions in sidebar.docs"
},
"sidebar.docs.category.utility-functions": {
"message": "工具函数",
"description": "The label for category utility-functions in sidebar.docs"
},
"sidebar.docs.category.Information Schema": {
"message": "Information Schema",
"description": "The label for category Information Schema in sidebar docs"
},
"sidebar.docs.category.System Metadatabase": {
"message": "System Metadatabase",
"description": "The label for category System Metadatabase in sidebar docs"
},
"sidebar.docs.category.HTTP API": {
"message": "HTTP API",
"description": "The label for category HTTP API in sidebar docs"
},
"sidebar.docs.category.FAQ": {
"message": "常见问题解答",
"description": "The label for category FAQ in sidebar docs"
},
"sidebar.docs.category.Data Migration": {
"message": "Data Migration",
"description": "The label for category Data Migration in sidebar docs"
},
"sidebar.docs.category.Benchmarks": {
"message": "性能测试",
"description": "The label for category Benchmarks in sidebar docs"
},
"sidebar.docs.category.Developers": {
"message": "开发指南",
"description": "The label for category Developers in sidebar docs"
},
"sidebar.docs.category.build-starrocks": {
"message": "build-starrocks",
"description": "The label for category build-starrocks in sidebar docs"
},
"sidebar.docs.category.code-style-guides": {
"message": "code-style-guides",
"description": "The label for category code-style-guides in sidebar docs"
},
"sidebar.docs.category.development-environment": {
"message": "development-environment",
"description": "The label for category development-environment in sidebar docs"
},
"sidebar.docs.category.trace-tools": {
"message": "trace-tools",
"description": "The label for category trace-tools in sidebar docs"
},
"sidebar.docs.link.Kettle connector": {
"message": "Kettle connector",
"description": "The label for link Kettle connector in sidebar docs, linking to https://github.com/StarRocks/starrocks-connector-for-kettle"
},
"sidebar.docs.link.DBT": {
"message": "DBT",
"description": "The label for link DBT in sidebar docs, linking to https://github.com/StarRocks/dbt-starrocks/blob/main/README.md"
},
"sidebar.docs.category.Aggregate": {
"message": "聚合函数",
"description": "The label for category Aggregate in sidebar docs"
},
"sidebar.docs.category.Array": {
"message": "Array 函数",
"description": "The label for category Array in sidebar docs"
},
"sidebar.docs.category.Binary": {
"message": "Binary 函数",
"description": "The label for category Binary in sidebar docs"
},
"sidebar.docs.category.Bit": {
"message": "Bit 函数",
"description": "The label for category Bit in sidebar docs"
},
"sidebar.docs.category.Bitmap": {
"message": "Bitmap 函数",
"description": "The label for category Bitmap in sidebar docs"
},
"sidebar.docs.category.Condition": {
"message": "条件函数",
"description": "The label for category Condition in sidebar docs"
},
"sidebar.docs.category.Cryptographic": {
"message": "加密函数",
"description": "The label for category Cryptographic in sidebar docs"
},
"sidebar.docs.category.Date and time": {
"message": "时间日期函数",
"description": "The label for category Date and time in sidebar docs"
},
"sidebar.docs.category.Dictionary": {
"message": "字典函数",
"description": "The label for category Dictionary in sidebar docs"
},
"sidebar.docs.category.Hash": {
"message": "Hash 函数",
"description": "The label for category Hash in sidebar docs"
},
"sidebar.docs.category.JSON": {
"message": "JSON 函数",
"description": "The label for category JSON in sidebar docs"
},
"sidebar.docs.category.JSON Constructor": {
"message": "JSON 构造函数",
"description": "The label for category JSON Constructor in sidebar docs"
},
"sidebar.docs.category.JSON query and processing": {
"message": "JSON 查询和处理函数",
"description": "The label for category JSON query and processing in sidebar docs"
},
"sidebar.docs.category.Pattern matching": {
"message": "模糊/正则匹配函数",
"description": "The label for category Pattern matching in sidebar docs"
},
"sidebar.docs.category.Map": {
"message": "Map 函数",
"description": "The label for category Map in sidebar docs"
},
"sidebar.docs.category.Math": {
"message": "数学函数",
"description": "The label for category Math in sidebar docs"
},
"sidebar.docs.category.Percentile": {
"message": "百分位函数",
"description": "The label for category Percentile in sidebar docs"
},
"sidebar.docs.category.Scalar": {
"message": "标量函数",
"description": "The label for category Scalar in sidebar docs"
},
"sidebar.docs.category.Spatial": {
"message": "地理位置函数",
"description": "The label for category Spatial in sidebar docs"
},
"sidebar.docs.category.Struct": {
"message": "Struct 函数",
"description": "The label for category Struct in sidebar docs"
},
"sidebar.docs.category.Table": {
"message": "Table",
"description": "The label for category Table in sidebar docs"
},
"sidebar.docs.category.Utility": {
"message": "工具函数",
"description": "The label for category Utility in sidebar docs"
},
"sidebar.docs.category.Data types": {
"message": "Data types",
"description": "The label for category Data types in sidebar docs"
},
"sidebar.docs.category.SQL statements": {
"message": "SQL 参考",
"description": "The label for category SQL statements in sidebar docs"
},
"sidebar.docs.category.系统元数据库": {
"message": "系统元数据库",
"description": "The label for category 系统元数据库 in sidebar docs"
}
}

View File

@ -0,0 +1,14 @@
{
"link.title.Docs": {
"message": "Docs",
"description": "The title of the footer links column with title=Docs in the footer"
},
"link.item.label.Documentation": {
"message": "Documentation",
"description": "The label of footer link with label=Documentation linking to /docs/introduction/StarRocks_intro"
},
"copyright": {
"message": "Docs built with Docusaurus.",
"description": "The footer copyright"
}
}

View File

@ -0,0 +1,18 @@
{
"title": {
"message": "StarRocks",
"description": "The title in the navbar"
},
"logo.alt": {
"message": "StarRocks Logo",
"description": "The alt text of navbar logo"
},
"item.label.Documentation": {
"message": "Documentation",
"description": "Navbar item with label Documentation"
},
"item.label.GitHub": {
"message": "GitHub",
"description": "Navbar item with label GitHub"
}
}

View File

@ -18,9 +18,9 @@
"dependencies": {
"@algolia/client-search": "^4.20.0",
"@docsearch/react": "3",
"@docusaurus/core": "^3.1.1",
"@docusaurus/preset-classic": "^3.1.1",
"@docusaurus/theme-search-algolia": "^3.1.1",
"@docusaurus/core": "^3.5.2",
"@docusaurus/preset-classic": "^3.5.2",
"@docusaurus/theme-search-algolia": "^3.5.2",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"fs-extra": "^11.1.1",
@ -29,8 +29,8 @@
"react-dom": "^18.2.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.1.1",
"@docusaurus/types": "^3.1.1"
"@docusaurus/module-type-aliases": "^3.5.2",
"@docusaurus/types": "^3.5.2"
},
"browserslist": {
"production": [

View File

@ -6,6 +6,7 @@ docker run --rm --interactive --tty \
-e DISABLE_VERSIONING=true \
--volume $DOCS_DIR/docusaurus/sidebars.json:/app/docusaurus/sidebars.json \
--volume $DOCS_DIR/en:/app/docusaurus/docs \
--volume "$DOCS_DIR/docusaurus/i18n:/app/docusaurus/i18n" \
--volume "$DOCS_DIR/zh:/app/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current" \
-p 3000:3000 \
docs-build /app/docusaurus/scripts/build-and-serve.sh

File diff suppressed because it is too large Load Diff

View File

@ -25,7 +25,7 @@ const ChineseFeatureList = [
},
{
title: '导入数据',
url: '../../loading/Loading_intro/',
url: '../../loading/loading_introduction/Loading_intro/',
description: (
<>
数据清洗转换导入
@ -52,7 +52,7 @@ const ChineseFeatureList = [
},
{
title: '半结构化类型',
url: '../../sql-reference/overview-pages/semi_structured/',
url: '../../category/semi-structured/',
description: (
<>
JSON, map, struct, array
@ -79,7 +79,7 @@ const ChineseFeatureList = [
},
{
title: '参考手册',
url: '../../reference/',
url: '../../category/reference/',
description: (
<>
SQL 语法命令函数变量
@ -127,7 +127,7 @@ const EnglishFeatureList = [
},
{
title: 'Data Loading',
url: '../../loading/Loading_intro/',
url: '../../loading/loading_introduction/Loading_intro/',
description: (
<>
Clean, transform, and load
@ -154,7 +154,7 @@ const EnglishFeatureList = [
},
{
title: 'Work with semi-structured data',
url: '../../sql-reference/overview-pages/semi_structured/',
url: '../../category/semi-structured/',
description: (
<>
JSON, map, struct, array
@ -181,7 +181,7 @@ const EnglishFeatureList = [
},
{
title: 'Reference',
url: '../../reference/',
url: '../../category/reference/',
description: (
<>
SQL, functions, error codes,

File diff suppressed because it is too large Load Diff

View File

@ -4,6 +4,6 @@ FE parameters are classified into dynamic parameters and static parameters.
- Static parameters can only be configured and adjusted in the FE configuration file **fe.conf**. **After you modify this file, you must restart your FE for the changes to take effect.**
Whether a parameter is a dynamic parameter is indicated by the `IsMutable` column in the output of [ADMIN SHOW CONFIG](../../sql-reference/sql-statements/Administration/ADMIN_SHOW_CONFIG.md). `TRUE` indicates a dynamic parameter.
Whether a parameter is a dynamic parameter is indicated by the `IsMutable` column in the output of [ADMIN SHOW CONFIG](../../sql-reference/sql-statements/cluster-management/config_vars/ADMIN_SHOW_CONFIG.md). `TRUE` indicates a dynamic parameter.
Note that both dynamic and static FE parameters can be configured in the **fe.conf** file.

View File

@ -1,7 +1,7 @@
- Synchronous loading using [INSERT](../../sql-reference/sql-statements/data-manipulation/INSERT.md)+[`FILES()`](../../sql-reference/sql-functions/table-functions/files.md)
- Asynchronous loading using [Broker Load](../../sql-reference/sql-statements/data-manipulation/BROKER_LOAD.md)
- Continuous asynchronous loading using [Pipe](../../sql-reference/sql-statements/data-manipulation/CREATE_PIPE.md)
- Synchronous loading using [INSERT](../../sql-reference/sql-statements/loading_unloading/INSERT.md)+[`FILES()`](../../sql-reference/sql-functions/table-functions/files.md)
- Asynchronous loading using [Broker Load](../../sql-reference/sql-statements/loading_unloading/BROKER_LOAD.md)
- Continuous asynchronous loading using [Pipe](../../sql-reference/sql-statements/loading_unloading/pipe/CREATE_PIPE.md)
Each of these options has its own advantages, which are detailed in the following sections.

View File

@ -1,5 +1,5 @@
For more information on how to create a storage volume for other object storages and set the default storage volume, see [CREATE STORAGE VOLUME](../../sql-reference/sql-statements/Administration/CREATE_STORAGE_VOLUME.md) and [SET DEFAULT STORAGE VOLUME](../../sql-reference/sql-statements/Administration/SET_DEFAULT_STORAGE_VOLUME.md).
For more information on how to create a storage volume for other object storages and set the default storage volume, see [CREATE STORAGE VOLUME](../../sql-reference/sql-statements/cluster-management/storage_volume/CREATE_STORAGE_VOLUME.md) and [SET DEFAULT STORAGE VOLUME](../../sql-reference/sql-statements/cluster-management/storage_volume/SET_DEFAULT_STORAGE_VOLUME.md).
### Create a database and a cloud-native table
@ -69,7 +69,7 @@ Whether to allow data to be written into object storage asynchronously. Default:
### View table information
You can view the information of tables in a specific database using `SHOW PROC "/dbs/<db_id>"`. See [SHOW PROC](../../sql-reference/sql-statements/Administration/SHOW_PROC.md) for more information.
You can view the information of tables in a specific database using `SHOW PROC "/dbs/<db_id>"`. See [SHOW PROC](../../sql-reference/sql-statements/cluster-management/nodes_processes/SHOW_PROC.md) for more information.
Example:
@ -90,7 +90,7 @@ Shared-data StarRocks clusters support all loading methods provided by StarRocks
### Query in a shared-data StarRocks cluster
Tables in a shared-data StarRocks cluster support all types of queries provided by StarRocks. See StarRocks [SELECT](../../sql-reference/sql-statements/data-manipulation/SELECT.md) for more information.
Tables in a shared-data StarRocks cluster support all types of queries provided by StarRocks. See StarRocks [SELECT](../../sql-reference/sql-statements/table_bucket_part_index/SELECT.md) for more information.
> **NOTE**
>

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Data Recovery

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Metadata Recovery

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Performance Optimization

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Query analysis
@ -16,7 +16,7 @@ Query performance in StarRocks is determined by query planning and query executi
A query plan provides the DBA with a macro perspective to access query information. A query plan is the key to query performance and a good resource for the DBA to reference. The following code snippet uses `TPCDS query96` as an example to show how to view a query plan.
Use the [EXPLAIN](../sql-reference/sql-statements/Administration/EXPLAIN.md) statement to view the plan of a query.
Use the [EXPLAIN](../sql-reference/sql-statements/cluster-management/plan_profile/EXPLAIN.md) statement to view the plan of a query.
~~~SQL
EXPLAIN select count(*)
@ -204,9 +204,9 @@ Query hints are directives or comments that explicitly suggest the query optimiz
### System variable hint
You can use a `SET_VAR` hint to set one or more [system variables](../reference/System_variable.md) in SELECT and SUBMIT TASK statements, and then execute the statements. You can also use a `SET_VAR` hint in the SELECT clause included in other statements, such as CREATE MATERIALIZED VIEW AS SELECT and CREATE VIEW AS SELECT. Note that if the `SET_VAR` hint is used in the SELECT clause of CTE, the `SET_VAR` hint does not take effect even if the statement is executed successfully.
You can use a `SET_VAR` hint to set one or more [system variables](../sql-reference/System_variable.md) in SELECT and SUBMIT TASK statements, and then execute the statements. You can also use a `SET_VAR` hint in the SELECT clause included in other statements, such as CREATE MATERIALIZED VIEW AS SELECT and CREATE VIEW AS SELECT. Note that if the `SET_VAR` hint is used in the SELECT clause of CTE, the `SET_VAR` hint does not take effect even if the statement is executed successfully.
Compared with [the general usage of system variables](../reference/System_variable.md) which takes effect at the session level, the `SET_VAR` hint takes effect at the statement level and does not impact the entire session.
Compared with [the general usage of system variables](../sql-reference/System_variable.md) which takes effect at the session level, the `SET_VAR` hint takes effect at the statement level and does not impact the entire session.
#### Syntax
@ -243,9 +243,9 @@ AS SELECT /*+ SET_VAR(query_timeout=500) */ * from dual;
### User-defined variable hint
You can use a `SET_USER_VARIABLE` hint to set one or more [user-defined variables](../reference/user_defined_variables.md) in the SELECT statements or INSERT statements. If other statements contain a SELECT clause, you can also use the `SET_USER_VARIABLE` hint in that SELECT clause. Other statements can be SELECT statements and INSERT statements, but cannot be CREATE MATERIALIZED VIEW AS SELECT statements and CREATE VIEW AS SELECT statements. Note that if the `SET_USER_VARIABLE` hint is used in the SELECT clause of CTE, the `SET_USER_VARIABLE` hint does not take effect even if the statement is executed successfully. Since v3.2.4, StarRocks supports the user-defined variable hint.
You can use a `SET_USER_VARIABLE` hint to set one or more [user-defined variables](../sql-reference/user_defined_variables.md) in the SELECT statements or INSERT statements. If other statements contain a SELECT clause, you can also use the `SET_USER_VARIABLE` hint in that SELECT clause. Other statements can be SELECT statements and INSERT statements, but cannot be CREATE MATERIALIZED VIEW AS SELECT statements and CREATE VIEW AS SELECT statements. Note that if the `SET_USER_VARIABLE` hint is used in the SELECT clause of CTE, the `SET_USER_VARIABLE` hint does not take effect even if the statement is executed successfully. Since v3.2.4, StarRocks supports the user-defined variable hint.
Compared with [the general usage of user-defined variables](../reference/user_defined_variables.md) which takes effect at the session level, the `SET_USER_VARIABLE` hint takes effect at the statement level and does not impact the entire session.
Compared with [the general usage of user-defined variables](../sql-reference/user_defined_variables.md) which takes effect at the session level, the `SET_USER_VARIABLE` hint takes effect at the statement level and does not impact the entire session.
#### Syntax

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Administration

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Cross-cluster Data Migration Tool

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Manage BE Blacklist
@ -19,7 +19,7 @@ By default, StarRocks can automatically manage the BE Blacklist, adding the BE n
## Add a BE to the blacklist
You can manually add a BE node to the BE Blacklist using [ADD BACKEND BLACKLIST](../../sql-reference/sql-statements/Administration/ADD_BACKEND_BLACKLIST.md). In this statement, you must specify the ID of the BE node to be blacklisted. You can obtain the BE ID by executing [SHOW BACKENDS](../../sql-reference/sql-statements/Administration/SHOW_BACKENDS.md).
You can manually add a BE node to the BE Blacklist using [ADD BACKEND BLACKLIST](../../sql-reference/sql-statements/cluster-management/nodes_processes/ADD_BACKEND_BLACKLIST.md). In this statement, you must specify the ID of the BE node to be blacklisted. You can obtain the BE ID by executing [SHOW BACKENDS](../../sql-reference/sql-statements/cluster-management/nodes_processes/SHOW_BACKENDS.md).
Example:
@ -36,7 +36,7 @@ ADD BACKEND BLACKLIST 10001;
## Remove a BE from blacklist
You can manually remove a BE node from the BE Blacklist using [DELETE BACKEND BLACKLIST](../../sql-reference/sql-statements/Administration/DELETE_BACKEND_BLACKLIST.md). In this statement, you must also specify the ID of the BE node.
You can manually remove a BE node from the BE Blacklist using [DELETE BACKEND BLACKLIST](../../sql-reference/sql-statements/cluster-management/nodes_processes/DELETE_BACKEND_BLACKLIST.md). In this statement, you must also specify the ID of the BE node.
Example:
@ -46,7 +46,7 @@ DELETE BACKEND BLACKLIST 10001;
## View BE Blacklist
You can view the BE nodes in the BE Blacklist using [SHOW BACKEND BLACKLIST](../../sql-reference/sql-statements/Administration/SHOW_BACKEND_BLACKLIST.md).
You can view the BE nodes in the BE Blacklist using [SHOW BACKEND BLACKLIST](../../sql-reference/sql-statements/cluster-management/nodes_processes/SHOW_BACKEND_BLACKLIST.md).
Example:
@ -77,4 +77,4 @@ You can configure the automatic management of the BE Blacklist using the followi
- `black_host_history_sec`: The time duration for retaining historical connection failures of BE nodes in the BE Blacklist.
- `black_host_connect_failures_within_time`: The threshold of connection failures allowed for a blacklisted BE node.
If a BE node is added to the BE Blacklist automatically, StarRocks will assess its connectivity and judge whether it can be removed from the BE Blacklist. Within `black_host_history_sec`, only if a blacklisted BE node has fewer connection failures than the threshold set in `black_host_connect_failures_within_time`, it can be removed from the BE Blacklist.
If a BE node is added to the BE Blacklist automatically, StarRocks will assess its connectivity and judge whether it can be removed from the BE Blacklist. Within `black_host_history_sec`, only if a blacklisted BE node has fewer connection failures than the threshold set in `black_host_connect_failures_within_time`, it can be removed from the BE Blacklist.

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
import BEConfigMethod from '../../_assets/commonMarkdown/BE_config_method.md'

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Back up and restore data
@ -26,7 +26,7 @@ If you have stored a large amount of data in a table, we recommend that you back
### Create a repository
Before backing up data, you need to create a repository, which is used to store data snapshots in a remote storage system. You can create multiple repositories in a StarRocks cluster. For detailed instructions, see [CREATE REPOSITORY](../../sql-reference/sql-statements/data-definition/backup_restore/CREATE_REPOSITORY.md).
Before backing up data, you need to create a repository, which is used to store data snapshots in a remote storage system. You can create multiple repositories in a StarRocks cluster. For detailed instructions, see [CREATE REPOSITORY](../../sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md).
- Create a repository in HDFS
@ -107,11 +107,11 @@ PROPERTIES(
>
> StarRocks supports creating repositories in Google GCS only according to the S3A protocol. Therefore, when you create repositories in Google GCS, you must replace the prefix in the GCS URI you pass as a repository location in `ON LOCATION` with `s3a://`.
After the repository is created, you can check the repository via [SHOW REPOSITORIES](../../sql-reference/sql-statements/data-manipulation/backup_restore/SHOW_REPOSITORIES.md). After restoring data, you can delete the repository in StarRocks using [DROP REPOSITORY](../../sql-reference/sql-statements/data-definition/backup_restore/DROP_REPOSITORY.md). However, data snapshots backed up in the remote storage system cannot be deleted through StarRocks. You need to delete them manually in the remote storage system.
After the repository is created, you can check the repository via [SHOW REPOSITORIES](../../sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md). After restoring data, you can delete the repository in StarRocks using [DROP REPOSITORY](../../sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md). However, data snapshots backed up in the remote storage system cannot be deleted through StarRocks. You need to delete them manually in the remote storage system.
### Back up a data snapshot
After the repository is created, you need to create a data snapshot and back up it in the remote repository. For detailed instructions, see [BACKUP](../../sql-reference/sql-statements/data-definition/backup_restore/BACKUP.md).
After the repository is created, you need to create a data snapshot and back up it in the remote repository. For detailed instructions, see [BACKUP](../../sql-reference/sql-statements/backup_restore/BACKUP.md).
The following example creates a data snapshot `sr_member_backup` for the table `sr_member` in the database `sr_hub` and backs up it in the repository `test_repo`.
@ -130,7 +130,7 @@ StarRocks supports BACKUP and RESTORE operations on the following levels of gran
:::
BACKUP is an asynchronous operation. You can check the status of a BACKUP job using [SHOW BACKUP](../../sql-reference/sql-statements/data-manipulation/backup_restore/SHOW_BACKUP.md), or cancel a BACKUP job using [CANCEL BACKUP](../../sql-reference/sql-statements/data-definition/backup_restore/CANCEL_BACKUP.md).
BACKUP is an asynchronous operation. You can check the status of a BACKUP job using [SHOW BACKUP](../../sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md), or cancel a BACKUP job using [CANCEL BACKUP](../../sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md).
## Restore or migrate data
@ -142,7 +142,7 @@ To migrate data to another StarRocks cluster, you need to create a repository wi
### Check the snapshot
Before restoring data, you can check the snapshots in a specified repository using [SHOW SNAPSHOT](../../sql-reference/sql-statements/data-manipulation/backup_restore/SHOW_SNAPSHOT.md).
Before restoring data, you can check the snapshots in a specified repository using [SHOW SNAPSHOT](../../sql-reference/sql-statements/backup_restore/SHOW_SNAPSHOT.md).
The following example checks the snapshot information in `test_repo`.
@ -158,7 +158,7 @@ mysql> SHOW SNAPSHOT ON test_repo;
### Restore data via the snapshot
You can use the [RESTORE](../../sql-reference/sql-statements/data-definition/backup_restore/RESTORE.md) statement to restore data snapshots in the remote storage system to the current or other StarRocks clusters.
You can use the [RESTORE](../../sql-reference/sql-statements/backup_restore/RESTORE.md) statement to restore data snapshots in the remote storage system to the current or other StarRocks clusters.
The following example restores the data snapshot `sr_member_backup` in `test_repo` on the table `sr_member`. It only restores ONE data replica.
@ -181,7 +181,7 @@ StarRocks supports BACKUP and RESTORE operations on the following levels of gran
:::
RESTORE is an asynchronous operation. You can check the status of a RESTORE job using [SHOW RESTORE](../../sql-reference/sql-statements/data-manipulation/backup_restore/SHOW_RESTORE.md), or cancel a RESTORE job using [CANCEL RESTORE](../../sql-reference/sql-statements/data-definition/backup_restore/CANCEL_RESTORE.md).
RESTORE is an asynchronous operation. You can check the status of a RESTORE job using [SHOW RESTORE](../../sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md), or cancel a RESTORE job using [CANCEL RESTORE](../../sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md).
## Configure BACKUP or RESTORE jobs
@ -216,10 +216,10 @@ During BACKUP and RESTORE of a database, StarRocks does as follows:
Any error encountered throughout the RESTORE process will not block the process.
After RESTORE, you can check the status of the materialized view using [SHOW MATERIALIZED VIEWS](../../sql-reference/sql-statements/data-manipulation/SHOW_MATERIALIZED_VIEW.md).
After RESTORE, you can check the status of the materialized view using [SHOW MATERIALIZED VIEWS](../../sql-reference/sql-statements/materialized_view/SHOW_MATERIALIZED_VIEW.md).
- If the materialized view is active, it can be used directly.
- If the materialized view is inactive, it might be because its base tables are not restored. After all the base tables are restored, you can use [ALTER MATERIALIZED VIEW](../../sql-reference/sql-statements/data-definition/ALTER_MATERIALIZED_VIEW.md) to re-activate the materialized view.
- If the materialized view is inactive, it might be because its base tables are not restored. After all the base tables are restored, you can use [ALTER MATERIALIZED VIEW](../../sql-reference/sql-statements/materialized_view/ALTER_MATERIALIZED_VIEW.md) to re-activate the materialized view.
## Usage notes

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
import FEConfigMethod from '../../_assets/commonMarkdown/FE_config_method.md'
@ -20,7 +20,7 @@ After your FE is started, you can run the ADMIN SHOW FRONTEND CONFIG command on
ADMIN SHOW FRONTEND CONFIG [LIKE "pattern"];
```
For detailed description of the returned fields, see [ADMIN SHOW CONFIG](../../sql-reference/sql-statements/Administration/ADMIN_SHOW_CONFIG.md).
For detailed description of the returned fields, see [ADMIN SHOW CONFIG](../../sql-reference/sql-statements/cluster-management/config_vars/ADMIN_SHOW_CONFIG.md).
:::note
You must have administrator privileges to run cluster administration-related commands.
@ -30,7 +30,7 @@ You must have administrator privileges to run cluster administration-related com
### Configure FE dynamic parameters
You can configure or modify the settings of FE dynamic parameters using [ADMIN SET FRONTEND CONFIG](../../sql-reference/sql-statements/Administration/ADMIN_SET_CONFIG.md).
You can configure or modify the settings of FE dynamic parameters using [ADMIN SET FRONTEND CONFIG](../../sql-reference/sql-statements/cluster-management/config_vars/ADMIN_SET_CONFIG.md).
```SQL
ADMIN SET FRONTEND CONFIG ("key" = "value");
@ -2133,7 +2133,7 @@ ADMIN SET FRONTEND CONFIG ("key" = "value");
- Type: Long
- Unit: Seconds
- Is mutable: Yes
- Description: The maximum time for each Routine Load task within the cluster to consume data. Since v3.1.0, Routine Load job supports a new parameter `task_consume_second` in [job_properties](../../sql-reference/sql-statements/data-manipulation/CREATE_ROUTINE_LOAD.md#job_properties). This parameter applies to individual load tasks within a Routine Load job, which is more flexible.
- Description: The maximum time for each Routine Load task within the cluster to consume data. Since v3.1.0, Routine Load job supports a new parameter `task_consume_second` in [job_properties](../../sql-reference/sql-statements/loading_unloading/routine_load/CREATE_ROUTINE_LOAD.md#job_properties). This parameter applies to individual load tasks within a Routine Load job, which is more flexible.
- Introduced in: -
##### routine_load_task_timeout_second
@ -2142,7 +2142,7 @@ ADMIN SET FRONTEND CONFIG ("key" = "value");
- Type: Long
- Unit: Seconds
- Is mutable: Yes
- Description: The timeout duration for each Routine Load task within the cluster. Since v3.1.0, Routine Load job supports a new parameter `task_timeout_second` in [job_properties](../../sql-reference/sql-statements/data-manipulation/CREATE_ROUTINE_LOAD.md#job_properties). This parameter applies to individual load tasks within a Routine Load job, which is more flexible.
- Description: The timeout duration for each Routine Load task within the cluster. Since v3.1.0, Routine Load job supports a new parameter `task_timeout_second` in [job_properties](../../sql-reference/sql-statements/loading_unloading/routine_load/CREATE_ROUTINE_LOAD.md#job_properties). This parameter applies to individual load tasks within a Routine Load job, which is more flexible.
- Introduced in: -
<!--
@ -2380,7 +2380,7 @@ ADMIN SET FRONTEND CONFIG ("key" = "value");
- Type: Long
- Unit: Seconds
- Is mutable: Yes
- Description: The longest duration the metadata can be retained after a database, table, or partition is dropped. If this duration expires, the data will be deleted and cannot be recovered through the [RECOVER](../../sql-reference/sql-statements/data-definition/backup_restore/RECOVER.md) command.
- Description: The longest duration the metadata can be retained after a database, table, or partition is dropped. If this duration expires, the data will be deleted and cannot be recovered through the [RECOVER](../../sql-reference/sql-statements/backup_restore/RECOVER.md) command.
- Introduced in: -
##### enable_auto_tablet_distribution
@ -2473,7 +2473,7 @@ ADMIN SET FRONTEND CONFIG ("key" = "value");
> **NOTE**
>
> - StarRocks shared-data clusters supports this parameter from v3.3.0.
> - If you need to configure the fast schema evolution for a specific table, such as disabling fast schema evolution for a specific table, you can set the table property [`fast_schema_evolution`](../../sql-reference/sql-statements/data-definition/CREATE_TABLE.md#set-fast-schema-evolution) at table creation.
> - If you need to configure the fast schema evolution for a specific table, such as disabling fast schema evolution for a specific table, you can set the table property [`fast_schema_evolution`](../../sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE.md#set-fast-schema-evolution) at table creation.
##### recover_with_empty_tablet

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Scale in and out

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Manage audit logs within StarRocks via AuditLoader
@ -10,7 +10,7 @@ StarRocks stores its audit logs in the local file **fe/log/fe.audit.log** rather
## Create a table to store audit logs
Create a database and a table in your StarRocks cluster to store its audit logs. See [CREATE DATABASE](../../sql-reference/sql-statements/data-definition/CREATE_DATABASE.md) and [CREATE TABLE](../../sql-reference/sql-statements/data-definition/CREATE_TABLE.md) for detailed instructions.
Create a database and a table in your StarRocks cluster to store its audit logs. See [CREATE DATABASE](../../sql-reference/sql-statements/Database/CREATE_DATABASE.md) and [CREATE TABLE](../../sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE.md) for detailed instructions.
Because the fields of audit logs vary among different StarRocks versions, you must choose among the following examples to create a table that is compatible with your StarRocks.
@ -111,11 +111,11 @@ Execute the following statement along with the path you copied to install AuditL
INSTALL PLUGIN FROM "<absolute_path_to_package>";
```
See [INSTALL PLUGIN](../../sql-reference/sql-statements/Administration/INSTALL_PLUGIN.md) for detailed instructions.
See [INSTALL PLUGIN](../../sql-reference/sql-statements/cluster-management/plugin/INSTALL_PLUGIN.md) for detailed instructions.
## Verify the installation and query audit logs
1. You can check if the installation is successful via [SHOW PLUGINS](../../sql-reference/sql-statements/Administration/SHOW_PLUGINS.md).
1. You can check if the installation is successful via [SHOW PLUGINS](../../sql-reference/sql-statements/cluster-management/plugin/SHOW_PLUGINS.md).
In the following example, the `Status` of the plugin `AuditLoader` is `INSTALLED`, meaning installation is successful.

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Configuration

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Enable FQDN access

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Management

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Monitor and manage big queries
@ -107,7 +107,7 @@ You can also decide how to deal with these queued queries by configuring the max
SET GLOBAL query_queue_pending_timeout_second = 480;
```
You can check whether a query is pending using [SHOW PROCESSLIST](../../sql-reference/sql-statements/Administration/SHOW_PROCESSLIST.md).
You can check whether a query is pending using [SHOW PROCESSLIST](../../sql-reference/sql-statements/cluster-management/nodes_processes/SHOW_PROCESSLIST.md).
```Plain
mysql> SHOW PROCESSLIST;
@ -126,7 +126,7 @@ From v3.0 onwards, StarRocks supports viewing the queries that are currently pro
### Monitor via MySQL client
1. You can view the queries that are currently processed (`current_queries`) using [SHOW PROC](../../sql-reference/sql-statements/Administration/SHOW_PROC.md).
1. You can view the queries that are currently processed (`current_queries`) using [SHOW PROC](../../sql-reference/sql-statements/cluster-management/nodes_processes/SHOW_PROC.md).
```SQL
SHOW PROC '/current_queries';
@ -187,7 +187,7 @@ In addition to MySQL client, you can use the FE console for visualized, interact
### Manually terminate big queries
If any big queries bypass the precautions you have set and threaten the system availability, you can terminate them manually using the corresponding connection ID in the [KILL](../../sql-reference/sql-statements/Administration/KILL.md) statement:
If any big queries bypass the precautions you have set and threaten the system availability, you can terminate them manually using the corresponding connection ID in the [KILL](../../sql-reference/sql-statements/cluster-management/nodes_processes/KILL.md) statement:
```SQL
KILL QUERY <ConnectionId>;
@ -247,7 +247,7 @@ To enable SQL Blacklist, execute the following statement:
ADMIN SET FRONTEND CONFIG ("enable_sql_blacklist" = "true");
```
Then you can add the regular expression that represents the SQL pattern to SQL Blacklist using [ADD SQLBLACKLIST](../../sql-reference/sql-statements/Administration/ADD_SQLBLACKLIST.md).
Then you can add the regular expression that represents the SQL pattern to SQL Blacklist using [ADD SQLBLACKLIST](../../sql-reference/sql-statements/cluster-management/sql_blacklist/ADD_SQLBLACKLIST.md).
The following example adds `COUNT(DISTINCT)` to SQL Blacklist:

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Monitor and Alert with Prometheus and Grafana

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Monitoring Metrics for Asynchronous Materialized Views

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Monitoring Metrics for Shared-data Clusters

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# General Monitoring Metrics

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Blacklist Management

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Load Balancing

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Memory Management

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Query Management

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Replica management

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Add labels on BEs

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# File manager
@ -14,7 +14,7 @@ With file manager, you can create, view, and delete files, such as the files tha
- Configure the following parameters for each FE.
- `small_file_dir`: the path in which the uploaded files are stored. The default path is `small_files/`, which is in the runtime directory of the FE. You need to specify this parameter in the **fe.conf** file and then restart the FE to allow the change to take effect.
- `max_small_file_size_bytes`: the maximum size of a single file. The default value of this parameter is 1 MB. If the size of a file exceeds the value of this parameter, the file cannot be created. You can specify this parameter by using the [ADMIN SET CONFIG](../../../sql-reference/sql-statements/Administration/ADMIN_SET_CONFIG.md) statement.
- `max_small_file_size_bytes`: the maximum size of a single file. The default value of this parameter is 1 MB. If the size of a file exceeds the value of this parameter, the file cannot be created. You can specify this parameter by using the [ADMIN SET CONFIG](../../../sql-reference/sql-statements/cluster-management/config_vars/ADMIN_SET_CONFIG.md) statement.
- `max_small_file_number`: the maximum number of files that can be created within a cluster. The default value of this parameter is 100. If the number of files that you have created reaches the value of this parameter, you cannot continue creating files. You can specify this parameter by using the ADMIN SET CONFIG statement.
> Note: Increasing the values of the two parameters causes an increase in the memory usage of the FE. Therefore, we recommend that you do not increase the values of the two parameters unless necessary.
@ -25,15 +25,15 @@ With file manager, you can create, view, and delete files, such as the files tha
## Create a file
You can execute the CREATE FILE statement to create a file. For more information, see [CREATE FILE](../../../sql-reference/sql-statements/Administration/CREATE_FILE.md). After a file is created, the file is uploaded and persisted in StarRocks.
You can execute the CREATE FILE statement to create a file. For more information, see [CREATE FILE](../../../sql-reference/sql-statements/cluster-management/file/CREATE_FILE.md). After a file is created, the file is uploaded and persisted in StarRocks.
## View a file
You can execute the SHOW FILE statement to view the information about a file stored in a database. For more information, see [SHOW FILE](../../../sql-reference/sql-statements/Administration/SHOW_FILE.md).
You can execute the SHOW FILE statement to view the information about a file stored in a database. For more information, see [SHOW FILE](../../../sql-reference/sql-statements/cluster-management/file/SHOW_FILE.md).
## Delete a file
You can execute the DROP FILE statement to delete a file. For more information, see [DROP FILE](../../../sql-reference/sql-statements/Administration/DROP_FILE.md).
You can execute the DROP FILE statement to delete a file. For more information, see [DROP FILE](../../../sql-reference/sql-statements/cluster-management/file/DROP_FILE.md).
## How an FE and a BE use a file

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Query queues
@ -117,7 +117,7 @@ You can view information related to query queues using the following methods.
### SHOW PROC
You can check the number of running queries, and memory and CPU usages in BE nodes using [SHOW PROC](../../../sql-reference/sql-statements/Administration/SHOW_PROC.md):
You can check the number of running queries, and memory and CPU usages in BE nodes using [SHOW PROC](../../../sql-reference/sql-statements/cluster-management/nodes_processes/SHOW_PROC.md):
```Plain
mysql> SHOW PROC '/backends'\G
@ -130,7 +130,7 @@ mysql> SHOW PROC '/backends'\G
### SHOW PROCESSLIST
You can check if a query is in a queue (when `IsPending` is `true`) using [SHOW PROCESSLIST](../../../sql-reference/sql-statements/Administration/SHOW_PROCESSLIST.md):
You can check if a query is in a queue (when `IsPending` is `true`) using [SHOW PROCESSLIST](../../../sql-reference/sql-statements/cluster-management/nodes_processes/SHOW_PROCESSLIST.md):
```Plain
mysql> SHOW PROCESSLIST;

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Resource group
@ -382,7 +382,7 @@ The following FE metrics only provide statistics within the current FE node:
### View resource group usage information
From v3.1.4 onwards, StarRocks supports the SQL statement [SHOW USAGE RESOURCE GROUPS](../../../sql-reference/sql-statements/Administration/SHOW_USAGE_RESOURCE_GROUPS.md), which is used to display usage information for each resource group across BEs. The descriptions of each field are as follows:
From v3.1.4 onwards, StarRocks supports the SQL statement [SHOW USAGE RESOURCE GROUPS](../../../sql-reference/sql-statements/cluster-management/resource_group/SHOW_USAGE_RESOURCE_GROUPS.md), which is used to display usage information for each resource group across BEs. The descriptions of each field are as follows:
- `Name`: The name of the resource group.
- `Id`: The ID of the resource group.

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Resource Management

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Spill to disk
@ -61,7 +61,7 @@ Follow these steps to enable intermediate result spilling:
From v3.3.0 onwards, StarRocks supports spilling intermediate results to object storage.
:::tip
Before enabling spilling to object storage, you must create a storage volume to define the object storage you want to use. For detailed instruction on creating a storage volume, see [CREATE STORAGE VOLUME](../../../sql-reference/sql-statements/Administration/CREATE_STORAGE_VOLUME.md).
Before enabling spilling to object storage, you must create a storage volume to define the object storage you want to use. For detailed instruction on creating a storage volume, see [CREATE STORAGE VOLUME](../../../sql-reference/sql-statements/cluster-management/storage_volume/CREATE_STORAGE_VOLUME.md).
:::
After you have enabled spilling in the previous step, you can further set these system variables to allow the intermediate results to be spilled to object storage:

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Configure a time zone

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Query Profile Structure and Metrics

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Query Profile Overview

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Text-based Query Profile Visualized Analysis
@ -8,7 +8,7 @@ This topic introduces how to obtain and analyze text-based Query Profiles throug
## Analyze Profiles of Existing Queries Using ANALYZE PROFILE
To analyze the text-based Profile of an existing (historical or running) query in you cluster, you first need to use the [SHOW PROFILELIST](../sql-reference/sql-statements/Administration/SHOW_PROFILELIST.md) statement to obtain a summary of the query. This command lists all queries that have finished successfully, failed with error, and those are still running (for more than 10 seconds and not yet finished). Through this statement, you can get the corresponding Query ID for subsequent analysis. The syntax is as follows:
To analyze the text-based Profile of an existing (historical or running) query in you cluster, you first need to use the [SHOW PROFILELIST](../sql-reference/sql-statements/cluster-management/plan_profile/SHOW_PROFILELIST.md) statement to obtain a summary of the query. This command lists all queries that have finished successfully, failed with error, and those are still running (for more than 10 seconds and not yet finished). Through this statement, you can get the corresponding Query ID for subsequent analysis. The syntax is as follows:
```SQL
SHOW PROFILELIST [LIMIT <num>];
@ -35,7 +35,7 @@ Output:
+--------------------------------------+---------------------+-------+----------+-----------------------------------------------------------------------------------------------------------------------------------+
```
Once you have the Query ID, you can proceed with Query Profile analysis using the [ANALYZE PROFILE](../sql-reference/sql-statements/Administration/ANALYZE_PROFILE.md) statement. The syntax is as follows:
Once you have the Query ID, you can proceed with Query Profile analysis using the [ANALYZE PROFILE](../sql-reference/sql-statements/cluster-management/plan_profile/ANALYZE_PROFILE.md) statement. The syntax is as follows:
```SQL
ANALYZE PROFILE FROM '<Query_ID>' [, <Node_ID> [, ...] ]
@ -87,7 +87,7 @@ Example:
## Simulate a query for Profile Analysis Using EXPLAIN ANALYZE
StarRocks provides the [EXPLAIN ANALYZE](../sql-reference/sql-statements/Administration/EXPLAIN_ANALYZE.md) statement, allowing you to simulate and analyze the profile of a query directly. The syntax is as follows:
StarRocks provides the [EXPLAIN ANALYZE](../sql-reference/sql-statements/cluster-management/plan_profile/EXPLAIN_ANALYZE.md) statement, allowing you to simulate and analyze the profile of a query directly. The syntax is as follows:
```SQL
EXPLAIN ANALYZE <sql_statement>

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Deploy and Manage StarRocks with StarGo

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Authentication methods

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Manage user privileges

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Privilege FAQ

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Privileges supported by StarRocks

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Overview of privileges

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Manage permissions with Apache Ranger

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# SSB Flat-table Benchmarking

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# TPC-H Benchmark

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# TPC-DS Benchmarking

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Benchmarks

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# TPC-DS test SQL

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Business Intelligence

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# CSP authentication

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Data Cache

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,9 +0,0 @@
---
displayed_sidebar: "English"
---
#
import DocCardList from '@theme/DocCardList';
<DocCardList />

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# SQL IDE tools

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
#

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# External table
@ -591,7 +591,7 @@ SHOW RESOURCES;
DROP RESOURCE "hive0";
~~~
You can modify `hive.metastore.uris` of a Hive resource in StarRocks 2.3 and later versions. For more information, see [ALTER RESOURCE](../sql-reference/sql-statements/data-definition/ALTER_RESOURCE.md).
You can modify `hive.metastore.uris` of a Hive resource in StarRocks 2.3 and later versions. For more information, see [ALTER RESOURCE](../sql-reference/sql-statements/Resource/ALTER_RESOURCE.md).
### Create a database
@ -800,7 +800,7 @@ The following table describes the related parameters.
| iceberg.catalog.type | The catalog type of the resource. Both Hive catalog and custom catalog are supported. If you specify a Hive catalog, set the value to `HIVE`. If you specify a custom catalog, set the value to `CUSTOM`. |
| iceberg.catalog-impl | The fully qualified class name of the custom catalog. FEs search for the catalog based on this name. If the catalog contains custom configuration items, you must add them to the `PROPERTIES` parameter as key-value pairs when you create an Iceberg external table. |
You can modify `hive.metastore.uris` and `iceberg.catalog-impl`of a Iceberg resource in StarRocks 2.3 and later versions. For more information, see [ALTER RESOURCE](../sql-reference/sql-statements/data-definition/ALTER_RESOURCE.md).
You can modify `hive.metastore.uris` and `iceberg.catalog-impl`of a Iceberg resource in StarRocks 2.3 and later versions. For more information, see [ALTER RESOURCE](../sql-reference/sql-statements/Resource/ALTER_RESOURCE.md).
##### View Iceberg resources
@ -945,7 +945,7 @@ The following table describes the parameters.
| type | The type of the Hudi resource. Set the vaue to hudi. |
| hive.metastore.uris | The Thrift URI of the Hive metastore to which the Hudi resource connects. After connecting the Hudi resource to a Hive metastore, you can create and manage Hudi tables by using Hive. The Thrift URI is in the `<IP address of the Hive metastore>:<Port number of the Hive metastore>` format. The default port number is 9083. |
From v2.3 onwards, StarRocks allows changing the `hive.metastore.uris` value of a Hudi resource. For more information, see [ALTER RESOURCE](../sql-reference/sql-statements/data-definition/ALTER_RESOURCE.md).
From v2.3 onwards, StarRocks allows changing the `hive.metastore.uris` value of a Hudi resource. For more information, see [ALTER RESOURCE](../sql-reference/sql-statements/Resource/ALTER_RESOURCE.md).
##### View Hudi resources

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
keywords: ['catalog']
---

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Overview
@ -39,7 +39,7 @@ Currently, StarRocks provides two types of catalogs: internal catalog and extern
## Access catalog
You can use the [SET CATALOG](../../sql-reference/sql-statements/data-definition/SET_CATALOG.md) statement to switch to a specified catalog in the current session. Then, you can query data by using that catalog.
You can use the [SET CATALOG](../../sql-reference/sql-statements/Catalog/SET_CATALOG.md) statement to switch to a specified catalog in the current session. Then, you can query data by using that catalog.
## Query data

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
---
# Default catalog
@ -14,7 +14,7 @@ StarRocks 2.3 and later provide an internal catalog to manage the internal data
- If you use the MySQL client to connect the StarRocks cluster, you go to `default_catalog` by default after connecting.
- If you use JDBC to connect the StarRocks cluster, you can go directly to the destination database in the default catalog by specifying `default_catalog.db_name` when connecting.
2. (Optional) Use [SHOW DATABASES](../../sql-reference/sql-statements/data-manipulation/SHOW_DATABASES.md) to view databases:
2. (Optional) Use [SHOW DATABASES](../../sql-reference/sql-statements/Database/SHOW_DATABASES.md) to view databases:
```SQL
SHOW DATABASES;
@ -26,25 +26,25 @@ StarRocks 2.3 and later provide an internal catalog to manage the internal data
SHOW DATABASES FROM <catalog_name>;
```
3. (Optional) Use [SET CATALOG](../../sql-reference/sql-statements/data-definition/SET_CATALOG.md) to switch to the destination catalog in the current session:
3. (Optional) Use [SET CATALOG](../../sql-reference/sql-statements/Catalog/SET_CATALOG.md) to switch to the destination catalog in the current session:
```SQL
SET CATALOG <catalog_name>;
```
Then, use [USE](../../sql-reference/sql-statements/data-definition/USE.md) to specify the active database in the current session:
Then, use [USE](../../sql-reference/sql-statements/Database/USE.md) to specify the active database in the current session:
```SQL
USE <db_name>;
```
Or, you can use [USE](../../sql-reference/sql-statements/data-definition/USE.md) to directly go to the active database in the destination catalog:
Or, you can use [USE](../../sql-reference/sql-statements/Database/USE.md) to directly go to the active database in the destination catalog:
```SQL
USE <catalog_name>.<db_name>;
```
4. Use [SELECT](../../sql-reference/sql-statements/data-manipulation/SELECT.md) to query internal data:
4. Use [SELECT](../../sql-reference/sql-statements/table_bucket_part_index/SELECT.md) to query internal data:
```SQL
SELECT * FROM <table_name>;

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
toc_max_heading_level: 5
---
@ -7,7 +7,7 @@ toc_max_heading_level: 5
A Delta Lake catalog is a kind of external catalog that enables you to query data from Delta Lake without ingestion.
Also, you can directly transform and load data from Delta Lake by using [INSERT INTO](../../sql-reference/sql-statements/data-manipulation/INSERT.md) based on Delta Lake catalogs. StarRocks supports Delta Lake catalogs from v2.5 onwards.
Also, you can directly transform and load data from Delta Lake by using [INSERT INTO](../../sql-reference/sql-statements/loading_unloading/INSERT.md) based on Delta Lake catalogs. StarRocks supports Delta Lake catalogs from v2.5 onwards.
To ensure successful SQL workloads on your Delta Lake cluster, your StarRocks cluster must be able to access the storage system and metastore of your Delta Lake cluster. StarRocks supports the following storage systems and metastores:
@ -761,13 +761,13 @@ PROPERTIES
## View Delta Lake catalogs
You can use [SHOW CATALOGS](../../sql-reference/sql-statements/data-manipulation/SHOW_CATALOGS.md) to query all catalogs in the current StarRocks cluster:
You can use [SHOW CATALOGS](../../sql-reference/sql-statements/Catalog/SHOW_CATALOGS.md) to query all catalogs in the current StarRocks cluster:
```SQL
SHOW CATALOGS;
```
You can also use [SHOW CREATE CATALOG](../../sql-reference/sql-statements/data-manipulation/SHOW_CREATE_CATALOG.md) to query the creation statement of an external catalog. The following example queries the creation statement of a Delta Lake catalog named `deltalake_catalog_glue`:
You can also use [SHOW CREATE CATALOG](../../sql-reference/sql-statements/Catalog/SHOW_CREATE_CATALOG.md) to query the creation statement of an external catalog. The following example queries the creation statement of a Delta Lake catalog named `deltalake_catalog_glue`:
```SQL
SHOW CREATE CATALOG deltalake_catalog_glue;
@ -777,7 +777,7 @@ SHOW CREATE CATALOG deltalake_catalog_glue;
You can use one of the following methods to switch to a Delta Lake catalog and a database in it:
- Use [SET CATALOG](../../sql-reference/sql-statements/data-definition/SET_CATALOG.md) to specify a Delta Lake catalog in the current session, and then use [USE](../../sql-reference/sql-statements/data-definition/USE.md) to specify an active database:
- Use [SET CATALOG](../../sql-reference/sql-statements/Catalog/SET_CATALOG.md) to specify a Delta Lake catalog in the current session, and then use [USE](../../sql-reference/sql-statements/Database/USE.md) to specify an active database:
```SQL
-- Switch to a specified catalog in the current session:
@ -786,7 +786,7 @@ You can use one of the following methods to switch to a Delta Lake catalog and a
USE <db_name>
```
- Directly use [USE](../../sql-reference/sql-statements/data-definition/USE.md) to switch to a Delta Lake catalog and a database in it:
- Directly use [USE](../../sql-reference/sql-statements/Database/USE.md) to switch to a Delta Lake catalog and a database in it:
```SQL
USE <catalog_name>.<db_name>
@ -794,7 +794,7 @@ You can use one of the following methods to switch to a Delta Lake catalog and a
## Drop a Delta Lake catalog
You can use [DROP CATALOG](../../sql-reference/sql-statements/data-definition/DROP_CATALOG.md) to drop an external catalog.
You can use [DROP CATALOG](../../sql-reference/sql-statements/Catalog/DROP_CATALOG.md) to drop an external catalog.
The following example drops a Delta Lake catalog named `deltalake_catalog_glue`:
@ -820,7 +820,7 @@ You can use one of the following syntaxes to view the schema of a Delta Lake tab
## Query a Delta Lake table
1. Use [SHOW DATABASES](../../sql-reference/sql-statements/data-manipulation/SHOW_DATABASES.md) to view the databases in your Delta Lake cluster:
1. Use [SHOW DATABASES](../../sql-reference/sql-statements/Database/SHOW_DATABASES.md) to view the databases in your Delta Lake cluster:
```SQL
SHOW DATABASES FROM <catalog_name>
@ -828,7 +828,7 @@ You can use one of the following syntaxes to view the schema of a Delta Lake tab
2. [Switch to a Delta Lake Catalog and a database in it](#switch-to-a-delta-lake-catalog-and-a-database-in-it).
3. Use [SELECT](../../sql-reference/sql-statements/data-manipulation/SELECT.md) to query the destination table in the specified database:
3. Use [SELECT](../../sql-reference/sql-statements/table_bucket_part_index/SELECT.md) to query the destination table in the specified database:
```SQL
SELECT count(*) FROM <table_name> LIMIT 10

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
toc_max_heading_level: 4
---

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
toc_max_heading_level: 5
---
@ -8,8 +8,8 @@ toc_max_heading_level: 5
A Hive catalog is a kind of external catalog that is supported by StarRocks from v2.4 onwards. Within Hive catalogs, you can:
- Directly query data stored in Hive without the need to manually create tables.
- Use [INSERT INTO](../../sql-reference/sql-statements/data-manipulation/INSERT.md) or asynchronous materialized views (which are supported from v2.5 onwards) to process data stored in Hive and load the data into StarRocks.
- Perform operations on StarRocks to create or drop Hive databases and tables, or sink data from StarRocks tables to Parquet-formatted (supported from v3.2 onwards) and ORC- or Textfile-formatted (supported from v3.3 onwards) Hive tables by using [INSERT INTO](../../sql-reference/sql-statements/data-manipulation/INSERT.md).
- Use [INSERT INTO](../../sql-reference/sql-statements/loading_unloading/INSERT.md) or asynchronous materialized views (which are supported from v2.5 onwards) to process data stored in Hive and load the data into StarRocks.
- Perform operations on StarRocks to create or drop Hive databases and tables, or sink data from StarRocks tables to Parquet-formatted (supported from v3.2 onwards) and ORC- or Textfile-formatted (supported from v3.3 onwards) Hive tables by using [INSERT INTO](../../sql-reference/sql-statements/loading_unloading/INSERT.md).
To ensure successful SQL workloads on your Hive cluster, your StarRocks cluster must be able to access the storage system and metastore of your Hive cluster. StarRocks supports the following storage systems and metastores:
@ -38,7 +38,7 @@ To ensure successful SQL workloads on your Hive cluster, your StarRocks cluster
- Parquet and ORC files support the following compression formats: NO_COMPRESSION, SNAPPY, LZ4, ZSTD, and GZIP.
- Textfile files support the NO_COMPRESSION compression format.
You can use the session variable [`connector_sink_compression_codec`](../../reference/System_variable.md#connector_sink_compression_codec) to specify the compression algorithm used for sinking data to Hive tables.
You can use the session variable [`connector_sink_compression_codec`](../../sql-reference/System_variable.md#connector_sink_compression_codec) to specify the compression algorithm used for sinking data to Hive tables.
## Integration preparations
@ -795,13 +795,13 @@ PROPERTIES
## View Hive catalogs
You can use [SHOW CATALOGS](../../sql-reference/sql-statements/data-manipulation/SHOW_CATALOGS.md) to query all catalogs in the current StarRocks cluster:
You can use [SHOW CATALOGS](../../sql-reference/sql-statements/Catalog/SHOW_CATALOGS.md) to query all catalogs in the current StarRocks cluster:
```SQL
SHOW CATALOGS;
```
You can also use [SHOW CREATE CATALOG](../../sql-reference/sql-statements/data-manipulation/SHOW_CREATE_CATALOG.md) to query the creation statement of an external catalog. The following example queries the creation statement of a Hive catalog named `hive_catalog_glue`:
You can also use [SHOW CREATE CATALOG](../../sql-reference/sql-statements/Catalog/SHOW_CREATE_CATALOG.md) to query the creation statement of an external catalog. The following example queries the creation statement of a Hive catalog named `hive_catalog_glue`:
```SQL
SHOW CREATE CATALOG hive_catalog_glue;
@ -811,7 +811,7 @@ SHOW CREATE CATALOG hive_catalog_glue;
You can use one of the following methods to switch to a Hive catalog and a database in it:
- Use [SET CATALOG](../../sql-reference/sql-statements/data-definition/SET_CATALOG.md) to specify a Hive catalog in the current session, and then use [USE](../../sql-reference/sql-statements/data-definition/USE.md) to specify an active database:
- Use [SET CATALOG](../../sql-reference/sql-statements/Catalog/SET_CATALOG.md) to specify a Hive catalog in the current session, and then use [USE](../../sql-reference/sql-statements/Database/USE.md) to specify an active database:
```SQL
-- Switch to a specified catalog in the current session:
@ -820,7 +820,7 @@ You can use one of the following methods to switch to a Hive catalog and a datab
USE <db_name>
```
- Directly use [USE](../../sql-reference/sql-statements/data-definition/USE.md) to switch to a Hive catalog and a database in it:
- Directly use [USE](../../sql-reference/sql-statements/Database/USE.md) to switch to a Hive catalog and a database in it:
```SQL
USE <catalog_name>.<db_name>
@ -828,7 +828,7 @@ You can use one of the following methods to switch to a Hive catalog and a datab
## Drop a Hive catalog
You can use [DROP CATALOG](../../sql-reference/sql-statements/data-definition/DROP_CATALOG.md) to drop an external catalog.
You can use [DROP CATALOG](../../sql-reference/sql-statements/Catalog/DROP_CATALOG.md) to drop an external catalog.
The following example drops a Hive catalog named `hive_catalog_glue`:
@ -854,7 +854,7 @@ You can use one of the following syntaxes to view the schema of a Hive table:
## Query a Hive table
1. Use [SHOW DATABASES](../../sql-reference/sql-statements/data-manipulation/SHOW_DATABASES.md) to view the databases in your Hive cluster:
1. Use [SHOW DATABASES](../../sql-reference/sql-statements/Database/SHOW_DATABASES.md) to view the databases in your Hive cluster:
```SQL
SHOW DATABASES FROM <catalog_name>
@ -862,7 +862,7 @@ You can use one of the following syntaxes to view the schema of a Hive table:
2. [Switch to a Hive Catalog and a database in it](#switch-to-a-hive-catalog-and-a-database-in-it).
3. Use [SELECT](../../sql-reference/sql-statements/data-manipulation/SELECT.md) to query the destination table in the specified database:
3. Use [SELECT](../../sql-reference/sql-statements/table_bucket_part_index/SELECT.md) to query the destination table in the specified database:
```SQL
SELECT count(*) FROM <table_name> LIMIT 10
@ -899,7 +899,7 @@ GRANT SELECT ON ALL TABLES IN ALL DATABASES TO ROLE hive_role_table;
## Create a Hive database
Similar to the internal catalog of StarRocks, if you have the [CREATE DATABASE](../../administration/user_privs/privilege_item.md#catalog) privilege on a Hive catalog, you can use the [CREATE DATABASE](../../sql-reference/sql-statements/data-definition/CREATE_DATABASE.md) statement to create a database in that Hive catalog. This feature is supported from v3.2 onwards.
Similar to the internal catalog of StarRocks, if you have the [CREATE DATABASE](../../administration/user_privs/privilege_item.md#catalog) privilege on a Hive catalog, you can use the [CREATE DATABASE](../../sql-reference/sql-statements/Database/CREATE_DATABASE.md) statement to create a database in that Hive catalog. This feature is supported from v3.2 onwards.
:::note
@ -932,7 +932,7 @@ The `prefix` varies based on the storage system you use:
## Drop a Hive database
Similar to the internal databases of StarRocks, if you have the [DROP](../../administration/user_privs/privilege_item.md#database) privilege on a Hive database, you can use the [DROP DATABASE](../../sql-reference/sql-statements/data-definition/DROP_DATABASE.md) statement to drop that Hive database. This feature is supported from v3.2 onwards. You can only drop empty databases.
Similar to the internal databases of StarRocks, if you have the [DROP](../../administration/user_privs/privilege_item.md#database) privilege on a Hive database, you can use the [DROP DATABASE](../../sql-reference/sql-statements/Database/DROP_DATABASE.md) statement to drop that Hive database. This feature is supported from v3.2 onwards. You can only drop empty databases.
:::note
@ -950,7 +950,7 @@ DROP DATABASE <database_name>
## Create a Hive table
Similar to the internal databases of StarRocks, if you have the [CREATE TABLE](../../administration/user_privs/privilege_item.md#database) privilege on a Hive database, you can use the [CREATE TABLE](../../sql-reference/sql-statements/data-definition/CREATE_TABLE.md), [CREATE TABLE AS SELECT (CTAS)](../../sql-reference/sql-statements/data-definition/CREATE_TABLE_AS_SELECT.md), or [CREATE TABLE LIKE](../../sql-reference/sql-statements/data-definition/CREATE_TABLE_LIKE.md) statement to create a managed table in that Hive database.
Similar to the internal databases of StarRocks, if you have the [CREATE TABLE](../../administration/user_privs/privilege_item.md#database) privilege on a Hive database, you can use the [CREATE TABLE](../../sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE.md), [CREATE TABLE AS SELECT ../../sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE_AS_SELECT.mdELECT.md), or [CREATE TABL../../sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE_LIKE.md_LIKE.md) statement to create a managed table in that Hive database.
This feature is supported since v3.2 in which version StarRocks only supports creating Parquet-formatted Hive tables. From v3.3 onwards, StarRocks also supports creating ORC- and Textfile-formatted Hive tables.
@ -1020,7 +1020,7 @@ The following table describes a few key properties.
| ----------------- | ------------------------------------------------------------ |
| location | The file path in which you want to create the managed table. When you use HMS as metastore, you do not need to specify the `location` parameter, because StarRocks will create the table in the default file path of the current Hive catalog. When you use AWS Glue as metadata service:<ul><li>If you have specified the `location` parameter for the database in which you want to create the table, you do not need to specify the `location` parameter for the table. As such, the table defaults to the file path of the database to which it belongs. </li><li>If you have not specified the `location` for the database in which you want to create the table, you must specify the `location` parameter for the table.</li></ul> |
| file_format | The file format of the managed table. Supported file formats are Parquet, ORC, and Textfile. ORC and Textfile formats are supported from v3.3 onwards. Valid values: `parquet`, `orc`, and `textfile`. Default value: `parquet`. |
| compression_codec | The compression algorithm used for the managed table. This property is deprecated in v3.2.3, since which version the compression algorithm used for sinking data to Hive tables is uniformly controlled by the session variable [connector_sink_compression_codec](../../reference/System_variable.md#connector_sink_compression_codec). |
| compression_codec | The compression algorithm used for the managed table. This property is deprecated in v3.2.3, since which version the compression algorithm used for sinking data to Hive tables is uniformly controlled by the session variable [connector_sink_compression_codec](../../sql-reference/System_variable.md#connector_sink_compression_codec). |
### Examples
@ -1058,16 +1058,16 @@ The following DDLs use the default file format Parquet as an example.
## Sink data to a Hive table
Similar to the internal tables of StarRocks, if you have the [INSERT](../../administration/user_privs/privilege_item.md#table) privilege on a Hive table (which can be a managed table or an external table), you can use the [INSERT](../../sql-reference/sql-statements/data-manipulation/INSERT.md) statement to sink the data of a StarRocks table to that Hive table.
Similar to the internal tables of StarRocks, if you have the [INSERT](../../administration/user_privs/privilege_item.md#table) privilege on a Hive table (which can be a managed table or an external table), you can use the [INSERT](../../sql-reference/sql-statements/loading_unloading/INSERT.md) statement to sink the data of a StarRocks table to that Hive table.
This feature is supported since v3.2 in which version data can be sunk only to Parquet-formatted Hive tables. From v3.3 onwards, StarRocks also supports sinking data to ORC- and Textfile-formatted Hive tables.
Note that sinking data to external tables is disabled by default. To sink data to external tables, you must set the [system variable `ENABLE_WRITE_HIVE_EXTERNAL_TABLE`](../../reference/System_variable.md) to `true`.
Note that sinking data to external tables is disabled by default. To sink data to external tables, you must set the [system variable `ENABLE_WRITE_HIVE_EXTERNAL_TABLE`](../../sql-reference/System_variable.md) to `true`.
:::note
- You can grant and revoke privileges by using [GRANT](../../sql-reference/sql-statements/account-management/GRANT.md) and [REVOKE](../../sql-reference/sql-statements/account-management/REVOKE.md).
- You can use the session variable [connector_sink_compression_codec](../../reference/System_variable.md#connector_sink_compression_codec) to specify the compression algorithm used for sinking data to Hive tables.
- You can use the session variable [connector_sink_compression_codec](../../sql-reference/System_variable.md#connector_sink_compression_codec) to specify the compression algorithm used for sinking data to Hive tables.
:::
@ -1156,7 +1156,7 @@ The following DMLs use the default file format Parquet as an example.
## Drop a Hive table
Similar to the internal tables of StarRocks, if you have the [DROP](../../administration/user_privs/privilege_item.md#table) privilege on a Hive table, you can use the [DROP TABLE](../../sql-reference/sql-statements/data-definition/DROP_TABLE.md) statement to drop that Hive table. This feature is supported from v3.1 onwards. Note that currently StarRocks supports dropping only managed tables of Hive.
Similar to the internal tables of StarRocks, if you have the [DROP](../../administration/user_privs/privilege_item.md#table) privilege on a Hive table, you can use the [DROP TABLE](../../sql-reference/sql-statements/table_bucket_part_index/DROP_TABLE.md) statement to drop that Hive table. This feature is supported from v3.1 onwards. Note that currently StarRocks supports dropping only managed tables of Hive.
:::note
@ -1176,7 +1176,7 @@ DROP TABLE <table_name> FORCE
### Manual update
By default, StarRocks caches the metadata of Hive and automatically updates the metadata in asynchronous mode to deliver better performance. Additionally, after some schema changes or table updates are made on a Hive table, you can also use [REFRESH EXTERNAL TABLE](../../sql-reference/sql-statements/data-definition/REFRESH_EXTERNAL_TABLE.md) to manually update its metadata, thereby ensuring that StarRocks can obtain up-to-date metadata at its earliest opportunity and generate appropriate execution plans:
By default, StarRocks caches the metadata of Hive and automatically updates the metadata in asynchronous mode to deliver better performance. Additionally, after some schema changes or table updates are made on a Hive table, you can also use [REFRESH EXTERNAL TABLE](../../sql-reference/sql-statements/table_bucket_part_index/REFRESH_EXTERNAL_TABLE.md) to manually update its metadata, thereby ensuring that StarRocks can obtain up-to-date metadata at its earliest opportunity and generate appropriate execution plans:
```SQL
REFRESH EXTERNAL TABLE <table_name> [PARTITION ('partition_name', ...)]
@ -1277,9 +1277,9 @@ From v2.5.5 onwards, StarRocks can periodically refresh the cached metadata of t
| Configuration item | Default | Description |
| ------------------------------------------------------------ | ------------------------------------ | ------------------------------------ |
| enable_background_refresh_connector_metadata | `true` in v3.0<br />`false` in v2.5 | Whether to enable the periodic Hive metadata cache refresh. After it is enabled, StarRocks polls the metastore (Hive Metastore or AWS Glue) of your Hive cluster, and refreshes the cached metadata of the frequently accessed Hive catalogs to perceive data changes. `true` indicates to enable the Hive metadata cache refresh, and `false` indicates to disable it. This item is an [FE dynamic parameter](../../administration/management/FE_configuration.md#configure-fe-dynamic-parameters). You can modify it using the [ADMIN SET FRONTEND CONFIG](../../sql-reference/sql-statements/Administration/ADMIN_SET_CONFIG.md) command. |
| background_refresh_metadata_interval_millis | `600000` (10 minutes) | The interval between two consecutive Hive metadata cache refreshes. Unit: millisecond. This item is an [FE dynamic parameter](../../administration/management/FE_configuration.md#configure-fe-dynamic-parameters). You can modify it using the [ADMIN SET FRONTEND CONFIG](../../sql-reference/sql-statements/Administration/ADMIN_SET_CONFIG.md) command. |
| background_refresh_metadata_time_secs_since_last_access_secs | `86400` (24 hours) | The expiration time of a Hive metadata cache refresh task. For the Hive catalog that has been accessed, if it has not been accessed for more than the specified time, StarRocks stops refreshing its cached metadata. For the Hive catalog that has not been accessed, StarRocks will not refresh its cached metadata. Unit: second. This item is an [FE dynamic parameter](../../administration/management/FE_configuration.md#configure-fe-dynamic-parameters). You can modify it using the [ADMIN SET FRONTEND CONFIG](../../sql-reference/sql-statements/Administration/ADMIN_SET_CONFIG.md) command. |
| enable_background_refresh_connector_metadata | `true` in v3.0<br />`false` in v2.5 | Whether to enable the periodic Hive metadata cache refresh. After it is enabled, StarRocks polls the metastore (Hive Metastore or AWS Glue) of your Hive cluster, and refreshes the cached metadata of the frequently accessed Hive catalogs to perceive data changes. `true` indicates to enable the Hive metadata cache refresh, and `false` indicates to disable it. This item is an [FE dynamic parameter](../../administration/management/FE_configuration.md#configure-fe-dynamic-parameters). You can modify it using the [ADMIN SET FRONTEND CONFIG](../../sql-reference/sql-statements/cluster-management/config_vars/ADMIN_SET_CONFIG.md) command. |
| background_refresh_metadata_interval_millis | `600000` (10 minutes) | The interval between two consecutive Hive metadata cache refreshes. Unit: millisecond. This item is an [FE dynamic parameter](../../administration/management/FE_configuration.md#configure-fe-dynamic-parameters). You can modify it using the [ADMIN SET FRONTEND CONFIG](../../sql-reference/sql-statements/cluster-management/config_vars/ADMIN_SET_CONFIG.md) command. |
| background_refresh_metadata_time_secs_since_last_access_secs | `86400` (24 hours) | The expiration time of a Hive metadata cache refresh task. For the Hive catalog that has been accessed, if it has not been accessed for more than the specified time, StarRocks stops refreshing its cached metadata. For the Hive catalog that has not been accessed, StarRocks will not refresh its cached metadata. Unit: second. This item is an [FE dynamic parameter](../../administration/management/FE_configuration.md#configure-fe-dynamic-parameters). You can modify it using the [ADMIN SET FRONTEND CONFIG](../../sql-reference/sql-statements/cluster-management/config_vars/ADMIN_SET_CONFIG.md) command. |
Using the periodic Hive metadata cache refresh feature and the metadata automatic asynchronous update policy together significantly accelerates data access, reduces the read load from external data sources, and improves query performance.

View File

@ -1,5 +1,5 @@
---
displayed_sidebar: "English"
displayed_sidebar: docs
toc_max_heading_level: 5
---
@ -7,7 +7,7 @@ toc_max_heading_level: 5
A Hudi catalog is a kind of external catalog that enables you to query data from Apache Hudi without ingestion.
Also, you can directly transform and load data from Hudi by using [INSERT INTO](../../sql-reference/sql-statements/data-manipulation/INSERT.md) based on Hudi catalogs. StarRocks supports Hudi catalogs from v2.4 onwards.
Also, you can directly transform and load data from Hudi by using [INSERT INTO](../../sql-reference/sql-statements/loading_unloading/INSERT.md) based on Hudi catalogs. StarRocks supports Hudi catalogs from v2.4 onwards.
To ensure successful SQL workloads on your Hudi cluster, your StarRocks cluster must be able to access the storage system and metastore of your Hudi cluster. StarRocks supports the following storage systems and metastores:
@ -759,13 +759,13 @@ PROPERTIES
## View Hudi catalogs
You can use [SHOW CATALOGS](../../sql-reference/sql-statements/data-manipulation/SHOW_CATALOGS.md) to query all catalogs in the current StarRocks cluster:
You can use [SHOW CATALOGS](../../sql-reference/sql-statements/Catalog/SHOW_CATALOGS.md) to query all catalogs in the current StarRocks cluster:
```SQL
SHOW CATALOGS;
```
You can also use [SHOW CREATE CATALOG](../../sql-reference/sql-statements/data-manipulation/SHOW_CREATE_CATALOG.md) to query the creation statement of an external catalog. The following example queries the creation statement of a Hudi catalog named `hudi_catalog_glue`:
You can also use [SHOW CREATE CATALOG](../../sql-reference/sql-statements/Catalog/SHOW_CREATE_CATALOG.md) to query the creation statement of an external catalog. The following example queries the creation statement of a Hudi catalog named `hudi_catalog_glue`:
```SQL
SHOW CREATE CATALOG hudi_catalog_glue;
@ -775,7 +775,7 @@ SHOW CREATE CATALOG hudi_catalog_glue;
You can use one of the following methods to switch to a Hudi catalog and a database in it:
- Use [SET CATALOG](../../sql-reference/sql-statements/data-definition/SET_CATALOG.md) to specify a Hudi catalog in the current session, and then use [USE](../../sql-reference/sql-statements/data-definition/USE.md) to specify an active database:
- Use [SET CATALOG](../../sql-reference/sql-statements/Catalog/SET_CATALOG.md) to specify a Hudi catalog in the current session, and then use [USE](../../sql-reference/sql-statements/Database/USE.md) to specify an active database:
```SQL
-- Switch to a specified catalog in the current session:
@ -784,7 +784,7 @@ You can use one of the following methods to switch to a Hudi catalog and a datab
USE <db_name>
```
- Directly use [USE](../../sql-reference/sql-statements/data-definition/USE.md) to switch to a Hudi catalog and a database in it:
- Directly use [USE](../../sql-reference/sql-statements/Database/USE.md) to switch to a Hudi catalog and a database in it:
```SQL
USE <catalog_name>.<db_name>
@ -792,7 +792,7 @@ You can use one of the following methods to switch to a Hudi catalog and a datab
## Drop a Hudi catalog
You can use [DROP CATALOG](../../sql-reference/sql-statements/data-definition/DROP_CATALOG.md) to drop an external catalog.
You can use [DROP CATALOG](../../sql-reference/sql-statements/Catalog/DROP_CATALOG.md) to drop an external catalog.
The following example drops a Hudi catalog named `hudi_catalog_glue`:
@ -818,7 +818,7 @@ You can use one of the following syntaxes to view the schema of a Hudi table:
## Query a Hudi table
1. Use [SHOW DATABASES](../../sql-reference/sql-statements/data-manipulation/SHOW_DATABASES.md) to view the databases in your Hudi cluster:
1. Use [SHOW DATABASES](../../sql-reference/sql-statements/Database/SHOW_DATABASES.md) to view the databases in your Hudi cluster:
```SQL
SHOW DATABASES FROM <catalog_name>
@ -826,7 +826,7 @@ You can use one of the following syntaxes to view the schema of a Hudi table:
2. [Switch to a Hudi Catalog and a database in it](#switch-to-a-hudi-catalog-and-a-database-in-it).
3. Use [SELECT](../../sql-reference/sql-statements/data-manipulation/SELECT.md) to query the destination table in the specified database:
3. Use [SELECT](../../sql-reference/sql-statements/table_bucket_part_index/SELECT.md) to query the destination table in the specified database:
```SQL
SELECT count(*) FROM <table_name> LIMIT 10
@ -844,7 +844,7 @@ INSERT INTO default_catalog.olap_db.olap_tbl SELECT * FROM hudi_table
### Manual update
By default, StarRocks caches the metadata of Hudi and automatically updates the metadata in asynchronous mode to deliver better performance. Additionally, after some schema changes or table updates are made on a Hudi table, you can also use [REFRESH EXTERNAL TABLE](../../sql-reference/sql-statements/data-definition/REFRESH_EXTERNAL_TABLE.md) to manually update its metadata, thereby ensuring that StarRocks can obtain up-to-date metadata at its earliest opportunity and generate appropriate execution plans:
By default, StarRocks caches the metadata of Hudi and automatically updates the metadata in asynchronous mode to deliver better performance. Additionally, after some schema changes or table updates are made on a Hudi table, you can also use [REFRESH EXTERNAL TABLE](../../sql-reference/sql-statements/table_bucket_part_index/REFRESH_EXTERNAL_TABLE.md) to manually update its metadata, thereby ensuring that StarRocks can obtain up-to-date metadata at its earliest opportunity and generate appropriate execution plans:
```SQL
REFRESH EXTERNAL TABLE <table_name> [PARTITION ('partition_name', ...)]

Some files were not shown because too many files have changed in this diff Show More