diff --git a/.asf.yaml b/.asf.yaml index 15b4f676..6f26560c 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -17,13 +17,12 @@ # under the License. # - notifications: - issues: reviews@iotdb.apache.org + issues: reviews@iotdb.apache.org pullrequests: reviews@iotdb.apache.org github: - description: "Apache IoTDB Documentation and Site" + description: 'Apache IoTDB Documentation and Site' homepage: https://iotdb.apache.org/ labels: - timeseries @@ -31,11 +30,11 @@ github: - documentation enabled_merge_buttons: # enable squash button: - squash: true + squash: true # enable merge button: - merge: false + merge: false # disable rebase button: - rebase: true + rebase: true collaborators: - CritasWang - krystal-xiao @@ -44,7 +43,7 @@ github: staging: profile: ~ - whoami: asf-staging + whoami: asf-staging publish: - whoami: asf-site + whoami: asf-site diff --git a/.eslintignore b/.eslintignore deleted file mode 100644 index cb2f7e95..00000000 --- a/.eslintignore +++ /dev/null @@ -1,4 +0,0 @@ -/dist -/node_modules -/public -!src/.vuepress \ No newline at end of file diff --git a/.eslintrc.cjs b/.eslintrc.cjs deleted file mode 100644 index 92754442..00000000 --- a/.eslintrc.cjs +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -/* eslint-env node */ -require('@rushstack/eslint-patch/modern-module-resolution'); - -module.exports = { - root: true, - extends: [ - 'plugin:vue/vue3-essential', - '@vue/eslint-config-airbnb-with-typescript', - // '@vue/eslint-config-airbnb-with-typescript/allow-js-in-vue', - ], - parserOptions: { - ecmaVersion: 'latest', - }, - rules: { - 'import/prefer-default-export': 'off', - 'import/no-extraneous-dependencies': 'off', - 'vue/multi-word-component-names': 'off', - '@typescript-eslint/no-empty-function': 'off', - '@typescript-eslint/no-var-requires': 'off', - 'no-param-reassign': 'off', // param reassign - 'no-plusplus': 'off', // ++ - 'vue/require-default-prop': 'off', // default prop todo - 'vuejs-accessibility/click-events-have-key-events': 'off', - 'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off', - 'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off', - 'vue/html-self-closing': ['error', { - html: { - void: 'never', - normal: 'never', - component: 'always', - }, - svg: 'always', - math: 'always', - }], - 'vue/max-len': [ - 'error', - 200, - 2, - { - ignoreUrls: true, - ignoreComments: false, - ignoreRegExpLiterals: true, - ignoreStrings: true, - ignoreTemplateLiterals: true, - - // 1. it's like `ignoreStrings` - // 2. SVG `path`s should be ignored - ignoreHTMLAttributeValues: true, - // Because spaces in HTML are insignificant, - // it shouldn't be hard to start a new line for text content - ignoreHTMLTextContents: false, - }, - ], - }, -}; diff --git a/.github/workflows/site-build.yaml b/.github/workflows/site-build.yaml index ef266adc..91594019 100644 --- a/.github/workflows/site-build.yaml +++ b/.github/workflows/site-build.yaml @@ -21,23 +21,22 @@ jobs: steps: - uses: actions/checkout@v4 + - name: Install pnpm uses: pnpm/action-setup@v4 - with: - package_json_file: 'package.json' - run_install: true - version: 8 - - name: Use Node.js 20 + + - name: Use Node.js 22 uses: actions/setup-node@v4 with: - node-version: 20 - cache: pnpm + node-version: 22 + - name: Install dependencies run: pnpm install + - name: Test build website env: - NODE_OPTIONS: --max_old_space_size=8192 - run: pnpm run build + NODE_OPTIONS: --max_old_space_size=8192 + run: pnpm build deploy: runs-on: ubuntu-latest @@ -50,21 +49,20 @@ jobs: - name: Install pnpm uses: pnpm/action-setup@v4 - with: - package_json_file: 'package.json' - run_install: true - version: 8 - - name: Use Node.js 20 + - name: Use Node.js 22 uses: actions/setup-node@v4 with: - node-version: 20 + node-version: 22 + - name: Install dependencies run: pnpm install + - name: Build website env: - NODE_OPTIONS: --max_old_space_size=8192 - run: pnpm run build + NODE_OPTIONS: --max_old_space_size=8192 + run: pnpm build + - name: Deploy website env: IOTDB_WEBSITE_BUILD: ${{ secrets.IOTDB_WEBSITE_BUILD }} diff --git a/.gitignore b/.gitignore index e23b8be9..74c2d216 100644 --- a/.gitignore +++ b/.gitignore @@ -31,7 +31,6 @@ pnpm-lock.yaml # Editor directories and files .vscode/* !.vscode/extensions.json -!.vscode/settings.json .idea *.suo *.ntvs* diff --git a/deploy.cjs b/deploy.cjs index b8beb00d..80e13b1a 100644 --- a/deploy.cjs +++ b/deploy.cjs @@ -1,32 +1,35 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ const ghpages = require('gh-pages'); -ghpages.publish('src/.vuepress/dist', { - branch: 'asf-site', - repo: 'https://github.com/apache/iotdb-website.git', - message: 'Site checkin for project iotdb-website', - dotfiles: true, -}, (err) => { - if (err instanceof Error) { - console.error(err); - process.exit(1); - } -}); +ghpages.publish( + 'src/.vuepress/dist', + { + branch: 'asf-site', + repo: 'https://github.com/apache/iotdb-website.git', + message: 'Site checkin for project iotdb-website', + dotfiles: true, + }, + (err) => { + if (err instanceof Error) { + console.error(err); + process.exit(1); + } + }, +); diff --git a/deploy_staging.cjs b/deploy_staging.cjs index 2ce93148..3a800399 100644 --- a/deploy_staging.cjs +++ b/deploy_staging.cjs @@ -1,32 +1,35 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ const ghpages = require('gh-pages'); -ghpages.publish('src/.vuepress/dist', { - branch: 'asf-staging', - repo: 'https://github.com/apache/iotdb-website.git', - message: 'Site checkin for project iotdb-website', - dotfiles: true, -}, (err) => { - if (err instanceof Error) { - console.error(err); - process.exit(1); - } -}); +ghpages.publish( + 'src/.vuepress/dist', + { + branch: 'asf-staging', + repo: 'https://github.com/apache/iotdb-website.git', + message: 'Site checkin for project iotdb-website', + dotfiles: true, + }, + (err) => { + if (err instanceof Error) { + console.error(err); + process.exit(1); + } + }, +); diff --git a/eslint.config.js b/eslint.config.js new file mode 100644 index 00000000..e23eb947 --- /dev/null +++ b/eslint.config.js @@ -0,0 +1,66 @@ +import jsConfig from '@eslint/js'; +import pluginVue from 'eslint-plugin-vue'; +import globals from 'globals'; +import { config, plugin, configs as tsConfigs } from 'typescript-eslint'; + +export default config( + { + ignores: [ + 'dist/**', + 'node_modules/**', + '!src/.vuepress/**', + 'src/.vuepress/.cache/**', + 'src/.vuepress/.temp/**', + 'src/.vuepress/public/**', + ], + }, + + { + languageOptions: { + ecmaVersion: 'latest', + sourceType: 'module', + parserOptions: { + extraFileExtensions: ['.vue'], + projectService: true, + tsconfigRootDir: import.meta.dirname, + }, + }, + }, + + jsConfig.configs.recommended, + ...tsConfigs.strict, + + { + files: ['**/*.ts', '**/*.cts', '**/*.mts'], + plugins: { + '@typescript-eslint': plugin, + }, + }, + ...pluginVue.configs['flat/recommended'], + + { + files: ['**/*.{js,cjs,mjs,jsx}'], + ...tsConfigs.disableTypeChecked, + }, + + { + files: ['**/*.cjs'], + rules: { + '@typescript-eslint/no-require-imports': 'off', + }, + }, + + { + files: ['**/*.vue'], + rules: { + 'vue/max-attributes-per-line': 'off', + }, + }, + + { + files: ['deploy.cjs', 'deploy_staging.cjs'], + languageOptions: { + globals: globals.node, + }, + }, +); diff --git a/package.json b/package.json index 80964b3f..c67f8ed1 100644 --- a/package.json +++ b/package.json @@ -4,50 +4,43 @@ "description": "Apache IoTDB Website", "license": "Apache Licence 2.0", "type": "module", - "scripts": { - "build": "node --max_old_space_size=6000 ./node_modules/vuepress/bin/vuepress.js build src", - "docs:clean-dev": "vuepress dev src --clean-cache", - "dev": "vuepress dev src", - "docs:update-package": "npx vp-update", - "deploy": "node --max_old_space_size=6000 deploy.cjs", - "deploy:staging": "node --max_old_space_size=6000 deploy_staging.cjs", - "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix" - }, - "devDependencies": { - "@docsearch/css": "3.8.0", - "@docsearch/js": "3.8.0", - "@docsearch/react": "3.8.0", - "@rushstack/eslint-patch": "1.6.0", - "@vue/eslint-config-airbnb-with-typescript": "^7.0.1", - "@vue/repl": "4.1.1", - "@vuepress/bundler-vite": "2.0.0-rc.14", - "@vuepress/helper": "2.0.0-rc.39", - "@vuepress/plugin-catalog": "2.0.0-rc.39", - "@vuepress/plugin-docsearch": "2.0.0-rc.39", - "@vuepress/plugin-google-analytics": "2.0.0-rc.37", - "@vuepress/plugin-prismjs": "2.0.0-rc.39", - "@vuepress/plugin-redirect": "2.0.0-rc.39", - "@vuepress/plugin-shiki": "2.0.0-rc.39", - "@vueuse/core": "10.11.0", - "algoliasearch": "^5.15.0", - "element-plus": "2.4.3", - "eslint": "8.55.0", - "eslint-plugin-vue": "9.19.2", - "gh-pages": "6.1.0", - "ts-debounce": "^4.0.0", - "vue": "^3.4.38", - "vuepress": "2.0.0-rc.14", - "vuepress-theme-hope": "2.0.0-rc.52" - }, - "extensionDependencies": [], "licenses": [ { "type": "Apache-2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" } ], + "scripts": { + "build": "node --max_old_space_size=8192 ./node_modules/vuepress/bin/vuepress.js build src", + "clean-dev": "vuepress dev src --clean-cache", + "dev": "vuepress dev src", + "update-package": "npx vp-update", + "deploy": "node --max_old_space_size=8192 deploy.cjs", + "deploy:staging": "node --max_old_space_size=8192 deploy_staging.cjs", + "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix" + }, "dependencies": { - "@vue/repl": "^4.1.1", - "katex": "^0.16.11" - } + "@vuepress/bundler-vite": "2.0.0-rc.19", + "@vuepress/helper": "2.0.0-rc.66", + "@vuepress/plugin-docsearch": "2.0.0-rc.67", + "mathjax-full": "3.2.2", + "sass-embedded": "1.83.0", + "vue": "3.5.13", + "vue3-carousel": "0.9.0", + "vuepress": "2.0.0-rc.19", + "vuepress-theme-hope": "2.0.0-rc.66" + }, + "devDependencies": { + "@eslint/js": "9.17.0", + "eslint": "9.17.0", + "eslint-plugin-vue": "9.32.0", + "gh-pages": "6.2.0", + "globals": "15.13.0", + "typescript-eslint": "8.18.0" + }, + "prettier": { + "singleQuote": true, + "trailingComma": "all" + }, + "packageManager": "pnpm@9.15.0" } diff --git a/src/.vuepress/client.ts b/src/.vuepress/client.ts index 6e93d5e5..bdbe4acd 100644 --- a/src/.vuepress/client.ts +++ b/src/.vuepress/client.ts @@ -1,37 +1,42 @@ /* -* Licensed to the Apache Software Foundation (ASF) under one -* or more contributor license agreements. See the NOTICE file -* distributed with this work for additional information -* regarding copyright ownership. The ASF licenses this file -* to you under the Apache License, Version 2.0 (the -* "License"); you may not use this file except in compliance -* with the License. You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ -import { defineClientConfig } from 'vuepress/client'; -import ElementPlus from 'element-plus'; -import IoTDB from './components/IoTDB.vue'; -import IoTDBZH from './components/IoTDBZH.vue'; -import Contributor from './components/Contributor.vue'; -import Contributors from './components/Contributors.vue'; - -import 'element-plus/dist/index.css'; +import { defineDocSearchConfig } from '@vuepress/plugin-docsearch/client'; +import { computed } from 'vue'; +import { defineClientConfig, usePageData } from 'vuepress/client'; +import { getDocVersion } from './utils/index.js'; export default defineClientConfig({ + setup() { + const pageData = usePageData(); + + const docSearchConfig = computed(() => ({ + appId: 'JLT9R2YGAE', + apiKey: 'f1f30c0df04d74534e066d07786bce05', + indexName: 'iotdb-apache', + maxResultsPerGroup: 10, + disableUserPersonalization: true, + searchParameters: { + indexName: 'iotdb-apache', + facetFilters: [`version:${getDocVersion(pageData.value.path)}`], + }, + })); - enhance: ({ app }) => { - app.use(ElementPlus); - app.component('IoTDB', IoTDB); - app.component('Contributor', Contributor); - app.component('Contributors', Contributors); - app.component('IoTDBZH', IoTDBZH); + defineDocSearchConfig(docSearchConfig); }, }); diff --git a/src/.vuepress/components/Contributor.vue b/src/.vuepress/components/Contributor.vue deleted file mode 100644 index c4cb1d80..00000000 --- a/src/.vuepress/components/Contributor.vue +++ /dev/null @@ -1,411 +0,0 @@ -/* -* Licensed to the Apache Software Foundation (ASF) under one -* or more contributor license agreements. See the NOTICE file -* distributed with this work for additional information -* regarding copyright ownership. The ASF licenses this file -* to you under the Apache License, Version 2.0 (the -* "License"); you may not use this file except in compliance -* with the License. You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - - - - - diff --git a/src/.vuepress/components/Contributors.vue b/src/.vuepress/components/Contributors.vue deleted file mode 100644 index 8fc5e67e..00000000 --- a/src/.vuepress/components/Contributors.vue +++ /dev/null @@ -1,418 +0,0 @@ -/* -* Licensed to the Apache Software Foundation (ASF) under one -* or more contributor license agreements. See the NOTICE file -* distributed with this work for additional information -* regarding copyright ownership. The ASF licenses this file -* to you under the Apache License, Version 2.0 (the -* "License"); you may not use this file except in compliance -* with the License. You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - - - - - diff --git a/src/.vuepress/components/HomeCarousel.vue b/src/.vuepress/components/HomeCarousel.vue new file mode 100644 index 00000000..6b76572c --- /dev/null +++ b/src/.vuepress/components/HomeCarousel.vue @@ -0,0 +1,121 @@ + + + + + + diff --git a/src/.vuepress/components/IoTDB.vue b/src/.vuepress/components/IoTDB.vue deleted file mode 100644 index 9b8b8475..00000000 --- a/src/.vuepress/components/IoTDB.vue +++ /dev/null @@ -1,312 +0,0 @@ -/* -* Licensed to the Apache Software Foundation (ASF) under one -* or more contributor license agreements. See the NOTICE file -* distributed with this work for additional information -* regarding copyright ownership. The ASF licenses this file -* to you under the Apache License, Version 2.0 (the -* "License"); you may not use this file except in compliance -* with the License. You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - - - - - - diff --git a/src/.vuepress/components/IoTDBZH.vue b/src/.vuepress/components/IoTDBZH.vue deleted file mode 100644 index dc061f09..00000000 --- a/src/.vuepress/components/IoTDBZH.vue +++ /dev/null @@ -1,306 +0,0 @@ -/* -* Licensed to the Apache Software Foundation (ASF) under one -* or more contributor license agreements. See the NOTICE file -* distributed with this work for additional information -* regarding copyright ownership. The ASF licenses this file -* to you under the Apache License, Version 2.0 (the -* "License"); you may not use this file except in compliance -* with the License. You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - - - - - - diff --git a/src/.vuepress/components/PageFooter.vue b/src/.vuepress/components/PageFooter.vue index df58dbac..dd8b4e4f 100644 --- a/src/.vuepress/components/PageFooter.vue +++ b/src/.vuepress/components/PageFooter.vue @@ -1,4 +1,4 @@ -/* + - + + + + diff --git a/src/.vuepress/components/ProjectContributors.vue b/src/.vuepress/components/ProjectContributors.vue new file mode 100644 index 00000000..d4a0ae69 --- /dev/null +++ b/src/.vuepress/components/ProjectContributors.vue @@ -0,0 +1,140 @@ + + + + + + + diff --git a/src/.vuepress/components/docsearch/client/components/Docsearch.ts b/src/.vuepress/components/docsearch/client/components/Docsearch.ts deleted file mode 100644 index 86936a2d..00000000 --- a/src/.vuepress/components/docsearch/client/components/Docsearch.ts +++ /dev/null @@ -1,129 +0,0 @@ -/* eslint-disable no-underscore-dangle */ -/* eslint-disable @typescript-eslint/naming-convention */ -import type { SearchParamsObject } from 'algoliasearch'; -import type { PropType } from 'vue'; -import { - computed, defineComponent, h, onMounted, ref, watch, -} from 'vue'; -import { usePageLang, useRouteLocale, usePageData } from 'vuepress/client'; -import type { DocsearchOptions } from '../../shared/index.js'; -import { - useDocsearchHotkeyListener, - useDocsearchShim, -} from '../composables/index.js'; -import { useDocSearchOptions } from '../helpers/index.js'; -import { - getFacetFilters, - getSearchButtonTemplate, - pollToOpenDocsearch, - preconnectToAlgolia, -} from '../utils/index.js'; - -import { getDocVersion } from '../../../../utils/version.js'; - -declare const __DOCSEARCH_INJECT_STYLES__: boolean; -const defaultBranch = 'latest'; - -if (__DOCSEARCH_INJECT_STYLES__) { - import('@docsearch/css'); - import('../styles/docsearch.css'); -} - -export const Docsearch = defineComponent({ - name: 'Docsearch', - - props: { - containerId: { - type: String, - default: 'docsearch-container', - }, - options: { - type: Object as PropType, - default: () => ({}), - }, - }, - - setup(props) { - const docSearchOptions = useDocSearchOptions(); - const docsearchShim = useDocsearchShim(); - const lang = usePageLang(); - const routeLocale = useRouteLocale(); - const pageData = usePageData(); - - const hasInitialized = ref(false); - const hasTriggered = ref(false); - - const version = computed(() => getDocVersion(defaultBranch, pageData.value.path)); - // resolve docsearch options for current locale - const options = computed(() => { - const { locales = {}, ...rest } = props.options; - - return { - ...docSearchOptions.value, - ...rest, - ...locales[routeLocale.value], - }; - }); - - /** - * Import docsearch js and initialize - */ - const initialize = async (): Promise => { - const { default: docsearch } = await import('@docsearch/js'); - - const { indexName, searchParameters } = options.value; - docsearch({ - ...docsearchShim, - ...options.value, - container: `#${props.containerId}`, - searchParameters: { - ...searchParameters, - indexName, - facetFilters: getFacetFilters( - (searchParameters as SearchParamsObject | undefined)?.facetFilters, - lang.value, - version.value, - ), - }, - }); - // mark as initialized - hasInitialized.value = true; - }; - - /** - * Trigger docsearch initialization and open it - */ - const trigger = (): void => { - if (hasTriggered.value || hasInitialized.value) return; - // mark as triggered - hasTriggered.value = true; - // initialize and open - initialize(); - pollToOpenDocsearch(); - // re-initialize when route locale changes - watch(routeLocale, initialize); - watch(() => version.value, initialize); - }; - - // trigger when hotkey is pressed - useDocsearchHotkeyListener(trigger); - - // preconnect to algolia - onMounted(() => preconnectToAlgolia(options.value.appId)); - - return () => [ - h('div', { - id: props.containerId, - style: { display: hasInitialized.value ? 'block' : 'none' }, - }), - hasInitialized.value - ? null - : h('div', { - onClick: trigger, - innerHTML: getSearchButtonTemplate( - options.value.translations?.button, - ), - }), - ]; - }, -}); diff --git a/src/.vuepress/components/docsearch/client/components/index.ts b/src/.vuepress/components/docsearch/client/components/index.ts deleted file mode 100644 index bf98de73..00000000 --- a/src/.vuepress/components/docsearch/client/components/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './Docsearch.js'; diff --git a/src/.vuepress/components/docsearch/client/composables/index.ts b/src/.vuepress/components/docsearch/client/composables/index.ts deleted file mode 100644 index 3656825a..00000000 --- a/src/.vuepress/components/docsearch/client/composables/index.ts +++ /dev/null @@ -1,2 +0,0 @@ -export * from './useDocsearchHotkeyListener.js'; -export * from './useDocsearchShim.js'; diff --git a/src/.vuepress/components/docsearch/client/composables/useDocsearchHotkeyListener.ts b/src/.vuepress/components/docsearch/client/composables/useDocsearchHotkeyListener.ts deleted file mode 100644 index b1ba3021..00000000 --- a/src/.vuepress/components/docsearch/client/composables/useDocsearchHotkeyListener.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { useEventListener } from '@vueuse/core'; - -/** - * Add hotkey listener, remove it after triggered - */ -export const useDocsearchHotkeyListener = (callback: () => void): void => { - const remove = useEventListener('keydown', (event) => { - const isHotKeyBind = event.key === 'k' && (event.ctrlKey || event.metaKey); - const isSlashKey = event.key === '/'; - - if (!isSlashKey && !isHotKeyBind) { - return; - } - - event.preventDefault(); - callback(); - remove(); - }); -}; diff --git a/src/.vuepress/components/docsearch/client/composables/useDocsearchShim.ts b/src/.vuepress/components/docsearch/client/composables/useDocsearchShim.ts deleted file mode 100644 index d4c4c687..00000000 --- a/src/.vuepress/components/docsearch/client/composables/useDocsearchShim.ts +++ /dev/null @@ -1,73 +0,0 @@ -/* eslint-disable no-underscore-dangle */ -/* eslint-disable @typescript-eslint/naming-convention */ -import type { DocSearchProps } from '@docsearch/react'; -import { debounce } from 'ts-debounce'; -import { useRouter } from 'vuepress/client'; -import { removeLeadingSlash, resolveRoutePathFromUrl } from 'vuepress/shared'; - -declare const __DOCSEARCH_INDEX_BASE__: string; - -const isSpecialClick = (event: MouseEvent): boolean => event.button === 1 - || event.altKey - || event.ctrlKey - || event.metaKey - || event.shiftKey; - -/** - * Get docsearch options to be compatible with VuePress - */ -export const useDocsearchShim = (): Partial => { - const router = useRouter(); - - return { - // convert item url to pathname of current site - transformItems: (items) => items.map((item) => ({ - ...item, - url: `${ - // append current base - __VUEPRESS_BASE__ - }${removeLeadingSlash( - // get route path - resolveRoutePathFromUrl(item.url, __DOCSEARCH_INDEX_BASE__), - )}`, - })), - - // render the hit component with custom `onClick` handler - hitComponent: ({ hit, children }) => ({ - type: 'a', - ref: undefined, - constructor: undefined, - key: undefined, - props: { - href: hit.url, - // handle `onClick` by `router.push` - onClick: (event: MouseEvent) => { - if (isSpecialClick(event)) { - return; - } - event.preventDefault(); - router.push(hit.url.replace(__VUEPRESS_BASE__, '/')); - }, - children, - }, - __v: null, - }) as unknown, - - // navigation behavior triggered by `onKeyDown` internally - navigator: { - // when pressing Enter without metaKey - navigate: ({ itemUrl }) => { - router.push(itemUrl.replace(__VUEPRESS_BASE__, '/')); - }, - }, - - // add search debounce - transformSearchClient: (searchClient) => { - const searchWithDebounce = debounce(searchClient.search, 500); - return { - ...searchClient, - search: async (...args) => searchWithDebounce(...args), - }; - }, - } as Partial; -}; diff --git a/src/.vuepress/components/docsearch/client/config.ts b/src/.vuepress/components/docsearch/client/config.ts deleted file mode 100644 index a09cb2f4..00000000 --- a/src/.vuepress/components/docsearch/client/config.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { defineClientConfig } from 'vuepress/client'; -import { Docsearch } from './components/index.js'; -import { injectDocSearchConfig } from './helpers/index.js'; - -export default defineClientConfig({ - enhance({ app }) { - injectDocSearchConfig(app); - app.component('Docsearch', Docsearch); - }, -}); diff --git a/src/.vuepress/components/docsearch/client/helpers/docsearch.ts b/src/.vuepress/components/docsearch/client/helpers/docsearch.ts deleted file mode 100644 index d042ce26..00000000 --- a/src/.vuepress/components/docsearch/client/helpers/docsearch.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* eslint-disable no-underscore-dangle */ -/* eslint-disable @typescript-eslint/naming-convention */ -import type { DocSearchProps } from '@docsearch/react'; -import { deepAssign, isFunction } from '@vuepress/helper/client'; -import type { - App, ComputedRef, InjectionKey, MaybeRefOrGetter, Ref, -} from 'vue'; -import { - computed, inject, isRef, ref, watch, -} from 'vue'; -import { useRouteLocale } from 'vuepress/client'; -import type { DocsearchOptions } from '../../shared/index.js'; - -declare const __VUEPRESS_DEV__: boolean; -declare const __DOCSEARCH_OPTIONS__: DocsearchOptions; - -const docSearchOptions: Partial = __DOCSEARCH_OPTIONS__; - -const docsearch: Ref = ref(docSearchOptions as DocSearchProps); - -const docsearchSymbol: InjectionKey< -Ref< -DocSearchProps & { - locales?: Record -} -> -> = Symbol(__VUEPRESS_DEV__ ? 'docsearch' : ''); - -export type DocSearchClientLocaleOptions = Partial< -Omit ->; - -export interface DocSearchClientOptions extends DocSearchClientLocaleOptions { - locales?: Record -} - -export const defineDocSearchConfig = ( - options: MaybeRefOrGetter, -): void => { - if (isRef(options)) { - watch( - () => options.value, - (value) => { - docsearch.value = deepAssign({}, docSearchOptions, value); - }, - ); - } else if (isFunction(options)) { - watch(options, (value) => { - docsearch.value = deepAssign({}, docSearchOptions, value); - }); - } else { - docsearch.value = deepAssign({}, docSearchOptions, options); - } -}; - -export const useDocSearchOptions = (): ComputedRef => { - const options = inject(docsearchSymbol)!; - const routeLocale = useRouteLocale(); - - return computed(() => ({ - ...options.value, - ...options.value.locales?.[routeLocale.value], - })); -}; - -export const injectDocSearchConfig = (app: App): void => { - app.provide(docsearchSymbol, docsearch); -}; diff --git a/src/.vuepress/components/docsearch/client/helpers/index.ts b/src/.vuepress/components/docsearch/client/helpers/index.ts deleted file mode 100644 index 3b13fb70..00000000 --- a/src/.vuepress/components/docsearch/client/helpers/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './docsearch.js'; diff --git a/src/.vuepress/components/docsearch/client/index.ts b/src/.vuepress/components/docsearch/client/index.ts deleted file mode 100644 index b791f762..00000000 --- a/src/.vuepress/components/docsearch/client/index.ts +++ /dev/null @@ -1,3 +0,0 @@ -export * from './components/index.js'; -export * from './helpers/index.js'; -export type * from '../shared/index.js'; diff --git a/src/.vuepress/components/docsearch/client/shims.d.ts b/src/.vuepress/components/docsearch/client/shims.d.ts deleted file mode 100644 index f7fc1aed..00000000 --- a/src/.vuepress/components/docsearch/client/shims.d.ts +++ /dev/null @@ -1,7 +0,0 @@ -declare module '@docsearch/css' { - export {}; -} - -declare module '*.css' { - export {}; -} diff --git a/src/.vuepress/components/docsearch/client/styles/docsearch.css b/src/.vuepress/components/docsearch/client/styles/docsearch.css deleted file mode 100644 index 75bb82f5..00000000 --- a/src/.vuepress/components/docsearch/client/styles/docsearch.css +++ /dev/null @@ -1,15 +0,0 @@ -/* stylelint-disable selector-class-pattern */ - -@media (max-width: 750px) { - .DocSearch-Container { - /* fix the search modal on mobile */ - position: fixed; - } -} - -@media print { - #docsearch-container, - .DocSearch-Button { - display: none; - } -} diff --git a/src/.vuepress/components/docsearch/client/utils/getFacetFilters.ts b/src/.vuepress/components/docsearch/client/utils/getFacetFilters.ts deleted file mode 100644 index 5eb7d7e6..00000000 --- a/src/.vuepress/components/docsearch/client/utils/getFacetFilters.ts +++ /dev/null @@ -1,19 +0,0 @@ -import type { DocsearchOptions } from '../../shared/index.js'; - -type FacetFilters = - Required['searchParameters']['facetFilters']; - -/** - * Get facet filters for current lang - */ -export const getFacetFilters = ( - rawFacetFilters: FacetFilters = [], - lang: string, - version: string, -): FacetFilters => [ - `lang:${lang}`, - `version:${version}`, - ...((Array.isArray(rawFacetFilters) - ? rawFacetFilters - : [rawFacetFilters]) as string[]), -]; diff --git a/src/.vuepress/components/docsearch/client/utils/getSearchButtonTemplate.ts b/src/.vuepress/components/docsearch/client/utils/getSearchButtonTemplate.ts deleted file mode 100644 index 7ae3717a..00000000 --- a/src/.vuepress/components/docsearch/client/utils/getSearchButtonTemplate.ts +++ /dev/null @@ -1,13 +0,0 @@ -import type { DocSearchTranslations } from '@docsearch/react'; - -/** - * Get the search button template - * - * Use the same content as in @docsearch/js - * - * TODO: the meta key text should also be dynamic - */ -export const getSearchButtonTemplate = ({ - buttonText = 'Search', - buttonAriaLabel = buttonText, -}: DocSearchTranslations['button'] = {}): string => ``; diff --git a/src/.vuepress/components/docsearch/client/utils/index.ts b/src/.vuepress/components/docsearch/client/utils/index.ts deleted file mode 100644 index 46345213..00000000 --- a/src/.vuepress/components/docsearch/client/utils/index.ts +++ /dev/null @@ -1,4 +0,0 @@ -export * from './getFacetFilters.js'; -export * from './getSearchButtonTemplate.js'; -export * from './pollToOpenDocsearch.js'; -export * from './preconnectToAlgolia.js'; diff --git a/src/.vuepress/components/docsearch/client/utils/pollToOpenDocsearch.ts b/src/.vuepress/components/docsearch/client/utils/pollToOpenDocsearch.ts deleted file mode 100644 index c9e79017..00000000 --- a/src/.vuepress/components/docsearch/client/utils/pollToOpenDocsearch.ts +++ /dev/null @@ -1,15 +0,0 @@ -const POLL_INTERVAL = 16; - -/** - * Programmatically open the docsearch modal - */ -export const pollToOpenDocsearch = (): void => { - if (document.querySelector('.DocSearch-Modal')) return; - const e = new Event('keydown') as { - -readonly [P in keyof KeyboardEvent]: KeyboardEvent[P] - }; - e.key = 'k'; - e.metaKey = true; - window.dispatchEvent(e); - setTimeout(pollToOpenDocsearch, POLL_INTERVAL); -}; diff --git a/src/.vuepress/components/docsearch/client/utils/preconnectToAlgolia.ts b/src/.vuepress/components/docsearch/client/utils/preconnectToAlgolia.ts deleted file mode 100644 index 3f925441..00000000 --- a/src/.vuepress/components/docsearch/client/utils/preconnectToAlgolia.ts +++ /dev/null @@ -1,16 +0,0 @@ -/** - * Preconnect to Algolia's API - */ -export const preconnectToAlgolia = (appId: string): void => { - const id = 'algolia-preconnect'; - const rIC = window.requestIdleCallback || setTimeout; - rIC(() => { - if (document.head.querySelector(`#${id}`)) return; - const preconnect = document.createElement('link'); - preconnect.id = id; - preconnect.rel = 'preconnect'; - preconnect.href = `https://${appId}-dsn.algolia.net`; - preconnect.crossOrigin = ''; - document.head.appendChild(preconnect); - }); -}; diff --git a/src/.vuepress/components/docsearch/node/docsearchPlugin.ts b/src/.vuepress/components/docsearch/node/docsearchPlugin.ts deleted file mode 100644 index c6ca0b2e..00000000 --- a/src/.vuepress/components/docsearch/node/docsearchPlugin.ts +++ /dev/null @@ -1,37 +0,0 @@ -import type { Plugin } from 'vuepress/core'; -import { getDirname, path } from 'vuepress/utils'; -import type { DocsearchOptions } from '../shared/index.js'; - -// eslint-disable-next-line @typescript-eslint/naming-convention, no-underscore-dangle -const __dirname = getDirname(import.meta.url); - -/** - * Options for @vuepress/plugin-docsearch - */ -export interface DocsearchPluginOptions extends DocsearchOptions { - /** - * Base path of the search index - */ - indexBase?: string - - /** - * Whether to inject docsearch default styles - */ - injectStyles?: boolean -} - -export const docsearchPlugin = ({ - injectStyles = true, - indexBase, - ...options -}: DocsearchPluginOptions = {}): Plugin => ({ - name: '@vuepress/plugin-docsearch-iotdb', - - clientConfigFile: path.resolve(__dirname, '../client/config.ts'), - - define: (app) => ({ - __DOCSEARCH_INJECT_STYLES__: injectStyles, - __DOCSEARCH_INDEX_BASE__: indexBase || app.options.base, - __DOCSEARCH_OPTIONS__: options, - }), -}); diff --git a/src/.vuepress/components/docsearch/node/index.ts b/src/.vuepress/components/docsearch/node/index.ts deleted file mode 100644 index 159eb7c3..00000000 --- a/src/.vuepress/components/docsearch/node/index.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { docsearchPlugin } from './docsearchPlugin.js'; - -export * from './docsearchPlugin.js'; -export type * from '../shared/index.js'; -/** @deprecated Use named export instead */ -export default docsearchPlugin; diff --git a/src/.vuepress/components/docsearch/shared/index.ts b/src/.vuepress/components/docsearch/shared/index.ts deleted file mode 100644 index d4702960..00000000 --- a/src/.vuepress/components/docsearch/shared/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './types.js'; diff --git a/src/.vuepress/components/docsearch/shared/types.ts b/src/.vuepress/components/docsearch/shared/types.ts deleted file mode 100644 index 57dae799..00000000 --- a/src/.vuepress/components/docsearch/shared/types.ts +++ /dev/null @@ -1,21 +0,0 @@ -import type { DocSearchProps } from '@docsearch/react'; -import type { LocaleConfig } from 'vuepress/shared'; - -export type DocsearchLocaleOptions = Partial< -Pick< -DocSearchProps, -| 'appId' -| 'apiKey' -| 'indexName' -| 'placeholder' -| 'searchParameters' -| 'maxResultsPerGroup' -| 'disableUserPersonalization' -| 'initialQuery' -| 'translations' -> ->; - -export interface DocsearchOptions extends DocsearchLocaleOptions { - locales?: LocaleConfig -} diff --git a/src/.vuepress/config.ts b/src/.vuepress/config.ts index 089806c6..f37a7751 100644 --- a/src/.vuepress/config.ts +++ b/src/.vuepress/config.ts @@ -1,27 +1,24 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ import { getDirname, path } from 'vuepress/utils'; import { viteBundler } from '@vuepress/bundler-vite'; import { defineUserConfig } from 'vuepress'; -import { redirectPlugin } from '@vuepress/plugin-redirect'; -import { docsearchPlugin } from './components/docsearch/node/index.js'; import theme from './theme.js'; const dirname = getDirname(import.meta.url); @@ -45,11 +42,33 @@ export default defineUserConfig({ theme, head: [ ['link', { rel: 'icon', href: '/favicon.ico' }], - ['meta', { name: 'Description', content: 'Apache IoTDB: Time Series Database for IoT' }], - ['meta', { name: 'Keywords', content: 'TSDB, time series, time series database, IoTDB, IoT database, IoT data management,时序数据库, 时间序列管理, IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据' }], + [ + 'meta', + { + name: 'Description', + content: 'Apache IoTDB: Time Series Database for IoT', + }, + ], + [ + 'meta', + { + name: 'Keywords', + content: + 'TSDB, time series, time series database, IoTDB, IoT database, IoT data management, 时序数据库, 时间序列管理, IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据', + }, + ], ['meta', { name: 'baidu-site-verification', content: 'wfKETzB3OT' }], - ['meta', { name: 'google-site-verification', content: 'mZWAoRY0yj_HAr-s47zHCGHzx5Ju-RVm5wDbPnwQYFo' }], - ['script', { type: 'text/javascript' }, ` + [ + 'meta', + { + name: 'google-site-verification', + content: 'mZWAoRY0yj_HAr-s47zHCGHzx5Ju-RVm5wDbPnwQYFo', + }, + ], + [ + 'script', + { type: 'text/javascript' }, + `\ var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ _paq.push(["setDoNotTrack", true]); @@ -63,7 +82,8 @@ _paq.push(['enableLinkTracking']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); - `], +`, + ], ], shouldPrefetch: false, @@ -72,70 +92,7 @@ _paq.push(['enableLinkTracking']); dirname, './components/PageFooter.vue', ), - // '@theme-hope/modules/info/utils/index': path.resolve( - // dirname, - // './utils/index', - // ), }, - plugins: [ - docsearchPlugin({ - appId: 'JLT9R2YGAE', - apiKey: 'f1f30c0df04d74534e066d07786bce05', - indexName: 'iotdb-apache', - maxResultsPerGroup: 10, - disableUserPersonalization: true, - locales: { - '/zh/': { - placeholder: '搜索文档', - translations: { - button: { - buttonText: '搜索文档', - buttonAriaLabel: '搜索文档', - }, - modal: { - searchBox: { - resetButtonTitle: '清除查询条件', - resetButtonAriaLabel: '清除查询条件', - cancelButtonText: '取消', - cancelButtonAriaLabel: '取消', - }, - startScreen: { - recentSearchesTitle: '搜索历史', - noRecentSearchesText: '没有搜索历史', - saveRecentSearchButtonTitle: '保存至搜索历史', - removeRecentSearchButtonTitle: '从搜索历史中移除', - favoriteSearchesTitle: '收藏', - removeFavoriteSearchButtonTitle: '从收藏中移除', - }, - errorScreen: { - titleText: '无法获取结果', - helpText: '你可能需要检查你的网络连接', - }, - footer: { - selectText: '选择', - navigateText: '切换', - closeText: '关闭', - searchByText: '搜索提供者', - }, - noResultsScreen: { - noResultsText: '无法找到相关结果', - suggestedQueryText: '你可以尝试查询', - reportMissingResultsText: '你认为该查询应该有结果？', - reportMissingResultsLinkText: '点击反馈', - }, - }, - }, - }, - }, - }), - redirectPlugin({ - // hostname: 'https://iotdb.apache.org/', - config: { - '/UserGuide/Master/QuickStart/QuickStart.html': '/UserGuide/latest/QuickStart/QuickStart_apache.html', - '/zh/UserGuide/Master/QuickStart/QuickStart.html': '/zh/UserGuide/latest/QuickStart/QuickStart_apache.html', - }, - }), - ], bundler: viteBundler({ vuePluginOptions: { template: { @@ -145,5 +102,12 @@ _paq.push(['enableLinkTracking']); }, }, }), - pagePatterns: ['**/*.md', '!**/*_timecho.md', '!**/stage/**/*.md', '!**/Master/**/*.md', '!.vuepress', '!node_modules'], + pagePatterns: [ + '**/*.md', + '!**/*_timecho.md', + '!**/stage/**/*.md', + '!**/Master/**/*.md', + '!.vuepress', + '!node_modules', + ], }); diff --git a/src/.vuepress/navbar/en.ts b/src/.vuepress/navbar/en.ts index e6a0d509..c3521349 100644 --- a/src/.vuepress/navbar/en.ts +++ b/src/.vuepress/navbar/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ import { navbar } from 'vuepress-theme-hope'; @@ -24,8 +23,14 @@ export const enNavbar = navbar([ text: 'Documentation', children: [ // { text: 'latest', link: '/UserGuide/Master/QuickStart/QuickStart_apache' }, - { text: 'v1.3.3', link: '/UserGuide/latest/QuickStart/QuickStart_apache' }, - { text: 'v1.3.0/1/2', link: '/UserGuide/V1.3.0-2/QuickStart/QuickStart_apache' }, + { + text: 'v1.3.3', + link: '/UserGuide/latest/QuickStart/QuickStart_apache', + }, + { + text: 'v1.3.0/1/2', + link: '/UserGuide/V1.3.0-2/QuickStart/QuickStart_apache', + }, { text: 'v1.2.x', link: '/UserGuide/V1.2.x/QuickStart/QuickStart' }, { text: 'v1.1.x', link: '/UserGuide/V1.1.x/QuickStart/QuickStart' }, { text: 'v1.0.x', link: '/UserGuide/V1.0.x/QuickStart/QuickStart' }, @@ -46,21 +51,33 @@ export const enNavbar = navbar([ { text: 'About the Community', link: '/Community/About-the-Community' }, { text: 'Development Guide', link: '/Community/Development-Guide' }, { text: 'Community Partners', link: '/Community/Community-Partners' }, - { text: 'Communication Channels', link: '/Community/Communication-Channels' }, + { + text: 'Communication Channels', + link: '/Community/Communication-Channels', + }, { text: 'Events and Reports', link: '/Community/Events-and-Reports' }, { text: 'Commiters', link: '/Community/Commiters' }, ], - }, + }, { text: 'ASF', children: [ { text: 'Foundation', link: 'https://www.apache.org/' }, { text: 'License', link: 'https://www.apache.org/licenses/' }, { text: 'Security', link: 'https://www.apache.org/security/' }, - { text: 'Sponsorship', link: 'https://www.apache.org/foundation/sponsorship.html' }, + { + text: 'Sponsorship', + link: 'https://www.apache.org/foundation/sponsorship.html', + }, { text: 'Thanks', link: 'https://www.apache.org/foundation/thanks.html' }, - { text: 'Current Events', link: 'https://www.apache.org/events/current-event' }, - { text: 'Privacy', link: 'https://privacy.apache.org/policies/privacy-policy-public.html' }, + { + text: 'Current Events', + link: 'https://www.apache.org/events/current-event', + }, + { + text: 'Privacy', + link: 'https://privacy.apache.org/policies/privacy-policy-public.html', + }, ], }, ]); diff --git a/src/.vuepress/navbar/index.ts b/src/.vuepress/navbar/index.ts index 4493c7eb..3e7096aa 100644 --- a/src/.vuepress/navbar/index.ts +++ b/src/.vuepress/navbar/index.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export * from './en.js'; diff --git a/src/.vuepress/navbar/zh.ts b/src/.vuepress/navbar/zh.ts index 4e9c7c71..a11bca08 100644 --- a/src/.vuepress/navbar/zh.ts +++ b/src/.vuepress/navbar/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ import { navbar } from 'vuepress-theme-hope'; @@ -24,8 +23,14 @@ export const zhNavbar = navbar([ text: '文档', children: [ // { text: 'latest', link: '/zh/UserGuide/Master/QuickStart/QuickStart_apache' }, - { text: 'v1.3.3', link: '/zh/UserGuide/latest/QuickStart/QuickStart_apache' }, - { text: 'v1.3.0/1/2', link: '/zh/UserGuide/V1.3.0-2/QuickStart/QuickStart_apache' }, + { + text: 'v1.3.3', + link: '/zh/UserGuide/latest/QuickStart/QuickStart_apache', + }, + { + text: 'v1.3.0/1/2', + link: '/zh/UserGuide/V1.3.0-2/QuickStart/QuickStart_apache', + }, { text: 'v1.2.x', link: '/zh/UserGuide/V1.2.x/QuickStart/QuickStart' }, { text: 'v1.1.x', link: '/zh/UserGuide/V1.1.x/QuickStart/QuickStart' }, { text: 'v1.0.x', link: '/zh/UserGuide/V1.0.x/QuickStart/QuickStart' }, @@ -57,10 +62,16 @@ export const zhNavbar = navbar([ { text: '基金会', link: 'https://www.apache.org/' }, { text: '许可证', link: 'https://www.apache.org/licenses/' }, { text: '安全', link: 'https://www.apache.org/security/' }, - { text: '赞助', link: 'https://www.apache.org/foundation/sponsorship.html' }, + { + text: '赞助', + link: 'https://www.apache.org/foundation/sponsorship.html', + }, { text: '致谢', link: 'https://www.apache.org/foundation/thanks.html' }, { text: '活动', link: 'https://www.apache.org/events/current-event' }, - { text: '隐私', link: 'https://privacy.apache.org/policies/privacy-policy-public.html' }, + { + text: '隐私', + link: 'https://privacy.apache.org/policies/privacy-policy-public.html', + }, ], }, ]); diff --git a/src/.vuepress/navbar_timecho/en.ts b/src/.vuepress/navbar_timecho/en.ts index 4a3b05f9..ed410ad1 100644 --- a/src/.vuepress/navbar_timecho/en.ts +++ b/src/.vuepress/navbar_timecho/en.ts @@ -1,53 +1,54 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ - import { navbar } from 'vuepress-theme-hope'; +import { navbar } from 'vuepress-theme-hope'; - export const enNavbar = navbar([ - { - text: 'Home', - link: '/', - }, - { - text: 'Product', - link: '/product', - }, - { - text: 'Documentation', - children: [ - { text: 'latest', link: '/UserGuide/latest/QuickStart/QuickStart_timecho' }, - { text: 'v1.1.x', link: '/UserGuide/V1.1.x/QuickStart/QuickStart' }, - { text: 'v1.0.x', link: '/UserGuide/V1.0.x/QuickStart/QuickStart' }, - { text: 'v0.13.x', link: '/UserGuide/V0.13.x/QuickStart/QuickStart' }, - ], - }, - { - text: 'News', - link: '/categories/news', - }, - { - text: 'Blogs', - link: '/categories/blogs', - }, - { - text: 'About', - link: '/aboutus', - }, - ]); - \ No newline at end of file +export const enNavbar = navbar([ + { + text: 'Home', + link: '/', + }, + { + text: 'Product', + link: '/product', + }, + { + text: 'Documentation', + children: [ + { + text: 'latest', + link: '/UserGuide/latest/QuickStart/QuickStart_timecho', + }, + { text: 'v1.1.x', link: '/UserGuide/V1.1.x/QuickStart/QuickStart' }, + { text: 'v1.0.x', link: '/UserGuide/V1.0.x/QuickStart/QuickStart' }, + { text: 'v0.13.x', link: '/UserGuide/V0.13.x/QuickStart/QuickStart' }, + ], + }, + { + text: 'News', + link: '/categories/news', + }, + { + text: 'Blogs', + link: '/categories/blogs', + }, + { + text: 'About', + link: '/aboutus', + }, +]); diff --git a/src/.vuepress/navbar_timecho/index.ts b/src/.vuepress/navbar_timecho/index.ts index 4493c7eb..3e7096aa 100644 --- a/src/.vuepress/navbar_timecho/index.ts +++ b/src/.vuepress/navbar_timecho/index.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export * from './en.js'; diff --git a/src/.vuepress/navbar_timecho/zh.ts b/src/.vuepress/navbar_timecho/zh.ts index 67ddd290..467f431a 100644 --- a/src/.vuepress/navbar_timecho/zh.ts +++ b/src/.vuepress/navbar_timecho/zh.ts @@ -1,60 +1,58 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ - import { navbar } from 'vuepress-theme-hope'; +import { navbar } from 'vuepress-theme-hope'; - export const zhNavbar = navbar([ - { - text: '首页', - link: 'https://www.timecho.com/', - target: '_self', - }, - { - text: '产品', - link: 'https://www.timecho.com/product', - target: '_self', - }, - { - text: '文档', - link: 'https://www.timecho.com/docs/zh/latest/QuickStart/QuickStart_timecho.html', - target: '_self', - // children: [ - // { text: 'latest', link: '/zh/UserGuide/Master/QuickStart/QuickStart' }, - // { text: 'v1.1.x', link: '/zh/UserGuide/V1.1.x/QuickStart/QuickStart' }, - // { text: 'v1.0.x', link: '/zh/UserGuide/V1.0.x/QuickStart/QuickStart' }, - // { text: 'v0.13.x', link: '/zh/UserGuide/V0.13.x/QuickStart/QuickStart' }, - // ], - }, - { - text: '新闻', - link: 'https://www.timecho.com/categories/news', - target: '_self', - }, - { - text: '博客', - link: 'https://www.timecho.com/categories/blogs', - target: '_self', - }, - { - text: '关于我们', - link: 'https://www.timecho.com/aboutus', - target: '_self', - }, - ]); - \ No newline at end of file +export const zhNavbar = navbar([ + { + text: '首页', + link: 'https://www.timecho.com/', + target: '_self', + }, + { + text: '产品', + link: 'https://www.timecho.com/product', + target: '_self', + }, + { + text: '文档', + link: 'https://www.timecho.com/docs/zh/latest/QuickStart/QuickStart_timecho.html', + target: '_self', + // children: [ + // { text: 'latest', link: '/zh/UserGuide/Master/QuickStart/QuickStart' }, + // { text: 'v1.1.x', link: '/zh/UserGuide/V1.1.x/QuickStart/QuickStart' }, + // { text: 'v1.0.x', link: '/zh/UserGuide/V1.0.x/QuickStart/QuickStart' }, + // { text: 'v0.13.x', link: '/zh/UserGuide/V0.13.x/QuickStart/QuickStart' }, + // ], + }, + { + text: '新闻', + link: 'https://www.timecho.com/categories/news', + target: '_self', + }, + { + text: '博客', + link: 'https://www.timecho.com/categories/blogs', + target: '_self', + }, + { + text: '关于我们', + link: 'https://www.timecho.com/aboutus', + target: '_self', + }, +]); diff --git a/src/.vuepress/public/.asf.yaml b/src/.vuepress/public/.asf.yaml index 99c6d991..b1a8a525 100644 --- a/src/.vuepress/public/.asf.yaml +++ b/src/.vuepress/public/.asf.yaml @@ -19,7 +19,7 @@ staging: profile: ~ - whoami: asf-staging + whoami: asf-staging publish: - whoami: asf-site \ No newline at end of file + whoami: asf-site diff --git a/src/.vuepress/public/img/arrow.png b/src/.vuepress/public/img/arrow.png deleted file mode 100644 index 0477c273..00000000 Binary files a/src/.vuepress/public/img/arrow.png and /dev/null differ diff --git a/src/.vuepress/public/img/home-icon1.png b/src/.vuepress/public/img/home-icon1.png deleted file mode 100644 index 4f82b6f0..00000000 Binary files a/src/.vuepress/public/img/home-icon1.png and /dev/null differ diff --git a/src/.vuepress/public/img/home-icon2.png b/src/.vuepress/public/img/home-icon2.png deleted file mode 100644 index d2978785..00000000 Binary files a/src/.vuepress/public/img/home-icon2.png and /dev/null differ diff --git a/src/.vuepress/public/img/home-icon3.png b/src/.vuepress/public/img/home-icon3.png deleted file mode 100644 index 41769db3..00000000 Binary files a/src/.vuepress/public/img/home-icon3.png and /dev/null differ diff --git a/src/.vuepress/public/img/home-icon4.png b/src/.vuepress/public/img/home-icon4.png deleted file mode 100644 index fe78527b..00000000 Binary files a/src/.vuepress/public/img/home-icon4.png and /dev/null differ diff --git a/src/.vuepress/public/img/home-icon5.png b/src/.vuepress/public/img/home-icon5.png deleted file mode 100644 index 1d001aa0..00000000 Binary files a/src/.vuepress/public/img/home-icon5.png and /dev/null differ diff --git a/src/.vuepress/public/img/home-icon6.png b/src/.vuepress/public/img/home-icon6.png deleted file mode 100644 index 51d2a421..00000000 Binary files a/src/.vuepress/public/img/home-icon6.png and /dev/null differ diff --git a/src/.vuepress/sidebar/V0.13.x/en.ts b/src/.vuepress/sidebar/V0.13.x/en.ts index 84d28482..0d375ad0 100644 --- a/src/.vuepress/sidebar/V0.13.x/en.ts +++ b/src/.vuepress/sidebar/V0.13.x/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -52,7 +51,10 @@ export const enSidebar = { collapsible: true, prefix: 'Data-Concept/', children: [ - { text: 'Data Model and Terminology', link: 'Data-Model-and-Terminology' }, + { + text: 'Data Model and Terminology', + link: 'Data-Model-and-Terminology', + }, { text: 'Schema Template', link: 'Schema-Template' }, { text: 'Data Type', link: 'Data-Type' }, { text: 'Deadband Process', link: 'Deadband-Process' }, @@ -66,9 +68,7 @@ export const enSidebar = { text: 'Syntax Conventions', collapsible: true, prefix: 'Reference/', - children: [ - { text: 'Syntax Conventions', link: 'Syntax-Conventions' }, - ], + children: [{ text: 'Syntax Conventions', link: 'Syntax-Conventions' }], }, { text: 'API', @@ -132,7 +132,10 @@ export const enSidebar = { collapsible: true, prefix: 'Process-Data/', children: [ - { text: 'UDF (User Defined Function)', link: 'UDF-User-Defined-Function' }, + { + text: 'UDF (User Defined Function)', + link: 'UDF-User-Defined-Function', + }, { text: 'Select Into', link: 'Select-Into' }, { text: 'Continuous Query', link: 'Continuous-Query' }, { text: 'Triggers', link: 'Triggers' }, @@ -143,9 +146,7 @@ export const enSidebar = { text: 'Administration', collapsible: true, prefix: 'Administration-Management/', - children: [ - { text: 'Administration', link: 'Administration' }, - ], + children: [{ text: 'Administration', link: 'Administration' }], }, { text: 'Maintenance Tools', @@ -171,7 +172,10 @@ export const enSidebar = { prefix: 'Ecosystem-Integration/', children: [ { text: 'Grafana Plugin', link: 'Grafana-Plugin' }, - { text: 'Grafana Connector (Not Recommended)', link: 'Grafana-Connector' }, + { + text: 'Grafana Connector (Not Recommended)', + link: 'Grafana-Connector', + }, { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, { text: 'DBeaver-IoTDB', link: 'DBeaver' }, { text: 'MapReduce TsFile', link: 'MapReduce-TsFile' }, @@ -196,7 +200,7 @@ export const enSidebar = { { text: 'Data Quality', link: 'Data-Quality' }, { text: 'Data Repairing', link: 'Data-Repairing' }, { text: 'Series Discovery', link: 'Series-Discovery' }, - { text: 'String Processing', link: 'String-Processing' } + { text: 'String Processing', link: 'String-Processing' }, ], }, { @@ -206,7 +210,10 @@ export const enSidebar = { children: [ { text: 'Config Manual', link: 'Config-Manual' }, { text: 'Keywords', link: 'Keywords' }, - { text: 'Frequently asked questions', link: 'Frequently-asked-questions' }, + { + text: 'Frequently asked questions', + link: 'Frequently-asked-questions', + }, { text: 'TSDB Comparison', link: 'TSDB-Comparison' }, ], }, diff --git a/src/.vuepress/sidebar/V0.13.x/zh.ts b/src/.vuepress/sidebar/V0.13.x/zh.ts index 72ff9bdb..5fce5eb3 100644 --- a/src/.vuepress/sidebar/V0.13.x/zh.ts +++ b/src/.vuepress/sidebar/V0.13.x/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -66,9 +65,7 @@ export const zhSidebar = { text: '语法约定', collapsible: true, prefix: 'Reference/', - children: [ - { text: '语法约定', link: 'Syntax-Conventions' }, - ], + children: [{ text: '语法约定', link: 'Syntax-Conventions' }], }, { text: '应用编程接口', @@ -143,9 +140,7 @@ export const zhSidebar = { text: '权限管理', collapsible: true, prefix: 'Administration-Management/', - children: [ - { text: '权限管理', link: 'Administration' }, - ], + children: [{ text: '权限管理', link: 'Administration' }], }, { text: '运维工具', @@ -196,7 +191,7 @@ export const zhSidebar = { { text: '数据质量', link: 'Data-Quality' }, { text: '数据修复', link: 'Data-Repairing' }, { text: '序列发现', link: 'Series-Discovery' }, - { text: '字符串处理', link: 'String-Processing' } + { text: '字符串处理', link: 'String-Processing' }, ], }, { diff --git a/src/.vuepress/sidebar/V1.0.x/en.ts b/src/.vuepress/sidebar/V1.0.x/en.ts index 7c3acba8..8403bfab 100644 --- a/src/.vuepress/sidebar/V1.0.x/en.ts +++ b/src/.vuepress/sidebar/V1.0.x/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -52,7 +51,10 @@ export const enSidebar = { collapsible: true, prefix: 'Data-Concept/', children: [ - { text: 'Data Model and Terminology', link: 'Data-Model-and-Terminology' }, + { + text: 'Data Model and Terminology', + link: 'Data-Model-and-Terminology', + }, { text: 'Schema Template', link: 'Schema-Template' }, { text: 'Data Type', link: 'Data-Type' }, { text: 'Deadband Process', link: 'Deadband-Process' }, @@ -73,7 +75,10 @@ export const enSidebar = { { text: 'Key-Value Pair', link: 'KeyValue-Pair' }, { text: 'Keywords', link: 'Keywords-And-Reserved-Words' }, { text: 'Session And TsFile API', link: 'Session-And-TsFile-API' }, - { text: 'Detailed Definitions of Lexical and Grammar', link: 'Detailed-Grammar' }, + { + text: 'Detailed Definitions of Lexical and Grammar', + link: 'Detailed-Grammar', + }, ], }, { @@ -199,9 +204,7 @@ export const enSidebar = { text: 'Administration Management', collapsible: true, prefix: 'Administration-Management/', - children: [ - { text: 'Administration', link: 'Administration' }, - ], + children: [{ text: 'Administration', link: 'Administration' }], }, { text: 'Maintenance Tools', @@ -212,9 +215,15 @@ export const enSidebar = { { text: 'Log Tool', link: 'Log-Tool' }, { text: 'JMX Tool', link: 'JMX-Tool' }, { text: 'MLogParser Tool', link: 'MLogParser-Tool' }, - { text: 'IoTDB Data Directory Overview Tool', link: 'IoTDB-Data-Dir-Overview-Tool' }, + { + text: 'IoTDB Data Directory Overview Tool', + link: 'IoTDB-Data-Dir-Overview-Tool', + }, { text: 'TsFile Sketch Tool', link: 'TsFile-Sketch-Tool' }, - { text: 'TsFile Resource Sketch Tool', link: 'TsFile-Resource-Sketch-Tool' }, + { + text: 'TsFile Resource Sketch Tool', + link: 'TsFile-Resource-Sketch-Tool', + }, { text: 'TsFile Split Tool', link: 'TsFile-Split-Tool' }, { text: 'TsFile Load Export Tool', link: 'TsFile-Load-Export-Tool' }, { text: 'CSV Load Export Tool', link: 'CSV-Tool' }, @@ -224,9 +233,7 @@ export const enSidebar = { text: 'Collaboration of Edge and Cloud', collapsible: true, prefix: 'Edge-Cloud-Collaboration/', - children: [ - { text: 'TsFile Sync Tool', link: 'Sync-Tool' }, - ], + children: [{ text: 'TsFile Sync Tool', link: 'Sync-Tool' }], }, { text: 'Ecosystem Integration', @@ -234,7 +241,10 @@ export const enSidebar = { prefix: 'Ecosystem-Integration/', children: [ { text: 'Grafana-Plugin', link: 'Grafana-Plugin' }, - { text: 'Grafana-Connector (Not Recommended)', link: 'Grafana-Connector' }, + { + text: 'Grafana-Connector (Not Recommended)', + link: 'Grafana-Connector', + }, { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, { text: 'DBeaver-IoTDB', link: 'DBeaver' }, { text: 'MapReduce-TsFile', link: 'MapReduce-TsFile' }, @@ -254,7 +264,10 @@ export const enSidebar = { { text: 'Cluster Concept', link: 'Cluster-Concept' }, { text: 'Cluster Setup', link: 'Cluster-Setup' }, { text: 'Cluster Maintenance', link: 'Cluster-Maintenance' }, - { text: 'Deployment Recommendation', link: 'Deployment-Recommendation' }, + { + text: 'Deployment Recommendation', + link: 'Deployment-Recommendation', + }, ], }, { @@ -262,7 +275,10 @@ export const enSidebar = { collapsible: true, prefix: 'FAQ/', children: [ - { text: 'Frequently asked questions', link: 'Frequently-asked-questions' }, + { + text: 'Frequently asked questions', + link: 'Frequently-asked-questions', + }, { text: 'FAQ for cluster setup', link: 'FAQ-for-cluster-setup' }, ], }, diff --git a/src/.vuepress/sidebar/V1.0.x/zh.ts b/src/.vuepress/sidebar/V1.0.x/zh.ts index 73cb9a13..0d0cee18 100644 --- a/src/.vuepress/sidebar/V1.0.x/zh.ts +++ b/src/.vuepress/sidebar/V1.0.x/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -200,9 +199,7 @@ export const zhSidebar = { text: '权限管理', collapsible: true, prefix: 'Administration-Management/', - children: [ - { text: '权限管理', link: 'Administration' }, - ], + children: [{ text: '权限管理', link: 'Administration' }], }, { text: '运维工具', @@ -213,9 +210,15 @@ export const zhSidebar = { { text: '日志工具', link: 'Log-Tool' }, { text: 'JMX 工具', link: 'JMX-Tool' }, { text: 'Mlog解析工具', link: 'MLogParser-Tool' }, - { text: 'IoTDB数据文件夹概览工具', link: 'IoTDB-Data-Dir-Overview-Tool' }, + { + text: 'IoTDB数据文件夹概览工具', + link: 'IoTDB-Data-Dir-Overview-Tool', + }, { text: 'TsFile概览工具', link: 'TsFile-Sketch-Tool' }, - { text: 'TsFile Resource概览工具', link: 'TsFile-Resource-Sketch-Tool' }, + { + text: 'TsFile Resource概览工具', + link: 'TsFile-Resource-Sketch-Tool', + }, { text: 'TsFile 拆分工具', link: 'TsFile-Split-Tool' }, { text: 'TsFile 导入导出工具', link: 'TsFile-Load-Export-Tool' }, { text: 'CSV 导入导出工具', link: 'CSV-Tool' }, @@ -225,9 +228,7 @@ export const zhSidebar = { text: '端云协同', collapsible: true, prefix: 'Edge-Cloud-Collaboration/', - children: [ - { text: 'TsFile 同步工具', link: 'Sync-Tool' }, - ], + children: [{ text: 'TsFile 同步工具', link: 'Sync-Tool' }], }, { text: '系统集成', diff --git a/src/.vuepress/sidebar/V1.1.x/en.ts b/src/.vuepress/sidebar/V1.1.x/en.ts index 92f032ec..b4f541fe 100644 --- a/src/.vuepress/sidebar/V1.1.x/en.ts +++ b/src/.vuepress/sidebar/V1.1.x/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -55,7 +54,10 @@ export const enSidebar = { prefix: 'Data-Concept/', // children: 'structure', children: [ - { text: 'Data Model and Terminology', link: 'Data-Model-and-Terminology' }, + { + text: 'Data Model and Terminology', + link: 'Data-Model-and-Terminology', + }, { text: 'Schema Template', link: 'Schema-Template' }, { text: 'Data Type', link: 'Data-Type' }, { text: 'Deadband Process', link: 'Deadband-Process' }, @@ -77,7 +79,10 @@ export const enSidebar = { { text: 'Key-Value Pair', link: 'KeyValue-Pair' }, { text: 'Keywords', link: 'Keywords-And-Reserved-Words' }, { text: 'Session And TsFile API', link: 'Session-And-TsFile-API' }, - { text: 'Detailed Definitions of Lexical and Grammar', link: 'Detailed-Grammar' }, + { + text: 'Detailed Definitions of Lexical and Grammar', + link: 'Detailed-Grammar', + }, ], }, { @@ -215,9 +220,7 @@ export const enSidebar = { collapsible: true, prefix: 'Administration-Management/', // children: 'structure', - children: [ - { text: 'Administration', link: 'Administration' }, - ], + children: [{ text: 'Administration', link: 'Administration' }], }, { text: 'Maintenance Tools', @@ -229,9 +232,15 @@ export const enSidebar = { { text: 'Log Tool', link: 'Log-Tool' }, { text: 'JMX Tool', link: 'JMX-Tool' }, { text: 'MLogParser Tool', link: 'MLogParser-Tool' }, - { text: 'Data Directory Overview Tool', link: 'IoTDB-Data-Dir-Overview-Tool' }, + { + text: 'Data Directory Overview Tool', + link: 'IoTDB-Data-Dir-Overview-Tool', + }, { text: 'TsFile Sketch Tool', link: 'TsFile-Sketch-Tool' }, - { text: 'TsFile Resource Sketch Tool', link: 'TsFile-Resource-Sketch-Tool' }, + { + text: 'TsFile Resource Sketch Tool', + link: 'TsFile-Resource-Sketch-Tool', + }, { text: 'TsFile Split Tool', link: 'TsFile-Split-Tool' }, { text: 'TsFile Load Export Tool', link: 'TsFile-Load-Export-Tool' }, { text: 'CSV Load Export Tool', link: 'CSV-Tool' }, @@ -242,9 +251,7 @@ export const enSidebar = { collapsible: true, prefix: 'Edge-Cloud-Collaboration/', // children: 'structure', - children: [ - { text: 'TsFile Sync Tool', link: 'Sync-Tool' }, - ], + children: [{ text: 'TsFile Sync Tool', link: 'Sync-Tool' }], }, { text: 'Ecosystem Integration', @@ -253,7 +260,10 @@ export const enSidebar = { // children: 'structure', children: [ { text: 'Grafana-Plugin', link: 'Grafana-Plugin' }, - { text: 'Grafana-Connector (Not Recommended)', link: 'Grafana-Connector' }, + { + text: 'Grafana-Connector (Not Recommended)', + link: 'Grafana-Connector', + }, { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, { text: 'DBeaver-IoTDB', link: 'DBeaver' }, { text: 'MapReduce-TsFile', link: 'MapReduce-TsFile' }, @@ -274,7 +284,10 @@ export const enSidebar = { { text: 'Cluster Concept', link: 'Cluster-Concept' }, { text: 'Cluster Setup', link: 'Cluster-Setup' }, { text: 'Cluster Maintenance', link: 'Cluster-Maintenance' }, - { text: 'Deployment Recommendation', link: 'Deployment-Recommendation' }, + { + text: 'Deployment Recommendation', + link: 'Deployment-Recommendation', + }, ], }, { @@ -283,7 +296,10 @@ export const enSidebar = { prefix: 'FAQ/', // children: 'structure', children: [ - { text: 'Frequently asked questions', link: 'Frequently-asked-questions' }, + { + text: 'Frequently asked questions', + link: 'Frequently-asked-questions', + }, { text: 'FAQ for cluster setup', link: 'FAQ-for-cluster-setup' }, ], }, diff --git a/src/.vuepress/sidebar/V1.1.x/zh.ts b/src/.vuepress/sidebar/V1.1.x/zh.ts index fd8dc4ac..1bd14aca 100644 --- a/src/.vuepress/sidebar/V1.1.x/zh.ts +++ b/src/.vuepress/sidebar/V1.1.x/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -216,9 +215,7 @@ export const zhSidebar = { collapsible: true, prefix: 'Administration-Management/', // children: 'structure', - children: [ - { text: '权限管理', link: 'Administration' }, - ], + children: [{ text: '权限管理', link: 'Administration' }], }, { text: '运维工具', @@ -230,9 +227,15 @@ export const zhSidebar = { { text: '日志工具', link: 'Log-Tool' }, { text: 'JMX 工具', link: 'JMX-Tool' }, { text: 'Mlog解析工具', link: 'MLogParser-Tool' }, - { text: 'IoTDB数据文件夹概览工具', link: 'IoTDB-Data-Dir-Overview-Tool' }, + { + text: 'IoTDB数据文件夹概览工具', + link: 'IoTDB-Data-Dir-Overview-Tool', + }, { text: 'TsFile概览工具', link: 'TsFile-Sketch-Tool' }, - { text: 'TsFile Resource概览工具', link: 'TsFile-Resource-Sketch-Tool' }, + { + text: 'TsFile Resource概览工具', + link: 'TsFile-Resource-Sketch-Tool', + }, { text: 'TsFile 拆分工具', link: 'TsFile-Split-Tool' }, { text: 'TsFile 导入导出工具', link: 'TsFile-Load-Export-Tool' }, { text: 'CSV 导入导出工具', link: 'CSV-Tool' }, @@ -244,9 +247,7 @@ export const zhSidebar = { collapsible: true, prefix: 'Edge-Cloud-Collaboration/', // children: 'structure', - children: [ - { text: 'TsFile 同步工具', link: 'Sync-Tool' }, - ], + children: [{ text: 'TsFile 同步工具', link: 'Sync-Tool' }], }, { text: '系统集成', diff --git a/src/.vuepress/sidebar/V1.2.x/en.ts b/src/.vuepress/sidebar/V1.2.x/en.ts index 2ecb9fff..e42f05d3 100644 --- a/src/.vuepress/sidebar/V1.2.x/en.ts +++ b/src/.vuepress/sidebar/V1.2.x/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -57,7 +56,10 @@ export const enSidebar = { { text: 'Data Model', link: 'Data-Model-and-Terminology' }, { text: 'Data Type', link: 'Data-Type' }, { text: 'Encoding and Compression', link: 'Encoding-and-Compression' }, - { text: 'Data Partitioning & Load Balancing', link: 'Cluster-data-partitioning' }, + { + text: 'Data Partitioning & Load Balancing', + link: 'Cluster-data-partitioning', + }, ], }, { @@ -66,11 +68,17 @@ export const enSidebar = { prefix: 'Deployment-and-Maintenance/', // children: 'structure', children: [ - { text: 'Environmental Requirement', link: 'Environmental-Requirement' }, + { + text: 'Environmental Requirement', + link: 'Environmental-Requirement', + }, { text: 'Resource Recommendation', link: 'Deployment-Recommendation' }, { text: 'Deployment Guide', link: 'Deployment-Guide' }, { text: 'Docker Install', link: 'Docker-Install' }, - { text: 'Monitoring Board Install and Deploy', link: 'Monitoring-Board-Install-and-Deploy' }, + { + text: 'Monitoring Board Install and Deploy', + link: 'Monitoring-Board-Install-and-Deploy', + }, ], }, @@ -150,9 +158,7 @@ export const enSidebar = { collapsible: true, prefix: 'SQL-Manual/', // children: 'structure', - children: [ - { text: 'SQL Manual', link: 'SQL-Manual' }, - ], + children: [{ text: 'SQL Manual', link: 'SQL-Manual' }], }, { text: 'FAQ', @@ -160,7 +166,11 @@ export const enSidebar = { prefix: 'FAQ/', // children: 'structure', children: [ - { text: 'Frequently Asked Questions', link: 'Frequently-asked-questions' }], + { + text: 'Frequently Asked Questions', + link: 'Frequently-asked-questions', + }, + ], }, { text: 'Reference', diff --git a/src/.vuepress/sidebar/V1.2.x/zh.ts b/src/.vuepress/sidebar/V1.2.x/zh.ts index 633dfcb7..e7329a8a 100644 --- a/src/.vuepress/sidebar/V1.2.x/zh.ts +++ b/src/.vuepress/sidebar/V1.2.x/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -149,17 +148,14 @@ export const zhSidebar = { collapsible: true, prefix: 'SQL-Manual/', // children: 'structure', - children: [ - { text: 'SQL手册', link: 'SQL-Manual' }, - ], + children: [{ text: 'SQL手册', link: 'SQL-Manual' }], }, { text: 'FAQ', collapsible: true, prefix: 'FAQ/', // children: 'structure', - children: [ - { text: '常见问题', link: 'Frequently-asked-questions' }], + children: [{ text: '常见问题', link: 'Frequently-asked-questions' }], }, { text: '参考', diff --git a/src/.vuepress/sidebar/V1.3.0-2/en.ts b/src/.vuepress/sidebar/V1.3.0-2/en.ts index 290e3d67..0bc5f4f6 100644 --- a/src/.vuepress/sidebar/V1.3.0-2/en.ts +++ b/src/.vuepress/sidebar/V1.3.0-2/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -47,12 +46,18 @@ export const enSidebar = { prefix: 'Basic-Concept/', // children: 'structure', children: [ - { text: 'Navigating Time Series Data', link: 'Navigating_Time_Series_Data' }, + { + text: 'Navigating Time Series Data', + link: 'Navigating_Time_Series_Data', + }, { text: 'Data Model', link: 'Data-Model-and-Terminology' }, { text: 'Data Type', link: 'Data-Type' }, { text: 'Encoding and Compression', link: 'Encoding-and-Compression' }, { text: 'Cluster-related Concepts', link: 'Cluster-Concept' }, - { text: 'Data Partitioning & Load Balancing', link: 'Cluster-data-partitioning' }, + { + text: 'Data Partitioning & Load Balancing', + link: 'Cluster-data-partitioning', + }, ], }, { @@ -64,7 +69,10 @@ export const enSidebar = { { text: 'Obtain IoTDB', link: 'IoTDB-Package_apache' }, { text: 'Database Resources', link: 'Database-Resources' }, { text: 'System Requirements', link: 'Environment-Requirements' }, - { text: 'Stand-Alone Deployment', link: 'Stand-Alone-Deployment_apache' }, + { + text: 'Stand-Alone Deployment', + link: 'Stand-Alone-Deployment_apache', + }, { text: 'Cluster Deployment', link: 'Cluster-Deployment_apache' }, { text: 'Docker Deployment', link: 'Docker-Deployment_apache' }, ], @@ -100,7 +108,10 @@ export const enSidebar = { { text: 'Benchmark Tool', link: 'Benchmark' }, { text: 'Maintenance Tool', link: 'Maintenance-Tool_apache' }, { text: 'Data Import Export Script', link: 'Data-Import-Export-Tool' }, - { text: 'TsFile Import Export Script', link: 'TsFile-Import-Export-Tool' }, + { + text: 'TsFile Import Export Script', + link: 'TsFile-Import-Export-Tool', + }, ], }, { @@ -147,9 +158,7 @@ export const enSidebar = { collapsible: true, prefix: 'SQL-Manual/', // children: 'structure', - children: [ - { text: 'SQL Manual', link: 'SQL-Manual' }, - ], + children: [{ text: 'SQL Manual', link: 'SQL-Manual' }], }, { text: 'FAQ', @@ -157,7 +166,11 @@ export const enSidebar = { prefix: 'FAQ/', // children: 'structure', children: [ - { text: 'Frequently Asked Questions', link: 'Frequently-asked-questions' }], + { + text: 'Frequently Asked Questions', + link: 'Frequently-asked-questions', + }, + ], }, { text: 'Reference', diff --git a/src/.vuepress/sidebar/V1.3.0-2/zh.ts b/src/.vuepress/sidebar/V1.3.0-2/zh.ts index f92c21ab..33214954 100644 --- a/src/.vuepress/sidebar/V1.3.0-2/zh.ts +++ b/src/.vuepress/sidebar/V1.3.0-2/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -147,17 +146,14 @@ export const zhSidebar = { collapsible: true, prefix: 'SQL-Manual/', // children: 'structure', - children: [ - { text: 'SQL手册', link: 'SQL-Manual' }, - ], + children: [{ text: 'SQL手册', link: 'SQL-Manual' }], }, { text: 'FAQ', collapsible: true, prefix: 'FAQ/', // children: 'structure', - children: [ - { text: '常见问题', link: 'Frequently-asked-questions' }], + children: [{ text: '常见问题', link: 'Frequently-asked-questions' }], }, { text: '参考', diff --git a/src/.vuepress/sidebar/V1.3.3/en.ts b/src/.vuepress/sidebar/V1.3.3/en.ts index e9b0ee76..9930cae5 100644 --- a/src/.vuepress/sidebar/V1.3.3/en.ts +++ b/src/.vuepress/sidebar/V1.3.3/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -55,7 +54,10 @@ export const enSidebar = { { text: 'Obtain IoTDB', link: 'IoTDB-Package_apache' }, { text: 'Database Resources', link: 'Database-Resources' }, { text: 'System Requirements', link: 'Environment-Requirements' }, - { text: 'Stand-Alone Deployment', link: 'Stand-Alone-Deployment_apache' }, + { + text: 'Stand-Alone Deployment', + link: 'Stand-Alone-Deployment_apache', + }, { text: 'Cluster Deployment', link: 'Cluster-Deployment_apache' }, { text: 'Docker Deployment', link: 'Docker-Deployment_apache' }, ], @@ -70,12 +72,21 @@ export const enSidebar = { text: 'Data Modeling', collapsible: true, children: [ - { text: 'Timeseries Data Model', link: 'Navigating_Time_Series_Data' }, - { text: 'Modeling Scheme Design', link: 'Data-Model-and-Terminology' }, - { text: 'Measurement Point Management', link: 'Operate-Metadata_apache' }, + { + text: 'Timeseries Data Model', + link: 'Navigating_Time_Series_Data', + }, + { + text: 'Modeling Scheme Design', + link: 'Data-Model-and-Terminology', + }, + { + text: 'Measurement Point Management', + link: 'Operate-Metadata_apache', + }, ], }, - { text: 'Write & Delete', link: 'Write-Delete-Data' }, + { text: 'Write & Delete', link: 'Write-Delete-Data' }, { text: 'Query Data', link: 'Query-Data' }, ], }, @@ -100,7 +111,7 @@ export const enSidebar = { text: 'Database Programming', collapsible: true, children: [ - { text: 'UDF Development', link: 'UDF-development' }, + { text: 'UDF Development', link: 'UDF-development' }, { text: 'Trigger', link: 'Trigger' }, { text: 'Stream Processing', link: 'Streaming_apache' }, ], @@ -117,7 +128,7 @@ export const enSidebar = { { text: 'Command Line Interface (CLI)', link: 'CLI' }, { text: 'Monitor Tool', link: 'Monitor-Tool_apache' }, { text: 'Benchmark Tool', link: 'Benchmark' }, - { text: 'Cluster Management Tool', link: 'Maintenance-Tool_apache' }, + { text: 'Cluster Management Tool', link: 'Maintenance-Tool_apache' }, { text: 'Data Import', link: 'Data-Import-Tool' }, { text: 'Data Export', link: 'Data-Export-Tool' }, ], @@ -142,7 +153,7 @@ export const enSidebar = { text: 'REST API', collapsible: true, children: [ - { text: 'V1 (Not Recommend)', link: 'RestServiceV1' }, + { text: 'V1 (Not Recommend)', link: 'RestServiceV1' }, { text: 'V2', link: 'RestServiceV2' }, ], }, @@ -179,8 +190,14 @@ export const enSidebar = { collapsible: true, children: [ { text: 'UDF Libraries', link: 'UDF-Libraries_apache' }, - { text: 'Operator and Expression', link: 'Operator-and-Expression' }, - { text: 'Function and Expression', link: 'Function-and-Expression' }, + { + text: 'Operator and Expression', + link: 'Operator-and-Expression', + }, + { + text: 'Function and Expression', + link: 'Function-and-Expression', + }, ], }, ], @@ -193,7 +210,10 @@ export const enSidebar = { children: [ { text: 'Research Paper ', link: 'Publication' }, { text: 'Compression & Encoding', link: 'Encoding-and-Compression' }, - { text: 'Data Partitioning & Load Balancing', link: 'Cluster-data-partitioning' }, + { + text: 'Data Partitioning & Load Balancing', + link: 'Cluster-data-partitioning', + }, ], }, { @@ -207,7 +227,10 @@ export const enSidebar = { collapsible: true, children: [ { text: 'Common Config Manual', link: 'Common-Config-Manual' }, - { text: 'ConfigNode Config Manual', link: 'ConfigNode-Config-Manual' }, + { + text: 'ConfigNode Config Manual', + link: 'ConfigNode-Config-Manual', + }, { text: 'DataNode Config Manual', link: 'DataNode-Config-Manual' }, ], }, @@ -216,7 +239,7 @@ export const enSidebar = { collapsible: true, children: [ { text: 'Identifiers', link: 'Syntax-Rule' }, - { text: 'Keywords', link: 'Keywords' }, + { text: 'Keywords', link: 'Keywords' }, ], }, { text: 'Status Codes', link: 'Status-Codes' }, @@ -228,7 +251,11 @@ export const enSidebar = { prefix: 'FAQ/', // children: 'structure', children: [ - { text: 'Frequently Asked Questions', link: 'Frequently-asked-questions' }], + { + text: 'Frequently Asked Questions', + link: 'Frequently-asked-questions', + }, + ], }, ], }; diff --git a/src/.vuepress/sidebar/V1.3.3/zh.ts b/src/.vuepress/sidebar/V1.3.3/zh.ts index 63557c09..e268ced6 100644 --- a/src/.vuepress/sidebar/V1.3.3/zh.ts +++ b/src/.vuepress/sidebar/V1.3.3/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -70,12 +69,12 @@ export const zhSidebar = { text: '数据建模', collapsible: true, children: [ - { text: '时序数据模型', link: 'Navigating_Time_Series_Data' }, + { text: '时序数据模型', link: 'Navigating_Time_Series_Data' }, { text: '建模方案设计', link: 'Data-Model-and-Terminology' }, { text: '测点管理', link: 'Operate-Metadata_apache' }, ], }, - { text: '写入&删除', link: 'Write-Delete-Data' }, + { text: '写入&删除', link: 'Write-Delete-Data' }, { text: '数据查询', link: 'Query-Data' }, ], }, @@ -90,9 +89,7 @@ export const zhSidebar = { { text: '安全管理', collapsible: true, - children: [ - { text: '权限管理', link: 'Authority-Management' }, - ], + children: [{ text: '权限管理', link: 'Authority-Management' }], }, { text: '用户自定义函数', link: 'User-defined-function_apache' }, { text: '连续查询', link: 'Database-Programming' }, @@ -100,12 +97,12 @@ export const zhSidebar = { text: '数据库编程', collapsible: true, children: [ - { text: 'UDF开发', link: 'UDF-development' }, + { text: 'UDF开发', link: 'UDF-development' }, { text: '触发器', link: 'Trigger' }, { text: '流处理框架', link: 'Streaming_apache' }, ], }, - { text: '运维语句', link: 'Maintennance'}, + { text: '运维语句', link: 'Maintennance' }, ], }, { @@ -142,7 +139,7 @@ export const zhSidebar = { text: 'REST API', collapsible: true, children: [ - { text: 'V1 (不推荐)', link: 'RestServiceV1' }, + { text: 'V1 (不推荐)', link: 'RestServiceV1' }, { text: 'V2', link: 'RestServiceV2' }, ], }, @@ -179,8 +176,8 @@ export const zhSidebar = { collapsible: true, children: [ { text: 'UDF函数库', link: 'UDF-Libraries_apache' }, - { text: '函数与运算符', link: 'Operator-and-Expression' }, - { text: '内置函数与表达式', link: 'Function-and-Expression' }, + { text: '函数与运算符', link: 'Operator-and-Expression' }, + { text: '内置函数与表达式', link: 'Function-and-Expression' }, ], }, ], @@ -216,7 +213,7 @@ export const zhSidebar = { collapsible: true, children: [ { text: '标识符', link: 'Syntax-Rule' }, - { text: '关键字', link: 'Keywords' }, + { text: '关键字', link: 'Keywords' }, ], }, { text: '状态码', link: 'Status-Codes' }, @@ -227,8 +224,7 @@ export const zhSidebar = { collapsible: true, prefix: 'FAQ/', // children: 'structure', - children: [ - { text: '常见问题', link: 'Frequently-asked-questions' }], + children: [{ text: '常见问题', link: 'Frequently-asked-questions' }], }, ], }; diff --git a/src/.vuepress/sidebar/en.ts b/src/.vuepress/sidebar/en.ts index 9f65f97f..904ab9cf 100644 --- a/src/.vuepress/sidebar/en.ts +++ b/src/.vuepress/sidebar/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ import { sidebar } from 'vuepress-theme-hope'; diff --git a/src/.vuepress/sidebar/index.ts b/src/.vuepress/sidebar/index.ts index 4493c7eb..3e7096aa 100644 --- a/src/.vuepress/sidebar/index.ts +++ b/src/.vuepress/sidebar/index.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export * from './en.js'; diff --git a/src/.vuepress/sidebar/zh.ts b/src/.vuepress/sidebar/zh.ts index 5d0cf0d7..2ef360f5 100644 --- a/src/.vuepress/sidebar/zh.ts +++ b/src/.vuepress/sidebar/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ import { sidebar } from 'vuepress-theme-hope'; diff --git a/src/.vuepress/sidebar_timecho/V0.13.x/en.ts b/src/.vuepress/sidebar_timecho/V0.13.x/en.ts index 8eb2577f..e8b42ca6 100644 --- a/src/.vuepress/sidebar_timecho/V0.13.x/en.ts +++ b/src/.vuepress/sidebar_timecho/V0.13.x/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -52,7 +51,10 @@ export const enSidebar = { collapsible: true, prefix: 'Data-Concept/', children: [ - { text: 'Data Model and Terminology', link: 'Data-Model-and-Terminology' }, + { + text: 'Data Model and Terminology', + link: 'Data-Model-and-Terminology', + }, { text: 'Schema Template', link: 'Schema-Template' }, { text: 'Data Type', link: 'Data-Type' }, { text: 'Deadband Process', link: 'Deadband-Process' }, @@ -66,9 +68,7 @@ export const enSidebar = { text: 'Syntax Conventions', collapsible: true, prefix: 'Reference/', - children: [ - { text: 'Syntax Conventions', link: 'Syntax-Conventions' }, - ], + children: [{ text: 'Syntax Conventions', link: 'Syntax-Conventions' }], }, { text: 'API', @@ -132,7 +132,10 @@ export const enSidebar = { collapsible: true, prefix: 'Process-Data/', children: [ - { text: 'UDF (User Defined Function)', link: 'UDF-User-Defined-Function' }, + { + text: 'UDF (User Defined Function)', + link: 'UDF-User-Defined-Function', + }, { text: 'Seletct Into', link: 'Select-Into' }, { text: 'Continuous Query', link: 'Continuous-Query' }, { text: 'Triggers', link: 'Triggers' }, @@ -143,9 +146,7 @@ export const enSidebar = { text: 'Administration', collapsible: true, prefix: 'Administration-Management/', - children: [ - { text: 'Administration', link: 'Administration' }, - ], + children: [{ text: 'Administration', link: 'Administration' }], }, { text: 'Maintenance Tools', @@ -171,7 +172,10 @@ export const enSidebar = { prefix: 'Ecosystem-Integration/', children: [ { text: 'Grafana Plugin', link: 'Grafana-Plugin' }, - { text: 'Grafana Connector (Not Recommended)', link: 'Grafana-Connector' }, + { + text: 'Grafana Connector (Not Recommended)', + link: 'Grafana-Connector', + }, { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, { text: 'DBeaver-IoTDB', link: 'DBeaver' }, { text: 'MapReduce TsFile', link: 'MapReduce-TsFile' }, @@ -207,7 +211,10 @@ export const enSidebar = { children: [ { text: 'Config Manual', link: 'Config-Manual' }, { text: 'Keywords', link: 'Keywords' }, - { text: 'Frequently asked questions', link: 'Frequently-asked-questions' }, + { + text: 'Frequently asked questions', + link: 'Frequently-asked-questions', + }, { text: 'TSDB Comparison', link: 'TSDB-Comparison' }, ], }, diff --git a/src/.vuepress/sidebar_timecho/V0.13.x/zh.ts b/src/.vuepress/sidebar_timecho/V0.13.x/zh.ts index 343e2a08..baa7a507 100644 --- a/src/.vuepress/sidebar_timecho/V0.13.x/zh.ts +++ b/src/.vuepress/sidebar_timecho/V0.13.x/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -31,8 +30,8 @@ export const zhSidebar = { children: [ { text: 'IoTDB简介', link: 'What-is-IoTDB' }, { text: '主要功能特点', link: 'Features' }, - // { text: '系统架构', link: 'Architecture' }, - // { text: '应用场景', link: 'Scenario' }, + // { text: '系统架构', link: 'Architecture' }, + // { text: '应用场景', link: 'Scenario' }, { text: '研究论文', link: 'Publication' }, ], }, @@ -66,9 +65,7 @@ export const zhSidebar = { text: '语法约定', collapsible: true, prefix: 'Reference/', - children: [ - { text: '语法约定', link: 'Syntax-Conventions' }, - ], + children: [{ text: '语法约定', link: 'Syntax-Conventions' }], }, { text: '应用编程接口', @@ -143,17 +140,13 @@ export const zhSidebar = { text: '权限管理', collapsible: true, prefix: 'Administration-Management/', - children: [ - { text: '权限管理', link: 'Administration' }, - ], + children: [{ text: '权限管理', link: 'Administration' }], }, { text: '双活版本', collapsible: true, prefix: 'Active-Active/', - children: [ - { text: '双活', link: 'Active-Active' }, - ], + children: [{ text: '双活', link: 'Active-Active' }], }, { text: '运维工具', diff --git a/src/.vuepress/sidebar_timecho/V1.0.x/en.ts b/src/.vuepress/sidebar_timecho/V1.0.x/en.ts index 4f946b82..58c4067c 100644 --- a/src/.vuepress/sidebar_timecho/V1.0.x/en.ts +++ b/src/.vuepress/sidebar_timecho/V1.0.x/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -52,7 +51,10 @@ export const enSidebar = { collapsible: true, prefix: 'Data-Concept/', children: [ - { text: 'Data Model and Terminology', link: 'Data-Model-and-Terminology' }, + { + text: 'Data Model and Terminology', + link: 'Data-Model-and-Terminology', + }, { text: 'Schema Template', link: 'Schema-Template' }, { text: 'Data Type', link: 'Data-Type' }, { text: 'Deadband Process', link: 'Deadband-Process' }, @@ -73,7 +75,10 @@ export const enSidebar = { { text: 'Key-Value Pair', link: 'KeyValue-Pair' }, { text: 'Keywords', link: 'Keywords-And-Reserved-Words' }, { text: 'Session And TsFile API', link: 'Session-And-TsFile-API' }, - { text: 'Detailed Definitions of Lexical and Grammar', link: 'Detailed-Grammar' }, + { + text: 'Detailed Definitions of Lexical and Grammar', + link: 'Detailed-Grammar', + }, ], }, { @@ -200,9 +205,7 @@ export const enSidebar = { text: 'Administration Management', collapsible: true, prefix: 'Administration-Management/', - children: [ - { text: 'Administration', link: 'Administration' }, - ], + children: [{ text: 'Administration', link: 'Administration' }], }, { text: 'Maintenance Tools', @@ -213,9 +216,15 @@ export const enSidebar = { { text: 'Log Tool', link: 'Log-Tool' }, { text: 'JMX Tool', link: 'JMX-Tool' }, { text: 'MLogParser Tool', link: 'MLogParser-Tool' }, - { text: 'IoTDB Data Directory Overview Tool', link: 'IoTDB-Data-Dir-Overview-Tool' }, + { + text: 'IoTDB Data Directory Overview Tool', + link: 'IoTDB-Data-Dir-Overview-Tool', + }, { text: 'TsFile Sketch Tool', link: 'TsFile-Sketch-Tool' }, - { text: 'TsFile Resource Sketch Tool', link: 'TsFile-Resource-Sketch-Tool' }, + { + text: 'TsFile Resource Sketch Tool', + link: 'TsFile-Resource-Sketch-Tool', + }, { text: 'TsFile Split Tool', link: 'TsFile-Split-Tool' }, { text: 'TsFile Load Export Tool', link: 'TsFile-Load-Export-Tool' }, { text: 'CSV Load Export Tool', link: 'CSV-Tool' }, @@ -225,9 +234,7 @@ export const enSidebar = { text: 'Collaboration of Edge and Cloud', collapsible: true, prefix: 'Edge-Cloud-Collaboration/', - children: [ - { text: 'TsFile Sync Tool', link: 'Sync-Tool' }, - ], + children: [{ text: 'TsFile Sync Tool', link: 'Sync-Tool' }], }, { text: 'Ecosystem Integration', @@ -235,7 +242,10 @@ export const enSidebar = { prefix: 'Ecosystem-Integration/', children: [ { text: 'Grafana-Plugin', link: 'Grafana-Plugin' }, - { text: 'Grafana-Connector (Not Recommended)', link: 'Grafana-Connector' }, + { + text: 'Grafana-Connector (Not Recommended)', + link: 'Grafana-Connector', + }, { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, { text: 'DBeaver-IoTDB', link: 'DBeaver' }, { text: 'MapReduce-TsFile', link: 'MapReduce-TsFile' }, @@ -255,7 +265,10 @@ export const enSidebar = { { text: 'Cluster Concept', link: 'Cluster-Concept' }, { text: 'Cluster Setup', link: 'Cluster-Setup' }, { text: 'Cluster Maintenance', link: 'Cluster-Maintenance' }, - { text: 'Deployment Recommendation', link: 'Deployment-Recommendation' }, + { + text: 'Deployment Recommendation', + link: 'Deployment-Recommendation', + }, ], }, { @@ -263,7 +276,10 @@ export const enSidebar = { collapsible: true, prefix: 'FAQ/', children: [ - { text: 'Frequently asked questions', link: 'Frequently-asked-questions' }, + { + text: 'Frequently asked questions', + link: 'Frequently-asked-questions', + }, { text: 'FAQ for cluster setup', link: 'FAQ-for-cluster-setup' }, ], }, diff --git a/src/.vuepress/sidebar_timecho/V1.0.x/zh.ts b/src/.vuepress/sidebar_timecho/V1.0.x/zh.ts index 4791a02e..823e559a 100644 --- a/src/.vuepress/sidebar_timecho/V1.0.x/zh.ts +++ b/src/.vuepress/sidebar_timecho/V1.0.x/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -31,7 +30,7 @@ export const zhSidebar = { children: [ { text: 'IoTDB简介', link: 'What-is-IoTDB' }, { text: '主要功能特点', link: 'Features' }, - // { text: '系统架构', link: 'Architecture' }, + // { text: '系统架构', link: 'Architecture' }, // { text: '应用场景', link: 'Scenario' }, { text: '研究论文', link: 'Publication' }, ], @@ -42,9 +41,9 @@ export const zhSidebar = { prefix: 'QuickStart/', children: [ { text: '快速上手', link: 'QuickStart' }, - // { text: '下载与安装', link: 'WayToGetIoTDB' }, -// { text: 'SQL命令行终端(CLI)', link: 'Command-Line-Interface' }, -// { text: '数据文件存储', link: 'Files' }, + // { text: '下载与安装', link: 'WayToGetIoTDB' }, + // { text: 'SQL命令行终端(CLI)', link: 'Command-Line-Interface' }, + // { text: '数据文件存储', link: 'Files' }, ], }, { @@ -64,12 +63,12 @@ export const zhSidebar = { prefix: 'Basic-Concept/', children: [ { text: '数据模型', link: 'Data-Model-and-Terminology' }, - // { text: '元数据模板', link: 'Schema-Template' }, + // { text: '元数据模板', link: 'Schema-Template' }, { text: '数据类型', link: 'Data-Type' }, - // { text: '死区处理', link: 'Deadband-Process' }, + // { text: '死区处理', link: 'Deadband-Process' }, { text: '编码和压缩', link: 'Encoding-and-Compression' }, - // { text: '数据的时间分区', link: 'Time-Partition' }, - // { text: '时区', link: 'Time-zone' }, + // { text: '数据的时间分区', link: 'Time-Partition' }, + // { text: '时区', link: 'Time-zone' }, ], }, { @@ -216,9 +215,15 @@ export const zhSidebar = { { text: '日志工具', link: 'Log-Tool' }, { text: 'JMX 工具', link: 'JMX-Tool' }, { text: 'Mlog解析工具', link: 'MLogParser-Tool' }, - { text: 'IoTDB数据文件夹概览工具', link: 'IoTDB-Data-Dir-Overview-Tool' }, + { + text: 'IoTDB数据文件夹概览工具', + link: 'IoTDB-Data-Dir-Overview-Tool', + }, { text: 'TsFile概览工具', link: 'TsFile-Sketch-Tool' }, - { text: 'TsFile Resource概览工具', link: 'TsFile-Resource-Sketch-Tool' }, + { + text: 'TsFile Resource概览工具', + link: 'TsFile-Resource-Sketch-Tool', + }, { text: 'TsFile 拆分工具', link: 'TsFile-Split-Tool' }, { text: 'TsFile 导入导出工具', link: 'TsFile-Load-Export-Tool' }, { text: 'CSV 导入导出工具', link: 'CSV-Tool' }, @@ -228,9 +233,7 @@ export const zhSidebar = { text: '端云协同', collapsible: true, prefix: 'Edge-Cloud-Collaboration/', - children: [ - { text: 'TsFile 同步工具', link: 'Sync-Tool' }, - ], + children: [{ text: 'TsFile 同步工具', link: 'Sync-Tool' }], }, { text: '系统集成', diff --git a/src/.vuepress/sidebar_timecho/V1.1.x/en.ts b/src/.vuepress/sidebar_timecho/V1.1.x/en.ts index 5a889dc3..0199ff11 100644 --- a/src/.vuepress/sidebar_timecho/V1.1.x/en.ts +++ b/src/.vuepress/sidebar_timecho/V1.1.x/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -55,7 +54,10 @@ export const enSidebar = { prefix: 'Data-Concept/', // children: 'structure', children: [ - { text: 'Data Model and Terminology', link: 'Data-Model-and-Terminology' }, + { + text: 'Data Model and Terminology', + link: 'Data-Model-and-Terminology', + }, { text: 'Schema Template', link: 'Schema-Template' }, { text: 'Data Type', link: 'Data-Type' }, { text: 'Deadband Process', link: 'Deadband-Process' }, @@ -215,9 +217,7 @@ export const enSidebar = { collapsible: true, prefix: 'Administration-Management/', // children: 'structure', - children: [ - { text: 'Administration', link: 'Administration' }, - ], + children: [{ text: 'Administration', link: 'Administration' }], }, { text: 'Maintenance Tools', @@ -229,9 +229,15 @@ export const enSidebar = { { text: 'Log Tool', link: 'Log-Tool' }, { text: 'JMX Tool', link: 'JMX-Tool' }, { text: 'MLogParser Tool', link: 'MLogParser-Tool' }, - { text: 'Data Directory Overview Tool', link: 'IoTDB-Data-Dir-Overview-Tool' }, + { + text: 'Data Directory Overview Tool', + link: 'IoTDB-Data-Dir-Overview-Tool', + }, { text: 'TsFile Sketch Tool', link: 'TsFile-Sketch-Tool' }, - { text: 'TsFile Resource Sketch Tool', link: 'TsFile-Resource-Sketch-Tool' }, + { + text: 'TsFile Resource Sketch Tool', + link: 'TsFile-Resource-Sketch-Tool', + }, { text: 'TsFile Split Tool', link: 'TsFile-Split-Tool' }, { text: 'TsFile Load Export Tool', link: 'TsFile-Load-Export-Tool' }, { text: 'CSV Load Export Tool', link: 'CSV-Tool' }, @@ -242,9 +248,7 @@ export const enSidebar = { collapsible: true, prefix: 'Edge-Cloud-Collaboration/', // children: 'structure', - children: [ - { text: 'TsFile Sync Tool', link: 'Sync-Tool' }, - ], + children: [{ text: 'TsFile Sync Tool', link: 'Sync-Tool' }], }, { text: 'Ecosystem Integration', @@ -253,7 +257,10 @@ export const enSidebar = { // children: 'structure', children: [ { text: 'Grafana-Plugin', link: 'Grafana-Plugin' }, - { text: 'Grafana-Connector (Not Recommended)', link: 'Grafana-Connector' }, + { + text: 'Grafana-Connector (Not Recommended)', + link: 'Grafana-Connector', + }, { text: 'Zeppelin-IoTDB', link: 'Zeppelin-IoTDB' }, { text: 'DBeaver-IoTDB', link: 'DBeaver' }, { text: 'MapReduce-TsFile', link: 'MapReduce-TsFile' }, @@ -274,7 +281,10 @@ export const enSidebar = { { text: 'Cluster Concept', link: 'Cluster-Concept' }, { text: 'Cluster Setup', link: 'Cluster-Setup' }, { text: 'Cluster Maintenance', link: 'Cluster-Maintenance' }, - { text: 'Deployment Recommendation', link: 'Deployment-Recommendation' }, + { + text: 'Deployment Recommendation', + link: 'Deployment-Recommendation', + }, ], }, { @@ -283,7 +293,10 @@ export const enSidebar = { prefix: 'FAQ/', // children: 'structure', children: [ - { text: 'Frequently asked questions', link: 'Frequently-asked-questions' }, + { + text: 'Frequently asked questions', + link: 'Frequently-asked-questions', + }, { text: 'FAQ for cluster setup', link: 'FAQ-for-cluster-setup' }, ], }, diff --git a/src/.vuepress/sidebar_timecho/V1.1.x/zh.ts b/src/.vuepress/sidebar_timecho/V1.1.x/zh.ts index 4485ba6f..52ec0f08 100644 --- a/src/.vuepress/sidebar_timecho/V1.1.x/zh.ts +++ b/src/.vuepress/sidebar_timecho/V1.1.x/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -44,10 +43,10 @@ export const zhSidebar = { children: [ { text: '单机版', link: 'QuickStart' }, { text: '集群版', link: 'ClusterQuickStart' }, -// { text: '下载与安装', link: 'WayToGetIoTDB' }, + // { text: '下载与安装', link: 'WayToGetIoTDB' }, { text: '常用SQL语句', link: 'General-SQL-Statements' }, -// { text: 'SQL命令行终端(CLI)', link: 'Command-Line-Interface' }, -// { text: '数据文件存储', link: 'Files' }, + // { text: 'SQL命令行终端(CLI)', link: 'Command-Line-Interface' }, + // { text: '数据文件存储', link: 'Files' }, ], }, { @@ -57,13 +56,13 @@ export const zhSidebar = { // children: 'structure', children: [ { text: '数据模型', link: 'Data-Model-and-Terminology' }, -// { text: '元数据模板', link: 'Schema-Template' }, + // { text: '元数据模板', link: 'Schema-Template' }, { text: '数据类型', link: 'Data-Type' }, -// { text: '死区处理', link: 'Deadband-Process' }, + // { text: '死区处理', link: 'Deadband-Process' }, { text: '编码和压缩', link: 'Encoding-and-Compression' }, -// { text: '压缩方式', link: 'Compression' }, -// { text: '数据的时间分区', link: 'Time-Partition' }, -// { text: '时区', link: 'Time-zone' }, + // { text: '压缩方式', link: 'Compression' }, + // { text: '数据的时间分区', link: 'Time-Partition' }, + // { text: '时区', link: 'Time-zone' }, ], }, { @@ -150,17 +149,14 @@ export const zhSidebar = { collapsible: true, prefix: 'SQL-Manual/', // children: 'structure', - children: [ - { text: 'SQL手册', link: 'SQL-Manual' }, - ], + children: [{ text: 'SQL手册', link: 'SQL-Manual' }], }, { text: 'FAQ', collapsible: true, prefix: 'FAQ/', // children: 'structure', - children: [ - { text: '常见问题', link: 'Frequently-asked-questions' }, ], + children: [{ text: '常见问题', link: 'Frequently-asked-questions' }], }, { text: '参考', diff --git a/src/.vuepress/sidebar_timecho/V1.2.x/en.ts b/src/.vuepress/sidebar_timecho/V1.2.x/en.ts index 891ed2d4..4c3d117b 100644 --- a/src/.vuepress/sidebar_timecho/V1.2.x/en.ts +++ b/src/.vuepress/sidebar_timecho/V1.2.x/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -57,7 +56,10 @@ export const enSidebar = { { text: 'Data Model', link: 'Data-Model-and-Terminology' }, { text: 'Data Type', link: 'Data-Type' }, { text: 'Encoding and Compression', link: 'Encoding-and-Compression' }, - { text: 'Data Partitioning & Load Balancing', link: 'Cluster-data-partitioning' }, + { + text: 'Data Partitioning & Load Balancing', + link: 'Cluster-data-partitioning', + }, ], }, { @@ -66,11 +68,17 @@ export const enSidebar = { prefix: 'Deployment-and-Maintenance/', // children: 'structure', children: [ - { text: 'Environmental Requirement', link: 'Environmental-Requirement' }, + { + text: 'Environmental Requirement', + link: 'Environmental-Requirement', + }, { text: 'Resource Recommendation', link: 'Deployment-Recommendation' }, { text: 'Deployment Guide', link: 'Deployment-Guide_timecho' }, { text: 'Docker Install', link: 'Docker-Install' }, - { text: 'Monitoring Board Install and Deploy', link: 'Monitoring-Board-Install-and-Deploy' }, + { + text: 'Monitoring Board Install and Deploy', + link: 'Monitoring-Board-Install-and-Deploy', + }, ], }, @@ -142,7 +150,7 @@ export const enSidebar = { { text: 'Apache Spark(IoTDB)', link: 'Spark-IoTDB' }, { text: 'Apache Hive(TsFile)', link: 'Hive-TsFile' }, { text: 'Apache Flink(IoTDB)', link: 'Flink-IoTDB' }, -// { text: 'Apache Flink(SQL)', link: 'Flink-SQL-IoTDB' }, + // { text: 'Apache Flink(SQL)', link: 'Flink-SQL-IoTDB' }, { text: 'Apache Flink(TsFile)', link: 'Flink-TsFile' }, { text: 'Apache NiFi', link: 'NiFi-IoTDB' }, { text: 'DBeaver', link: 'DBeaver' }, @@ -154,9 +162,7 @@ export const enSidebar = { collapsible: true, prefix: 'SQL-Manual/', // children: 'structure', - children: [ - { text: 'SQL Manual', link: 'SQL-Manual' }, - ], + children: [{ text: 'SQL Manual', link: 'SQL-Manual' }], }, { text: 'FAQ', @@ -164,7 +170,11 @@ export const enSidebar = { prefix: 'FAQ/', // children: 'structure', children: [ - { text: 'Frequently Asked Questions', link: 'Frequently-asked-questions' }], + { + text: 'Frequently Asked Questions', + link: 'Frequently-asked-questions', + }, + ], }, { text: 'Reference', diff --git a/src/.vuepress/sidebar_timecho/V1.2.x/zh.ts b/src/.vuepress/sidebar_timecho/V1.2.x/zh.ts index 28f6449a..09427fe4 100644 --- a/src/.vuepress/sidebar_timecho/V1.2.x/zh.ts +++ b/src/.vuepress/sidebar_timecho/V1.2.x/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -70,7 +69,10 @@ export const zhSidebar = { { text: '资源推荐', link: 'Deployment-Recommendation' }, { text: '部署指导', link: 'Deployment-Guide_timecho' }, { text: 'docker部署', link: 'Docker-Install' }, - { text: '监控面板安装部署', link: 'Monitoring-Board-Install-and-Deploy' }, + { + text: '监控面板安装部署', + link: 'Monitoring-Board-Install-and-Deploy', + }, ], }, @@ -142,7 +144,7 @@ export const zhSidebar = { { text: 'Apache Spark(IoTDB)', link: 'Spark-IoTDB' }, { text: 'Apache Hive(TsFile)', link: 'Hive-TsFile' }, { text: 'Apache Flink(IoTDB)', link: 'Flink-IoTDB' }, -// { text: 'Apache Flink(SQL)', link: 'Flink-SQL-IoTDB' }, + // { text: 'Apache Flink(SQL)', link: 'Flink-SQL-IoTDB' }, { text: 'Apache Flink(TsFile)', link: 'Flink-TsFile' }, { text: 'Apache NiFi', link: 'NiFi-IoTDB' }, { text: 'DBeaver', link: 'DBeaver' }, @@ -154,17 +156,14 @@ export const zhSidebar = { collapsible: true, prefix: 'SQL-Manual/', // children: 'structure', - children: [ - { text: 'SQL手册', link: 'SQL-Manual' }, - ], + children: [{ text: 'SQL手册', link: 'SQL-Manual' }], }, { text: 'FAQ', collapsible: true, prefix: 'FAQ/', // children: 'structure', - children: [ - { text: '常见问题', link: 'Frequently-asked-questions' }], + children: [{ text: '常见问题', link: 'Frequently-asked-questions' }], }, { text: '参考', diff --git a/src/.vuepress/sidebar_timecho/V1.3.0-2/en.ts b/src/.vuepress/sidebar_timecho/V1.3.0-2/en.ts index ea7a0847..b9c9b9ea 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.0-2/en.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.0-2/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -47,12 +46,18 @@ export const enSidebar = { prefix: 'Basic-Concept/', // children: 'structure', children: [ - { text: 'Navigating Time Series Data', link: 'Navigating_Time_Series_Data' }, + { + text: 'Navigating Time Series Data', + link: 'Navigating_Time_Series_Data', + }, { text: 'Data Model', link: 'Data-Model-and-Terminology' }, { text: 'Data Type', link: 'Data-Type' }, { text: 'Encoding and Compression', link: 'Encoding-and-Compression' }, { text: 'Cluster-related Concepts', link: 'Cluster-Concept' }, - { text: 'Data Partitioning & Load Balancing', link: 'Cluster-data-partitioning' }, + { + text: 'Data Partitioning & Load Balancing', + link: 'Cluster-data-partitioning', + }, ], }, { @@ -64,12 +69,21 @@ export const enSidebar = { { text: 'Obtain TimechoDB', link: 'IoTDB-Package_timecho' }, { text: 'Database Resources', link: 'Database-Resources' }, { text: 'System Requirements', link: 'Environment-Requirements' }, - { text: 'Stand-Alone Deployment', link: 'Stand-Alone-Deployment_timecho' }, + { + text: 'Stand-Alone Deployment', + link: 'Stand-Alone-Deployment_timecho', + }, { text: 'Cluster Deployment', link: 'Cluster-Deployment_timecho' }, - { text: 'Dual Active Deployment', link: 'Dual-Active-Deployment_timecho' }, + { + text: 'Dual Active Deployment', + link: 'Dual-Active-Deployment_timecho', + }, { text: 'Docker Deployment', link: 'Docker-Deployment_timecho' }, { text: 'AINode Deployment', link: 'AINode_Deployment_timecho' }, - { text: 'Monitoring Panel Deployment', link: 'Monitoring-panel-deployment' }, + { + text: 'Monitoring Panel Deployment', + link: 'Monitoring-panel-deployment', + }, { text: 'Workbench Deployment', link: 'workbench-deployment_timecho' }, ], }, @@ -109,7 +123,10 @@ export const enSidebar = { { text: 'Benchmark Tool', link: 'Benchmark' }, { text: 'Maintenance Tool', link: 'Maintenance-Tool_timecho' }, { text: 'Data Import Export Script', link: 'Data-Import-Export-Tool' }, - { text: 'TsFile Import Export Script', link: 'TsFile-Import-Export-Tool' }, + { + text: 'TsFile Import Export Script', + link: 'TsFile-Import-Export-Tool', + }, ], }, { @@ -158,9 +175,7 @@ export const enSidebar = { collapsible: true, prefix: 'SQL-Manual/', // children: 'structure', - children: [ - { text: 'SQL Manual', link: 'SQL-Manual' }, - ], + children: [{ text: 'SQL Manual', link: 'SQL-Manual' }], }, { text: 'FAQ', @@ -168,7 +183,11 @@ export const enSidebar = { prefix: 'FAQ/', // children: 'structure', children: [ - { text: 'Frequently Asked Questions', link: 'Frequently-asked-questions' }], + { + text: 'Frequently Asked Questions', + link: 'Frequently-asked-questions', + }, + ], }, { text: 'Reference', diff --git a/src/.vuepress/sidebar_timecho/V1.3.0-2/zh.ts b/src/.vuepress/sidebar_timecho/V1.3.0-2/zh.ts index ff0dfe0a..a4b1d0a9 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.0-2/zh.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.0-2/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -150,7 +149,7 @@ export const zhSidebar = { { text: 'Ignition', link: 'Ignition-IoTDB-plugin_timecho' }, { text: 'Grafana(IoTDB)', link: 'Grafana-Connector' }, { text: 'Grafana插件', link: 'Grafana-Plugin' }, - { text: 'ThingsBoard', link: 'Thingsboard' }, + { text: 'ThingsBoard', link: 'Thingsboard' }, ], }, { @@ -158,17 +157,14 @@ export const zhSidebar = { collapsible: true, prefix: 'SQL-Manual/', // children: 'structure', - children: [ - { text: 'SQL手册', link: 'SQL-Manual' }, - ], + children: [{ text: 'SQL手册', link: 'SQL-Manual' }], }, { text: 'FAQ', collapsible: true, prefix: 'FAQ/', // children: 'structure', - children: [ - { text: '常见问题', link: 'Frequently-asked-questions' }], + children: [{ text: '常见问题', link: 'Frequently-asked-questions' }], }, { text: '参考', diff --git a/src/.vuepress/sidebar_timecho/V1.3.3/en.ts b/src/.vuepress/sidebar_timecho/V1.3.3/en.ts index 77976ce4..444b93f3 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.3/en.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.3/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const enSidebar = { @@ -55,12 +54,21 @@ export const enSidebar = { { text: 'Obtain TimechoDB', link: 'IoTDB-Package_timecho' }, { text: 'Database Resources', link: 'Database-Resources' }, { text: 'System Requirements', link: 'Environment-Requirements' }, - { text: 'Stand-Alone Deployment', link: 'Stand-Alone-Deployment_timecho' }, + { + text: 'Stand-Alone Deployment', + link: 'Stand-Alone-Deployment_timecho', + }, { text: 'Cluster Deployment', link: 'Cluster-Deployment_timecho' }, - { text: 'Dual Active Deployment', link: 'Dual-Active-Deployment_timecho' }, + { + text: 'Dual Active Deployment', + link: 'Dual-Active-Deployment_timecho', + }, { text: 'Docker Deployment', link: 'Docker-Deployment_timecho' }, { text: 'AINode Deployment', link: 'AINode_Deployment_timecho' }, - { text: 'Monitoring Panel Deployment', link: 'Monitoring-panel-deployment' }, + { + text: 'Monitoring Panel Deployment', + link: 'Monitoring-panel-deployment', + }, { text: 'Workbench Deployment', link: 'workbench-deployment_timecho' }, ], }, @@ -74,12 +82,21 @@ export const enSidebar = { text: 'Data Modeling', collapsible: true, children: [ - { text: 'Timeseries Data Model', link: 'Navigating_Time_Series_Data' }, - { text: 'Modeling Scheme Design', link: 'Data-Model-and-Terminology' }, - { text: 'Measurement Point Management', link: 'Operate-Metadata_timecho' }, + { + text: 'Timeseries Data Model', + link: 'Navigating_Time_Series_Data', + }, + { + text: 'Modeling Scheme Design', + link: 'Data-Model-and-Terminology', + }, + { + text: 'Measurement Point Management', + link: 'Operate-Metadata_timecho', + }, ], }, - { text: 'Write & Delete', link: 'Write-Delete-Data' }, + { text: 'Write & Delete', link: 'Write-Delete-Data' }, { text: 'Query Data', link: 'Query-Data' }, ], }, @@ -96,7 +113,7 @@ export const enSidebar = { text: 'Security Management', collapsible: true, children: [ - { text: 'White List', link: 'White-List_timecho' }, + { text: 'White List', link: 'White-List_timecho' }, { text: 'Audit Log', link: 'Audit-Log_timecho' }, { text: 'Authority Management', link: 'Authority-Management' }, ], @@ -109,7 +126,7 @@ export const enSidebar = { text: 'Database Programming', collapsible: true, children: [ - { text: 'UDF Development', link: 'UDF-development' }, + { text: 'UDF Development', link: 'UDF-development' }, { text: 'Trigger', link: 'Trigger' }, { text: 'Stream Processing', link: 'Streaming_timecho' }, ], @@ -153,7 +170,7 @@ export const enSidebar = { text: 'REST API', collapsible: true, children: [ - { text: 'V1 (Not Recommend)', link: 'RestServiceV1' }, + { text: 'V1 (Not Recommend)', link: 'RestServiceV1' }, { text: 'V2', link: 'RestServiceV2' }, ], }, @@ -192,8 +209,14 @@ export const enSidebar = { collapsible: true, children: [ { text: 'UDF Libraries', link: 'UDF-Libraries_timecho' }, - { text: 'Operator and Expression', link: 'Operator-and-Expression' }, - { text: 'Function and Expression', link: 'Function-and-Expression' }, + { + text: 'Operator and Expression', + link: 'Operator-and-Expression', + }, + { + text: 'Function and Expression', + link: 'Function-and-Expression', + }, ], }, ], @@ -206,7 +229,10 @@ export const enSidebar = { children: [ { text: 'Research Paper ', link: 'Publication' }, { text: 'Compression & Encoding', link: 'Encoding-and-Compression' }, - { text: 'Data Partitioning & Load Balancing', link: 'Cluster-data-partitioning' }, + { + text: 'Data Partitioning & Load Balancing', + link: 'Cluster-data-partitioning', + }, ], }, { @@ -220,7 +246,10 @@ export const enSidebar = { collapsible: true, children: [ { text: 'Common Config Manual', link: 'Common-Config-Manual' }, - { text: 'ConfigNode Config Manual', link: 'ConfigNode-Config-Manual' }, + { + text: 'ConfigNode Config Manual', + link: 'ConfigNode-Config-Manual', + }, { text: 'DataNode Config Manual', link: 'DataNode-Config-Manual' }, ], }, @@ -229,7 +258,7 @@ export const enSidebar = { collapsible: true, children: [ { text: 'Identifiers', link: 'Syntax-Rule' }, - { text: 'Keywords', link: 'Keywords' }, + { text: 'Keywords', link: 'Keywords' }, ], }, { text: 'Status Codes', link: 'Status-Codes' }, @@ -241,8 +270,11 @@ export const enSidebar = { prefix: 'FAQ/', // children: 'structure', children: [ - { text: 'Frequently Asked Questions', link: 'Frequently-asked-questions' }], + { + text: 'Frequently Asked Questions', + link: 'Frequently-asked-questions', + }, + ], }, ], }; - diff --git a/src/.vuepress/sidebar_timecho/V1.3.3/zh.ts b/src/.vuepress/sidebar_timecho/V1.3.3/zh.ts index af8b9e56..e4a00e0d 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.3/zh.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.3/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export const zhSidebar = { @@ -74,12 +73,12 @@ export const zhSidebar = { text: '数据建模', collapsible: true, children: [ - { text: '时序数据模型', link: 'Navigating_Time_Series_Data' }, + { text: '时序数据模型', link: 'Navigating_Time_Series_Data' }, { text: '建模方案设计', link: 'Data-Model-and-Terminology' }, { text: '测点管理', link: 'Operate-Metadata_timecho' }, ], }, - { text: '写入&删除', link: 'Write-Delete-Data' }, + { text: '写入&删除', link: 'Write-Delete-Data' }, { text: '数据查询', link: 'Query-Data' }, ], }, @@ -96,7 +95,7 @@ export const zhSidebar = { text: '安全管理', collapsible: true, children: [ - { text: '白名单', link: 'White-List_timecho' }, + { text: '白名单', link: 'White-List_timecho' }, { text: '审计日志', link: 'Audit-Log_timecho' }, { text: '权限管理', link: 'Authority-Management' }, ], @@ -109,12 +108,12 @@ export const zhSidebar = { text: '数据库编程', collapsible: true, children: [ - { text: 'UDF开发', link: 'UDF-development' }, + { text: 'UDF开发', link: 'UDF-development' }, { text: '触发器', link: 'Trigger' }, { text: '流处理框架', link: 'Streaming_timecho' }, ], }, - { text: '运维语句', link: 'Maintennance'}, + { text: '运维语句', link: 'Maintennance' }, ], }, { @@ -153,7 +152,7 @@ export const zhSidebar = { text: 'REST API', collapsible: true, children: [ - { text: 'V1 (不推荐)', link: 'RestServiceV1' }, + { text: 'V1 (不推荐)', link: 'RestServiceV1' }, { text: 'V2', link: 'RestServiceV2' }, ], }, @@ -177,7 +176,7 @@ export const zhSidebar = { { text: 'Ignition', link: 'Ignition-IoTDB-plugin_timecho' }, { text: 'Grafana(IoTDB)', link: 'Grafana-Connector' }, { text: 'Grafana插件', link: 'Grafana-Plugin' }, - { text: 'ThingsBoard', link: 'Thingsboard' }, + { text: 'ThingsBoard', link: 'Thingsboard' }, ], }, { @@ -192,8 +191,8 @@ export const zhSidebar = { collapsible: true, children: [ { text: 'UDF函数库', link: 'UDF-Libraries_timecho' }, - { text: '函数与运算符', link: 'Operator-and-Expression' }, - { text: '内置函数与表达式', link: 'Function-and-Expression' }, + { text: '函数与运算符', link: 'Operator-and-Expression' }, + { text: '内置函数与表达式', link: 'Function-and-Expression' }, ], }, ], @@ -229,7 +228,7 @@ export const zhSidebar = { collapsible: true, children: [ { text: '标识符', link: 'Syntax-Rule' }, - { text: '关键字', link: 'Keywords' }, + { text: '关键字', link: 'Keywords' }, ], }, { text: '状态码', link: 'Status-Codes' }, @@ -240,8 +239,7 @@ export const zhSidebar = { collapsible: true, prefix: 'FAQ/', // children: 'structure', - children: [ - { text: '常见问题', link: 'Frequently-asked-questions' }], + children: [{ text: '常见问题', link: 'Frequently-asked-questions' }], }, ], }; diff --git a/src/.vuepress/sidebar_timecho/en.ts b/src/.vuepress/sidebar_timecho/en.ts index 9f65f97f..904ab9cf 100644 --- a/src/.vuepress/sidebar_timecho/en.ts +++ b/src/.vuepress/sidebar_timecho/en.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ import { sidebar } from 'vuepress-theme-hope'; diff --git a/src/.vuepress/sidebar_timecho/index.ts b/src/.vuepress/sidebar_timecho/index.ts index 4493c7eb..3e7096aa 100644 --- a/src/.vuepress/sidebar_timecho/index.ts +++ b/src/.vuepress/sidebar_timecho/index.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ export * from './en.js'; diff --git a/src/.vuepress/sidebar_timecho/zh.ts b/src/.vuepress/sidebar_timecho/zh.ts index 5d0cf0d7..2ef360f5 100644 --- a/src/.vuepress/sidebar_timecho/zh.ts +++ b/src/.vuepress/sidebar_timecho/zh.ts @@ -1,20 +1,19 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ import { sidebar } from 'vuepress-theme-hope'; diff --git a/src/.vuepress/styles/config.scss b/src/.vuepress/styles/config.scss index aaf5ff42..e828ad19 100644 --- a/src/.vuepress/styles/config.scss +++ b/src/.vuepress/styles/config.scss @@ -1,26 +1,24 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ -// you can change config here +$theme-color: #495ad4; $colors: #c0392b, #d35400, #f39c12, #27ae60, #16a085, #2980b9, #8e44ad, #2c3e50, - #7f8c8d !default; - + #7f8c8d; $code-bg-color: #282c34; $code-color: #fff; $pc: 1280px; diff --git a/src/.vuepress/styles/index.scss b/src/.vuepress/styles/index.scss index bdaf3464..072e55dc 100644 --- a/src/.vuepress/styles/index.scss +++ b/src/.vuepress/styles/index.scss @@ -1,64 +1,66 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ - http://www.apache.org/licenses/LICENSE-2.0 +.vp-hero-image { + max-width: 420px; +} - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - */ +.vp-hero-title { + font-size: 72px; +} -// place your custom styles here -.hero-info-wrapper, .site-name, .vp-hero-info-wrapper, .vp-site-name{ - display: none; -} -.home.project -.theme-hope-content { - max-width: unset; +.vp-highlight-header, +.vp-feature-header { + color: #ffa500; + text-align: center; } -.vp-project-home .theme-hope-content { - max-width: unset; + +// FIXME: Should be an upstream bug +.vp-highlight-info-wrapper:only-child { + flex-basis: 0; } + .el-popover.el-popper { text-align: start !important; word-break: break-word !important; } -.theme-hope-content:not(.custom)>p, .theme-hope-content:not(.custom)>ul p, .theme-hope-content:not(.custom)>ol p { +.theme-hope-content:not(.custom) > p, +.theme-hope-content:not(.custom) > ul p, +.theme-hope-content:not(.custom) > ol p { text-align: start !important; } -// #app { -// --code-bg-color: #282c34; -// --code-color: #fff; -// html[data-theme="light"] & { -// --code-bg-color: #282c34; -// --code-color: #fff; -// .token.doctype, .token.punctuation, .token.entity{ -// color: #ccc; -// } -// } -// } - table { word-wrap: break-word; word-break: keep-all; } -td a span{ +td a span { display: none; } -h1, h2, h3, h4, h5, h6 { - font-family: var(--font-family) +h1, +h2, +h3, +h4, +h5, +h6 { + font-family: var(--font-family); } .fade-slide-y-enter-active { @@ -68,10 +70,7 @@ h1, h2, h3, h4, h5, h6 { .fade-slide-y-leave-active { transition: none !important; } -// .fade-slide-y-enter-from, -// .fade-slide-y-leave-to { -// transform: none !important; -// } + .page-pageview-info { display: none !important; } @@ -79,6 +78,7 @@ h1, h2, h3, h4, h5, h6 { footer { z-index: 999; } -div[class*=language-] pre code { + +div[class*='language-'] pre code { color: var(--code-c-text); -} \ No newline at end of file +} diff --git a/src/.vuepress/styles/palette.scss b/src/.vuepress/styles/palette.scss deleted file mode 100644 index b5528874..00000000 --- a/src/.vuepress/styles/palette.scss +++ /dev/null @@ -1,23 +0,0 @@ -/* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - */ - -// you can change colors here -// old: #D513A5 -$theme-color: #495ad4; -// $content-width: 1080px; \ No newline at end of file diff --git a/src/.vuepress/theme.ts b/src/.vuepress/theme.ts index 12c7d501..780c6d12 100644 --- a/src/.vuepress/theme.ts +++ b/src/.vuepress/theme.ts @@ -1,163 +1,109 @@ /* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ import { hopeTheme } from 'vuepress-theme-hope'; import { enNavbar, zhNavbar } from './navbar/index.js'; import { enSidebar, zhSidebar } from './sidebar/index.js'; -export default hopeTheme({ - hostname: 'https://iotdb.apache.org/', - - darkmode: 'toggle', - - logo: '/logo.png', - - repo: 'https://github.com/apache/iotdb', - - repoLabel: 'GitHub', - - repoDisplay: true, - - docsRepo: 'https://github.com/apache/iotdb-docs', - - docsDir: 'src', - - docsBranch: 'main', - - pure: true, - - breadcrumb: false, - - navbarIcon: false, - - lastUpdated: true, - - contributors: false, - - navbarLayout: { - start: ['Brand'], - center: [], - end: ['Search', 'Links', 'Language', 'Outlook', 'Repo'], - }, +export default hopeTheme( + { + hostname: 'https://iotdb.apache.org/', + logo: '/logo.png', + + repo: 'apache/iotdb', + docsRepo: 'https://github.com/apache/iotdb-docs', + docsDir: 'src', + + pure: true, + darkmode: 'toggle', + breadcrumb: false, + contributors: false, + + navbarTitle: '', + navbarLayout: { + start: ['Brand'], + center: [], + end: ['Search', 'Links', 'Language', 'Outlook', 'Repo'], + }, - locales: { - '/': { - // navbar - navbar: enNavbar, + locales: { + '/': { + // navbar + navbar: enNavbar, - // sidebar - sidebar: enSidebar, + // sidebar + sidebar: enSidebar, - footer: 'Default footer', + footer: 'Default footer', - displayFooter: true, + displayFooter: true, - metaLocales: { - editLink: 'Found Error? Edit this page on GitHub', + metaLocales: { + editLink: 'Found Error? Edit this page on GitHub', + }, }, - }, - /** - * Chinese locale config - */ - '/zh/': { - // navbar - navbar: zhNavbar, + /** + * Chinese locale config + */ + '/zh/': { + // navbar + navbar: zhNavbar, - // sidebar - sidebar: zhSidebar, + // sidebar + sidebar: zhSidebar, - footer: '默认页脚', + footer: '默认页脚', - displayFooter: true, + displayFooter: true, - // page meta - metaLocales: { - editLink: '发现错误？在 GitHub 上编辑此页', + // page meta + metaLocales: { + editLink: '发现错误？在 GitHub 上编辑此页', + }, }, }, - }, - // encrypt: { - // config: { - // "/demo/encrypt.html": ["1234"], - // "/zh/demo/encrypt.html": ["1234"], - // }, - // }, - - plugins: { - // comment: { - // // @ts-expect-error: You should generate and use your own comment service - // provider: "Waline", - // }, - - // all features are enabled for demo, only preserve features you need here - prismjs: { - themes: { - light: 'one-dark', - dark: 'one-dark', - }, - }, - // shiki: { - // theme: 'one-dark-pro', - // langs: ['java', 'shell', 'sql', 'yaml', 'json', 'xml', 'go', 'python', 'scala', 'text', 'plaintext', 'txt', 'properties', 'rust', 'javascript', 'cpp', 'c#', 'csharp', 'js', 'cmd'], - // }, - catalog: true, - git: true, - comment: { - provider: 'None', - }, - mdEnhance: { + markdown: { align: true, - attrs: true, - chart: false, - codetabs: true, - hint: true, - demo: false, - echarts: false, + hint: false, figure: true, - flowchart: false, gfm: true, imgLazyload: true, - imgSize: true, - include: true, - katex: true, - mark: true, - mermaid: false, - stylize: [ - { - matcher: 'Recommended', - // eslint-disable-next-line consistent-return - replacer: ({ tag }) => { - if (tag === 'em') { - return { - tag: 'Badge', - attrs: { type: 'tip' }, - content: 'Recommended', - }; - } - }, + math: true, + highlighter: { + type: 'shiki', + theme: 'one-dark-pro', + }, + }, + + plugins: { + docsearch: {}, + + redirect: { + config: { + '/UserGuide/Master/QuickStart/QuickStart.html': + '/UserGuide/latest/QuickStart/QuickStart_apache.html', + '/zh/UserGuide/Master/QuickStart/QuickStart.html': + '/zh/UserGuide/latest/QuickStart/QuickStart_apache.html', }, - ], - sub: true, - sup: true, - tabs: true, - vPre: true, - vuePlayground: false, + }, }, }, -}, { custom: true }); + { custom: true }, +); diff --git a/src/.vuepress/utils/contributors.ts b/src/.vuepress/utils/contributors.ts new file mode 100644 index 00000000..e21790e4 --- /dev/null +++ b/src/.vuepress/utils/contributors.ts @@ -0,0 +1,301 @@ +export const mentors = [ + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Justin Mclean', + role: 'Mentor', + id: 'jmclean', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Christofer Dutz', + role: 'Mentor', + id: 'cdutz', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Willem Ning Jiang', + role: 'Mentor', + id: 'ningjiang', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Kevin A. McGrail', + role: 'Champion', + id: 'kmcgrail', + date: '2018/11/18', + }, +]; + +export const committers = [ + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Gaofei Cao', + role: 'PMC, Committer', + id: 'caogaofei', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Yi Xu', + role: 'PMC, Committer', + id: 'dope', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Dongfang Mao', + role: 'PMC, Committer', + id: 'east', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Wangminhao Gou', + role: 'Committer', + id: 'ejttianyu', + date: '2020/03/03', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Boris Zhu', + role: 'Committer', + id: 'geniuspig', + date: '2019/12/19', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Haonan Hou', + role: 'PMC, Committer', + id: 'haonan', + date: '2020/01/30', + }, + { + avatar: '/img/contributor-avatar/xdh.jpg', + name: 'Xiangdong Huang', + role: 'PMC, Committer', + id: 'hxd', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/yt.jpg', + name: 'Yuan Tian', + role: 'PMC, Committer', + id: 'jackietien', + date: '2019/12/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Julian Feinauer', + role: 'PMC, Committer', + id: 'jfeinauer', + date: '2019/07/15', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Tian Jiang', + role: 'PMC, Committer', + id: 'jiangtian', + date: '2018/11/18', + }, + { + avatar: 'http://ise.thss.tsinghua.edu.cn/~wangjianmin/jimwang.jpg', + name: 'Jianmin Wang', + role: 'PMC, Committer', + id: 'jimwang', + date: '2018/11/18', + }, + { + avatar: + 'https://avatars1.githubusercontent.com/u/22488084?s=400&u=2ef5ad52a7c4241bf88fb5e45682948b307a7d90&v=4', + name: 'Jincheng Sun', + role: 'PMC, Committer', + id: 'jincheng', + date: '2020/01/21', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Rong Kang', + role: 'PMC, Committer', + id: 'kangrong', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Lei Rui', + role: 'PMC, Committer', + id: 'leirui', + date: '2019/06/20', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Dawei Liu', + role: 'PMC, Committer', + id: 'liudw', + date: '2020/03/01', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Kun Liu', + role: 'PMC, Committer', + id: 'liukun', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Rui Liu', + role: 'PMC, Committer', + id: 'liurui', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Tianan Li', + role: 'PMC, Committer', + id: 'lta', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/jlq.png', + name: 'Jialin Qiao', + role: 'PMC, Committer', + id: 'qiaojialin', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Shuo Zhang', + role: 'PMC, Committer', + id: 'shuozhang', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/zss.jpg', + name: 'Zesong Sun', + role: 'Committer', + id: 'sunzesong', + date: '2019/12/23', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Yue Su', + role: 'PMC, Committer', + id: 'suyue', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Zonghan Cai', + role: 'Committer', + id: 'tsaitsunghan', + date: '2019/11/05', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Chen Wang', + role: 'PMC, Committer', + id: 'wangchen', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Jinrui Zhang', + role: 'PMC, Committer', + id: 'xingtanzjr', + date: '2018/11/18', + }, + { + avatar: + 'https://avatars0.githubusercontent.com/u/6711230?s=460&u=b8f03cad5891dbe4eab23ca75df3d97358b23b0c&v=4', + name: 'Xin Wang', + role: 'Committer', + id: 'xinwang', + date: '2020/05/18', + }, + { + avatar: '/img/contributor-avatar/kfx.jpeg', + name: 'Kaifeng Xue', + role: 'Committer', + id: 'xuekaifeng', + date: '2018/12/19', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Jun Yuan', + role: 'PMC, Committer', + id: 'yuanjun', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Stefanie Zhao', + role: 'PMC, Committer', + id: 'zhaoxinyi', + date: '2018/11/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Wei Zhi', + role: 'Committer', + id: 'WeiZhi', + date: '2020/06/18', + }, + { + avatar: '/img/contributor-avatar/cw.jpg', + name: 'Chao Wang', + role: 'PMC, Committer', + id: 'chaow', + date: '2020/09/04', + }, + { + avatar: '/img/contributor-avatar/qhl.jpg', + name: 'Houliang Qi', + role: 'PMC, Committer', + id: 'neuyilan', + date: '2020/12/18', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Xinyu Tan', + role: 'PMC, Committer', + id: 'tanxinyu', + date: '2020/12/21', + }, + { + avatar: '/img/contributor-avatar/xww.jpg', + name: 'Xiangwei Wei', + role: 'Committer', + id: 'Alima777', + date: '2021/02/20', + }, + { + avatar: '/img/contributor-avatar/yrzh.jpg', + name: 'Jesse Zhou', + role: 'Committer', + id: 'JesseZhou-1', + date: '2021/02/20', + }, + { + avatar: 'https://avatars.githubusercontent.com/u/30497621', + name: 'Steve Yurong Su', + role: 'Committer', + id: 'rong', + date: '2021/05/12', + }, + { + avatar: '/img/contributor-avatar/user.svg', + name: 'Chao Wang', + role: 'PMC, Committer', + id: 'wangchao316', + date: '2021/06/30', + }, + { + avatar: '/img/contributor-avatar/ericpai.jpg', + name: 'Jian Bai', + role: 'Committer', + id: 'ericpai', + date: '2021/12/24', + }, +]; diff --git a/src/.vuepress/utils/define.ts b/src/.vuepress/utils/define.ts deleted file mode 100644 index 6758840d..00000000 --- a/src/.vuepress/utils/define.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - */ - -import { type ReadingTimeLocaleConfig } from 'vuepress-plugin-reading-time2'; - -declare const READING_TIME_LOCALES: ReadingTimeLocaleConfig; - -// eslint-disable-next-line import/prefer-default-export -export const readingTimeLocales = READING_TIME_LOCALES; diff --git a/src/.vuepress/utils/editLink.ts b/src/.vuepress/utils/editLink.ts deleted file mode 100644 index e249b337..00000000 --- a/src/.vuepress/utils/editLink.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - */ - -import { - isLinkHttp, - removeEndingSlash, - removeLeadingSlash, -} from '@vuepress/shared'; -import { type RepoType, resolveRepoType } from 'vuepress-shared/client'; - -export const editLinkPatterns: Record, string> = { - GitHub: ':repo/edit/:branch/:path', - GitLab: ':repo/-/edit/:branch/:path', - Gitee: ':repo/edit/:branch/:path', - Bitbucket: - ':repo/src/:branch/:path?mode=edit&spa=0&at=:branch&fileviewer=file-view-default', -}; - -interface EditLinkOptions { - docsRepo: string; - docsBranch: string; - docsDir: string; - filePathRelative: string | null; - editLinkPattern?: string; -} - -export const resolveEditLink = ({ - docsRepo, - docsBranch, - docsDir, - filePathRelative, - editLinkPattern, -}: EditLinkOptions): string | null => { - if (!filePathRelative) return null; - - const repoType = resolveRepoType(docsRepo); - - let pattern: string | undefined; - - if (editLinkPattern) pattern = editLinkPattern; - else if (repoType !== null) pattern = editLinkPatterns[repoType]; - - if (!pattern) return null; - - return pattern - .replace( - /:repo/, - isLinkHttp(docsRepo) ? docsRepo : `https://github.com/${docsRepo}`, - ) - .replace(/:branch/, docsBranch) - .replace( - /:path/, - removeLeadingSlash(`${removeEndingSlash(docsDir)}/${filePathRelative}`), - ); -}; diff --git a/src/.vuepress/utils/getDocVersion.ts b/src/.vuepress/utils/getDocVersion.ts new file mode 100644 index 00000000..9be36337 --- /dev/null +++ b/src/.vuepress/utils/getDocVersion.ts @@ -0,0 +1,34 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +const VERSION_REG = /UserGuide\/([^/]+)/; + +export const getDocVersion = (path = '', defaultValue = 'latest') => { + if (path.includes('UserGuide/Master') || !path.includes('UserGuide')) { + return defaultValue; + } + /** + * 路径 /zh/UserGuide/V1.3.0-2/QuickStart/QuickStart_apache.html, 匹配 V1.3.0-2 + * 路径 /zh/UserGuide/V1.2.x/QuickStart/QuickStart_apache.html, 匹配 V1.2.x + * 路径 /zh/UserGuide/latest/QuickStart/QuickStart_apache.html, 匹配 latest + * + * 匹配路径中的版本号，UserGuide 后面的版本号为当前文档的版本号, 版本号不一定为数字，可能为 latest或其它，因此只用 / 作为分隔符 + */ + + return VERSION_REG.exec(path)?.[1] ?? defaultValue; +}; diff --git a/src/.vuepress/utils/index.ts b/src/.vuepress/utils/index.ts index 97491056..cb5ae38f 100644 --- a/src/.vuepress/utils/index.ts +++ b/src/.vuepress/utils/index.ts @@ -1,22 +1,2 @@ -/* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - */ - -export * from './define.js'; -export * from './editLink.js'; -export * from './typings.js'; +export * from './contributors.js'; +export * from './getDocVersion.js'; diff --git a/src/.vuepress/utils/typings.ts b/src/.vuepress/utils/typings.ts deleted file mode 100644 index 7c3f980f..00000000 --- a/src/.vuepress/utils/typings.ts +++ /dev/null @@ -1,36 +0,0 @@ -/* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - */ - -export interface PageCategory { - /** - * Category name - * - * 分类名称 - */ - name: string; - - /** - * Category path - * - * 分类路径 - */ - path?: string; -} - -export type PageTag = PageCategory; diff --git a/src/.vuepress/utils/version.ts b/src/.vuepress/utils/version.ts deleted file mode 100644 index 73126cc8..00000000 --- a/src/.vuepress/utils/version.ts +++ /dev/null @@ -1,41 +0,0 @@ -/* - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - */ - -const getDocVersion = (defaultValue = 'latest', path = '') => { - if (path.indexOf('UserGuide/Master') > -1 || path.indexOf('UserGuide') === -1) { - return defaultValue; - } - /** - * 路径 /zh/UserGuide/V1.3.0-2/QuickStart/QuickStart_apache.html, 匹配 V1.3.0-2 - * 路径 /zh/UserGuide/V1.2.x/QuickStart/QuickStart_apache.html, 匹配 V1.2.x - * 路径 /zh/UserGuide/latest/QuickStart/QuickStart_apache.html, 匹配 latest - * - * 匹配路径中的版本号，UserGuide 后面的版本号为当前文档的版本号, 版本号不一定为数字，可能为 latest或其它，因此只用 / 作为分隔符 - */ - // eslint-disable-next-line no-useless-escape - const versionRex = /UserGuide\/([^\/]+)/; - - if (versionRex.test(path)) { - const tag = versionRex.exec(path)![1]; - return tag; - } - return defaultValue; -}; - -export { getDocVersion }; diff --git a/src/Community/Development-Guide.md b/src/Community/Development-Guide.md index 41ead421..6327f81b 100644 --- a/src/Community/Development-Guide.md +++ b/src/Community/Development-Guide.md @@ -504,7 +504,8 @@ Please conduct discussions in English: - Unable to download `errorprone`: - ```Failed to read artifact descriptor for com.google.errorprone:javac + ``` + Failed to read artifact descriptor for com.google.errorprone:javac -shaded:jar:9+181-r4173-1: Could not transfer artifact com.google.errorprone:javac-shaded:pom:9+181-r4173-1 ``` diff --git a/src/Community/stage/Committers.md b/src/Community/stage/Committers.md index c4a9d805..bf4f4ae9 100644 --- a/src/Community/stage/Committers.md +++ b/src/Community/stage/Committers.md @@ -22,4 +22,8 @@ home: true --> - + + + diff --git a/src/Community/stage/Community-Project-Committers.md b/src/Community/stage/Community-Project-Committers.md index 46627d85..bf4f4ae9 100644 --- a/src/Community/stage/Community-Project-Committers.md +++ b/src/Community/stage/Community-Project-Committers.md @@ -22,4 +22,8 @@ home: true --> - + + + diff --git a/src/Download/README.md b/src/Download/README.md index 497b9924..af8d015b 100644 --- a/src/Download/README.md +++ b/src/Download/README.md @@ -7,9 +7,9 @@ to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 - + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -22,57 +22,207 @@ # Release version - + + - - - - + + + + - - - - - - - - + + + + + + + + - - - + + + - - - - - - - - - + + + + + + + + + - - - - - - - - + + + + + + + + - - - + + + - - - + + + +
VersionIoTDB BinariesIoTDB Sourcesrelease notes
IoTDB BinariesIoTDB Sourcesrelease notes
1.3.3All-in-oneSHA512ASCSourcesSHA512ASCrelease notes1.3.3 + All-in-one + + SHA512 + + ASC + + Sources + + SHA512 + + ASC + + release notes +
AINodeSHA512ASC + AINode + + SHA512 + + ASC +
1.3.2All-in-oneSHA512ASCSourcesSHA512ASCrelease notes
1.3.2 + All-in-one + + SHA512 + + ASC + + Sources + + SHA512 + + ASC + + release notes +
0.13.4All-in-oneSHA512ASCSourcesSHA512ASCrelease notes0.13.4 + All-in-one + + SHA512 + + ASC + + Sources + + SHA512 + + ASC + + release notes +
Grafana-connectorSHA512ASC + Grafana-connector + + SHA512 + + ASC +
Grafana-pluginSHA512ASC + Grafana-plugin + + SHA512 + + ASC +
Legacy version are available here: [https://archive.apache.org/dist/iotdb/](https://archive.apache.org/dist/iotdb/) @@ -80,11 +230,13 @@ Legacy version are available here: [https://archive.apache.org/dist/iotdb/](http ## Configurations - Recommended OS parameters - * Set the somaxconn as 65535 to avoid "connection reset" error when the system is under high load. + + - Set the somaxconn as 65535 to avoid "connection reset" error when the system is under high load. + ``` # Linux > sudo sysctl -w net.core.somaxconn=65535 - + # FreeBSD or Darwin > sudo sysctl -w kern.ipc.somaxconn=65535 ``` @@ -92,9 +244,9 @@ Legacy version are available here: [https://archive.apache.org/dist/iotdb/](http ## About Version 1.0 **After we release version 1.0, how to upgrade from v0.13.x to v1.0.x?** - - - **Version 1.0 has changed the SQL syntax conventions (please refer to the syntax conventions section of the user manual)**. - - In order to ensure the stability of UDF-related APIs, in version 1.0, UDF-related APIs are seperated into an independent module and no longer depend on the tsfile package. The implemented UDFs need to rewrite the code, replace `TsDataType` with `Type`, and replace `org .apache.iotdb.tsfile.utils.Binary` with `org.apache.iotdb.udf.api.type.Binary`, then redo the packaging and loading process. + +- **Version 1.0 has changed the SQL syntax conventions (please refer to the syntax conventions section of the user manual)**. +- In order to ensure the stability of UDF-related APIs, in version 1.0, UDF-related APIs are seperated into an independent module and no longer depend on the tsfile package. The implemented UDFs need to rewrite the code, replace `TsDataType` with `Type`, and replace `org .apache.iotdb.tsfile.utils.Binary` with `org.apache.iotdb.udf.api.type.Binary`, then redo the packaging and loading process. ### Detailed description of Syntax Conventions in version 1.0 that are different from older versions @@ -190,7 +342,7 @@ for(int i = 0; i <= values.length; i++){ Query the data of root.sg.a, you can see that there is no unescaping: -```Plain%20Text +``` // query result +-----------------------------+---------+ | Time|root.sg.a| @@ -214,7 +366,7 @@ insert into root.sg(time, a) values(4, "\u96d5") Query the data of root.sg.a, you can see that the string is unescaped: -```Plain%20Text +``` // query result +-----------------------------+---------+ | Time|root.sg.a| @@ -226,91 +378,91 @@ Query the data of root.sg.a, you can see that the string is unescaped: +-----------------------------+---------+ ``` - ## How to Upgrade - How to upgrade a minor version (e.g., from v0.12.3 to v0.12.5)? - * versions which have the same major version are compatible. - * Just download and unzip the new version. Then modify the configuration files to keep consistent + + - versions which have the same major version are compatible. + - Just download and unzip the new version. Then modify the configuration files to keep consistent with what you set in the old version. - * stop the old version instance, and start the new one. + - stop the old version instance, and start the new one. - How to upgrade from v0.12.x to v0.13.x? - * The data format (i.e., TsFile data) of v0.12.x and v0.13.x are compatible, but the WAL file is + - The data format (i.e., TsFile data) of v0.12.x and v0.13.x are compatible, but the WAL file is incompatible. So, you can follow the steps: - * ** Execute `SET SYSTEM TO READONLY` command in CLI. ** - * ** Stop writing new data.** - * Execute `flush` command to close all TsFiles. - * We recommend to back up all data files before upgrading for rolling back. - * Just download, unzip v0.13.x.zip, and modify conf/iotdb-engine.properties, ** especially the unchangeable configurations like timestamp precision**. Let all the + - ** Execute `SET SYSTEM TO READONLY` command in CLI. ** + - ** Stop writing new data.** + - Execute `flush` command to close all TsFiles. + - We recommend to back up all data files before upgrading for rolling back. + - Just download, unzip v0.13.x.zip, and modify conf/iotdb-engine.properties, ** especially the unchangeable configurations like timestamp precision**. Let all the directories point to the data folder set in v0.12.x (or the backup folder). You can also modify other settings if you want. - * Stop IoTDB v0.12.x instance, and then start v0.13.x. - * **After the steps above, please make sure the `iotdb_version` in `data/system/schema/system.properties` file is `0.13.x`. + - Stop IoTDB v0.12.x instance, and then start v0.13.x. + - **After the steps above, please make sure the `iotdb_version` in `data/system/schema/system.properties` file is `0.13.x`. If not, please change it to `0.13.x` manually.** - * __NOTICE: V0.13 changes many settings in conf/iotdb-engine.properties, so do not use v0.12's - configuration file directly.__ - * **In 0.13, the SQL syntax has been changed. The identifiers not enclosed in backquotes can only contain the following characters, otherwise they need to be enclosed in backquotes.** - * **[0-9 a-z A-Z _ : @ # $ { }] (letters, digits, some special characters)** - * **['\u2E80'..'\u9FFF'] (UNICODE Chinese characters)** - * **In 0.13, if the path node name in the `SELECT` clause consists of pure numbers, it needs to be enclosed in backquotes to distinguish it from the constant in the expression. For example, in the statement "select 123 + \`123\` from root.sg", the former 123 represents a constant, and the latter \`123\` will be spliced with root.sg, indicating the path root.sg.\`123\`.** + - **NOTICE: V0.13 changes many settings in conf/iotdb-engine.properties, so do not use v0.12's + configuration file directly.** + - **In 0.13, the SQL syntax has been changed. The identifiers not enclosed in backquotes can only contain the following characters, otherwise they need to be enclosed in backquotes.** + - **[0-9 a-z A-Z _ : @ # $ { }] (letters, digits, some special characters)** + - **['\u2E80'..'\u9FFF'] (UNICODE Chinese characters)** + - **In 0.13, if the path node name in the `SELECT` clause consists of pure numbers, it needs to be enclosed in backquotes to distinguish it from the constant in the expression. For example, in the statement "select 123 + \`123\` from root.sg", the former 123 represents a constant, and the latter \`123\` will be spliced with root.sg, indicating the path root.sg.\`123\`.** - How to upgrade from v0.11.x or v0.10.x to v0.12.x? - * Upgrading from v0.11 or v0.10 to v0.12 is similar as v0.9 to v0.10. The upgrade tool will rewrite the data files automatically. - * **Stop writing new data.** - * Call `flush` command using sbin/start-cli.sh in original version to close all TsFiles. - * We recommend to backup the data file (also the wal files and mlog.txt) before upgrading for rolling back. - * Just download, unzip v0.12.x.zip, and modify conf/iotdb-engine.proeprties to let all the - directories point to the folders set in previous version (or the backup folder). - You can also modify other settings if you want. Any other config changes in v0.11 should be moved to v0.12. - * Stop IoTDB v0.11 or v0.10 instance, and start v0.12.x, then the IoTDB will upgrade data file format automatically. It is ok to read and write data when the upgrading process works. - * After a log `All files upgraded successfully!` printed, the upgrading completes. - * __NOTICE 1: V0.12 changes many settings in conf/iotdb-engine.properties, so do not use previous - configuration file directly.__ - * __NOTICE 2: V0.12 doesn't support upgrade from v0.9 or lower version, please upgrade to v0.10 first if needed.__ - * __NOTICE 3: We don't recommend deleting data before the upgrading finished. The deletion will fail if you try to delete data in the database with upgrading files.__ + + - Upgrading from v0.11 or v0.10 to v0.12 is similar as v0.9 to v0.10. The upgrade tool will rewrite the data files automatically. + - **Stop writing new data.** + - Call `flush` command using sbin/start-cli.sh in original version to close all TsFiles. + - We recommend to backup the data file (also the wal files and mlog.txt) before upgrading for rolling back. + - Just download, unzip v0.12.x.zip, and modify conf/iotdb-engine.proeprties to let all the + directories point to the folders set in previous version (or the backup folder). + You can also modify other settings if you want. Any other config changes in v0.11 should be moved to v0.12. + - Stop IoTDB v0.11 or v0.10 instance, and start v0.12.x, then the IoTDB will upgrade data file format automatically. It is ok to read and write data when the upgrading process works. + - After a log `All files upgraded successfully!` printed, the upgrading completes. + - **NOTICE 1: V0.12 changes many settings in conf/iotdb-engine.properties, so do not use previous + configuration file directly.** + - **NOTICE 2: V0.12 doesn't support upgrade from v0.9 or lower version, please upgrade to v0.10 first if needed.** + - **NOTICE 3: We don't recommend deleting data before the upgrading finished. The deletion will fail if you try to delete data in the database with upgrading files.** - How to upgrade from v0.10.x to v0.11.x? - * The data format (i.e., TsFile data) of v0.10.x and v0.11 are compatible, but the WAL file is - incompatible. So, you can follow the steps: - * **Stop writing new data.** - * Call `flush` command using `sbin/start-cli.sh` in v0.10.x to close all TsFiles. - * We recommend to backup the wal files and mlog.txt before upgrading for rolling back. - * Just download, unzip v0.11.x.zip, and modify conf/iotdb-engine.properties to let all the - directories point to the data folder set in v0.10.x (or the backup folder). You can also modify + + - The data format (i.e., TsFile data) of v0.10.x and v0.11 are compatible, but the WAL file is + incompatible. So, you can follow the steps: + - **Stop writing new data.** + - Call `flush` command using `sbin/start-cli.sh` in v0.10.x to close all TsFiles. + - We recommend to backup the wal files and mlog.txt before upgrading for rolling back. + - Just download, unzip v0.11.x.zip, and modify conf/iotdb-engine.properties to let all the + directories point to the data folder set in v0.10.x (or the backup folder). You can also modify other settings if you want. - * Stop IoTDB v0.10.x instance, and start v0.11.x, then the IoTDB will upgrade data file format + - Stop IoTDB v0.10.x instance, and start v0.11.x, then the IoTDB will upgrade data file format automatically. - * __NOTICE: V0.11 changes many settings in conf/iotdb-engine.properties, so do not use v0.10's - configuration file directly.__ + - **NOTICE: V0.11 changes many settings in conf/iotdb-engine.properties, so do not use v0.10's + configuration file directly.** - How to upgrade from v0.9.x to v0.10.x? - * Upgrading from v0.9 to v0.10 is more complex than v0.8 to v0.9. - * **Stop writing new data.** - * Call `flush` command using sbin/start-client.sh in v0.9 to close all TsFiles. - * We recommend to backup the data file (also the wal files and mlog.txt) before upgrading for rolling back. - * Just download, unzip v0.10.x.zip, and modify conf/iotdb-engine.proeprties to let all the - directories point to the folders set in v0.9.x (or the backup folder). - You can also modify other settings if you want. - * Stop IoTDB v0.9 instance, and start v0.10.x, then the IoTDB will upgrade data file format automatically. -- How to upgrade from 0.8.x to v0.9.x? - * We recommend to backup the data file (also the wal files and mlog.txt) before upgrading for rolling back. - * Just download, unzip v0.9.x.zip, and modify conf/iotdb-engine.properties to let all the - directories point to the folders set in v0.8.x (or the backup folder). - You can also modify other settings if you want. - * Stop IoTDB v0.8 instance, and start v0.9.x, then the IoTDB will upgrade data file format automatically. + - Upgrading from v0.9 to v0.10 is more complex than v0.8 to v0.9. + - **Stop writing new data.** + - Call `flush` command using sbin/start-client.sh in v0.9 to close all TsFiles. + - We recommend to backup the data file (also the wal files and mlog.txt) before upgrading for rolling back. + - Just download, unzip v0.10.x.zip, and modify conf/iotdb-engine.proeprties to let all the + directories point to the folders set in v0.9.x (or the backup folder). + You can also modify other settings if you want. + - Stop IoTDB v0.9 instance, and start v0.10.x, then the IoTDB will upgrade data file format automatically. +- How to upgrade from 0.8.x to v0.9.x? + - We recommend to backup the data file (also the wal files and mlog.txt) before upgrading for rolling back. + - Just download, unzip v0.9.x.zip, and modify conf/iotdb-engine.properties to let all the + directories point to the folders set in v0.8.x (or the backup folder). + You can also modify other settings if you want. + - Stop IoTDB v0.8 instance, and start v0.9.x, then the IoTDB will upgrade data file format automatically. -​ +​ # All releases Find all releases in the [Archive repository](https://archive.apache.org/dist/iotdb/). - - # Verifying Hashes and Signatures -Along with our releases, we also provide sha512 hashes in *.sha512 files and cryptographic signatures in *.asc files. The Apache Software Foundation has an extensive tutorial to [verify hashes and signatures ](http://www.apache.org/info/verification.html)which you can follow by using any of these release-signing [KEYS ](https://downloads.apache.org/iotdb/KEYS). +Along with our releases, we also provide sha512 hashes in _.sha512 files and cryptographic signatures in _.asc files. The Apache Software Foundation has an extensive tutorial to [verify hashes and signatures ](http://www.apache.org/info/verification.html)which you can follow by using any of these release-signing [KEYS ](https://downloads.apache.org/iotdb/KEYS). diff --git a/src/README.md b/src/README.md index a08f82df..1b9fe14e 100644 --- a/src/README.md +++ b/src/README.md @@ -1,6 +1,41 @@ --- home: true +heroText: Apache IoTDB +heroImage: /img/logo.svg +tagline: Database for Internet of Things +actions: + - text: Download + link: ./Download/ + type: primary + + - text: Quick Start + link: ./UserGuide/latest/QuickStart/QuickStart_apache.html + +highlights: + - header: Introduction + description: Apache IoTDB (Database for Internet of Things) is an IoT native database with high performance for data management and analysis, deployable on the edge and the cloud. Due to its light-weight architecture, high performance and rich feature set together with its deep integration with Apache Hadoop, Spark and Flink, Apache IoTDB can meet the requirements of massive data storage, high-speed data ingestion and complex data analysis in the IoT industrial fields. + + - header: Main Features + features: + - title: High-throughput read and write + details: Apache IoTDB can support high-speed write access for millions of low-power and intelligently networked devices. It also provides lightning read access for retrieving data. + + - title: Efficient directory structure + details: Apache IoTDB can efficiently organize complex data structure from IoT devices and large size of timeseries data with fuzzy searching strategy for complex directory of timeseries data. + + - title: Rich query semantics + details: Apache IoTDB can support time alignment for timeseries data across devices and sensors, computation in timeseries field and abundant aggregation functions in time dimension. + + - title: Low cost on hardware + details: Apache IoTDB can reach a high compression ratio of disk storage (it costs less than $0.23 to store 1GB of data on hard disk). + + - title: Flexible deployment + details: Apache IoTDB can provide users one-click installation on the cloud, terminal tool on desktop and the bridge tool between cloud platform and on premise machine (Data Synchronization Tool). + + - title: Intense integration with Open Source Ecosystem + details: Apache IoTDB can support analysis ecosystems, for example, Hadoop, Spark, Flink and Grafana (visualization tool). --- + - + + + diff --git a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md index 59a380db..c449b646 100644 --- a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md +++ b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # Database Resources ## CPU + @@ -77,10 +78,12 @@ +
Number of timeseries (frequency<=1HZ) CPUOver 10000000 Please contact Timecho Business for consultation
## Memory + @@ -137,12 +140,14 @@ +
Number of timeseries (frequency<=1HZ) MemoryOver 10000000 Please contact Timecho Business for consultation
## Storage (Disk) ### Storage space Calculation formula: Number of measurement points * Sampling frequency (Hz) * Size of each data point (Byte, different data types may vary, see table below) * Storage time (seconds) * Number of copies (usually 1 copy for a single node and 2 copies for a cluster) ÷ Compression ratio (can be estimated at 5-10 times, but may be higher in actual situations) + @@ -177,6 +182,7 @@ Calculation formula: Number of measurement points * Sampling frequency (Hz) * Si +
Data point size calculation
The average is a 8+a
Example: 1000 devices, each with 100 measurement points, a total of 100000 sequences, INT32 type. Sampling frequency 1Hz (once per second), storage for 1 year, 3 copies. diff --git a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md index 539d03b0..5599d149 100644 --- a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md @@ -80,7 +80,8 @@ IoTDB supports operating systems such as Linux, Windows, and MacOS, while the en - Each disk group corresponds to only one partition. Data disks (with multiple disk groups, corresponding to raid) do not need additional partitions. All space is used by the IoTDB. The following table lists the recommended disk partitioning methods. - + + @@ -115,6 +116,7 @@ The following table lists the recommended disk partitioning methods. +
Disk classification Disk set Drive
......
### Network Configuration diff --git a/src/UserGuide/Master/Tree/API/Programming-Cpp-Native-API.md b/src/UserGuide/Master/Tree/API/Programming-Cpp-Native-API.md index 83f024d8..b462983d 100644 --- a/src/UserGuide/Master/Tree/API/Programming-Cpp-Native-API.md +++ b/src/UserGuide/Master/Tree/API/Programming-Cpp-Native-API.md @@ -119,12 +119,12 @@ Run Maven to compile in the IoTDB root directory: ``` - Windows using Visual Studio 2022 - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp ``` - Windows using Visual Studio 2019 - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator="Visual Studio 16 2019" -Diotdb-tools-thrift.version=0.14.1.1-msvc142-SNAPSHOT ``` - If you haven't added the Boost library path to the PATH environment variable, you need to add the relevant parameters to the compile command, e.g., `-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"`. diff --git a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Database-Resources.md b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Database-Resources.md index 59a380db..c449b646 100644 --- a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Database-Resources.md +++ b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # Database Resources ## CPU + @@ -77,10 +78,12 @@ +
Number of timeseries (frequency<=1HZ) CPUOver 10000000 Please contact Timecho Business for consultation
## Memory + @@ -137,12 +140,14 @@ +
Number of timeseries (frequency<=1HZ) MemoryOver 10000000 Please contact Timecho Business for consultation
## Storage (Disk) ### Storage space Calculation formula: Number of measurement points * Sampling frequency (Hz) * Size of each data point (Byte, different data types may vary, see table below) * Storage time (seconds) * Number of copies (usually 1 copy for a single node and 2 copies for a cluster) ÷ Compression ratio (can be estimated at 5-10 times, but may be higher in actual situations) + @@ -177,6 +182,7 @@ Calculation formula: Number of measurement points * Sampling frequency (Hz) * Si +
Data point size calculation
The average is a 8+a
Example: 1000 devices, each with 100 measurement points, a total of 100000 sequences, INT32 type. Sampling frequency 1Hz (once per second), storage for 1 year, 3 copies. diff --git a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md index d2b6ff06..abe20eb9 100644 --- a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md @@ -80,7 +80,8 @@ IoTDB supports operating systems such as Linux, Windows, and MacOS, while the en - Each disk group corresponds to only one partition. Data disks (with multiple disk groups, corresponding to raid) do not need additional partitions. All space is used by the IoTDB. The following table lists the recommended disk partitioning methods. - + + @@ -115,6 +116,7 @@ The following table lists the recommended disk partitioning methods. +
Disk classification Disk set Drive
......
### Network Configuration diff --git a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md index a99a70bc..f618a58a 100644 --- a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md +++ b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md @@ -45,7 +45,8 @@ The visualization console is one of the supporting tools for IoTDB (similar to N 1. Open the monitoring configuration item. The configuration items related to monitoring in IoTDB are disabled by default. Before deploying the monitoring panel, you need to open the relevant configuration items (note that the service needs to be restarted after enabling monitoring configuration). - + + @@ -93,7 +94,8 @@ The visualization console is one of the supporting tools for IoTDB (similar to N -
Configuration Located in the configuration file Descriptionaudit_log_operation Please add this configuration item in the configuration file, with values set to DML,DDL,QUERY
+ + 2. Restart all nodes. After modifying the monitoring indicator configuration of three nodes, the confignode and datanode services of all nodes can be restarted: diff --git a/src/UserGuide/Master/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md b/src/UserGuide/Master/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md index c2d3784d..5d9402db 100644 --- a/src/UserGuide/Master/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md +++ b/src/UserGuide/Master/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md @@ -80,7 +80,8 @@ Step 5: Select `IoTDB` and fill in the configuration information The configuration content is as follows: - + + @@ -151,6 +152,7 @@ The configuration content is as follows: +
Name Description Default ValueJust keep it as default
diff --git a/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md index f4866314..4dce11e4 100644 --- a/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -83,8 +83,8 @@ Building on the open-source version, TimechoDB offers a range of advanced produc The detailed functional comparison is as follows： - - + + @@ -208,6 +208,7 @@ The detailed functional comparison is as follows： +
Function
Function Apache IoTDB TimechoDB
× √
### More efficient/stable product performance diff --git a/src/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md b/src/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md index f03c3a5b..e6a94501 100644 --- a/src/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md +++ b/src/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md @@ -5,8 +5,8 @@ IoTDB currently supports importing data in CSV, SQL, and TsFile (IoTDB's underlying open-time series file format) into the database. The specific functionalities are as follows: - - + + @@ -29,6 +29,7 @@ IoTDB currently supports importing data in CSV, SQL, and TsFile (IoTDB's underly +
File Format
File Format IoTDB Tool Description
TsFile Active Listening & Loading Feature According to user configuration, it listens for changes in TsFile files in the specified path and loads newly added TsFile files into IoTDB
## 2. import-data Scripts diff --git a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md index 16e58170..4a9476b0 100644 --- a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md @@ -38,8 +38,8 @@ A data synchronization task consists of three stages: By declaratively configuring the specific content of the three parts through SQL statements, flexible data synchronization capabilities can be achieved. Currently, data synchronization supports the synchronization of the following information, and you can select the synchronization scope when creating a synchronization task (the default is data.insert, which means synchronizing newly written data): - - + + @@ -74,6 +74,7 @@ By declaratively configuring the specific content of the three parts through SQL +
Synchronization Scope
Synchronization Scope Synchronization Content Description
- Synchronize user permissions and access control
### Functional limitations and instructions @@ -213,8 +214,8 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param - - + + @@ -251,6 +252,7 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param +
Type
Type Custom Plugin Plugin Name DescriptionUsed for data transfer between IoTDB ( V1.3.1+ ) and IoTDB ( V1.2.0+ ). It uses the Thrift RPC framework to transfer data, with a single-threaded sync blocking IO model, suitable for scenarios with higher security requirements 1.3.1+
For importing custom plugins, please refer to the [Stream Processing](./Streaming_timecho.md#custom-stream-processing-plugin-management) section. diff --git a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md index d7084b4f..bc01b10d 100644 --- a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md +++ b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md @@ -38,8 +38,8 @@ A data synchronization task consists of three stages: By declaratively configuring the specific content of the three parts through SQL statements, flexible data synchronization capabilities can be achieved. Currently, data synchronization supports the synchronization of the following information, and you can select the synchronization scope when creating a synchronization task (the default is data.insert, which means synchronizing newly written data): - - + + @@ -74,6 +74,7 @@ By declaratively configuring the specific content of the three parts through SQL +
Synchronization Scope
Synchronization Scope Synchronization Content Description
- Synchronize user permissions and access control
### Functional limitations and instructions @@ -216,8 +217,8 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param - - + + @@ -259,6 +260,7 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param +
Type
Type Custom Plugin Plugin Name DescriptionUsed for data transfer between IoTDB ( V1.3.1+ ) and IoTDB ( V1.2.0+ ). It uses the Thrift RPC framework to transfer data, with a single-threaded sync blocking IO model, suitable for scenarios with higher security requirements 1.3.1+
For importing custom plugins, please refer to the [Stream Processing](./Streaming_timecho.md#custom-stream-processing-plugin-management) section. diff --git a/src/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md b/src/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md index 2bf1553c..72325f08 100644 --- a/src/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md +++ b/src/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md @@ -7,8 +7,8 @@ UDF (User Defined Function) refers to user-defined functions. IoTDB provides a v In IoTDB, you can expand two types of UDF: - - + + @@ -26,6 +26,7 @@ In IoTDB, you can expand two types of UDF: +
UDF Class
UDF Class AccessStrategy Description
- Custom aggregation function, input k columns of time series m rows of data, output 1 column of time series 1 row of data, can be used in any clause and expression that appears in the aggregation function, such as select clause, having clause, etc.
### 1.1 UDF usage diff --git a/src/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md b/src/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md index fcbae4cc..2b91554b 100644 --- a/src/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md +++ b/src/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md @@ -7,8 +7,8 @@ UDF (User Defined Function) refers to user-defined functions. IoTDB provides a v In IoTDB, you can expand two types of UDF: - - + + @@ -26,6 +26,7 @@ In IoTDB, you can expand two types of UDF: +
UDF Class
UDF Class AccessStrategy Description
- Custom aggregation function, input k columns of time series m rows of data, output 1 column of time series 1 row of data, can be used in any clause and expression that appears in the aggregation function, such as select clause, having clause, etc.
### 1.1 UDF usage diff --git a/src/UserGuide/V0.13.x/API/Programming-Go-Native-API.md b/src/UserGuide/V0.13.x/API/Programming-Go-Native-API.md index 507d1478..f4437a73 100644 --- a/src/UserGuide/V0.13.x/API/Programming-Go-Native-API.md +++ b/src/UserGuide/V0.13.x/API/Programming-Go-Native-API.md @@ -70,7 +70,7 @@ The PutBack method must be called after use #### New sessionPool -```golang +```go config := &client.PoolConfig{ Host: host, Port: port, @@ -84,7 +84,7 @@ sessionPool = client.NewSessionPool(config, 3, 60000, 60000, false) set storage group -```golang +```go session, err := sessionPool.GetSession() defer sessionPool.PutBack(session) if err == nil { @@ -94,7 +94,7 @@ if err == nil { query statement -```golang +```go var timeout int64 = 1000 session, err := sessionPool.GetSession() defer sessionPool.PutBack(session) diff --git a/src/UserGuide/V0.13.x/Process-Data/Triggers.md b/src/UserGuide/V0.13.x/Process-Data/Triggers.md index 425fa0b3..0d9a09db 100644 --- a/src/UserGuide/V0.13.x/Process-Data/Triggers.md +++ b/src/UserGuide/V0.13.x/Process-Data/Triggers.md @@ -588,10 +588,7 @@ AlertManagerEvent(String alertname, Map extraLabels, Map}} - ``` +* `annotations` is optional, and its value can use Go style template `{{.}}` It will be replaced with `labels[]` when the message is finally generated. * `labels` and `annotations` will be parsed into json string and sent to `AlertManager`: ```json diff --git a/src/UserGuide/V1.3.0-2/API/Programming-Cpp-Native-API.md b/src/UserGuide/V1.3.0-2/API/Programming-Cpp-Native-API.md index 83f024d8..b462983d 100644 --- a/src/UserGuide/V1.3.0-2/API/Programming-Cpp-Native-API.md +++ b/src/UserGuide/V1.3.0-2/API/Programming-Cpp-Native-API.md @@ -119,12 +119,12 @@ Run Maven to compile in the IoTDB root directory: ``` - Windows using Visual Studio 2022 - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp ``` - Windows using Visual Studio 2019 - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator="Visual Studio 16 2019" -Diotdb-tools-thrift.version=0.14.1.1-msvc142-SNAPSHOT ``` - If you haven't added the Boost library path to the PATH environment variable, you need to add the relevant parameters to the compile command, e.g., `-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"`. diff --git a/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Database-Resources.md b/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Database-Resources.md index 59a380db..0cdfbda7 100644 --- a/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Database-Resources.md +++ b/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Database-Resources.md @@ -20,163 +20,172 @@ --> # Database Resources ## CPU - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
Number of timeseries (frequency<=1HZ)CPUNumber of nodes
standalone modeDouble activeDistributed
Within 1000002core-4core123
Within 3000004core-8core123
Within 5000008core-26core123
Within 100000016core-32core123
Within 200000032core-48core123
Within 1000000048core12Please contact Timecho Business for consultation
Over 10000000Please contact Timecho Business for consultation
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Number of timeseries (frequency<=1HZ)CPUNumber of nodes
standalone modeDouble activeDistributed
Within 1000002core-4core123
Within 3000004core-8core123
Within 5000008core-26core123
Within 100000016core-32core123
Within 200000032core-48core123
Within 1000000048core12Please contact Timecho Business for consultation
Over 10000000Please contact Timecho Business for consultation
-## Memory - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +## Memory + +
Number of timeseries (frequency<=1HZ)MemoryNumber of nodes
standalone modeDouble activeDistributed
Within 1000004G-8G123
Within 30000012G-32G123
Within 50000024G-48G123
Within 100000032G-96G123
Within 200000064G-128G123
Within 10000000128G12Please contact Timecho Business for consultation
Over 10000000Please contact Timecho Business for consultation
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Number of timeseries (frequency<=1HZ)MemoryNumber of nodes
standalone modeDouble activeDistributed
Within 1000004G-8G123
Within 30000012G-32G123
Within 50000024G-48G123
Within 100000032G-96G123
Within 200000064G-128G123
Within 10000000128G12Please contact Timecho Business for consultation
Over 10000000Please contact Timecho Business for consultation
+ ## Storage (Disk) ### Storage space Calculation formula: Number of measurement points * Sampling frequency (Hz) * Size of each data point (Byte, different data types may vary, see table below) * Storage time (seconds) * Number of copies (usually 1 copy for a single node and 2 copies for a cluster) ÷ Compression ratio (can be estimated at 5-10 times, but may be higher in actual situations) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
Data point size calculation
data typeTimestamp (Bytes) Value (Bytes) Total size of data points (in bytes) -
Boolean819
INT32/FLOAT8412
INT64/DOUBLE8816
TEXT8The average is a8+a
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Data point size calculation
data typeTimestamp (Bytes)Value (Bytes)Total size of data points (in bytes)
Boolean819
INT32/FLOAT8412
INT64/DOUBLE8816
TEXT8The average is a8+a
Example: 1000 devices, each with 100 measurement points, a total of 100000 sequences, INT32 type. Sampling frequency 1Hz (once per second), storage for 1 year, 3 copies. diff --git a/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Environment-Requirements.md b/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Environment-Requirements.md index d2b6ff06..abe20eb9 100644 --- a/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Environment-Requirements.md @@ -80,7 +80,8 @@ IoTDB supports operating systems such as Linux, Windows, and MacOS, while the en - Each disk group corresponds to only one partition. Data disks (with multiple disk groups, corresponding to raid) do not need additional partitions. All space is used by the IoTDB. The following table lists the recommended disk partitioning methods. - + + @@ -115,6 +116,7 @@ The following table lists the recommended disk partitioning methods. +
Disk classification Disk set Drive
......
### Network Configuration diff --git a/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/workbench-deployment_timecho.md b/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/workbench-deployment_timecho.md index 5eefb6c9..6aab0e19 100644 --- a/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/workbench-deployment_timecho.md +++ b/src/UserGuide/V1.3.0-2/Deployment-and-Maintenance/workbench-deployment_timecho.md @@ -45,7 +45,8 @@ The visualization console is one of the supporting tools for IoTDB (similar to N 1. Open the monitoring configuration item. The configuration items related to monitoring in IoTDB are disabled by default. Before deploying the monitoring panel, you need to open the relevant configuration items (note that the service needs to be restarted after enabling monitoring configuration). - + + @@ -93,7 +94,8 @@ The visualization console is one of the supporting tools for IoTDB (similar to N -
Configuration Located in the configuration file Descriptionaudit_log_operation Uncomment configuration items
+ + 2. Restart all nodes. After modifying the monitoring indicator configuration of three nodes, the confignode and datanode services of all nodes can be restarted: diff --git a/src/UserGuide/V1.3.0-2/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md b/src/UserGuide/V1.3.0-2/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md index c2d3784d..5d9402db 100644 --- a/src/UserGuide/V1.3.0-2/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md +++ b/src/UserGuide/V1.3.0-2/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md @@ -80,7 +80,8 @@ Step 5: Select `IoTDB` and fill in the configuration information The configuration content is as follows: - + + @@ -151,6 +152,7 @@ The configuration content is as follows: +
Name Description Default ValueJust keep it as default
diff --git a/src/UserGuide/V1.3.0-2/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/UserGuide/V1.3.0-2/IoTDB-Introduction/IoTDB-Introduction_timecho.md index f4866314..4dce11e4 100644 --- a/src/UserGuide/V1.3.0-2/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/UserGuide/V1.3.0-2/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -83,8 +83,8 @@ Building on the open-source version, TimechoDB offers a range of advanced produc The detailed functional comparison is as follows： - - + + @@ -208,6 +208,7 @@ The detailed functional comparison is as follows： +
Function
Function Apache IoTDB TimechoDB
× √
### More efficient/stable product performance diff --git a/src/UserGuide/V1.3.0-2/User-Manual/Data-Sync_apache.md b/src/UserGuide/V1.3.0-2/User-Manual/Data-Sync_apache.md index 8bfd5e39..0913f71e 100644 --- a/src/UserGuide/V1.3.0-2/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/V1.3.0-2/User-Manual/Data-Sync_apache.md @@ -38,8 +38,8 @@ A data synchronization task consists of three stages: By declaratively configuring the specific content of the three parts through SQL statements, flexible data synchronization capabilities can be achieved. Currently, data synchronization supports the synchronization of the following information, and you can select the synchronization scope when creating a synchronization task (the default is data.insert, which means synchronizing newly written data): - - + + @@ -74,6 +74,7 @@ By declaratively configuring the specific content of the three parts through SQL +
Synchronization Scope
Synchronization Scope Synchronization Content Description
- Synchronize user permissions and access control
### Functional limitations and instructions @@ -221,8 +222,8 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param - - + + @@ -259,6 +260,7 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param +
Type
Type Custom Plugin Plugin Name DescriptionUsed for data transfer between IoTDB ( V1.3.1+ ) and IoTDB ( V1.2.0+ ). It uses the Thrift RPC framework to transfer data, with a single-threaded sync blocking IO model, suitable for scenarios with higher security requirements 1.3.1+
For importing custom plugins, please refer to the [Stream Processing](./Streaming_timecho.md#custom-stream-processing-plugin-management) section. diff --git a/src/UserGuide/V1.3.0-2/User-Manual/Data-Sync_timecho.md b/src/UserGuide/V1.3.0-2/User-Manual/Data-Sync_timecho.md index 81c1aeac..d0afbbe1 100644 --- a/src/UserGuide/V1.3.0-2/User-Manual/Data-Sync_timecho.md +++ b/src/UserGuide/V1.3.0-2/User-Manual/Data-Sync_timecho.md @@ -38,8 +38,8 @@ A data synchronization task consists of three stages: By declaratively configuring the specific content of the three parts through SQL statements, flexible data synchronization capabilities can be achieved. Currently, data synchronization supports the synchronization of the following information, and you can select the synchronization scope when creating a synchronization task (the default is data.insert, which means synchronizing newly written data): - - + + @@ -74,6 +74,7 @@ By declaratively configuring the specific content of the three parts through SQL +
Synchronization Scope
Synchronization Scope Synchronization Content Description
- Synchronize user permissions and access control
### Functional limitations and instructions @@ -219,8 +220,8 @@ IoTDB> SHOW PIPEPLUGINS Detailed introduction of pre-installed plugins is as follows (for detailed parameters of each plugin, please refer to the [Parameter Description](#reference-parameter-description) section): - - + + @@ -262,6 +263,7 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param +
Type
Type Custom Plugin Plugin Name DescriptionUsed for data transfer between IoTDB ( V1.3.1+ ) and IoTDB ( V1.2.0+ ). It uses the Thrift RPC framework to transfer data, with a single-threaded sync blocking IO model, suitable for scenarios with higher security requirements 1.3.1+
For importing custom plugins, please refer to the [Stream Processing](./Streaming_timecho.md#custom-stream-processing-plugin-management) section. diff --git a/src/UserGuide/V1.3.0-2/User-Manual/User-defined-function.md b/src/UserGuide/V1.3.0-2/User-Manual/User-defined-function.md index ed544c95..4f03857d 100644 --- a/src/UserGuide/V1.3.0-2/User-Manual/User-defined-function.md +++ b/src/UserGuide/V1.3.0-2/User-Manual/User-defined-function.md @@ -7,8 +7,8 @@ UDF (User Defined Function) refers to user-defined functions. IoTDB provides a v In IoTDB, you can expand two types of UDF: - - + + @@ -26,6 +26,7 @@ In IoTDB, you can expand two types of UDF: +
UDF Class
UDF Class AccessStrategy Description
- Custom aggregation function, input k columns of time series m rows of data, output 1 column of time series 1 row of data, can be used in any clause and expression that appears in the aggregation function, such as select clause, having clause, etc.
### 1.1 UDF usage diff --git a/src/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Database-Resources.md b/src/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Database-Resources.md index 59a380db..c449b646 100644 --- a/src/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Database-Resources.md +++ b/src/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # Database Resources ## CPU + @@ -77,10 +78,12 @@ +
Number of timeseries (frequency<=1HZ) CPUOver 10000000 Please contact Timecho Business for consultation
## Memory + @@ -137,12 +140,14 @@ +
Number of timeseries (frequency<=1HZ) MemoryOver 10000000 Please contact Timecho Business for consultation
## Storage (Disk) ### Storage space Calculation formula: Number of measurement points * Sampling frequency (Hz) * Size of each data point (Byte, different data types may vary, see table below) * Storage time (seconds) * Number of copies (usually 1 copy for a single node and 2 copies for a cluster) ÷ Compression ratio (can be estimated at 5-10 times, but may be higher in actual situations) + @@ -177,6 +182,7 @@ Calculation formula: Number of measurement points * Sampling frequency (Hz) * Si +
Data point size calculation
The average is a 8+a
Example: 1000 devices, each with 100 measurement points, a total of 100000 sequences, INT32 type. Sampling frequency 1Hz (once per second), storage for 1 year, 3 copies. diff --git a/src/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Environment-Requirements.md b/src/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Environment-Requirements.md index 539d03b0..5599d149 100644 --- a/src/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Environment-Requirements.md @@ -80,7 +80,8 @@ IoTDB supports operating systems such as Linux, Windows, and MacOS, while the en - Each disk group corresponds to only one partition. Data disks (with multiple disk groups, corresponding to raid) do not need additional partitions. All space is used by the IoTDB. The following table lists the recommended disk partitioning methods. - + + @@ -115,6 +116,7 @@ The following table lists the recommended disk partitioning methods. +
Disk classification Disk set Drive
......
### Network Configuration diff --git a/src/UserGuide/V2.0.1/Tree/API/Programming-Cpp-Native-API.md b/src/UserGuide/V2.0.1/Tree/API/Programming-Cpp-Native-API.md index 83f024d8..b462983d 100644 --- a/src/UserGuide/V2.0.1/Tree/API/Programming-Cpp-Native-API.md +++ b/src/UserGuide/V2.0.1/Tree/API/Programming-Cpp-Native-API.md @@ -119,12 +119,12 @@ Run Maven to compile in the IoTDB root directory: ``` - Windows using Visual Studio 2022 - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp ``` - Windows using Visual Studio 2019 - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator="Visual Studio 16 2019" -Diotdb-tools-thrift.version=0.14.1.1-msvc142-SNAPSHOT ``` - If you haven't added the Boost library path to the PATH environment variable, you need to add the relevant parameters to the compile command, e.g., `-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"`. diff --git a/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Database-Resources.md b/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Database-Resources.md index 59a380db..c449b646 100644 --- a/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Database-Resources.md +++ b/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # Database Resources ## CPU + @@ -77,10 +78,12 @@ +
Number of timeseries (frequency<=1HZ) CPUOver 10000000 Please contact Timecho Business for consultation
## Memory + @@ -137,12 +140,14 @@ +
Number of timeseries (frequency<=1HZ) MemoryOver 10000000 Please contact Timecho Business for consultation
## Storage (Disk) ### Storage space Calculation formula: Number of measurement points * Sampling frequency (Hz) * Size of each data point (Byte, different data types may vary, see table below) * Storage time (seconds) * Number of copies (usually 1 copy for a single node and 2 copies for a cluster) ÷ Compression ratio (can be estimated at 5-10 times, but may be higher in actual situations) + @@ -177,6 +182,7 @@ Calculation formula: Number of measurement points * Sampling frequency (Hz) * Si +
Data point size calculation
The average is a 8+a
Example: 1000 devices, each with 100 measurement points, a total of 100000 sequences, INT32 type. Sampling frequency 1Hz (once per second), storage for 1 year, 3 copies. diff --git a/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Environment-Requirements.md b/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Environment-Requirements.md index a1b54472..916c3331 100644 --- a/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Environment-Requirements.md @@ -80,7 +80,8 @@ IoTDB supports operating systems such as Linux, Windows, and MacOS, while the en - Each disk group corresponds to only one partition. Data disks (with multiple disk groups, corresponding to raid) do not need additional partitions. All space is used by the IoTDB. The following table lists the recommended disk partitioning methods. - + + @@ -115,6 +116,7 @@ The following table lists the recommended disk partitioning methods. +
Disk classification Disk set Drive
......
### Network Configuration diff --git a/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md b/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md index a99a70bc..f618a58a 100644 --- a/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md +++ b/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md @@ -45,7 +45,8 @@ The visualization console is one of the supporting tools for IoTDB (similar to N 1. Open the monitoring configuration item. The configuration items related to monitoring in IoTDB are disabled by default. Before deploying the monitoring panel, you need to open the relevant configuration items (note that the service needs to be restarted after enabling monitoring configuration). - + + @@ -93,7 +94,8 @@ The visualization console is one of the supporting tools for IoTDB (similar to N -
Configuration Located in the configuration file Descriptionaudit_log_operation Please add this configuration item in the configuration file, with values set to DML,DDL,QUERY
+ + 2. Restart all nodes. After modifying the monitoring indicator configuration of three nodes, the confignode and datanode services of all nodes can be restarted: diff --git a/src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md b/src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md index c2d3784d..5d9402db 100644 --- a/src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md +++ b/src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md @@ -80,7 +80,8 @@ Step 5: Select `IoTDB` and fill in the configuration information The configuration content is as follows: - + + @@ -151,6 +152,7 @@ The configuration content is as follows: +
Name Description Default ValueJust keep it as default
diff --git a/src/UserGuide/V2.0.1/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/UserGuide/V2.0.1/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md index f4866314..4dce11e4 100644 --- a/src/UserGuide/V2.0.1/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/UserGuide/V2.0.1/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -83,8 +83,8 @@ Building on the open-source version, TimechoDB offers a range of advanced produc The detailed functional comparison is as follows： - - + + @@ -208,6 +208,7 @@ The detailed functional comparison is as follows： +
Function
Function Apache IoTDB TimechoDB
× √
### More efficient/stable product performance diff --git a/src/UserGuide/V2.0.1/Tree/Tools-System/Data-Import-Tool.md b/src/UserGuide/V2.0.1/Tree/Tools-System/Data-Import-Tool.md index f03c3a5b..e6a94501 100644 --- a/src/UserGuide/V2.0.1/Tree/Tools-System/Data-Import-Tool.md +++ b/src/UserGuide/V2.0.1/Tree/Tools-System/Data-Import-Tool.md @@ -5,8 +5,8 @@ IoTDB currently supports importing data in CSV, SQL, and TsFile (IoTDB's underlying open-time series file format) into the database. The specific functionalities are as follows: - - + + @@ -29,6 +29,7 @@ IoTDB currently supports importing data in CSV, SQL, and TsFile (IoTDB's underly +
File Format
File Format IoTDB Tool Description
TsFile Active Listening & Loading Feature According to user configuration, it listens for changes in TsFile files in the specified path and loads newly added TsFile files into IoTDB
## 2. import-data Scripts diff --git a/src/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_apache.md b/src/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_apache.md index 16e58170..4a9476b0 100644 --- a/src/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_apache.md @@ -38,8 +38,8 @@ A data synchronization task consists of three stages: By declaratively configuring the specific content of the three parts through SQL statements, flexible data synchronization capabilities can be achieved. Currently, data synchronization supports the synchronization of the following information, and you can select the synchronization scope when creating a synchronization task (the default is data.insert, which means synchronizing newly written data): - - + + @@ -74,6 +74,7 @@ By declaratively configuring the specific content of the three parts through SQL +
Synchronization Scope
Synchronization Scope Synchronization Content Description
- Synchronize user permissions and access control
### Functional limitations and instructions @@ -213,8 +214,8 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param - - + + @@ -251,6 +252,7 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param +
Type
Type Custom Plugin Plugin Name DescriptionUsed for data transfer between IoTDB ( V1.3.1+ ) and IoTDB ( V1.2.0+ ). It uses the Thrift RPC framework to transfer data, with a single-threaded sync blocking IO model, suitable for scenarios with higher security requirements 1.3.1+
For importing custom plugins, please refer to the [Stream Processing](./Streaming_timecho.md#custom-stream-processing-plugin-management) section. diff --git a/src/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_timecho.md b/src/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_timecho.md index d7084b4f..bc01b10d 100644 --- a/src/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_timecho.md +++ b/src/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_timecho.md @@ -38,8 +38,8 @@ A data synchronization task consists of three stages: By declaratively configuring the specific content of the three parts through SQL statements, flexible data synchronization capabilities can be achieved. Currently, data synchronization supports the synchronization of the following information, and you can select the synchronization scope when creating a synchronization task (the default is data.insert, which means synchronizing newly written data): - - + + @@ -74,6 +74,7 @@ By declaratively configuring the specific content of the three parts through SQL +
Synchronization Scope
Synchronization Scope Synchronization Content Description
- Synchronize user permissions and access control
### Functional limitations and instructions @@ -216,8 +217,8 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param - - + + @@ -259,6 +260,7 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param +
Type
Type Custom Plugin Plugin Name DescriptionUsed for data transfer between IoTDB ( V1.3.1+ ) and IoTDB ( V1.2.0+ ). It uses the Thrift RPC framework to transfer data, with a single-threaded sync blocking IO model, suitable for scenarios with higher security requirements 1.3.1+
For importing custom plugins, please refer to the [Stream Processing](./Streaming_timecho.md#custom-stream-processing-plugin-management) section. diff --git a/src/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_apache.md b/src/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_apache.md index 2bf1553c..72325f08 100644 --- a/src/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_apache.md +++ b/src/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_apache.md @@ -7,8 +7,8 @@ UDF (User Defined Function) refers to user-defined functions. IoTDB provides a v In IoTDB, you can expand two types of UDF: - - + + @@ -26,6 +26,7 @@ In IoTDB, you can expand two types of UDF: +
UDF Class
UDF Class AccessStrategy Description
- Custom aggregation function, input k columns of time series m rows of data, output 1 column of time series 1 row of data, can be used in any clause and expression that appears in the aggregation function, such as select clause, having clause, etc.
### 1.1 UDF usage diff --git a/src/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_timecho.md b/src/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_timecho.md index fcbae4cc..2b91554b 100644 --- a/src/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_timecho.md +++ b/src/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_timecho.md @@ -7,8 +7,8 @@ UDF (User Defined Function) refers to user-defined functions. IoTDB provides a v In IoTDB, you can expand two types of UDF: - - + + @@ -26,6 +26,7 @@ In IoTDB, you can expand two types of UDF: +
UDF Class
UDF Class AccessStrategy Description
- Custom aggregation function, input k columns of time series m rows of data, output 1 column of time series 1 row of data, can be used in any clause and expression that appears in the aggregation function, such as select clause, having clause, etc.
### 1.1 UDF usage diff --git a/src/UserGuide/latest/API/Programming-Cpp-Native-API.md b/src/UserGuide/latest/API/Programming-Cpp-Native-API.md index 83f024d8..b462983d 100644 --- a/src/UserGuide/latest/API/Programming-Cpp-Native-API.md +++ b/src/UserGuide/latest/API/Programming-Cpp-Native-API.md @@ -119,12 +119,12 @@ Run Maven to compile in the IoTDB root directory: ``` - Windows using Visual Studio 2022 - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp ``` - Windows using Visual Studio 2019 - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator="Visual Studio 16 2019" -Diotdb-tools-thrift.version=0.14.1.1-msvc142-SNAPSHOT ``` - If you haven't added the Boost library path to the PATH environment variable, you need to add the relevant parameters to the compile command, e.g., `-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"`. diff --git a/src/UserGuide/latest/Deployment-and-Maintenance/Database-Resources.md b/src/UserGuide/latest/Deployment-and-Maintenance/Database-Resources.md index 59a380db..c449b646 100644 --- a/src/UserGuide/latest/Deployment-and-Maintenance/Database-Resources.md +++ b/src/UserGuide/latest/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # Database Resources ## CPU + @@ -77,10 +78,12 @@ +
Number of timeseries (frequency<=1HZ) CPUOver 10000000 Please contact Timecho Business for consultation
## Memory + @@ -137,12 +140,14 @@ +
Number of timeseries (frequency<=1HZ) MemoryOver 10000000 Please contact Timecho Business for consultation
## Storage (Disk) ### Storage space Calculation formula: Number of measurement points * Sampling frequency (Hz) * Size of each data point (Byte, different data types may vary, see table below) * Storage time (seconds) * Number of copies (usually 1 copy for a single node and 2 copies for a cluster) ÷ Compression ratio (can be estimated at 5-10 times, but may be higher in actual situations) + @@ -177,6 +182,7 @@ Calculation formula: Number of measurement points * Sampling frequency (Hz) * Si +
Data point size calculation
The average is a 8+a
Example: 1000 devices, each with 100 measurement points, a total of 100000 sequences, INT32 type. Sampling frequency 1Hz (once per second), storage for 1 year, 3 copies. diff --git a/src/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md b/src/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md index a1b54472..90eb66dd 100644 --- a/src/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md @@ -79,8 +79,10 @@ IoTDB supports operating systems such as Linux, Windows, and MacOS, while the en - The system disk needs only the space used by the operating system, and does not need to reserve space for the IoTDB. - Each disk group corresponds to only one partition. Data disks (with multiple disk groups, corresponding to raid) do not need additional partitions. All space is used by the IoTDB. The following table lists the recommended disk partitioning methods. + - + + @@ -115,7 +117,9 @@ The following table lists the recommended disk partitioning methods. +
Disk classification Disk set Drive
......
+ ### Network Configuration 1. Disable the firewall diff --git a/src/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment_timecho.md b/src/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment_timecho.md index a99a70bc..f618a58a 100644 --- a/src/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment_timecho.md +++ b/src/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment_timecho.md @@ -45,7 +45,8 @@ The visualization console is one of the supporting tools for IoTDB (similar to N 1. Open the monitoring configuration item. The configuration items related to monitoring in IoTDB are disabled by default. Before deploying the monitoring panel, you need to open the relevant configuration items (note that the service needs to be restarted after enabling monitoring configuration). - + + @@ -93,7 +94,8 @@ The visualization console is one of the supporting tools for IoTDB (similar to N -
Configuration Located in the configuration file Descriptionaudit_log_operation Please add this configuration item in the configuration file, with values set to DML,DDL,QUERY
+ + 2. Restart all nodes. After modifying the monitoring indicator configuration of three nodes, the confignode and datanode services of all nodes can be restarted: diff --git a/src/UserGuide/latest/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md b/src/UserGuide/latest/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md index c2d3784d..5d9402db 100644 --- a/src/UserGuide/latest/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md +++ b/src/UserGuide/latest/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md @@ -80,7 +80,8 @@ Step 5: Select `IoTDB` and fill in the configuration information The configuration content is as follows: - + + @@ -151,6 +152,7 @@ The configuration content is as follows: +
Name Description Default ValueJust keep it as default
diff --git a/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md index f4866314..4dce11e4 100644 --- a/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -83,8 +83,8 @@ Building on the open-source version, TimechoDB offers a range of advanced produc The detailed functional comparison is as follows： - - + + @@ -208,6 +208,7 @@ The detailed functional comparison is as follows： +
Function
Function Apache IoTDB TimechoDB
× √
### More efficient/stable product performance diff --git a/src/UserGuide/latest/Tools-System/Data-Import-Tool.md b/src/UserGuide/latest/Tools-System/Data-Import-Tool.md index f03c3a5b..e6a94501 100644 --- a/src/UserGuide/latest/Tools-System/Data-Import-Tool.md +++ b/src/UserGuide/latest/Tools-System/Data-Import-Tool.md @@ -5,8 +5,8 @@ IoTDB currently supports importing data in CSV, SQL, and TsFile (IoTDB's underlying open-time series file format) into the database. The specific functionalities are as follows: - - + + @@ -29,6 +29,7 @@ IoTDB currently supports importing data in CSV, SQL, and TsFile (IoTDB's underly +
File Format
File Format IoTDB Tool Description
TsFile Active Listening & Loading Feature According to user configuration, it listens for changes in TsFile files in the specified path and loads newly added TsFile files into IoTDB
## 2. import-data Scripts diff --git a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md index 16e58170..4a9476b0 100644 --- a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md @@ -38,8 +38,8 @@ A data synchronization task consists of three stages: By declaratively configuring the specific content of the three parts through SQL statements, flexible data synchronization capabilities can be achieved. Currently, data synchronization supports the synchronization of the following information, and you can select the synchronization scope when creating a synchronization task (the default is data.insert, which means synchronizing newly written data): - - + + @@ -74,6 +74,7 @@ By declaratively configuring the specific content of the three parts through SQL +
Synchronization Scope
Synchronization Scope Synchronization Content Description
- Synchronize user permissions and access control
### Functional limitations and instructions @@ -213,8 +214,8 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param - - + + @@ -251,6 +252,7 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param +
Type
Type Custom Plugin Plugin Name DescriptionUsed for data transfer between IoTDB ( V1.3.1+ ) and IoTDB ( V1.2.0+ ). It uses the Thrift RPC framework to transfer data, with a single-threaded sync blocking IO model, suitable for scenarios with higher security requirements 1.3.1+
For importing custom plugins, please refer to the [Stream Processing](./Streaming_timecho.md#custom-stream-processing-plugin-management) section. diff --git a/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md b/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md index d7084b4f..bc01b10d 100644 --- a/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md +++ b/src/UserGuide/latest/User-Manual/Data-Sync_timecho.md @@ -38,8 +38,8 @@ A data synchronization task consists of three stages: By declaratively configuring the specific content of the three parts through SQL statements, flexible data synchronization capabilities can be achieved. Currently, data synchronization supports the synchronization of the following information, and you can select the synchronization scope when creating a synchronization task (the default is data.insert, which means synchronizing newly written data): - - + + @@ -74,6 +74,7 @@ By declaratively configuring the specific content of the three parts through SQL +
Synchronization Scope
Synchronization Scope Synchronization Content Description
- Synchronize user permissions and access control
### Functional limitations and instructions @@ -216,8 +217,8 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param - - + + @@ -259,6 +260,7 @@ Detailed introduction of pre-installed plugins is as follows (for detailed param +
Type
Type Custom Plugin Plugin Name DescriptionUsed for data transfer between IoTDB ( V1.3.1+ ) and IoTDB ( V1.2.0+ ). It uses the Thrift RPC framework to transfer data, with a single-threaded sync blocking IO model, suitable for scenarios with higher security requirements 1.3.1+
For importing custom plugins, please refer to the [Stream Processing](./Streaming_timecho.md#custom-stream-processing-plugin-management) section. diff --git a/src/UserGuide/latest/User-Manual/User-defined-function_apache.md b/src/UserGuide/latest/User-Manual/User-defined-function_apache.md index 2bf1553c..72325f08 100644 --- a/src/UserGuide/latest/User-Manual/User-defined-function_apache.md +++ b/src/UserGuide/latest/User-Manual/User-defined-function_apache.md @@ -7,8 +7,8 @@ UDF (User Defined Function) refers to user-defined functions. IoTDB provides a v In IoTDB, you can expand two types of UDF: - - + + @@ -26,6 +26,7 @@ In IoTDB, you can expand two types of UDF: +
UDF Class
UDF Class AccessStrategy Description
- Custom aggregation function, input k columns of time series m rows of data, output 1 column of time series 1 row of data, can be used in any clause and expression that appears in the aggregation function, such as select clause, having clause, etc.
### 1.1 UDF usage diff --git a/src/UserGuide/latest/User-Manual/User-defined-function_timecho.md b/src/UserGuide/latest/User-Manual/User-defined-function_timecho.md index fcbae4cc..2b91554b 100644 --- a/src/UserGuide/latest/User-Manual/User-defined-function_timecho.md +++ b/src/UserGuide/latest/User-Manual/User-defined-function_timecho.md @@ -7,8 +7,8 @@ UDF (User Defined Function) refers to user-defined functions. IoTDB provides a v In IoTDB, you can expand two types of UDF: - - + + @@ -26,6 +26,7 @@ In IoTDB, you can expand two types of UDF: +
UDF Class
UDF Class AccessStrategy Description
- Custom aggregation function, input k columns of time series m rows of data, output 1 column of time series 1 row of data, can be used in any clause and expression that appears in the aggregation function, such as select clause, having clause, etc.
### 1.1 UDF usage diff --git a/src/zh/Community/Development-Guide.md b/src/zh/Community/Development-Guide.md index 011f7f45..667f0b87 100644 --- a/src/zh/Community/Development-Guide.md +++ b/src/zh/Community/Development-Guide.md @@ -439,7 +439,8 @@ Issue 的完整生命周期：创建 issue -> 认领 issue -> 提交 pr -> 审 * 将该文件拷贝到 thrift/target/tools/目录下 * 重新执行 maven 的编译命令 - 无法下载errorprone ： - ```Failed to read artifact descriptor for com.google.errorprone:javac + ``` + Failed to read artifact descriptor for com.google.errorprone:javac -shaded:jar:9+181-r4173-1: Could not transfer artifact com.google.errorprone:javac-shaded:pom:9+181-r4173-1 ``` 解决方法： diff --git a/src/zh/Download/README.md b/src/zh/Download/README.md index 828a212b..c0b2ef64 100644 --- a/src/zh/Download/README.md +++ b/src/zh/Download/README.md @@ -19,59 +19,208 @@ --> # 发行版本 - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版本IoTDB 二进制包IoTDB 源代码发布说明
1.3.3All-in-oneSHA512ASC源代码SHA512ASCrelease notes
AINodeSHA512ASC
1.3.2All-in-oneSHA512ASC源代码SHA512ASCrelease notes
0.13.4All-in-oneSHA512ASC源代码SHA512ASCrelease notes
Grafana 连接器SHA512ASC
Grafana 插件SHA512ASC
IoTDB 二进制包IoTDB 源代码发布说明
1.3.3 + All-in-one + + SHA512 + + ASC + + 源代码 + + SHA512 + + ASC + + release notes +
+ AINode + + SHA512 + + ASC +
1.3.2 + All-in-one + + SHA512 + + ASC + + 源代码 + + SHA512 + + ASC + + release notes +
0.13.4 + All-in-one + + SHA512 + + ASC + + 源代码 + + SHA512 + + ASC + + release notes +
+ Grafana 连接器 + + SHA512 + + ASC +
+ Grafana 插件 + + SHA512 + + ASC +
历史版本下载：[https://archive.apache.org/dist/iotdb/](https://archive.apache.org/dist/iotdb/) @@ -190,7 +339,7 @@ for(int i = 0; i <= values.length; i++){ 查询 root.sg.a 的数据，可以看到没有做反转义处理： -```Plain%20Text +``` // 查询结果 +-----------------------------+---------+ | Time|root.sg.a| @@ -214,7 +363,7 @@ insert into root.sg(time, a) values(4, "\u96d5") 查询 root.sg.a 的数据，可以看到字符串进行了反转义： -```Plain%20Text +``` // 查询结果 +-----------------------------+---------+ | Time|root.sg.a| diff --git a/src/zh/README.md b/src/zh/README.md index e6dc0b3e..02e31bfe 100644 --- a/src/zh/README.md +++ b/src/zh/README.md @@ -1,6 +1,41 @@ --- home: true +heroText: Apache IoTDB +heroImage: /img/logo.svg +tagline: 物联网数据库 +actions: + - text: 下载 + link: ./Download/ + type: primary + + - text: 快速上手 + link: ./UserGuide/latest/QuickStart/QuickStart_apache.html + +highlights: + - header: 介绍 + description: Apache IoTDB（物联网数据库）是一体化收集、存储、管理与分析物联网时序数据的软件系统。Apache IoTDB 采用轻量式架构，具有高性能和丰富的功能，并与 Apache Hadoop、Spark 和 Flink 等进行了深度集成，可以满足工业物联网领域的海量数据存储、高速数据读取和复杂数据分析需求。 + + - header: 主要特点 + features: + - title: 高吞吐量读写 + details: Apache IoTDB 中可以支持数百万个低功耗和智能联网设备的高速写访问。 它还提供数据快速读取访问以查询。 + + - title: 高效的目录结构 + details: Apache IoTDB 可以对拥有复杂组织关系的物联网设备进行树形结构管理，并使用通配符对这些元数据进行模糊匹配。 + + - title: 丰富的查询语义 + details: Apache IoTDB 可以支持跨设备和传感器的时间对齐查询，在时间维度上的聚合（降采样）等。 + + - title: 低硬件成本 + details: Apache IoTDB 可以实现磁盘存储的高压缩率。 + + - title: 部署灵活 + details: Apache IoTDB 可以为用户提供云上的一键式安装、终端访问工具以及边-云之间的协同（数据同步工具）。 + + - title: 与开源生态系统的紧密集成 + details: Apache IoTDB 支持许多大数据软件生态系统，例如Hadoop、Spark、Flink和Grafana（可视化工具） --- + - + + diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md index 17e09aa0..74ad4192 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # 资源规划 ## CPU + @@ -77,10 +78,12 @@ +
序列数（采集频率<=1HZ） CPU1000w以上 请联系天谋商务咨询
## 内存 + @@ -137,12 +140,14 @@ +
序列数（采集频率<=1HZ） 内存1000w以上 请联系天谋商务咨询
## 存储(磁盘) ### 存储空间 计算公式：测点数量 * 采样频率（Hz）* 每个数据点大小（Byte，不同数据类型不一样，见下表） + @@ -176,6 +181,7 @@ +
数据点大小计算表
平均为a 8+a
示例：1000设备，每个设备100 测点，共 100000 序列，INT32 类型。采样频率1Hz（每秒一次），存储1年，3副本。 diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md index 99c5b14c..2bfbc16c 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md @@ -90,7 +90,8 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 建议的磁盘分区方式如下表所示。 - + + @@ -125,6 +126,7 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 +
硬盘分类 磁盘组 对应盘符
......
### 网络配置 diff --git a/src/zh/UserGuide/Master/Tree/API/Programming-Cpp-Native-API.md b/src/zh/UserGuide/Master/Tree/API/Programming-Cpp-Native-API.md index 77636edf..5f02f2e6 100644 --- a/src/zh/UserGuide/Master/Tree/API/Programming-Cpp-Native-API.md +++ b/src/zh/UserGuide/Master/Tree/API/Programming-Cpp-Native-API.md @@ -124,12 +124,12 @@ git checkout rc/1.3.2 ``` - 使用 Visual Studio 2022 的 Windows - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp ``` - 使用 Visual Studio 2019 的 Windows - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator="Visual Studio 16 2019" -Diotdb-tools-thrift.version=0.14.1.1-msvc142-SNAPSHOT ``` - 如果没有将 Boost 库地址加入 PATH 环境变量，在编译命令中还需添加相关参数，例如：`-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"` diff --git a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Database-Resources.md b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Database-Resources.md index 17e09aa0..74ad4192 100644 --- a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Database-Resources.md +++ b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # 资源规划 ## CPU + @@ -77,10 +78,12 @@ +
序列数（采集频率<=1HZ） CPU1000w以上 请联系天谋商务咨询
## 内存 + @@ -137,12 +140,14 @@ +
序列数（采集频率<=1HZ） 内存1000w以上 请联系天谋商务咨询
## 存储(磁盘) ### 存储空间 计算公式：测点数量 * 采样频率（Hz）* 每个数据点大小（Byte，不同数据类型不一样，见下表） + @@ -176,6 +181,7 @@ +
数据点大小计算表
平均为a 8+a
示例：1000设备，每个设备100 测点，共 100000 序列，INT32 类型。采样频率1Hz（每秒一次），存储1年，3副本。 diff --git a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md index 75be11d6..63b85c16 100644 --- a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md @@ -90,7 +90,8 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 建议的磁盘分区方式如下表所示。 - + + @@ -125,6 +126,7 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 +
硬盘分类 磁盘组 对应盘符
......
### 网络配置 diff --git a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md index cf17d08d..245593b2 100644 --- a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md +++ b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md @@ -44,7 +44,8 @@ 1. 打开监控配置项。IoTDB中监控有关的配置项默认是关闭的，在部署监控面板前，您需要打开相关配置项（注意开启监控配置后需要重启服务）。 - + + @@ -92,7 +93,8 @@ -
配置项 所在配置文件 配置说明audit_log_operation 请在配置文件中添加该配置项，值设置为DML,DDL,QUERY
+ + 2. 重启所有节点。修改3个节点的监控指标配置后，可重新启动所有节点的confignode和datanode服务： diff --git a/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md b/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md index fe001d7e..efbcbaaf 100644 --- a/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md +++ b/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md @@ -79,7 +79,8 @@ Ignition-IoTDB连接器提供了将 Ignition 采集到的数据存入 IoTDB 的 配置内容如下： - + + @@ -150,6 +151,7 @@ Ignition-IoTDB连接器提供了将 Ignition 采集到的数据存入 IoTDB 的 +
名称 含义 默认值保持默认即可
diff --git a/src/zh/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/zh/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md index b5fa25b2..d108342b 100644 --- a/src/zh/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/zh/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -81,8 +81,8 @@ TimechoDB 在开源版基础上提供了更多高阶产品功能，在内核层 详细功能对比如下： - - + + @@ -206,6 +206,7 @@ TimechoDB 在开源版基础上提供了更多高阶产品功能，在内核层 +
功能
功能 Apache IoTDB TimechoDB
× √
### 更高效/稳定的产品性能 diff --git a/src/zh/UserGuide/Master/Tree/Reference/Syntax-Rule.md b/src/zh/UserGuide/Master/Tree/Reference/Syntax-Rule.md index 1579bc52..6faaa277 100644 --- a/src/zh/UserGuide/Master/Tree/Reference/Syntax-Rule.md +++ b/src/zh/UserGuide/Master/Tree/Reference/Syntax-Rule.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/src/zh/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md b/src/zh/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md index 08659116..ed67d75a 100644 --- a/src/zh/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md +++ b/src/zh/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md @@ -5,8 +5,8 @@ IoTDB 目前支持将 CSV、SQL、及TsFile（IoTDB底层开放式时间序列文件格式）格式的数据导入数据库。具体功能如下： - - + + @@ -29,6 +29,7 @@ IoTDB 目前支持将 CSV、SQL、及TsFile（IoTDB底层开放式时间序列 +
文件格式
文件格式 IoTDB工具 具体介绍
TsFile 主动监听&加载功能 根据用户配置，监听指定路径下TsFile文件的变化，将新增加的TsFile文件加载入IoTDB
## 2. import-data 脚本 diff --git a/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md b/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md index b882513b..0ce0c4ee 100644 --- a/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md +++ b/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md @@ -37,8 +37,8 @@ 通过 SQL 语句声明式地配置 3 个部分的具体内容，可实现灵活的数据同步能力。目前数据同步支持以下信息的同步，您可以在创建同步任务时对同步范围进行选择（默认选择 data.insert，即同步新写入的数据）： - - + + @@ -73,6 +73,7 @@ +
同步范围
同步范围 同步内容 说明
- 同步用户权限和访问控制
### 功能限制及说明 @@ -213,8 +214,8 @@ IoTDB> SHOW PIPEPLUGINS 预置插件详细介绍如下(各插件的详细参数可参考本文[参数说明](#参考参数说明))： - - + + @@ -251,6 +252,7 @@ IoTDB> SHOW PIPEPLUGINS +
类型
类型 自定义插件 插件名称 介绍用于 IoTDB（V1.3.1 及以上）与 IoTDB（V1.2.0 及以上）之间的数据传输。使用 Thrift RPC 框架传输数据，单线程 sync blocking IO 模型，适用于安全需求较高的场景 1.3.1+
导入自定义插件可参考[流处理框架](./Streaming_timecho.md#自定义流处理插件管理)章节。 diff --git a/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md b/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md index db6e76bd..9472acc7 100644 --- a/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md +++ b/src/zh/UserGuide/Master/Tree/User-Manual/Data-Sync_timecho.md @@ -37,8 +37,8 @@ 通过 SQL 语句声明式地配置 3 个部分的具体内容，可实现灵活的数据同步能力。目前数据同步支持以下信息的同步，您可以在创建同步任务时对同步范围进行选择（默认选择 data.insert，即同步新写入的数据）： - - + + @@ -73,6 +73,7 @@ +
同步范围
同步范围 同步内容 说明
- 同步用户权限和访问控制
### 功能限制及说明 @@ -216,8 +217,8 @@ IoTDB> SHOW PIPEPLUGINS - - + + @@ -259,6 +260,7 @@ IoTDB> SHOW PIPEPLUGINS +
类型
类型 自定义插件 插件名称 介绍用于 IoTDB（V1.3.1 及以上）与 IoTDB（V1.2.0 及以上）之间的数据传输。使用 Thrift RPC 框架传输数据，单线程 sync blocking IO 模型，适用于安全需求较高的场景 1.3.1+
导入自定义插件可参考[流处理框架](./Streaming_timecho.md#自定义流处理插件管理)章节。 diff --git a/src/zh/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md b/src/zh/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md index 7c085f60..237031ae 100644 --- a/src/zh/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md +++ b/src/zh/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md @@ -7,8 +7,8 @@ UDF（User Defined Function）即用户自定义函数，IoTDB 提供多种内 IoTDB 支持两种类型的 UDF 函数，如下表所示。 - - + + @@ -26,6 +26,7 @@ IoTDB 支持两种类型的 UDF 函数，如下表所示。 +
UDF 分类
UDF 分类 数据访问策略 描述
- 自定义聚合函数，输入 k 列时间序列 m 行数据，输出 1 列时间序列 1 行数据，可用于聚合函数出现的任何子句和表达式中，如select子句、having子句等。
### 1.1 UDF 使用 diff --git a/src/zh/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md b/src/zh/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md index 2125951b..05c25351 100644 --- a/src/zh/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md +++ b/src/zh/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md @@ -7,8 +7,8 @@ UDF（User Defined Function）即用户自定义函数，IoTDB 提供多种内 IoTDB 支持两种类型的 UDF 函数，如下表所示。 - - + + @@ -26,6 +26,7 @@ IoTDB 支持两种类型的 UDF 函数，如下表所示。 +
UDF 分类
UDF 分类 数据访问策略 描述
- 自定义聚合函数，输入 k 列时间序列 m 行数据，输出 1 列时间序列 1 行数据，可用于聚合函数出现的任何子句和表达式中，如select子句、having子句等。
### 1.1 UDF 使用 diff --git a/src/zh/UserGuide/Master/Tree/stage/Edge-Cloud-Collaboration/Sync-Tool.md b/src/zh/UserGuide/Master/Tree/stage/Edge-Cloud-Collaboration/Sync-Tool.md index 1ead9f51..08a4f51e 100644 --- a/src/zh/UserGuide/Master/Tree/stage/Edge-Cloud-Collaboration/Sync-Tool.md +++ b/src/zh/UserGuide/Master/Tree/stage/Edge-Cloud-Collaboration/Sync-Tool.md @@ -124,7 +124,7 @@ IoTDB> DROP PIPE my_pipe - 显示当前所能支持的 PipeSink 类型。 -```Plain%20Text +``` IoTDB> SHOW PIPESINKTYPE IoTDB> +-----+ @@ -170,7 +170,7 @@ IoTDB> - 创建同步任务 - 其中 select 语句目前仅支持`**`（即所有序列中的数据），from 语句目前仅支持`root`，where语句仅支持指定 time 的起始时间。起始时间的指定形式可以是 yyyy-mm-dd HH:MM:SS或时间戳。 -```Plain%20Text +``` IoTDB> CREATE PIPE my_pipe TO my_iotdb [FROM (select ** from root WHERE time>=yyyy-mm-dd HH:MM:SS)] ``` @@ -227,7 +227,7 @@ IoTDB> DROP PIPE - ERROR 状态，这表明出现了网络连接正常但数据无法传输的问题，例如发送端 IP 不在接收端白名单中，或是发送端与接收端版本不兼容 - 当出现 ERROR 状态时，建议 STOP PIPE 后查看 DataNode 日志，检查接收端配置或网络情况后重新 START PIPE -```Plain%20Text +``` IoTDB> SHOW PIPES IoTDB> +-----------------------+--------+--------+-------------+---------+------------------------------------+-------+ @@ -287,7 +287,7 @@ IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>= 16485696 启动Pipe -```Plain%20Text +``` IoTDB> START PIPE p ``` @@ -318,7 +318,7 @@ flush; 在发送端和接受端执行查询，可查询到相同的结果 -```Plain%20Text +``` IoTDB> select ** from root.vehicle +-----------------------------+------------------+------------------+------------------+------------------+ | Time|root.vehicle.d0.s0|root.vehicle.d0.s1|root.vehicle.d1.s3|root.vehicle.d1.s2| diff --git a/src/zh/UserGuide/Master/Tree/stage/Syntax-Conventions/Literal-Values.md b/src/zh/UserGuide/Master/Tree/stage/Syntax-Conventions/Literal-Values.md index f2ad963b..62753a6d 100644 --- a/src/zh/UserGuide/Master/Tree/stage/Syntax-Conventions/Literal-Values.md +++ b/src/zh/UserGuide/Master/Tree/stage/Syntax-Conventions/Literal-Values.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/src/zh/UserGuide/V0.13.x/Process-Data/Triggers.md b/src/zh/UserGuide/V0.13.x/Process-Data/Triggers.md index 0bf17139..7e778795 100644 --- a/src/zh/UserGuide/V0.13.x/Process-Data/Triggers.md +++ b/src/zh/UserGuide/V0.13.x/Process-Data/Triggers.md @@ -528,9 +528,7 @@ AlertManagerEvent(String alertname, Map extraLabels, Map}} +* `annotations` 可选传，它的 value 值可使用 Go 语言模板风格的 `{{.}}` ``` 它在最终生成消息时会被替换为 `labels[]`。 * `labels` 和 `annotations` 会被解析成 json 字符串发送给 `AlertManager`： diff --git a/src/zh/UserGuide/V1.1.x/Edge-Cloud-Collaboration/Sync-Tool.md b/src/zh/UserGuide/V1.1.x/Edge-Cloud-Collaboration/Sync-Tool.md index 78ea9adb..d9ee3e2c 100644 --- a/src/zh/UserGuide/V1.1.x/Edge-Cloud-Collaboration/Sync-Tool.md +++ b/src/zh/UserGuide/V1.1.x/Edge-Cloud-Collaboration/Sync-Tool.md @@ -124,7 +124,7 @@ IoTDB> DROP PIPE my_pipe - 显示当前所能支持的 PipeSink 类型。 -```Plain%20Text +``` IoTDB> SHOW PIPESINKTYPE IoTDB> +-----+ @@ -170,7 +170,7 @@ IoTDB> - 创建同步任务 - 其中 select 语句目前仅支持`**`（即所有序列中的数据），from 语句目前仅支持`root`，where语句仅支持指定 time 的起始时间。起始时间的指定形式可以是 yyyy-mm-dd HH:MM:SS或时间戳。 -```Plain%20Text +``` IoTDB> CREATE PIPE my_pipe TO my_iotdb [FROM (select ** from root WHERE time>=yyyy-mm-dd HH:MM:SS)] ``` @@ -227,7 +227,7 @@ IoTDB> DROP PIPE - ERROR 状态，这表明出现了网络连接正常但数据无法传输的问题，例如发送端 IP 不在接收端白名单中，或是发送端与接收端版本不兼容 - 当出现 ERROR 状态时，建议 STOP PIPE 后查看 DataNode 日志，检查接收端配置或网络情况后重新 START PIPE -```Plain%20Text +``` IoTDB> SHOW PIPES IoTDB> +-----------------------+--------+--------+-------------+---------+------------------------------------+-------+ @@ -287,7 +287,7 @@ IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>= 16485696 启动Pipe -```Plain%20Text +``` IoTDB> START PIPE p ``` @@ -318,7 +318,7 @@ flush; 在发送端和接受端执行查询，可查询到相同的结果 -```Plain%20Text +``` IoTDB> select ** from root.vehicle +-----------------------------+------------------+------------------+------------------+------------------+ | Time|root.vehicle.d0.s0|root.vehicle.d0.s1|root.vehicle.d1.s3|root.vehicle.d1.s2| diff --git a/src/zh/UserGuide/V1.1.x/Syntax-Conventions/Literal-Values.md b/src/zh/UserGuide/V1.1.x/Syntax-Conventions/Literal-Values.md index f2ad963b..62753a6d 100644 --- a/src/zh/UserGuide/V1.1.x/Syntax-Conventions/Literal-Values.md +++ b/src/zh/UserGuide/V1.1.x/Syntax-Conventions/Literal-Values.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/src/zh/UserGuide/V1.2.x/User-Manual/Syntax-Rule.md b/src/zh/UserGuide/V1.2.x/User-Manual/Syntax-Rule.md index 2105dfe7..53c26cb4 100644 --- a/src/zh/UserGuide/V1.2.x/User-Manual/Syntax-Rule.md +++ b/src/zh/UserGuide/V1.2.x/User-Manual/Syntax-Rule.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/src/zh/UserGuide/V1.2.x/stage/Edge-Cloud-Collaboration/Sync-Tool.md b/src/zh/UserGuide/V1.2.x/stage/Edge-Cloud-Collaboration/Sync-Tool.md index 78ea9adb..d9ee3e2c 100644 --- a/src/zh/UserGuide/V1.2.x/stage/Edge-Cloud-Collaboration/Sync-Tool.md +++ b/src/zh/UserGuide/V1.2.x/stage/Edge-Cloud-Collaboration/Sync-Tool.md @@ -124,7 +124,7 @@ IoTDB> DROP PIPE my_pipe - 显示当前所能支持的 PipeSink 类型。 -```Plain%20Text +``` IoTDB> SHOW PIPESINKTYPE IoTDB> +-----+ @@ -170,7 +170,7 @@ IoTDB> - 创建同步任务 - 其中 select 语句目前仅支持`**`（即所有序列中的数据），from 语句目前仅支持`root`，where语句仅支持指定 time 的起始时间。起始时间的指定形式可以是 yyyy-mm-dd HH:MM:SS或时间戳。 -```Plain%20Text +``` IoTDB> CREATE PIPE my_pipe TO my_iotdb [FROM (select ** from root WHERE time>=yyyy-mm-dd HH:MM:SS)] ``` @@ -227,7 +227,7 @@ IoTDB> DROP PIPE - ERROR 状态，这表明出现了网络连接正常但数据无法传输的问题，例如发送端 IP 不在接收端白名单中，或是发送端与接收端版本不兼容 - 当出现 ERROR 状态时，建议 STOP PIPE 后查看 DataNode 日志，检查接收端配置或网络情况后重新 START PIPE -```Plain%20Text +``` IoTDB> SHOW PIPES IoTDB> +-----------------------+--------+--------+-------------+---------+------------------------------------+-------+ @@ -287,7 +287,7 @@ IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>= 16485696 启动Pipe -```Plain%20Text +``` IoTDB> START PIPE p ``` @@ -318,7 +318,7 @@ flush; 在发送端和接受端执行查询，可查询到相同的结果 -```Plain%20Text +``` IoTDB> select ** from root.vehicle +-----------------------------+------------------+------------------+------------------+------------------+ | Time|root.vehicle.d0.s0|root.vehicle.d0.s1|root.vehicle.d1.s3|root.vehicle.d1.s2| diff --git a/src/zh/UserGuide/V1.2.x/stage/Syntax-Conventions/Literal-Values.md b/src/zh/UserGuide/V1.2.x/stage/Syntax-Conventions/Literal-Values.md index f2ad963b..62753a6d 100644 --- a/src/zh/UserGuide/V1.2.x/stage/Syntax-Conventions/Literal-Values.md +++ b/src/zh/UserGuide/V1.2.x/stage/Syntax-Conventions/Literal-Values.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/src/zh/UserGuide/V1.3.0-2/API/Programming-Cpp-Native-API.md b/src/zh/UserGuide/V1.3.0-2/API/Programming-Cpp-Native-API.md index 19fce9dd..ba499ff4 100644 --- a/src/zh/UserGuide/V1.3.0-2/API/Programming-Cpp-Native-API.md +++ b/src/zh/UserGuide/V1.3.0-2/API/Programming-Cpp-Native-API.md @@ -125,12 +125,12 @@ git checkout rc/1.3.2 ``` - 使用 Visual Studio 2022 的 Windows - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp ``` - 使用 Visual Studio 2019 的 Windows - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator="Visual Studio 16 2019" -Diotdb-tools-thrift.version=0.14.1.1-msvc142-SNAPSHOT ``` - 如果没有将 Boost 库地址加入 PATH 环境变量，在编译命令中还需添加相关参数，例如：`-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"` diff --git a/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Database-Resources.md b/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Database-Resources.md index 83936024..cbe3f271 100644 --- a/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Database-Resources.md +++ b/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # 资源规划 ## CPU + @@ -77,10 +78,12 @@ +
序列数（采集频率<=1HZ） CPU1000w以上 请联系天谋商务咨询
## 内存 + @@ -137,12 +140,14 @@ +
序列数（采集频率<=1HZ） 内存1000w以上 请联系天谋商务咨询
## 存储(磁盘) ### 存储空间 计算公式：测点数量 * 采样频率（Hz）* 每个数据点大小（Byte，不同数据类型不一样，见下表） + @@ -176,6 +181,7 @@ +
数据点大小计算表
平均为a 8+a
diff --git a/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Environment-Requirements.md b/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Environment-Requirements.md index 75be11d6..63b85c16 100644 --- a/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/Environment-Requirements.md @@ -90,7 +90,8 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 建议的磁盘分区方式如下表所示。 - + + @@ -125,6 +126,7 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 +
硬盘分类 磁盘组 对应盘符
......
### 网络配置 diff --git a/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/workbench-deployment_timecho.md b/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/workbench-deployment_timecho.md index 0976604e..5af9dad7 100644 --- a/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/workbench-deployment_timecho.md +++ b/src/zh/UserGuide/V1.3.0-2/Deployment-and-Maintenance/workbench-deployment_timecho.md @@ -43,7 +43,8 @@ 1. 打开监控配置项。IoTDB中监控有关的配置项默认是关闭的，在部署监控面板前，您需要打开相关配置项（注意开启监控配置后需要重启服务）。 - + + @@ -91,7 +92,8 @@ -
配置项 所在配置文件 配置说明audit_log_operation 将配置项取消注释
+ + 2. 重启所有节点。修改3个节点的监控指标配置后，可重新启动所有节点的confignode和datanode服务： diff --git a/src/zh/UserGuide/V1.3.0-2/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md b/src/zh/UserGuide/V1.3.0-2/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md index 0da72fbc..92c6fef6 100644 --- a/src/zh/UserGuide/V1.3.0-2/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md +++ b/src/zh/UserGuide/V1.3.0-2/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md @@ -79,7 +79,8 @@ Ignition-IoTDB连接器提供了将 Ignition 采集到的数据存入 IoTDB 的 配置内容如下： - + + @@ -150,6 +151,7 @@ Ignition-IoTDB连接器提供了将 Ignition 采集到的数据存入 IoTDB 的 +
名称 含义 默认值保持默认即可
diff --git a/src/zh/UserGuide/V1.3.0-2/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/zh/UserGuide/V1.3.0-2/IoTDB-Introduction/IoTDB-Introduction_timecho.md index 9c73e8f5..6a8b57c5 100644 --- a/src/zh/UserGuide/V1.3.0-2/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/zh/UserGuide/V1.3.0-2/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -81,8 +81,8 @@ TimechoDB 在开源版基础上提供了更多高阶产品功能，在内核层 详细功能对比如下： - - + + @@ -206,6 +206,7 @@ TimechoDB 在开源版基础上提供了更多高阶产品功能，在内核层 +
功能
功能 Apache IoTDB TimechoDB
× √
### 更高效/稳定的产品性能 diff --git a/src/zh/UserGuide/V1.3.0-2/User-Manual/Data-Sync_apache.md b/src/zh/UserGuide/V1.3.0-2/User-Manual/Data-Sync_apache.md index 7c82a858..e91c2e18 100644 --- a/src/zh/UserGuide/V1.3.0-2/User-Manual/Data-Sync_apache.md +++ b/src/zh/UserGuide/V1.3.0-2/User-Manual/Data-Sync_apache.md @@ -37,8 +37,8 @@ 通过 SQL 语句声明式地配置 3 个部分的具体内容，可实现灵活的数据同步能力。目前数据同步支持以下信息的同步，您可以在创建同步任务时对同步范围进行选择（默认选择 data.insert，即同步新写入的数据）： - - + + @@ -73,6 +73,7 @@ +
同步范围
同步范围 同步内容 说明
- 同步用户权限和访问控制
### 功能限制及说明 @@ -215,8 +216,8 @@ IoTDB> SHOW PIPEPLUGINS - - + + @@ -253,6 +254,7 @@ IoTDB> SHOW PIPEPLUGINS +
类型
类型 自定义插件 插件名称 介绍用于 IoTDB（V1.3.1 及以上）与 IoTDB（V1.2.0 及以上）之间的数据传输。使用 Thrift RPC 框架传输数据，单线程 sync blocking IO 模型，适用于安全需求较高的场景 1.3.1+
导入自定义插件可参考[流处理框架](./Streaming_timecho.md#自定义流处理插件管理)章节。 diff --git a/src/zh/UserGuide/V1.3.0-2/User-Manual/Data-Sync_timecho.md b/src/zh/UserGuide/V1.3.0-2/User-Manual/Data-Sync_timecho.md index b22db406..bd94fef6 100644 --- a/src/zh/UserGuide/V1.3.0-2/User-Manual/Data-Sync_timecho.md +++ b/src/zh/UserGuide/V1.3.0-2/User-Manual/Data-Sync_timecho.md @@ -37,8 +37,8 @@ 通过 SQL 语句声明式地配置 3 个部分的具体内容，可实现灵活的数据同步能力。目前数据同步支持以下信息的同步，您可以在创建同步任务时对同步范围进行选择（默认选择 data.insert，即同步新写入的数据）： - - + + @@ -73,6 +73,7 @@ +
同步范围
同步范围 同步内容 说明
- 同步用户权限和访问控制
### 功能限制及说明 @@ -218,8 +219,8 @@ IoTDB> SHOW PIPEPLUGINS - - + + @@ -261,6 +262,7 @@ IoTDB> SHOW PIPEPLUGINS +
类型
类型 自定义插件 插件名称 介绍用于 IoTDB（V1.3.1 及以上）与 IoTDB（V1.2.0 及以上）之间的数据传输。使用 Thrift RPC 框架传输数据，单线程 sync blocking IO 模型，适用于安全需求较高的场景 1.3.1+
导入自定义插件可参考[流处理框架](./Streaming_timecho.md#自定义流处理插件管理)章节。 diff --git a/src/zh/UserGuide/V1.3.0-2/User-Manual/Syntax-Rule.md b/src/zh/UserGuide/V1.3.0-2/User-Manual/Syntax-Rule.md index 379bc26c..e05c1c77 100644 --- a/src/zh/UserGuide/V1.3.0-2/User-Manual/Syntax-Rule.md +++ b/src/zh/UserGuide/V1.3.0-2/User-Manual/Syntax-Rule.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/src/zh/UserGuide/V1.3.0-2/User-Manual/User-defined-function.md b/src/zh/UserGuide/V1.3.0-2/User-Manual/User-defined-function.md index d2eddcea..c74a5f86 100644 --- a/src/zh/UserGuide/V1.3.0-2/User-Manual/User-defined-function.md +++ b/src/zh/UserGuide/V1.3.0-2/User-Manual/User-defined-function.md @@ -7,8 +7,8 @@ UDF（User Defined Function）即用户自定义函数，IoTDB 提供多种内 IoTDB 支持两种类型的 UDF 函数，如下表所示。 - - + + @@ -26,6 +26,7 @@ IoTDB 支持两种类型的 UDF 函数，如下表所示。 +
UDF 分类
UDF 分类 数据访问策略 描述
- 自定义聚合函数，输入 k 列时间序列 m 行数据，输出 1 列时间序列 1 行数据，可用于聚合函数出现的任何子句和表达式中，如select子句、having子句等。
### 1.1 UDF 使用 diff --git a/src/zh/UserGuide/V1.3.0-2/stage/Edge-Cloud-Collaboration/Sync-Tool.md b/src/zh/UserGuide/V1.3.0-2/stage/Edge-Cloud-Collaboration/Sync-Tool.md index 03d4a318..555e92e0 100644 --- a/src/zh/UserGuide/V1.3.0-2/stage/Edge-Cloud-Collaboration/Sync-Tool.md +++ b/src/zh/UserGuide/V1.3.0-2/stage/Edge-Cloud-Collaboration/Sync-Tool.md @@ -124,7 +124,7 @@ IoTDB> DROP PIPE my_pipe - 显示当前所能支持的 PipeSink 类型。 -```Plain%20Text +``` IoTDB> SHOW PIPESINKTYPE IoTDB> +-----+ @@ -170,7 +170,7 @@ IoTDB> - 创建同步任务 - 其中 select 语句目前仅支持`**`（即所有序列中的数据），from 语句目前仅支持`root`，where语句仅支持指定 time 的起始时间。起始时间的指定形式可以是 yyyy-mm-dd HH:MM:SS或时间戳。 -```Plain%20Text +``` IoTDB> CREATE PIPE my_pipe TO my_iotdb [FROM (select ** from root WHERE time>=yyyy-mm-dd HH:MM:SS)] ``` @@ -227,7 +227,7 @@ IoTDB> DROP PIPE - ERROR 状态，这表明出现了网络连接正常但数据无法传输的问题，例如发送端 IP 不在接收端白名单中，或是发送端与接收端版本不兼容 - 当出现 ERROR 状态时，建议 STOP PIPE 后查看 DataNode 日志，检查接收端配置或网络情况后重新 START PIPE -```Plain%20Text +``` IoTDB> SHOW PIPES IoTDB> +-----------------------+--------+--------+-------------+---------+------------------------------------+-------+ @@ -287,7 +287,7 @@ IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>= 16485696 启动Pipe -```Plain%20Text +``` IoTDB> START PIPE p ``` @@ -318,7 +318,7 @@ flush; 在发送端和接受端执行查询，可查询到相同的结果 -```Plain%20Text +``` IoTDB> select ** from root.vehicle +-----------------------------+------------------+------------------+------------------+------------------+ | Time|root.vehicle.d0.s0|root.vehicle.d0.s1|root.vehicle.d1.s3|root.vehicle.d1.s2| diff --git a/src/zh/UserGuide/V1.3.0-2/stage/Syntax-Conventions/Literal-Values.md b/src/zh/UserGuide/V1.3.0-2/stage/Syntax-Conventions/Literal-Values.md index f2ad963b..62753a6d 100644 --- a/src/zh/UserGuide/V1.3.0-2/stage/Syntax-Conventions/Literal-Values.md +++ b/src/zh/UserGuide/V1.3.0-2/stage/Syntax-Conventions/Literal-Values.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/src/zh/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Database-Resources.md b/src/zh/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Database-Resources.md index 17e09aa0..74ad4192 100644 --- a/src/zh/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Database-Resources.md +++ b/src/zh/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # 资源规划 ## CPU + @@ -77,10 +78,12 @@ +
序列数（采集频率<=1HZ） CPU1000w以上 请联系天谋商务咨询
## 内存 + @@ -137,12 +140,14 @@ +
序列数（采集频率<=1HZ） 内存1000w以上 请联系天谋商务咨询
## 存储(磁盘) ### 存储空间 计算公式：测点数量 * 采样频率（Hz）* 每个数据点大小（Byte，不同数据类型不一样，见下表） + @@ -176,6 +181,7 @@ +
数据点大小计算表
平均为a 8+a
示例：1000设备，每个设备100 测点，共 100000 序列，INT32 类型。采样频率1Hz（每秒一次），存储1年，3副本。 diff --git a/src/zh/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Environment-Requirements.md b/src/zh/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Environment-Requirements.md index 99c5b14c..2bfbc16c 100644 --- a/src/zh/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/zh/UserGuide/V2.0.1/Table/Deployment-and-Maintenance/Environment-Requirements.md @@ -90,7 +90,8 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 建议的磁盘分区方式如下表所示。 - + + @@ -125,6 +126,7 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 +
硬盘分类 磁盘组 对应盘符
......
### 网络配置 diff --git a/src/zh/UserGuide/V2.0.1/Tree/API/Programming-Cpp-Native-API.md b/src/zh/UserGuide/V2.0.1/Tree/API/Programming-Cpp-Native-API.md index 77636edf..5f02f2e6 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/API/Programming-Cpp-Native-API.md +++ b/src/zh/UserGuide/V2.0.1/Tree/API/Programming-Cpp-Native-API.md @@ -124,12 +124,12 @@ git checkout rc/1.3.2 ``` - 使用 Visual Studio 2022 的 Windows - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp ``` - 使用 Visual Studio 2019 的 Windows - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator="Visual Studio 16 2019" -Diotdb-tools-thrift.version=0.14.1.1-msvc142-SNAPSHOT ``` - 如果没有将 Boost 库地址加入 PATH 环境变量，在编译命令中还需添加相关参数，例如：`-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"` diff --git a/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Database-Resources.md b/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Database-Resources.md index 17e09aa0..74ad4192 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Database-Resources.md +++ b/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # 资源规划 ## CPU + @@ -77,10 +78,12 @@ +
序列数（采集频率<=1HZ） CPU1000w以上 请联系天谋商务咨询
## 内存 + @@ -137,12 +140,14 @@ +
序列数（采集频率<=1HZ） 内存1000w以上 请联系天谋商务咨询
## 存储(磁盘) ### 存储空间 计算公式：测点数量 * 采样频率（Hz）* 每个数据点大小（Byte，不同数据类型不一样，见下表） + @@ -176,6 +181,7 @@ +
数据点大小计算表
平均为a 8+a
示例：1000设备，每个设备100 测点，共 100000 序列，INT32 类型。采样频率1Hz（每秒一次），存储1年，3副本。 diff --git a/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Environment-Requirements.md b/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Environment-Requirements.md index 75be11d6..63b85c16 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Environment-Requirements.md @@ -90,7 +90,8 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 建议的磁盘分区方式如下表所示。 - + + @@ -125,6 +126,7 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 +
硬盘分类 磁盘组 对应盘符
......
### 网络配置 diff --git a/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md b/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md index cf17d08d..245593b2 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md +++ b/src/zh/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/workbench-deployment_timecho.md @@ -44,7 +44,8 @@ 1. 打开监控配置项。IoTDB中监控有关的配置项默认是关闭的，在部署监控面板前，您需要打开相关配置项（注意开启监控配置后需要重启服务）。 - + + @@ -92,7 +93,8 @@ -
配置项 所在配置文件 配置说明audit_log_operation 请在配置文件中添加该配置项，值设置为DML,DDL,QUERY
+ + 2. 重启所有节点。修改3个节点的监控指标配置后，可重新启动所有节点的confignode和datanode服务： diff --git a/src/zh/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md b/src/zh/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md index fe001d7e..efbcbaaf 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md +++ b/src/zh/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md @@ -79,7 +79,8 @@ Ignition-IoTDB连接器提供了将 Ignition 采集到的数据存入 IoTDB 的 配置内容如下： - + + @@ -150,6 +151,7 @@ Ignition-IoTDB连接器提供了将 Ignition 采集到的数据存入 IoTDB 的 +
名称 含义 默认值保持默认即可
diff --git a/src/zh/UserGuide/V2.0.1/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/zh/UserGuide/V2.0.1/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md index b5fa25b2..d108342b 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/zh/UserGuide/V2.0.1/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -81,8 +81,8 @@ TimechoDB 在开源版基础上提供了更多高阶产品功能，在内核层 详细功能对比如下： - - + + @@ -206,6 +206,7 @@ TimechoDB 在开源版基础上提供了更多高阶产品功能，在内核层 +
功能
功能 Apache IoTDB TimechoDB
× √
### 更高效/稳定的产品性能 diff --git a/src/zh/UserGuide/V2.0.1/Tree/Reference/Syntax-Rule.md b/src/zh/UserGuide/V2.0.1/Tree/Reference/Syntax-Rule.md index 1579bc52..6faaa277 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/Reference/Syntax-Rule.md +++ b/src/zh/UserGuide/V2.0.1/Tree/Reference/Syntax-Rule.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/src/zh/UserGuide/V2.0.1/Tree/Tools-System/Data-Import-Tool.md b/src/zh/UserGuide/V2.0.1/Tree/Tools-System/Data-Import-Tool.md index 08659116..ed67d75a 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/Tools-System/Data-Import-Tool.md +++ b/src/zh/UserGuide/V2.0.1/Tree/Tools-System/Data-Import-Tool.md @@ -5,8 +5,8 @@ IoTDB 目前支持将 CSV、SQL、及TsFile（IoTDB底层开放式时间序列文件格式）格式的数据导入数据库。具体功能如下： - - + + @@ -29,6 +29,7 @@ IoTDB 目前支持将 CSV、SQL、及TsFile（IoTDB底层开放式时间序列 +
文件格式
文件格式 IoTDB工具 具体介绍
TsFile 主动监听&加载功能 根据用户配置，监听指定路径下TsFile文件的变化，将新增加的TsFile文件加载入IoTDB
## 2. import-data 脚本 diff --git a/src/zh/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_apache.md b/src/zh/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_apache.md index b882513b..0ce0c4ee 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_apache.md +++ b/src/zh/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_apache.md @@ -37,8 +37,8 @@ 通过 SQL 语句声明式地配置 3 个部分的具体内容，可实现灵活的数据同步能力。目前数据同步支持以下信息的同步，您可以在创建同步任务时对同步范围进行选择（默认选择 data.insert，即同步新写入的数据）： - - + + @@ -73,6 +73,7 @@ +
同步范围
同步范围 同步内容 说明
- 同步用户权限和访问控制
### 功能限制及说明 @@ -213,8 +214,8 @@ IoTDB> SHOW PIPEPLUGINS 预置插件详细介绍如下(各插件的详细参数可参考本文[参数说明](#参考参数说明))： - - + + @@ -251,6 +252,7 @@ IoTDB> SHOW PIPEPLUGINS +
类型
类型 自定义插件 插件名称 介绍用于 IoTDB（V1.3.1 及以上）与 IoTDB（V1.2.0 及以上）之间的数据传输。使用 Thrift RPC 框架传输数据，单线程 sync blocking IO 模型，适用于安全需求较高的场景 1.3.1+
导入自定义插件可参考[流处理框架](./Streaming_timecho.md#自定义流处理插件管理)章节。 diff --git a/src/zh/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_timecho.md b/src/zh/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_timecho.md index db6e76bd..9472acc7 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_timecho.md +++ b/src/zh/UserGuide/V2.0.1/Tree/User-Manual/Data-Sync_timecho.md @@ -37,8 +37,8 @@ 通过 SQL 语句声明式地配置 3 个部分的具体内容，可实现灵活的数据同步能力。目前数据同步支持以下信息的同步，您可以在创建同步任务时对同步范围进行选择（默认选择 data.insert，即同步新写入的数据）： - - + + @@ -73,6 +73,7 @@ +
同步范围
同步范围 同步内容 说明
- 同步用户权限和访问控制
### 功能限制及说明 @@ -216,8 +217,8 @@ IoTDB> SHOW PIPEPLUGINS - - + + @@ -259,6 +260,7 @@ IoTDB> SHOW PIPEPLUGINS +
类型
类型 自定义插件 插件名称 介绍用于 IoTDB（V1.3.1 及以上）与 IoTDB（V1.2.0 及以上）之间的数据传输。使用 Thrift RPC 框架传输数据，单线程 sync blocking IO 模型，适用于安全需求较高的场景 1.3.1+
导入自定义插件可参考[流处理框架](./Streaming_timecho.md#自定义流处理插件管理)章节。 diff --git a/src/zh/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_apache.md b/src/zh/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_apache.md index 7c085f60..237031ae 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_apache.md +++ b/src/zh/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_apache.md @@ -7,8 +7,8 @@ UDF（User Defined Function）即用户自定义函数，IoTDB 提供多种内 IoTDB 支持两种类型的 UDF 函数，如下表所示。 - - + + @@ -26,6 +26,7 @@ IoTDB 支持两种类型的 UDF 函数，如下表所示。 +
UDF 分类
UDF 分类 数据访问策略 描述
- 自定义聚合函数，输入 k 列时间序列 m 行数据，输出 1 列时间序列 1 行数据，可用于聚合函数出现的任何子句和表达式中，如select子句、having子句等。
### 1.1 UDF 使用 diff --git a/src/zh/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_timecho.md b/src/zh/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_timecho.md index 2125951b..05c25351 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_timecho.md +++ b/src/zh/UserGuide/V2.0.1/Tree/User-Manual/User-defined-function_timecho.md @@ -7,8 +7,8 @@ UDF（User Defined Function）即用户自定义函数，IoTDB 提供多种内 IoTDB 支持两种类型的 UDF 函数，如下表所示。 - - + + @@ -26,6 +26,7 @@ IoTDB 支持两种类型的 UDF 函数，如下表所示。 +
UDF 分类
UDF 分类 数据访问策略 描述
- 自定义聚合函数，输入 k 列时间序列 m 行数据，输出 1 列时间序列 1 行数据，可用于聚合函数出现的任何子句和表达式中，如select子句、having子句等。
### 1.1 UDF 使用 diff --git a/src/zh/UserGuide/V2.0.1/Tree/stage/Edge-Cloud-Collaboration/Sync-Tool.md b/src/zh/UserGuide/V2.0.1/Tree/stage/Edge-Cloud-Collaboration/Sync-Tool.md index 1ead9f51..08a4f51e 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/stage/Edge-Cloud-Collaboration/Sync-Tool.md +++ b/src/zh/UserGuide/V2.0.1/Tree/stage/Edge-Cloud-Collaboration/Sync-Tool.md @@ -124,7 +124,7 @@ IoTDB> DROP PIPE my_pipe - 显示当前所能支持的 PipeSink 类型。 -```Plain%20Text +``` IoTDB> SHOW PIPESINKTYPE IoTDB> +-----+ @@ -170,7 +170,7 @@ IoTDB> - 创建同步任务 - 其中 select 语句目前仅支持`**`（即所有序列中的数据），from 语句目前仅支持`root`，where语句仅支持指定 time 的起始时间。起始时间的指定形式可以是 yyyy-mm-dd HH:MM:SS或时间戳。 -```Plain%20Text +``` IoTDB> CREATE PIPE my_pipe TO my_iotdb [FROM (select ** from root WHERE time>=yyyy-mm-dd HH:MM:SS)] ``` @@ -227,7 +227,7 @@ IoTDB> DROP PIPE - ERROR 状态，这表明出现了网络连接正常但数据无法传输的问题，例如发送端 IP 不在接收端白名单中，或是发送端与接收端版本不兼容 - 当出现 ERROR 状态时，建议 STOP PIPE 后查看 DataNode 日志，检查接收端配置或网络情况后重新 START PIPE -```Plain%20Text +``` IoTDB> SHOW PIPES IoTDB> +-----------------------+--------+--------+-------------+---------+------------------------------------+-------+ @@ -287,7 +287,7 @@ IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>= 16485696 启动Pipe -```Plain%20Text +``` IoTDB> START PIPE p ``` @@ -318,7 +318,7 @@ flush; 在发送端和接受端执行查询，可查询到相同的结果 -```Plain%20Text +``` IoTDB> select ** from root.vehicle +-----------------------------+------------------+------------------+------------------+------------------+ | Time|root.vehicle.d0.s0|root.vehicle.d0.s1|root.vehicle.d1.s3|root.vehicle.d1.s2| diff --git a/src/zh/UserGuide/V2.0.1/Tree/stage/Syntax-Conventions/Literal-Values.md b/src/zh/UserGuide/V2.0.1/Tree/stage/Syntax-Conventions/Literal-Values.md index f2ad963b..62753a6d 100644 --- a/src/zh/UserGuide/V2.0.1/Tree/stage/Syntax-Conventions/Literal-Values.md +++ b/src/zh/UserGuide/V2.0.1/Tree/stage/Syntax-Conventions/Literal-Values.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/src/zh/UserGuide/latest/API/Programming-Cpp-Native-API.md b/src/zh/UserGuide/latest/API/Programming-Cpp-Native-API.md index 77636edf..5f02f2e6 100644 --- a/src/zh/UserGuide/latest/API/Programming-Cpp-Native-API.md +++ b/src/zh/UserGuide/latest/API/Programming-Cpp-Native-API.md @@ -124,12 +124,12 @@ git checkout rc/1.3.2 ``` - 使用 Visual Studio 2022 的 Windows - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp ``` - 使用 Visual Studio 2019 的 Windows - ```Batchfile + ```batch .\mvnw.cmd clean package -pl example/client-cpp-example -am -DskipTests -P with-cpp -Dcmake.generator="Visual Studio 16 2019" -Diotdb-tools-thrift.version=0.14.1.1-msvc142-SNAPSHOT ``` - 如果没有将 Boost 库地址加入 PATH 环境变量，在编译命令中还需添加相关参数，例如：`-DboostIncludeDir="C:\Program Files (x86)\boost_1_78_0" -DboostLibraryDir="C:\Program Files (x86)\boost_1_78_0\stage\lib"` diff --git a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Database-Resources.md b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Database-Resources.md index 17e09aa0..74ad4192 100644 --- a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Database-Resources.md +++ b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Database-Resources.md @@ -21,6 +21,7 @@ # 资源规划 ## CPU + @@ -77,10 +78,12 @@ +
序列数（采集频率<=1HZ） CPU1000w以上 请联系天谋商务咨询
## 内存 + @@ -137,12 +140,14 @@ +
序列数（采集频率<=1HZ） 内存1000w以上 请联系天谋商务咨询
## 存储(磁盘) ### 存储空间 计算公式：测点数量 * 采样频率（Hz）* 每个数据点大小（Byte，不同数据类型不一样，见下表） + @@ -176,6 +181,7 @@ +
数据点大小计算表
平均为a 8+a
示例：1000设备，每个设备100 测点，共 100000 序列，INT32 类型。采样频率1Hz（每秒一次），存储1年，3副本。 diff --git a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md index 75be11d6..63b85c16 100644 --- a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md @@ -90,7 +90,8 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 建议的磁盘分区方式如下表所示。 - + + @@ -125,6 +126,7 @@ IoTDB支持Linux、Windows、MacOS等操作系统，同时企业版支持龙芯 +
硬盘分类 磁盘组 对应盘符
......
### 网络配置 diff --git a/src/zh/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment_timecho.md b/src/zh/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment_timecho.md index cf17d08d..245593b2 100644 --- a/src/zh/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment_timecho.md +++ b/src/zh/UserGuide/latest/Deployment-and-Maintenance/workbench-deployment_timecho.md @@ -44,7 +44,8 @@ 1. 打开监控配置项。IoTDB中监控有关的配置项默认是关闭的，在部署监控面板前，您需要打开相关配置项（注意开启监控配置后需要重启服务）。 - + + @@ -92,7 +93,8 @@ -
配置项 所在配置文件 配置说明audit_log_operation 请在配置文件中添加该配置项，值设置为DML,DDL,QUERY
+ + 2. 重启所有节点。修改3个节点的监控指标配置后，可重新启动所有节点的confignode和datanode服务： diff --git a/src/zh/UserGuide/latest/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md b/src/zh/UserGuide/latest/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md index fe001d7e..efbcbaaf 100644 --- a/src/zh/UserGuide/latest/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md +++ b/src/zh/UserGuide/latest/Ecosystem-Integration/Ignition-IoTDB-plugin_timecho.md @@ -79,7 +79,8 @@ Ignition-IoTDB连接器提供了将 Ignition 采集到的数据存入 IoTDB 的 配置内容如下： - + + @@ -150,6 +151,7 @@ Ignition-IoTDB连接器提供了将 Ignition 采集到的数据存入 IoTDB 的 +
名称 含义 默认值保持默认即可
diff --git a/src/zh/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/zh/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md index b5fa25b2..d108342b 100644 --- a/src/zh/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/zh/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -81,8 +81,8 @@ TimechoDB 在开源版基础上提供了更多高阶产品功能，在内核层 详细功能对比如下： - - + + @@ -206,6 +206,7 @@ TimechoDB 在开源版基础上提供了更多高阶产品功能，在内核层 +
功能
功能 Apache IoTDB TimechoDB
× √
### 更高效/稳定的产品性能 diff --git a/src/zh/UserGuide/latest/Reference/Syntax-Rule.md b/src/zh/UserGuide/latest/Reference/Syntax-Rule.md index 29571210..dbf6d7e2 100644 --- a/src/zh/UserGuide/latest/Reference/Syntax-Rule.md +++ b/src/zh/UserGuide/latest/Reference/Syntax-Rule.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/src/zh/UserGuide/latest/Tools-System/Data-Import-Tool.md b/src/zh/UserGuide/latest/Tools-System/Data-Import-Tool.md index 08659116..ed67d75a 100644 --- a/src/zh/UserGuide/latest/Tools-System/Data-Import-Tool.md +++ b/src/zh/UserGuide/latest/Tools-System/Data-Import-Tool.md @@ -5,8 +5,8 @@ IoTDB 目前支持将 CSV、SQL、及TsFile（IoTDB底层开放式时间序列文件格式）格式的数据导入数据库。具体功能如下： - - + + @@ -29,6 +29,7 @@ IoTDB 目前支持将 CSV、SQL、及TsFile（IoTDB底层开放式时间序列 +
文件格式
文件格式 IoTDB工具 具体介绍
TsFile 主动监听&加载功能 根据用户配置，监听指定路径下TsFile文件的变化，将新增加的TsFile文件加载入IoTDB
## 2. import-data 脚本 diff --git a/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md b/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md index b882513b..0ce0c4ee 100644 --- a/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md +++ b/src/zh/UserGuide/latest/User-Manual/Data-Sync_apache.md @@ -37,8 +37,8 @@ 通过 SQL 语句声明式地配置 3 个部分的具体内容，可实现灵活的数据同步能力。目前数据同步支持以下信息的同步，您可以在创建同步任务时对同步范围进行选择（默认选择 data.insert，即同步新写入的数据）： - - + + @@ -73,6 +73,7 @@ +
同步范围
同步范围 同步内容 说明
- 同步用户权限和访问控制
### 功能限制及说明 @@ -213,8 +214,8 @@ IoTDB> SHOW PIPEPLUGINS 预置插件详细介绍如下(各插件的详细参数可参考本文[参数说明](#参考参数说明))： - - + + @@ -251,6 +252,7 @@ IoTDB> SHOW PIPEPLUGINS +
类型
类型 自定义插件 插件名称 介绍用于 IoTDB（V1.3.1 及以上）与 IoTDB（V1.2.0 及以上）之间的数据传输。使用 Thrift RPC 框架传输数据，单线程 sync blocking IO 模型，适用于安全需求较高的场景 1.3.1+
导入自定义插件可参考[流处理框架](./Streaming_timecho.md#自定义流处理插件管理)章节。 diff --git a/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md b/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md index db6e76bd..9472acc7 100644 --- a/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md +++ b/src/zh/UserGuide/latest/User-Manual/Data-Sync_timecho.md @@ -37,8 +37,8 @@ 通过 SQL 语句声明式地配置 3 个部分的具体内容，可实现灵活的数据同步能力。目前数据同步支持以下信息的同步，您可以在创建同步任务时对同步范围进行选择（默认选择 data.insert，即同步新写入的数据）： - - + + @@ -73,6 +73,7 @@ +
同步范围
同步范围 同步内容 说明
- 同步用户权限和访问控制
### 功能限制及说明 @@ -216,8 +217,8 @@ IoTDB> SHOW PIPEPLUGINS - - + + @@ -259,6 +260,7 @@ IoTDB> SHOW PIPEPLUGINS +
类型
类型 自定义插件 插件名称 介绍用于 IoTDB（V1.3.1 及以上）与 IoTDB（V1.2.0 及以上）之间的数据传输。使用 Thrift RPC 框架传输数据，单线程 sync blocking IO 模型，适用于安全需求较高的场景 1.3.1+
导入自定义插件可参考[流处理框架](./Streaming_timecho.md#自定义流处理插件管理)章节。 diff --git a/src/zh/UserGuide/latest/User-Manual/User-defined-function_apache.md b/src/zh/UserGuide/latest/User-Manual/User-defined-function_apache.md index 7c085f60..237031ae 100644 --- a/src/zh/UserGuide/latest/User-Manual/User-defined-function_apache.md +++ b/src/zh/UserGuide/latest/User-Manual/User-defined-function_apache.md @@ -7,8 +7,8 @@ UDF（User Defined Function）即用户自定义函数，IoTDB 提供多种内 IoTDB 支持两种类型的 UDF 函数，如下表所示。 - - + + @@ -26,6 +26,7 @@ IoTDB 支持两种类型的 UDF 函数，如下表所示。 +
UDF 分类
UDF 分类 数据访问策略 描述
- 自定义聚合函数，输入 k 列时间序列 m 行数据，输出 1 列时间序列 1 行数据，可用于聚合函数出现的任何子句和表达式中，如select子句、having子句等。
### 1.1 UDF 使用 diff --git a/src/zh/UserGuide/latest/User-Manual/User-defined-function_timecho.md b/src/zh/UserGuide/latest/User-Manual/User-defined-function_timecho.md index 2125951b..05c25351 100644 --- a/src/zh/UserGuide/latest/User-Manual/User-defined-function_timecho.md +++ b/src/zh/UserGuide/latest/User-Manual/User-defined-function_timecho.md @@ -7,8 +7,8 @@ UDF（User Defined Function）即用户自定义函数，IoTDB 提供多种内 IoTDB 支持两种类型的 UDF 函数，如下表所示。 - - + + @@ -26,6 +26,7 @@ IoTDB 支持两种类型的 UDF 函数，如下表所示。 +
UDF 分类
UDF 分类 数据访问策略 描述
- 自定义聚合函数，输入 k 列时间序列 m 行数据，输出 1 列时间序列 1 行数据，可用于聚合函数出现的任何子句和表达式中，如select子句、having子句等。
### 1.1 UDF 使用 diff --git a/src/zh/UserGuide/latest/stage/Edge-Cloud-Collaboration/Sync-Tool.md b/src/zh/UserGuide/latest/stage/Edge-Cloud-Collaboration/Sync-Tool.md index 1ead9f51..08a4f51e 100644 --- a/src/zh/UserGuide/latest/stage/Edge-Cloud-Collaboration/Sync-Tool.md +++ b/src/zh/UserGuide/latest/stage/Edge-Cloud-Collaboration/Sync-Tool.md @@ -124,7 +124,7 @@ IoTDB> DROP PIPE my_pipe - 显示当前所能支持的 PipeSink 类型。 -```Plain%20Text +``` IoTDB> SHOW PIPESINKTYPE IoTDB> +-----+ @@ -170,7 +170,7 @@ IoTDB> - 创建同步任务 - 其中 select 语句目前仅支持`**`（即所有序列中的数据），from 语句目前仅支持`root`，where语句仅支持指定 time 的起始时间。起始时间的指定形式可以是 yyyy-mm-dd HH:MM:SS或时间戳。 -```Plain%20Text +``` IoTDB> CREATE PIPE my_pipe TO my_iotdb [FROM (select ** from root WHERE time>=yyyy-mm-dd HH:MM:SS)] ``` @@ -227,7 +227,7 @@ IoTDB> DROP PIPE - ERROR 状态，这表明出现了网络连接正常但数据无法传输的问题，例如发送端 IP 不在接收端白名单中，或是发送端与接收端版本不兼容 - 当出现 ERROR 状态时，建议 STOP PIPE 后查看 DataNode 日志，检查接收端配置或网络情况后重新 START PIPE -```Plain%20Text +``` IoTDB> SHOW PIPES IoTDB> +-----------------------+--------+--------+-------------+---------+------------------------------------+-------+ @@ -287,7 +287,7 @@ IoTDB> CREATE PIPE p TO my_iotdb FROM (select ** from root where time>= 16485696 启动Pipe -```Plain%20Text +``` IoTDB> START PIPE p ``` @@ -318,7 +318,7 @@ flush; 在发送端和接受端执行查询，可查询到相同的结果 -```Plain%20Text +``` IoTDB> select ** from root.vehicle +-----------------------------+------------------+------------------+------------------+------------------+ | Time|root.vehicle.d0.s0|root.vehicle.d0.s1|root.vehicle.d1.s3|root.vehicle.d1.s2| diff --git a/src/zh/UserGuide/latest/stage/Syntax-Conventions/Literal-Values.md b/src/zh/UserGuide/latest/stage/Syntax-Conventions/Literal-Values.md index f2ad963b..62753a6d 100644 --- a/src/zh/UserGuide/latest/stage/Syntax-Conventions/Literal-Values.md +++ b/src/zh/UserGuide/latest/stage/Syntax-Conventions/Literal-Values.md @@ -28,7 +28,7 @@ 在 IoTDB 中，字符串是由**单引号（`'`）或双引号（`"`）字符括起来的字符序列**。示例如下： -```Plain%20Text +``` 'a string' "another string" ``` @@ -112,7 +112,7 @@ 字符串内使用引号的示例如下： -```Plain%20Text +``` 'string' // string '"string"' // "string" '""string""' // ""string"" diff --git a/tsconfig.base.json b/tsconfig.base.json index d27ffa63..570c04fc 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -16,7 +16,7 @@ // Modules "baseUrl": "./", - "module": "ESNext", + "module": "NodeNext", "moduleResolution": "NodeNext", "resolveJsonModule": true, @@ -41,10 +41,8 @@ // lib "lib": ["DOM", "ESNext"], - // minimal node 14 support - "target": "ES2020", - // minimal node 16 support - // "target": "ES2021", + // minimal node 18 support + "target": "ES2022", // Compiler Diagnostics "diagnostics": false, @@ -53,4 +51,4 @@ "skipLibCheck": true, "pretty": true } -} \ No newline at end of file +} diff --git a/tsconfig.json b/tsconfig.json index 81da69ac..fec95436 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,8 +1,20 @@ { "extends": "./tsconfig.base.json", "compilerOptions": { - "module": "ESNext", - "baseUrl": "./", + "module": "NodeNext", + "baseUrl": "./" }, - "include": ["**/*.ts", "**/*.js", "**/*.vue", "src/.vuepress/*.js", "src/.vuepress/*.ts", "src/.vuepress/*.vue", "src/.vuepress/**/*.js", "src/.vuepress/**/*.ts", "src/.vuepress/**/*.vue", "deploy.cjs", "deploy_staging.cjs"] -} \ No newline at end of file + "include": [ + "**/*.ts", + "**/*.js", + "**/*.vue", + "src/.vuepress/*.js", + "src/.vuepress/*.ts", + "src/.vuepress/*.vue", + "src/.vuepress/**/*.js", + "src/.vuepress/**/*.ts", + "src/.vuepress/**/*.vue", + "deploy.cjs", + "deploy_staging.cjs" + ] +}