You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by lu...@apache.org on 2024/03/19 10:11:46 UTC
(doris-website) branch master updated: [docs] Revise docs (#425)
This is an automated email from the ASF dual-hosted git repository.
luzhijing pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 8a61fbf458f9 [docs] Revise docs (#425)
8a61fbf458f9 is described below
commit 8a61fbf458f9f0872166fd2f855031f592089506
Author: KassieZ <13...@users.noreply.github.com>
AuthorDate: Tue Mar 19 18:11:39 2024 +0800
[docs] Revise docs (#425)
---
.../version-2.0.json | 234 +--
.../{ecosystem => admin-manual}/audit-plugin.md | 24 +-
.../{http-actions => }/be/check-rpc-channel.md | 8 +-
.../{http-actions => }/be/check-tablet-segment.md | 15 +-
.../admin-manual/{http-actions => }/be/checksum.md | 6 +-
.../{http-actions => }/be/compaction-run.md | 36 +-
.../{http-actions => }/be/compaction-status.md | 27 +-
.../admin-manual/{http-actions => }/be/config.md | 18 +-
.../admin-manual/{http-actions => }/be/download.md | 8 +-
.../admin-manual/{http-actions => }/be/health.md | 10 +-
.../admin-manual/{http-actions => }/be/meta.md | 12 +-
.../admin-manual/{http-actions => }/be/metrics.md | 16 +-
.../{http-actions => }/be/pad-rowset.md | 10 +-
.../{http-actions => }/be/reset-rpc-channel.md | 14 +-
.../admin-manual/{http-actions => }/be/snapshot.md | 8 +-
.../{http-actions => }/be/tablet-distribution.md | 12 +-
.../{http-actions => }/be/tablet-info.md | 12 +-
.../{http-actions => }/be/tablet-migration.md | 20 +-
.../{http-actions => }/be/tablet-reload.md | 11 +-
.../{http-actions => }/be/tablet-restore.md | 10 +-
.../{http-actions => }/be/version-info.md | 8 +-
.../cluster-management/elastic-expansion.md | 73 +-
.../admin-manual/cluster-management/fqdn.md | 49 +-
.../cluster-management/load-balancing.md | 146 +-
.../admin-manual/cluster-management/upgrade.md | 74 +-
.../best-practice => admin-manual}/compaction.md | 41 +-
.../version-2.0/admin-manual/config/be-config.md | 624 +++----
.../version-2.0/admin-manual/config/config-dir.md | 8 +-
.../admin-manual/config/fe-config-template.md | 12 +-
.../version-2.0/admin-manual/config/fe-config.md | 513 +++---
.../admin-manual/config/user-property.md | 4 +-
.../version-2.0/admin-manual/data-admin/backup.md | 126 +-
.../version-2.0/admin-manual/data-admin/ccr.md | 637 +++++++
.../admin-manual/data-admin/data-recovery.md | 8 +-
.../admin-manual/data-admin/delete-recover.md | 66 +-
.../version-2.0/admin-manual/data-admin/restore.md | 121 +-
.../{http-actions => }/fe/backends-action.md | 4 +-
.../{http-actions => }/fe/bootstrap-action.md | 12 +-
.../{http-actions => }/fe/cancel-load-action.md | 16 +-
.../fe/check-decommission-action.md | 8 +-
.../fe/check-storage-type-action.md | 2 +-
.../{http-actions => }/fe/cluster-action.md | 4 +-
.../{http-actions => }/fe/colocate-meta-action.md | 8 +-
.../{http-actions => }/fe/config-action.md | 2 +-
.../{http-actions => }/fe/connection-action.md | 2 +-
.../{http-actions => }/fe/debug-point-action.md | 10 +-
.../{http-actions => }/fe/extra-basepath-action.md | 4 +-
.../fe/fe-version-info-action.md | 4 +-
.../{http-actions => }/fe/get-ddl-stmt-action.md | 4 +-
.../{http-actions => }/fe/get-load-info-action.md | 6 +-
.../{http-actions => }/fe/get-load-state.md | 28 +-
.../{http-actions => }/fe/get-log-file-action.md | 2 +-
.../{http-actions => }/fe/get-small-file.md | 10 +-
.../{http-actions => }/fe/ha-action.md | 2 +-
.../{http-actions => }/fe/hardware-info-action.md | 6 +-
.../{http-actions => }/fe/health-action.md | 2 +-
.../{http-actions => }/fe/help-action.md | 4 +-
.../{http-actions => }/fe/import-action.md | 4 +-
.../{http-actions => }/fe/log-action.md | 2 +-
.../{http-actions => }/fe/login-action.md | 2 +-
.../{http-actions => }/fe/logout-action.md | 2 +-
.../{http-actions => }/fe/meta-action.md | 4 +-
.../{http-actions => }/fe/meta-info-action-V2.md | 2 +-
.../{http-actions => }/fe/meta-info-action.md | 4 +-
.../fe/meta-replay-state-action.md | 2 +-
.../{http-actions => }/fe/metrics-action.md | 10 +-
.../{http-actions => }/fe/node-action.md | 14 +-
.../{http-actions => }/fe/profile-action.md | 6 +-
.../{http-actions => }/fe/query-detail-action.md | 2 +-
.../fe/query-profile-action-controller.md | 2 +-
.../{http-actions => }/fe/query-profile-action.md | 40 +-
.../{http-actions => }/fe/query-schema-action.md | 4 +-
.../{http-actions => }/fe/query-stats-action.md | 10 +-
.../{http-actions => }/fe/row-count-action.md | 4 +-
.../{http-actions => }/fe/session-action.md | 10 +-
.../{http-actions => }/fe/set-config-action.md | 6 +-
.../{http-actions => }/fe/show-data-action.md | 2 +-
.../{http-actions => }/fe/show-meta-info-action.md | 4 +-
.../{http-actions => }/fe/show-proc-action.md | 2 +-
.../fe/show-runtime-info-action.md | 2 +-
.../fe/show-table-data-action.md | 4 +-
.../fe/statement-execution-action.md | 4 +-
.../admin-manual}/fe/statistic-action.md | 2 +-
.../{http-actions => }/fe/system-action.md | 4 +-
.../fe/table-query-plan-action.md | 2 +-
.../fe/table-row-count-action.md | 2 +-
.../{http-actions => }/fe/table-schema-action.md | 14 +-
.../{http-actions => }/fe/upload-action.md | 12 +-
.../maint-monitor/automatic-service-start.md | 110 +-
.../maint-monitor/be-olap-error-code.md | 250 +--
.../maint-monitor}/debug-log.md | 16 +-
.../admin-manual/maint-monitor/disk-capacity.md | 26 +-
.../admin-manual/maint-monitor/doris-error-code.md | 96 +-
.../maint-monitor/metadata-operation.md | 127 +-
.../admin-manual/maint-monitor/monitor-alert.md | 74 +-
.../maint-monitor/monitor-metrics/metrics.md | 285 +--
.../maint-monitor/tablet-local-debug.md | 41 +-
.../admin-manual/maint-monitor/tablet-meta-tool.md | 44 +-
.../maint-monitor/tablet-repair-and-balance.md | 199 +-
.../maint-monitor/tablet-restore-tool.md | 57 +-
.../memory-management/be-oom-analysis.md | 37 +-
.../memory-limit-exceeded-analysis.md | 78 +-
.../memory-management/memory-tracker.md | 85 +-
.../version-2.0/admin-manual/multi-tenant.md | 269 ---
.../plugin-development-manual.md | 52 +-
.../admin-manual/privilege-ldap/apache-ranger.md | 11 +-
.../{ => privilege-ldap}/certificate.md | 31 +-
.../{ => privilege-ldap}/fe-certificate.md | 31 +-
.../admin-manual/privilege-ldap/ldap.md | 237 ++-
.../admin-manual/privilege-ldap/user-privilege.md | 166 +-
.../version-2.0/admin-manual/query-admin/job.md | 169 ++
.../admin-manual/query-admin/kill-query.md | 85 +
.../admin-manual/query-admin/sql-interception.md | 117 ++
.../version-2.0/admin-manual/query-profile.md | 280 ---
.../admin-manual/resource-admin/compute-node.md | 116 ++
.../admin-manual/resource-admin/multi-tenant.md | 281 +++
.../admin-manual/resource-admin/workload-group.md | 114 ++
.../admin-manual/{system-table => }/rowsets.md | 23 +-
.../{advanced => admin-manual}/small-file-mgr.md | 5 +-
.../version-2.0/admin-manual/sql-interception.md | 98 -
.../version-2.0/admin-manual/workload-group.md | 101 -
.../advanced/alter-table/schema-change.md | 295 ---
.../version-2.0/advanced/cold-hot-separation.md | 208 ---
.../advanced/orthogonal-bitmap-manual.md | 205 ---
.../advanced/partition/dynamic-partition.md | 553 ------
.../advanced/partition/table-temp-partition.md | 286 ---
.../version-2.0/advanced/sql-mode.md | 76 -
.../version-2.0/benchmark/ssb.md | 102 +-
.../version-2.0/benchmark/tpch.md | 95 +-
.../delete/atomicity-replace.md} | 26 +-
.../batch-delete-manual.md | 153 +-
.../data-operate/delete/delete-manual.md | 289 +++
.../data-operate/delete/table-temp-partition.md | 259 +++
.../delete/truncate-manual.md} | 69 +-
.../data-operate/export/export-manual.md | 114 +-
.../data-operate/export/export-with-mysql-dump.md | 22 +-
.../version-2.0/data-operate/export/outfile.md | 34 +-
.../external-storage-load.md | 0
.../external-table-load.md | 0
.../jdbc-load.md | 0
.../kafka-load.md | 0
.../local-file-load.md | 0
.../binlog-load-manual.md | 0
.../s3-load-manual.md | 0
.../spark-load-manual.md | 0
.../data-operate/import/broker-load-manual.md | 736 ++++++++
.../data-operate/import/group-commit-manual.md | 513 ++++++
.../import/import-scenes/load-atomicity.md | 49 -
.../import/import-scenes/load-data-convert.md | 366 ----
.../import/import-way/broker-load-manual.md | 445 -----
.../import/import-way/insert-into-manual.md | 281 ---
.../import/import-way/mysql-load-manual.md | 155 --
.../import/import-way/routine-load-manual.md | 579 ------
.../import/import-way/stream-load-manual.md | 547 ------
.../data-operate/import/insert-into-manual.md | 448 +++++
.../data-operate/import/load-atomicity.md | 295 +++
.../data-operate/import/load-data-convert.md | 428 +++++
.../import/{import-way => }/load-json-format.md | 208 ++-
.../version-2.0/data-operate/import/load-manual.md | 38 +-
.../import/{import-scenes => }/load-strict-mode.md | 90 +-
.../import/migrate-data-from-other-olap.md | 78 +
.../data-operate/import/min-load-replica-num.md | 101 +
.../data-operate/import/mysql-load-manual.md | 273 +++
.../data-operate/import/routine-load-manual.md | 1941 ++++++++++++++++++++
.../data-operate/import/sample-cdc-load-manual.md | 7 +-
.../data-operate/import/stream-load-manual.md | 1067 +++++++++++
.../data-operate/update-delete/delete-manual.md | 156 --
.../data-operate/update-delete/partial-update.md | 231 ---
.../update-delete/sequence-column-manual.md | 276 ---
.../data-operate/update-delete/update.md | 130 --
.../data-operate/update/aggregate-load-update.md | 83 +
.../data-operate/update/unique-load-update.md | 160 ++
.../update/unique-update-transaction.md | 299 +++
.../data-operate/update/unique-update.md | 89 +
.../data-operate/update/update-overview.md | 93 +
.../version-2.0/data-table/basic-usage.md | 723 --------
.../version-2.0/data-table/best-practice.md | 181 --
.../version-2.0/data-table/data-partition.md | 431 -----
.../version-2.0/data-table/index/bloomfilter.md | 127 --
.../version-2.0/data-table/index/index-overview.md | 86 -
.../version-2.0/data-table/index/inverted-index.md | 552 ------
.../data-table/index/ngram-bloomfilter-index.md | 84 -
....md => (delete)native-user-defined-function.md} | 0
.../remote-user-defined-aggregation-function.md | 0
.../{udf => (delete)udf}/contribute-udf.md | 0
.../version-2.0/ecosystem/apache-superset.md | 69 +
.../version-2.0/ecosystem/beats.md | 22 +-
.../version-2.0/ecosystem/cloudcanal.md | 32 +-
.../version-2.0/ecosystem/datax.md | 367 ++--
.../version-2.0/ecosystem/dbt-doris-adapter.md | 105 +-
.../version-2.0/ecosystem/doris-kafka-connector.md | 24 +-
.../version-2.0/ecosystem/doris-streamloader.md | 28 +-
.../version-2.0/ecosystem/ecosystem-overview.md | 9 +-
.../version-2.0/ecosystem/flink-doris-connector.md | 221 ++-
.../version-2.0/ecosystem/hive-bitmap-udf.md | 42 +-
.../version-2.0/ecosystem/kyuubi.md | 27 +-
.../version-2.0/ecosystem/logstash.md | 66 +-
.../version-2.0/ecosystem/seatunnel.md | 58 +-
.../version-2.0/ecosystem/spark-doris-connector.md | 140 +-
.../version-2.0/faq/data-faq.md | 55 +-
.../version-2.0/faq/install-faq.md | 166 +-
.../{lakehouse/faq.md => faq/lakehouse-faq.md} | 119 +-
.../version-2.0/faq/sql-faq.md | 27 +-
.../version-2.0/get-starting/quick-start.md | 475 ++---
.../get-starting/what-is-apache-doris.md | 65 +-
.../(delete)build-docker-image.md} | 2 +-
.../cluster-deployment/k8s-deploy/debug-crash.md | 75 +
.../k8s-deploy/doris-cluster-upgrade.md | 298 +++
.../k8s-deploy/expansion-and-contraction.md | 103 ++
.../k8s-deploy/helm-chart-deploy.md | 39 +-
.../{ => cluster-deployment}/k8s-deploy/network.md | 57 +-
.../k8s-deploy/operator-deploy.md | 43 +-
.../k8s-deploy/persistent-volume.md | 24 +-
.../cluster-deployment/k8s-deploy/root-user-use.md | 67 +
.../cluster-deployment/run-docker-cluster.md | 335 ++++
.../cluster-deployment/standard-deployment.md | 626 +++++++
.../install/construct-docker/run-docker-cluster.md | 190 --
...n-general.md => (delete)compilation-general.md} | 0
.../install/source-install/compilation-arm.md | 645 ++-----
.../install/source-install/compilation-linux.md | 60 +
.../install/source-install/compilation-mac.md | 139 +-
.../install/source-install/compilation-win.md | 65 +-
.../source-install/compilation-with-docker.md | 150 ++
.../compilation-with-ldb-toolchain.md | 154 +-
.../version-2.0/install/standard-deployment.md | 391 ----
...chmark-tool.md => (delete)fs-benchmark-tool.md} | 0
.../version-2.0/lakehouse/compute-node.md | 111 --
.../dlf.md => database/(delete)dlf.md} | 0
.../(delete)faq-multi-catalog.md} | 0
.../(delete)multi-catalog.md} | 0
.../lakehouse/{multi-catalog => database}/es.md | 154 +-
.../lakehouse/{multi-catalog => database}/jdbc.md | 258 +--
.../{multi-catalog => database}/max-compute.md | 31 +-
.../version-2.0/lakehouse/datalake/cloud-auth.md | 62 +
.../version-2.0/lakehouse/datalake/hive.md | 680 +++++++
.../lakehouse/{multi-catalog => datalake}/hudi.md | 31 +-
.../{multi-catalog => datalake}/iceberg.md | 45 +-
.../{multi-catalog => datalake}/paimon.md | 84 +-
.../version-2.0/lakehouse/external-statistics.md | 321 ++--
.../version-2.0/lakehouse/file.md | 37 +-
.../version-2.0/lakehouse/filecache.md | 34 +-
.../version-2.0/lakehouse/lakehouse-overview.md | 445 +++++
.../version-2.0/lakehouse/multi-catalog/hive.md | 481 -----
.../version-2.0/lakehouse/sql-dialect.md | 140 ++
.../hight-concurrent-point-query.md | 159 --
.../join-optimization/runtime-filter.md | 288 ---
.../query/duplicate/orthogonal-bitmap-manual.md | 212 +++
.../{advanced => query/duplicate}/using-hll.md | 56 +-
.../query/high-concurrent-point-query.md | 179 ++
.../join-optimization/bucket-shuffle-join.md | 64 +-
.../join-optimization/colocation-join.md | 61 +-
.../join-optimization/doris-join-optimization.md | 51 +-
.../join-optimization/join-hint.md} | 224 ++-
.../query/join-optimization/runtime-filter.md | 327 ++++
.../nereids}/nereids.md | 21 +-
.../nereids}/statistics.md | 101 +-
.../pipeline}/pipeline-execution-engine.md | 30 +-
.../query/pipeline/pipelinex-execution-engine.md | 41 +
.../query-analysis}/import-analysis.md | 20 +-
.../query-analysis}/query-analysis.md | 18 +-
.../query/query-analysis/query-profile.md | 369 ++++
.../query/query-cache/partition-cache-manual.md | 170 ++
.../version-2.0/query/query-cache/query-cache.md | 148 ++
.../query/query-cache/sql-cache-manual.md | 78 +
.../query/query-data/common-table-expression.md | 43 +
.../query-data/complex-type.md} | 35 +-
.../query/query-data/encryption-function.md | 215 +++
.../{advanced => query/query-data}/lateral-view.md | 6 +-
.../query/query-data/mysql-compatibility.md | 360 ++++
.../version-2.0/query/query-data/select.md | 428 +++++
.../version-2.0/query/query-data/subquery.md | 44 +
.../query/query-data/window-function.md | 109 ++
.../version-2.0/query/query-variables/sql-mode.md | 83 +
.../query-variables}/time-zone.md | 33 +-
.../query-variables}/variables.md | 155 +-
.../udf/java-user-defined-function.md | 127 +-
.../udf/remote-user-defined-function.md | 83 +-
.../asyn-materialized-view.md | 11 +-
.../query/view-materialized-view/create-view.md | 84 +
.../view-materialized-view}/materialized-view.md | 79 +-
.../(delete)data-model.md} | 120 +-
.../(delete)hit-the-rollup.md} | 0
.../version-2.0/table-design/auto-increment.md | 274 +++
.../version-2.0/table-design/best-practice.md | 561 ++++++
.../table-design/cold-hot-separation.md | 239 +++
.../table-design/data-model/aggregate.md | 317 ++++
.../table-design/data-model/duplicate.md | 153 ++
.../table-design/data-model/overview.md | 39 +
.../version-2.0/table-design/data-model/tips.md | 190 ++
.../version-2.0/table-design/data-model/unique.md | 113 ++
.../version-2.0/table-design/data-partition.md | 1051 +++++++++++
.../version-2.0/table-design/data-type.md | 57 +
.../version-2.0/table-design/index/bitmap-index.md | 92 +
.../version-2.0/table-design/index/bloomfilter.md | 119 ++
.../table-design/index/index-overview.md | 43 +
.../table-design/index/inverted-index.md | 627 +++++++
.../table-design/index/ngram-bloomfilter-index.md | 89 +
.../version-2.0/table-design/index/prefix-index.md | 77 +
.../version-2.0/table-design/schema-change.md | 489 +++++
.../alter-table/replace-table.md" | 0
.../autobucket.md" | 0
.../broker.md" | 0
.../cache/partition-cache.md" | 0
.../is-being-synced.md" | 0
.../resource.md" | 0
.../variables-template.md" | 0
.../version-2.1/advanced/auto-increment.md | 52 +-
.../version-2.1/data-table/data-model.md | 128 +-
static/images/Bitmap-index.png | Bin 0 -> 295177 bytes
static/images/CBO-Optimizer.png | Bin 0 -> 156604 bytes
static/images/Doris-Web-UI-Playground.png | Bin 0 -> 120740 bytes
static/images/Doris-Web-UI.png | Bin 0 -> 373008 bytes
static/images/agg-key.png | Bin 0 -> 189837 bytes
static/images/broker-load.png | Bin 0 -> 121834 bytes
static/images/ccr-architecture.png | Bin 0 -> 172654 bytes
static/images/connector.png | Bin 0 -> 97839 bytes
static/images/create-data-table.png | Bin 0 -> 251433 bytes
static/images/doris-architecture.png | Bin 0 -> 57827 bytes
static/images/doris-query-engine-mpp.png | Bin 0 -> 72422 bytes
static/images/doris-query-engine.png | Bin 0 -> 93015 bytes
static/images/doris-scenario.png | Bin 0 -> 356421 bytes
static/images/duplicate-key.png | Bin 0 -> 206772 bytes
static/images/lakehouse-architecture.png | Bin 0 -> 272470 bytes
static/images/mergeIO.png | Bin 0 -> 272373 bytes
.../images/metadata-syncer-for-hive-metastore.png | Bin 0 -> 229465 bytes
static/images/native-reader.png | Bin 0 -> 716936 bytes
static/images/remote-file-system-2.png | Bin 0 -> 102701 bytes
static/images/remote-file-system.png | Bin 0 -> 210439 bytes
static/images/routine-load.jpeg | Bin 0 -> 118779 bytes
static/images/stream-load.png | Bin 0 -> 142985 bytes
static/images/vectorized-block-reader.png | Bin 0 -> 547129 bytes
static/images/x2doris-core-features.png | Bin 0 -> 243730 bytes
static/images/x2doris-create-table-2.png | Bin 0 -> 240730 bytes
static/images/x2doris-create-table.png | Bin 0 -> 166587 bytes
.../{ecosystem => admin-manual}/audit-plugin.md | 0
.../{http-actions => }/be/check-rpc-channel.md | 0
.../{http-actions => }/be/check-tablet-segment.md | 0
.../admin-manual/{http-actions => }/be/checksum.md | 0
.../{http-actions => }/be/compaction-run.md | 0
.../{http-actions => }/be/compaction-status.md | 0
.../admin-manual/{http-actions => }/be/config.md | 0
.../admin-manual/{http-actions => }/be/download.md | 0
.../admin-manual/{http-actions => }/be/health.md | 0
.../admin-manual/{http-actions => }/be/meta.md | 0
.../admin-manual/{http-actions => }/be/metrics.md | 0
.../{http-actions => }/be/pad-rowset.md | 0
.../{http-actions => }/be/reset-rpc-channel.md | 0
.../admin-manual/{http-actions => }/be/snapshot.md | 0
.../{http-actions => }/be/tablet-distribution.md | 0
.../{http-actions => }/be/tablet-info.md | 0
.../{http-actions => }/be/tablet-migration.md | 0
.../{http-actions => }/be/tablet-reload.md | 0
.../{http-actions => }/be/tablet-restore.md | 0
.../{http-actions => }/be/version-info.md | 0
.../best-practice => admin-manual}/compaction.md | 0
.../data-admin/ccr.md} | 7 +-
.../admin-manual/data-admin/delete-recover.md | 2 +-
.../version-2.0/admin-manual/data-admin/restore.md | 4 +-
.../{http-actions => }/fe/backends-action.md | 0
.../{http-actions => }/fe/bootstrap-action.md | 0
.../{http-actions => }/fe/cancel-load-action.md | 0
.../fe/check-decommission-action.md | 0
.../fe/check-storage-type-action.md | 0
.../{http-actions => }/fe/cluster-action.md | 0
.../{http-actions => }/fe/colocate-meta-action.md | 0
.../{http-actions => }/fe/config-action.md | 0
.../{http-actions => }/fe/connection-action.md | 0
.../{http-actions => }/fe/debug-point-action.md | 0
.../{http-actions => }/fe/extra-basepath-action.md | 0
.../fe/fe-version-info-action.md | 0
.../{http-actions => }/fe/get-ddl-stmt-action.md | 0
.../{http-actions => }/fe/get-load-info-action.md | 0
.../{http-actions => }/fe/get-load-state.md | 0
.../{http-actions => }/fe/get-log-file-action.md | 0
.../{http-actions => }/fe/get-small-file.md | 0
.../{http-actions => }/fe/ha-action.md | 0
.../{http-actions => }/fe/hardware-info-action.md | 0
.../{http-actions => }/fe/health-action.md | 0
.../{http-actions => }/fe/help-action.md | 0
.../{http-actions => }/fe/import-action.md | 0
.../{http-actions => }/fe/log-action.md | 0
.../{http-actions => }/fe/login-action.md | 0
.../{http-actions => }/fe/logout-action.md | 0
.../{http-actions => }/fe/meta-action.md | 0
.../{http-actions => }/fe/meta-info-action-V2.md | 0
.../{http-actions => }/fe/meta-info-action.md | 0
.../fe/meta-replay-state-action.md | 0
.../{http-actions => }/fe/metrics-action.md | 0
.../{http-actions => }/fe/node-action.md | 0
.../{http-actions => }/fe/profile-action.md | 0
.../{http-actions => }/fe/query-detail-action.md | 0
.../fe/query-profile-action-controller.md | 0
.../{http-actions => }/fe/query-profile-action.md | 0
.../{http-actions => }/fe/query-schema-action.md | 0
.../{http-actions => }/fe/query-stats-action.md | 0
.../{http-actions => }/fe/row-count-action.md | 0
.../{http-actions => }/fe/session-action.md | 0
.../{http-actions => }/fe/set-config-action.md | 0
.../{http-actions => }/fe/show-data-action.md | 0
.../{http-actions => }/fe/show-meta-info-action.md | 0
.../{http-actions => }/fe/show-proc-action.md | 0
.../fe/show-runtime-info-action.md | 0
.../fe/show-table-data-action.md | 0
.../fe/statement-execution-action.md | 0
.../admin-manual}/fe/statistic-action.md | 0
.../{http-actions => }/fe/system-action.md | 0
.../fe/table-query-plan-action.md | 0
.../fe/table-row-count-action.md | 0
.../{http-actions => }/fe/table-schema-action.md | 0
.../{http-actions => }/fe/upload-action.md | 0
.../{multi-tenant.md => (delete) multi-tenant.md} | 0
.../maint-monitor}/debug-log.md | 0
.../memory-management/be-oom-analysis.md | 0
.../memory-limit-exceeded-analysis.md | 0
.../memory-management/memory-tracker.md | 0
.../plugin-development-manual.md | 0
.../privilege-ldap/apache-ranger.md} | 7 +-
.../{ => privilege-ldap}/certificate.md | 0
.../{ => privilege-ldap}/fe-certificate.md | 0
.../query-admin/job.md} | 5 +-
.../query-admin/kill-query.md} | 5 +-
.../{ => query-admin}/sql-interception.md | 8 +-
.../resource-admin}/compute-node.md | 0
.../{ => resource-admin}/multi-tenant.md | 0
.../{ => resource-admin}/workload-group.md | 0
.../admin-manual/{system-table => }/rowsets.md | 0
.../{advanced => admin-manual}/small-file-mgr.md | 0
.../delete/atomicity-replace.md} | 5 +-
.../batch-delete-manual.md | 0
.../{update-delete => delete}/delete-manual.md | 0
.../delete}/table-temp-partition.md | 0
.../delete/truncate-manual.md} | 5 +-
.../external-storage-load.md | 0
.../external-table-load.md | 0
.../jdbc-load.md | 0
.../kafka-load.md | 0
.../local-file-load.md | 0
.../binlog-load-manual.md | 0
.../s3-load-manual.md | 0
.../spark-load-manual.md | 0
.../import/(sample) cdc-load-manual.md} | 4 +-
.../import/{import-way => }/broker-load-manual.md | 0
.../data-operate/import/group-commit-manual.md | 501 +++++
.../import/{import-way => }/insert-into-manual.md | 0
.../import/{import-scenes => }/load-atomicity.md | 0
.../{import-scenes => }/load-data-convert.md | 0
.../import/{import-way => }/load-json-format.md | 0
.../import/{import-scenes => }/load-strict-mode.md | 0
.../import/migrate-data-from-other-olap.md} | 5 +-
.../data-operate/import/min-load-replica-num.md | 101 +
.../import/{import-way => }/mysql-load-manual.md | 0
.../import/{import-way => }/routine-load-manual.md | 0
.../import/{import-way => }/stream-load-manual.md | 0
.../update/aggregate-load-update.md} | 5 +-
.../unique-load-update.md} | 2 +-
.../unique-update-transaction.md} | 0
.../update/unique-update.md} | 5 +-
.../update.md => update/update-overview.md} | 0
.../remote-user-defined-aggregation-function.md | 0
.../{udf => (delete)udf}/contribute-udf.md | 0
.../native-user-defined-function.md | 0
.../version-2.0/ecosystem/apache-superset.md | 53 +
.../ecosystem-overview.md} | 7 +-
.../{lakehouse/faq.md => faq/lakehouse-faq.md} | 0
.../build-docker-image.md | 0
.../cluster-deployment/k8s-deploy/debug-crash.md | 73 +
.../k8s-deploy/doris-cluster-upgrade.md | 286 +++
.../k8s-deploy/expansion-and-contraction.md | 100 +
.../k8s-deploy/helm-chart-deploy.md | 6 +-
.../{ => cluster-deployment}/k8s-deploy/network.md | 4 +-
.../k8s-deploy/operator-deploy.md | 0
.../k8s-deploy/persistent-volume.md | 6 +-
.../cluster-deployment/k8s-deploy/root-user-use.md | 63 +
.../run-docker-cluster.md | 0
.../standard-deployment.md | 0
...n-general.md => (delete)compilation-general.md} | 0
.../source-install/compilation-linux.md} | 7 +-
.../compilation-with-docker.md} | 7 +-
...chmark-tool.md => (delete)fs-benchmark-tool.md} | 0
.../multi-catalog.md => (delete)multi-catalog.md} | 0
.../dlf.md => database/(delete)dlf.md} | 0
.../(delete)faq-multi-catalog.md} | 0
.../lakehouse/{multi-catalog => database}/es.md | 0
.../lakehouse/{multi-catalog => database}/jdbc.md | 0
.../{multi-catalog => database}/max-compute.md | 0
.../version-2.0/lakehouse/datalake/cloud-auth.md | 61 +
.../lakehouse/{multi-catalog => datalake}/hive.md | 0
.../lakehouse/{multi-catalog => datalake}/hudi.md | 0
.../{multi-catalog => datalake}/iceberg.md | 0
.../{multi-catalog => datalake}/paimon.md | 0
.../lakehouse-overview.md} | 7 +-
.../version-2.0/lakehouse/sql-dialect.md | 129 ++
.../duplicate}/orthogonal-bitmap-manual.md | 0
.../{advanced => query/duplicate}/using-hll.md | 0
.../high-concurrent-point-query.md} | 0
.../join-optimization/bucket-shuffle-join.md | 0
.../join-optimization/colocation-join.md | 0
.../join-optimization/doris-join-optimization.md | 0
.../join-optimization/join-hint.md} | 0
.../join-optimization/runtime-filter.md | 0
.../nereids}/nereids.md | 0
.../nereids}/statistics.md | 0
.../pipeline}/pipeline-execution-engine.md | 0
.../pipeline/pipelinex-execution-engine.md} | 9 +-
.../query-analysis}/import-analysis.md | 0
.../query-analysis}/query-analysis.md | 0
.../query-analysis}/query-profile.md | 0
.../query/query-cache/partition-cache-manual.md | 170 ++
.../version-2.0/query/query-cache/query-cache.md | 140 ++
.../query/query-cache/sql-cache-manual.md | 78 +
.../query-data/common-table-expression.md} | 5 +-
.../query-data/complex-type.md} | 5 +-
.../query-data/encryption-function.md} | 5 +-
.../{advanced => query/query-data}/lateral-view.md | 0
.../query-data/mysql-compatibility.md} | 5 +-
.../query-cache.md => query/query-data/select.md} | 5 +-
.../query-data/subquery.md} | 5 +-
.../query-data/window-function.md} | 5 +-
.../query-variables}/sql-mode.md | 0
.../query-variables}/time-zone.md | 0
.../query-variables}/variables.md | 0
.../udf/java-user-defined-function.md | 0
.../udf/remote-user-defined-function.md | 0
.../asyn-materialized-view.md} | 9 +-
.../view-materialized-view/create-view.md} | 7 +-
.../view-materialized-view}/materialized-view.md | 0
.../(delete) advance-usage.md} | 0
.../(delete) hit-the-rollup.md} | 0
.../version-2.0/table-design}/auto-increment.md | 137 +-
.../{data-table => table-design}/best-practice.md | 0
.../cold-hot-separation.md | 2 +-
.../data-model/aggregate.md} | 407 +---
.../table-design/data-model/duplicate.md | 272 +++
.../table-design/data-model/overview.md | 42 +
.../data-model/tips.md} | 2 +-
.../version-2.0/table-design/data-model/unique.md | 177 ++
.../{data-table => table-design}/data-partition.md | 2 +-
.../version-2.0/table-design/data-type.md | 55 +
.../index/bitmap-index.md} | 7 +-
.../index/bloomfilter.md | 0
.../index/index-overview.md | 0
.../index/inverted-index.md | 0
.../index/ngram-bloomfilter-index.md | 0
.../index/prefix-index.md} | 6 +-
.../alter-table => table-design}/schema-change.md | 2 +-
.../alter-table/replace-table.md" | 0
.../alter-table/schema-change.md" | 0
.../autobucket.md" | 0
.../broker.md" | 0
.../cache/partition-cache.md" | 0
.../cold-hot-separation.md" | 0
.../is-being-synced.md" | 0
.../orthogonal-hll-manual.md" | 0
.../partition/dynamic-partition.md" | 0
.../partition/table-temp-partition.md" | 0
.../resource.md" | 0
.../variables-template.md" | 0
.../version-2.1/data-table/data-model.md | 2 +-
versioned_sidebars/version-2.0-sidebars.json | 715 +++----
559 files changed, 28153 insertions(+), 15627 deletions(-)
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0.json b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0.json
index ecc322e9d3ea..1da34f2af99e 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0.json
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0.json
@@ -7,32 +7,32 @@
"message": "快速开始",
"description": "The label for category Getting Started in sidebar docs"
},
- "sidebar.docs.category.Doris Introduction": {
- "message": "Doris 介绍",
- "description": "The label for category Doris Introduction in sidebar docs"
- },
"sidebar.docs.category.Install and Deploy": {
"message": "安装部署",
"description": "The label for category Install and Deploy in sidebar docs"
},
- "sidebar.docs.category.Docker Deployment": {
- "message": "Docker 部署",
- "description": "Make docker image and quickly start Doris's Docker cluster"
- },
- "sidebar.docs.category.Deploy Doris on Kubernetes": {
- "message": "基于 Kubernetes 部署",
- "description": "The label for category Deploy Doris on Kubernetes in sidebar docs"
- },
"sidebar.docs.category.Source Code Compilation": {
"message": "源码编译",
"description": "The label for category Compile in sidebar docs"
},
+ "sidebar.docs.category.Cluster Deployment": {
+ "message": "集群部署",
+ "description": "The label for category Cluster Deployment in sidebar docs"
+ },
+ "sidebar.docs.category.Deploy on Kubernetes": {
+ "message": "K8s 部署",
+ "description": "The label for category Deploy on Kubernetes in sidebar docs"
+ },
"sidebar.docs.category.Table Design": {
"message": "数据表设计",
"description": "The label for category Table Design in sidebar docs"
},
+ "sidebar.docs.category.Data Model": {
+ "message": "数据模型",
+ "description": "The label for category Data Model in sidebar docs"
+ },
"sidebar.docs.category.Index": {
- "message": "索引",
+ "message": "表索引",
"description": "The label for category Index in sidebar docs"
},
"sidebar.docs.category.Data Operation": {
@@ -43,29 +43,73 @@
"message": "数据导入",
"description": "The label for category Import in sidebar docs"
},
- "sidebar.docs.category.Import Scenes": {
- "message": "按场景导入",
- "description": "The label for category Import Scenes in sidebar docs"
- },
- "sidebar.docs.category.Import Way": {
- "message": "按方式导入",
- "description": "The label for category Import Way in sidebar docs"
+ "sidebar.docs.category.Update": {
+ "message": "数据更新",
+ "description": "The label for category Update in sidebar docs"
},
- "sidebar.docs.category.Import Advanced": {
- "message": "高级导入",
- "description": "The label for category Import Advanced in sidebar docs"
+ "sidebar.docs.category.Delete": {
+ "message": "数据删除",
+ "description": "The label for category Delete in sidebar docs"
},
"sidebar.docs.category.Export": {
- "message": "导出",
+ "message": "数据导出",
"description": "The label for category Export in sidebar docs"
},
- "sidebar.docs.category.Update and Delete": {
- "message": "数据更新及删除",
- "description": "The label for category Update and Delete in sidebar docs"
+ "sidebar.docs.category.Lakehouse": {
+ "message": "湖仓一体",
+ "description": "The label for category Lakehouse in sidebar docs"
+ },
+ "sidebar.docs.category.Data Lake Analytics": {
+ "message": "数据湖分析",
+ "description": "The label for category Data Lake Analytics in sidebar docs"
+ },
+ "sidebar.docs.category.Database Analytics": {
+ "message": "数据库分析",
+ "description": "The label for category Database Analytics.Multi Catalog in sidebar docs"
+ },
+ "sidebar.docs.category.Query": {
+ "message": "数据查询",
+ "description": "The label for category Query in sidebar docs"
+ },
+ "sidebar.docs.category.Query Data": {
+ "message": "数据查询",
+ "description": "The label for category Query Data in sidebar docs"
},
- "sidebar.docs.category.Advanced Usage": {
- "message": "进阶使用",
- "description": "The label for category Advanced Usage in sidebar docs"
+ "sidebar.docs.category.Query Variables": {
+ "message": "查询变量",
+ "description": "The label for category Query Variables in sidebar docs"
+ },
+ "sidebar.docs.category.Nereids": {
+ "message": "全新优化器",
+ "description": "The label for category Nereids in sidebar docs"
+ },
+ "sidebar.docs.category.Pipeline": {
+ "message": "Pipeline 执行引擎",
+ "description": "The label for category Pipeline in sidebar docs"
+ },
+ "sidebar.docs.category.Cache": {
+ "message": "查询缓存",
+ "description": "The label for category Pipeline in sidebar docs"
+ },
+ "sidebar.docs.category.Create View and Materialize View": {
+ "message": "视图与物化视图",
+ "description": "The label for category View and Materialize View in sidebar docs"
+ },
+ "sidebar.docs.category.Join Optimization": {
+ "message": "Join 优化",
+ "description": "The label for category Join Optimization in sidebar docs"
+ },
+ "sidebar.docs.category.Duplicate": {
+ "message": "高效去重",
+ "description": "The label for category Duplicate in sidebar docs"
+ },
+ "sidebar.docs.category.Query Analysis": {
+ "message": "查询分析",
+ "description": "The label for category Query Analysis in sidebar docs"
+ },
+ "sidebar.docs.category.UDF": {
+ "message": "自定义函数",
+ "description": "The label for category UDF in sidebar docs"
},
"sidebar.docs.category.Alter Table": {
"message": "表结构变更",
@@ -75,41 +119,61 @@
"message": "Doris 表分区",
"description": "The label for category Doris Partition in sidebar docs"
},
- "sidebar.docs.category.Join Optimization": {
- "message": "Join 优化",
- "description": "The label for category Join Optimization in sidebar docs"
- },
- "sidebar.docs.category.Data Cache": {
- "message": "数据缓存",
- "description": "The label for category Data Cache in sidebar docs"
- },
"sidebar.docs.category.Best Practice": {
"message": "最佳实践",
"description": "The label for category Best Practice in sidebar docs"
},
- "sidebar.docs.category.Query Acceleration": {
- "message": "查询加速",
- "description": "The label for category Query Acceleration in sidebar docs"
- },
"sidebar.docs.category.Ecosystem": {
"message": "生态扩展",
"description": "The label for category Ecosystem in sidebar docs"
},
- "sidebar.docs.category.Doris Manager": {
- "message": "Doris Manager",
- "description": "The label for category Doris Manager in sidebar docs"
+ "sidebar.docs.category.Admin Manual": {
+ "message": "管理指南",
+ "description": "The label for category Admin Manual in sidebar docs"
},
- "sidebar.docs.category.SeaTunnel": {
- "message": "SeaTunnel",
- "description": "The label for category SeaTunnel in sidebar docs"
+ "sidebar.docs.category.Cluster Management": {
+ "message": "集群管理",
+ "description": "The label for category cluster management in sidebar docs"
},
- "sidebar.docs.category.UDAF": {
- "message": "UDAF",
- "description": "The label for category UDAF in sidebar docs"
+ "sidebar.docs.category.Data Admin": {
+ "message": "数据管理",
+ "description": "The label for category Data Admin in sidebar docs"
},
- "sidebar.docs.category.UDF": {
- "message": "自定义函数",
- "description": "The label for category UDF in sidebar docs"
+ "sidebar.docs.category.Resource Admin": {
+ "message": "资源管理",
+ "description": "The label for category Data Admin in sidebar docs"
+ },
+ "sidebar.docs.category.Query Admin": {
+ "message": "查询管理",
+ "description": "The label for category Data Admin in sidebar docs"
+ },
+ "sidebar.docs.category.User Privilege and Ldap": {
+ "message": "安全管理",
+ "description": "The label for category User Privilege and Ldap in sidebar docs"
+ },
+ "sidebar.docs.category.Memory Management": {
+ "message": "内存管理",
+ "description": "The label for category Memory Management in sidebar docs"
+ },
+ "sidebar.docs.category.Maintenance and Monitor": {
+ "message": "运维监控",
+ "description": "The label for category Maintenance and Monitor in sidebar docs"
+ },
+ "sidebar.docs.category.Config": {
+ "message": "配置管理",
+ "description": "The label for category Config in sidebar docs"
+ },
+ "sidebar.docs.category.FE OPEN API": {
+ "message": "FE OPEN API",
+ "description": "The label for category FE OPEN API in sidebar docs"
+ },
+ "sidebar.docs.category.BE OPEN API": {
+ "message": "BE OPEN API",
+ "description": "The label for category BE OPEN API in sidebar docs"
+ },
+ "sidebar.docs.category.Monitor Metrics": {
+ "message": "监控指标",
+ "description": "The label for category Monitor Metrics in sidebar docs"
},
"sidebar.docs.category.SQL Manual": {
"message": "SQL 手册",
@@ -247,54 +311,6 @@
"message": "辅助命令",
"description": "The label for category Utility in sidebar docs"
},
- "sidebar.docs.category.Admin Manual": {
- "message": "管理手册",
- "description": "The label for category Admin Manual in sidebar docs"
- },
- "sidebar.docs.category.cluster management": {
- "message": "集群管理",
- "description": "The label for category cluster management in sidebar docs"
- },
- "sidebar.docs.category.Data Admin": {
- "message": "数据管理",
- "description": "The label for category Data Admin in sidebar docs"
- },
- "sidebar.docs.category.Maintenance and Monitor": {
- "message": "运维监控",
- "description": "The label for category Maintenance and Monitor in sidebar docs"
- },
- "sidebar.docs.category.Monitor Metrics": {
- "message": "监控指标",
- "description": "The label for category Monitor Metrics in sidebar docs"
- },
- "sidebar.docs.category.Memory Management": {
- "message": "内存管理",
- "description": "The label for category Memory Management in sidebar docs"
- },
- "sidebar.docs.category.Config": {
- "message": "配置管理",
- "description": "The label for category Config in sidebar docs"
- },
- "sidebar.docs.category.User Privilege and Ldap": {
- "message": "用户权限及认证",
- "description": "The label for category User Privilege and Ldap in sidebar docs"
- },
- "sidebar.docs.category.System Table": {
- "message": "System Table",
- "description": "The label for category System Table in sidebar docs"
- },
- "sidebar.docs.category.HTTP API": {
- "message": "HTTP API",
- "description": "The label for category HTTP API in sidebar docs"
- },
- "sidebar.docs.category.FE": {
- "message": "FE",
- "description": "The label for category FE in sidebar docs"
- },
- "sidebar.docs.category.BE": {
- "message": "BE",
- "description": "The label for category BE in sidebar docs"
- },
"sidebar.docs.category.FAQ": {
"message": "常见问题",
"description": "The label for category FAQ in sidebar docs"
@@ -303,20 +319,8 @@
"message": "性能测试",
"description": "The label for category Benchmark in sidebar docs"
},
- "sidebar.docs.category.Lakehouse": {
- "message": "数据湖分析",
- "description": "The label for category Lakehouse in sidebar docs"
- },
- "sidebar.docs.category.Multi Catalog": {
- "message": "多源数据目录",
- "description": "The label for category Lakehouse.Multi Catalog in sidebar docs"
- },
- "sidebar.docs.category.External Table": {
- "message": "外部表",
- "description": "The label for category Lakehouse.External Table in sidebar docs"
- },
"sidebar.docs.category.Release notes": {
"message": "版本发布",
"description": "The label for category Release notes in sidebar docs"
}
-}
+}
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/ecosystem/audit-plugin.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/audit-plugin.md
similarity index 93%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/ecosystem/audit-plugin.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/audit-plugin.md
index f700ce28d0c0..ce0e2d7f70ce 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/ecosystem/audit-plugin.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/audit-plugin.md
@@ -1,6 +1,6 @@
---
{
- "title": "审计日志插件",
+ "title": "审计日志",
"language": "zh-CN"
}
---
@@ -51,23 +51,31 @@ Doris 的审计日志插件是在 FE 的插件框架基础上开发的。是一
解压生成以下文件:
* auditloader.jar:插件代码包。
+
* plugin.properties:插件属性文件。
+
* plugin.conf:插件配置文件。
-您可以将这个文件放置在一个 http 服务器上,或者拷贝`auditloader.zip`(或者解压`auditloader.zip`)到所有 FE 的指定目录下。这里我们使用后者。
+您可以将这个文件放置在一个 http 服务器上,或者拷贝`auditloader.zip`(或者解压`auditloader.zip`) 到所有 FE 的指定目录下。这里我们使用后者。
该插件的安装可以参阅 [INSTALL](../sql-manual/sql-reference/Database-Administration-Statements/INSTALL-PLUGIN.md)
-执行install后会自动生成AuditLoader目录
+执行 install 后会自动生成 AuditLoader 目录
3. 修改 plugin.conf
以下配置可供修改:
- * frontend_host_port:FE 节点 IP 地址和 HTTP 端口,格式为 <fe_ip>:<fe_http_port>。 默认值为 127.0.0.1:8030。
+ * frontend_host_port:FE 节点 IP 地址和 HTTP 端口,格式为 <fe_ip>:<fe_http_port>。默认值为 127.0.0.1:8030。
+
* database:审计日志库名。
+
* audit_log_table:审计日志表名。
+
* slow_log_table:慢查询日志表名。
+
* enable_slow_log:是否开启慢查询日志导入功能。默认值为 false。
+
* user:集群用户名。该用户必须具有对应表的 INSERT 权限。
+
* password:集群用户密码。
4. 重新打包 Audit Loader 插件
@@ -162,9 +170,11 @@ properties(
);
```
->**注意**
->
-> 上面表结构中:stmt string ,这个只能在0.15及之后版本中使用,之前版本,字段类型使用varchar
+:::caution
+**注意**
+
+- 上面表结构中:stmt string,这个只能在 0.15 及之后版本中使用,之前版本,字段类型使用 varchar
+:::
### 部署
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/check-rpc-channel.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/check-rpc-channel.md
similarity index 90%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/check-rpc-channel.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/check-rpc-channel.md
index 5a796a6a1492..558672b00140 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/check-rpc-channel.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/check-rpc-channel.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 检查连接缓存
+
## Request
@@ -32,13 +32,13 @@ under the License.
## Description
-该功能用于检查brpc的连接缓存。
+该功能用于检查 brpc 的连接缓存。
## Path parameters
* `host_to_check`
- 需要查检的IP。
+ 需要查检的 IP。
* `remot_brpc_port`
@@ -46,7 +46,7 @@ under the License.
* `payload_size`
- 负载大小,单位B,取值范围1~1024000。
+ 负载大小,单位 B,取值范围 1~1024000。
## Request body
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/check-tablet-segment.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/check-tablet-segment.md
similarity index 73%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/check-tablet-segment.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/check-tablet-segment.md
index 9462a38c4432..7a06d80e7eb4 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/check-tablet-segment.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/check-tablet-segment.md
@@ -1,6 +1,6 @@
---
{
- "title": "检查tablet文件丢失",
+ "title": "检查 tablet 文件丢失",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 检查tablet文件丢失
+
## Request
@@ -32,15 +32,16 @@ under the License.
## Description
-在BE节点上,可能会因为一些异常情况导致数据文件丢失,但是元数据显示正常,这种副本异常不会被FE检测到,也不能被修复。
-当用户查询时,会报错`failed to initialize storage reader`。该接口的功能是检测出当前BE节点上所有存在文件丢失的tablet。
+在 BE 节点上,可能会因为一些异常情况导致数据文件丢失,但是元数据显示正常,这种副本异常不会被 FE 检测到,也不能被修复。
+当用户查询时,会报错`failed to initialize storage reader`。该接口的功能是检测出当前 BE 节点上所有存在文件丢失的 tablet。
## Query parameters
* `repair`
- - 设置为`true`时,存在文件丢失的tablet都会被设为`SHUTDOWN`状态,该副本会被作为坏副本处理,进而能够被FE检测和修复。
- - 设置为`false`时,只会返回所有存在文件丢失的tablet,并不做任何处理。
+ - 设置为`true`时,存在文件丢失的 tablet 都会被设为`SHUTDOWN`状态,该副本会被作为坏副本处理,进而能够被 FE 检测和修复。
+
+ - 设置为`false`时,只会返回所有存在文件丢失的 tablet,并不做任何处理。
## Request body
@@ -68,7 +69,7 @@ under the License.
## Examples
- ```
+ ```bash
curl http://127.0.0.1:8040/api/check_tablet_segment_lost?repair=false
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/checksum.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/checksum.md
similarity index 93%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/checksum.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/checksum.md
index 2f59fb23a264..52747c2c2f09 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/checksum.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/checksum.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Checksum
+
## Request
@@ -37,10 +37,10 @@ checksum
## Query parameters
* `tablet_id`
- 需要校验的tablet的id
+ 需要校验的 tablet 的 id
* `version`
- 需要校验的tablet的version
+ 需要校验的 tablet 的 version
* `schema_hash`
schema hash
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/compaction-run.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/compaction-run.md
similarity index 76%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/compaction-run.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/compaction-run.md
index 8120fbaaaf1f..61bffa2732d0 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/compaction-run.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/compaction-run.md
@@ -1,6 +1,6 @@
---
{
- "title": "触发Compaction",
+ "title": "触发 Compaction",
"language": "zh-CN"
}
---
@@ -24,12 +24,12 @@ specific language governing permissions and limitations
under the License.
-->
-# 触发Compaction
+
## Request
`POST /api/compaction/run?tablet_id={int}&compact_type={enum}`
-`POST /api/compaction/run?table_id={int}&compact_type=full` 注意,table_id=xxx只有在compact_type=full时指定才会生效。
+`POST /api/compaction/run?table_id={int}&compact_type=full` 注意,table_id=xxx 只有在 compact_type=full 时指定才会生效。
`GET /api/compaction/run_status?tablet_id={int}`
@@ -40,13 +40,16 @@ under the License.
## Query parameters
* `tablet_id`
- - tablet的id
+
+ - tablet 的 id
* `table_id`
- - table的id。注意,table_id=xxx只有在compact_type=full时指定才会生效,并且tablet_id和table_id只能指定一个,不能够同时指定,指定table_id后会自动对此table下所有tablet执行full_compaction。
+
+ - table 的 id。注意,table_id=xxx 只有在 compact_type=full 时指定才会生效,并且 tablet_id 和 table_id 只能指定一个,不能够同时指定,指定 table_id 后会自动对此 table 下所有 tablet 执行 full_compaction。
* `compact_type`
- - 取值为`base`或`cumulative`或`full`。full_compaction的使用场景请参考[数据恢复](../../data-admin/data-recovery.md)。
+
+ - 取值为`base`或`cumulative`或`full`。full_compaction 的使用场景请参考[数据恢复](../data-admin/data-recovery.md)。
## Request body
@@ -54,11 +57,11 @@ under the License.
## Response
-### 触发Compaction
+### 触发 Compaction
若 tablet 不存在,返回 JSON 格式的错误:
-```
+```json
{
"status": "Fail",
"msg": "Tablet not found"
@@ -67,16 +70,16 @@ under the License.
若 compaction 执行任务触发失败时,返回 JSON 格式的错误:
-```
+```json
{
"status": "Fail",
"msg": "fail to execute compaction, error = -2000"
}
```
-若 compaction 执行触发成功时,则返回 JSON 格式的结果:
+若 compaction 执行触发成功时,则返回 JSON 格式的结果:
-```
+```json
{
"status": "Success",
"msg": "compaction task is successfully triggered."
@@ -85,14 +88,15 @@ under the License.
结果说明:
-* status:触发任务状态,当成功触发时为Success;当因某些原因(比如,没有获取到合适的版本)时,返回Fail。
+* status:触发任务状态,当成功触发时为 Success;当因某些原因(比如,没有获取到合适的版本)时,返回 Fail。
+
* msg:给出具体的成功或失败的信息。
### 查询状态
若 tablet 不存在,返回 JSON 格式:
-```
+```json
{
"status": "Fail",
"msg": "Tablet not found"
@@ -101,7 +105,7 @@ under the License.
若 tablet 存在并且 tablet 不在正在执行 compaction,返回 JSON 格式:
-```
+```json
{
"status" : "Success",
"run_status" : false,
@@ -114,7 +118,7 @@ under the License.
若 tablet 存在并且 tablet 正在执行 compaction,返回 JSON 格式:
-```
+```json
{
"status" : "Success",
"run_status" : true,
@@ -131,6 +135,6 @@ under the License.
### Examples
-```
+```bash
curl -X POST "http://127.0.0.1:8040/api/compaction/run?tablet_id=10015&compact_type=cumulative"
```
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/compaction-status.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/compaction-status.md
similarity index 81%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/compaction-status.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/compaction-status.md
index 0c23156995dd..377688f5772a 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/compaction-status.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/compaction-status.md
@@ -1,6 +1,6 @@
---
{
- "title": "查看Compaction状态",
+ "title": "查看 Compaction 状态",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 查看Compaction状态
+
## Request
@@ -38,7 +38,8 @@ under the License.
## Query parameters
* `tablet_id`
- - tablet的id
+
+ - tablet 的 id
## Request body
@@ -46,7 +47,7 @@ under the License.
## Response
-### 整体Compaction状态
+### 整体 Compaction 状态
```
{
@@ -63,9 +64,9 @@ under the License.
该结构表示某个数据目录下,正在执行 compaction 任务的 tablet 的 id,以及 compaction 的类型。
-### 指定tablet的Compaction状态
+### 指定 tablet 的 Compaction 状态
-```
+```json
{
"cumulative policy type": "SIZE_BASED",
"cumulative point": 50,
@@ -97,16 +98,22 @@ under the License.
结果说明:
-* cumulative policy type:当前tablet所使用的 cumulative compaction 策略。
+* cumulative policy type:当前 tablet 所使用的 cumulative compaction 策略。
+
* cumulative point:base 和 cumulative compaction 的版本分界线。在 point(不含)之前的版本由 base compaction 处理。point(含)之后的版本由 cumulative compaction 处理。
+
* last cumulative failure time:上一次尝试 cumulative compaction 失败的时间。默认 10min 后才会再次尝试对该 tablet 做 cumulative compaction。
+
* last base failure time:上一次尝试 base compaction 失败的时间。默认 10min 后才会再次尝试对该 tablet 做 base compaction。
-* rowsets:该 tablet 当前的 rowset 集合。如 [0-48] 表示 0-48 版本。第二位数字表示该版本中 segment 的数量。`DELETE` 表示 delete 版本。`DATA` 表示数据版本。`OVERLAPPING` 和 `NONOVERLAPPING` 表示segment数据是否重叠。
+
+* rowsets:该 tablet 当前的 rowset 集合。如 [0-48] 表示 0-48 版本。第二位数字表示该版本中 segment 的数量。`DELETE` 表示 delete 版本。`DATA` 表示数据版本。`OVERLAPPING` 和 `NONOVERLAPPING` 表示 segment 数据是否重叠。
+
* missing_rowsets: 缺失的版本。
-* stale version path:该 table 当前被合并rowset集合的合并版本路径,该结构是一个数组结构,每个元素表示一个合并路径。每个元素中包含了三个属性:path id 表示版本路径id,last create time 表示当前路径上最近的 rowset 创建时间,默认在这个时间半个小时之后这条路径上的所有 rowset 会被过期删除。
+
+* stale version path:该 table 当前被合并 rowset 集合的合并版本路径,该结构是一个数组结构,每个元素表示一个合并路径。每个元素中包含了三个属性:path id 表示版本路径 id,last create time 表示当前路径上最近的 rowset 创建时间,默认在这个时间半个小时之后这条路径上的所有 rowset 会被过期删除。
## Examples
-```
+```bash
curl http://192.168.10.24:8040/api/compaction/show?tablet_id=10015
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/config.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/config.md
similarity index 94%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/config.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/config.md
index 21e73d0687fb..5da0f15d6bce 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/config.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/config.md
@@ -1,6 +1,6 @@
---
{
- "title": "BE的配置信息",
+ "title": "BE 的配置信息",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# BE的配置信息
+
## Request
@@ -33,7 +33,7 @@ under the License.
## Description
-查询/更新 BE的配置信息
+查询/更新 BE 的配置信息
## Query parameters
@@ -54,12 +54,12 @@ under the License.
### 查询
-```
+```json
[["agent_task_trace_threshold_sec","int32_t","2","true"], ...]
```
### 更新
-```
+```json
[
{
"config_name": "agent_task_trace_threshold_sec",
@@ -69,7 +69,7 @@ under the License.
]
```
-```
+```json
[
{
"config_name": "agent_task_trace_threshold_sec",
@@ -91,15 +91,15 @@ under the License.
## Examples
-```
+```bash
curl "http://127.0.0.1:8040/api/show_config"
```
-```
+```bash
curl -X POST "http://127.0.0.1:8040/api/update_config?agent_task_trace_threshold_sec=2&persist=true"
```
-```
+```bash
curl -X POST "http://127.0.0.1:8040/api/update_config?agent_task_trace_threshold_sec=2&enable_merge_on_write_correctness_check=true&persist=true"
```
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/download.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/download.md
similarity index 92%
copy from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/download.md
copy to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/download.md
index f27ce3f10f9a..1ee6c3e344cc 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/download.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/download.md
@@ -1,6 +1,6 @@
---
{
- "title": "下载load日志",
+ "title": "下载 load 日志",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 下载load日志
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-下载load错误日志文件。
+下载 load 错误日志文件。
## Query parameters
@@ -53,7 +53,7 @@ under the License.
## Examples
- ```
+ ```bash
curl "http://127.0.0.1:8040/api/_load_error_log?file=a&token=1"
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/health.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/health.md
similarity index 88%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/health.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/health.md
index 69e62d125613..657e42c15b07 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/health.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/health.md
@@ -1,6 +1,6 @@
---
{
- "title": "BE探活",
+ "title": "BE 探活",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# BE探活
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-给监控服务提供的探活接口,请求能响应代表BE状态正常。
+给监控服务提供的探活接口,请求能响应代表 BE 状态正常。
## Query parameters
无
@@ -42,14 +42,14 @@ under the License.
## Response
- ```
+ ```json
{"status": "OK","msg": "To Be Added"}
```
## Examples
- ```
+ ```bash
curl http://127.0.0.1:8040/api/health
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/meta.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/meta.md
similarity index 91%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/meta.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/meta.md
index d426f1f0e663..f9acca501ccf 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/meta.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/meta.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 查询元信息
+
## Request
@@ -32,17 +32,17 @@ under the License.
## Description
-查询tablet元信息
+查询 tablet 元信息
## Path parameters
* `tablet_id`
- table的id
+ table 的 id
## Query parameters
* `byte_to_base64`
- 是否按base64编码,选填,默认`false`。
+ 是否按 base64 编码,选填,默认`false`。
## Request body
@@ -50,7 +50,7 @@ under the License.
## Response
- ```
+ ```json
{
"table_id": 148107,
"partition_id": 148104,
@@ -66,7 +66,7 @@ under the License.
## Examples
- ```
+ ```bash
curl "http://127.0.0.1:8040/api/meta/header/148193&byte_to_base64=true"
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/metrics.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/metrics.md
similarity index 87%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/metrics.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/metrics.md
index a078d7dee02c..f6c885788b70 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/metrics.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/metrics.md
@@ -1,6 +1,6 @@
---
{
- "title": "metrics信息",
+ "title": "metrics 信息",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# metrics信息
+
## Request
@@ -32,17 +32,19 @@ under the License.
## Description
-prometheus监控采集接口
+prometheus 监控采集接口
## Query parameters
* `type`
输出方式,选填,默认全部输出,另有以下取值:
+
- `core`: 只输出核心采集项
- - `json`: 以json格式输出
+
+ - `json`: 以 json 格式输出
* `with_tablet`
- 是否输出tablet相关的采集项,选填,默认`false`。
+ 是否输出 tablet 相关的采集项,选填,默认`false`。
## Request body
@@ -50,7 +52,7 @@ prometheus监控采集接口
## Response
- ```
+ ```json
doris_be__max_network_receive_bytes_rate LONG 60757
doris_be__max_network_send_bytes_rate LONG 16232
doris_be_process_thread_num LONG 1120
@@ -61,7 +63,7 @@ prometheus监控采集接口
## Examples
- ```
+ ```bash
curl "http://127.0.0.1:8040/metrics?type=json&with_tablet=true"
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/pad-rowset.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/pad-rowset.md
similarity index 91%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/pad-rowset.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/pad-rowset.md
index 864ed519cbf6..735f2e8d8a35 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/pad-rowset.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/pad-rowset.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 填充坏副本
+
## Request
@@ -32,12 +32,12 @@ under the License.
## Description
-该功能用于使用一个空的rowset填充损坏的副本。
+该功能用于使用一个空的 rowset 填充损坏的副本。
## Query parameters
* `tablet_id`
- table的id
+ table 的 id
* `start_version`
起始版本
@@ -52,7 +52,7 @@ under the License.
## Response
- ```
+ ```json
{
msg: "OK",
code: 0
@@ -61,7 +61,7 @@ under the License.
## Examples
- ```
+ ```bash
curl -X POST "http://127.0.0.1:8040/api/pad_rowset?tablet_id=123456&start_version=1111111&end_version=1111112"
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/reset-rpc-channel.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/reset-rpc-channel.md
similarity index 91%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/reset-rpc-channel.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/reset-rpc-channel.md
index 4c9f270f85fb..84c5bbf3f5a2 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/reset-rpc-channel.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/reset-rpc-channel.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 重置连接缓存
+
## Request
@@ -32,13 +32,15 @@ under the License.
## Description
-该功能用于重置brpc的连接缓存。
+该功能用于重置 brpc 的连接缓存。
## Path parameters
* `endpoints`
- 支持如下形式:
+ 支持如下形式:
+
- `all`
+
- `host1:port1,host2:port2`
## Request body
@@ -47,7 +49,7 @@ under the License.
## Response
- ```
+ ```json
{
"msg":"success",
"code":0,
@@ -58,11 +60,11 @@ under the License.
## Examples
- ```
+ ```bash
curl http://127.0.0.1:8040/api/reset_rpc_channel/all
```
- ```
+ ```bash
curl http://127.0.0.1:8040/api/reset_rpc_channel/1.1.1.1:8080,2.2.2.2:8080
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/snapshot.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/snapshot.md
similarity index 93%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/snapshot.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/snapshot.md
index b8e73addb37e..a9e8e1ebdd16 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/snapshot.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/snapshot.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 做快照
+
## Request
@@ -32,12 +32,12 @@ under the License.
## Description
-该功能用于tablet做快照。
+该功能用于 tablet 做快照。
## Query parameters
* `tablet_id`
- 需要做快照的table的id
+ 需要做快照的 table 的 id
* `schema_hash`
schema hash
@@ -55,7 +55,7 @@ under the License.
## Examples
- ```
+ ```bash
curl "http://127.0.0.1:8040/api/snapshot?tablet_id=123456&schema_hash=1111111"
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-distribution.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-distribution.md
similarity index 89%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-distribution.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-distribution.md
index c17fa92c0591..6021637d7b87 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-distribution.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-distribution.md
@@ -1,6 +1,6 @@
---
{
- "title": "查询tablet分布",
+ "title": "查询 tablet 分布",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 查询tablet分布
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-获取BE节点上每一个partition下的tablet在不同磁盘上的分布情况
+获取 BE 节点上每一个 partition 下的 tablet 在不同磁盘上的分布情况
## Query parameters
@@ -40,7 +40,7 @@ under the License.
分组,当前只支持`partition`
* `partition_id`
- 指定partition的id,选填,默认返回所有partition。
+ 指定 partition 的 id,选填,默认返回所有 partition。
## Request body
@@ -48,7 +48,7 @@ under the License.
## Response
- ```
+ ```json
{
msg: "OK",
code: 0,
@@ -85,7 +85,7 @@ under the License.
## Examples
- ```
+ ```bash
curl "http://127.0.0.1:8040/api/tablets_distribution?group_by=partition&partition_id=123"
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-info.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-info.md
similarity index 85%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-info.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-info.md
index 877e00eb4c98..1a74cfd57367 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-info.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-info.md
@@ -1,6 +1,6 @@
---
{
- "title": "查询tablet信息",
+ "title": "查询 tablet 信息",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 查询tablet信息
+
## Request
@@ -32,12 +32,12 @@ under the License.
## Description
-获取特定BE节点上指定数量的tablet的tablet id和schema hash信息
+获取特定 BE 节点上指定数量的 tablet 的 tablet id 和 schema hash 信息
## Query parameters
* `limit`
- 返回的tablet数量,选填,默认1000个,可填`all`返回全部tablet。
+ 返回的 tablet 数量,选填,默认 1000 个,可填`all`返回全部 tablet。
## Request body
@@ -45,7 +45,7 @@ under the License.
## Response
- ```
+ ```json
{
msg: "OK",
code: 0,
@@ -71,7 +71,7 @@ under the License.
## Examples
- ```
+ ```bash
curl http://127.0.0.1:8040/api/tablets_json?limit=123
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-migration.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-migration.md
similarity index 91%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-migration.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-migration.md
index d60997836e3f..a1861b0f6e5f 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-migration.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-migration.md
@@ -1,6 +1,6 @@
---
{
- "title": "迁移tablet",
+ "title": "迁移 tablet",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 迁移tablet
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-在BE节点上迁移单个tablet到指定磁盘
+在 BE 节点上迁移单个 tablet 到指定磁盘
## Query parameters
@@ -41,7 +41,7 @@ under the License.
- `status`:查询任务的执行状态
* `tablet_id`
- 需要迁移的tablet的id
+ 需要迁移的 tablet 的 id
* `schema_hash`
schema hash
@@ -57,14 +57,14 @@ under the License.
### 提交结果
-```
+```json
{
status: "Success",
msg: "migration task is successfully submitted."
}
```
或
-```
+```json
{
status: "Fail",
msg: "Migration task submission failed"
@@ -73,7 +73,7 @@ under the License.
### 执行状态
-```
+```json
{
status: "Success",
msg: "migration task is running",
@@ -83,7 +83,7 @@ under the License.
或
-```
+```json
{
status: "Success",
msg: "migration task has finished successfully",
@@ -93,7 +93,7 @@ under the License.
或
-```
+```json
{
status: "Success",
msg: "migration task failed.",
@@ -104,7 +104,7 @@ under the License.
## Examples
- ```
+ ```bash
curl "http://127.0.0.1:8040/api/tablet_migration?goal=run&tablet_id=123&schema_hash=333&disk=/disk1"
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-reload.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-reload.md
similarity index 89%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-reload.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-reload.md
index b03a1c4e8aa8..562d06c395e0 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-reload.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-reload.md
@@ -1,6 +1,6 @@
---
{
- "title": "重加载tablet",
+ "title": "重加载 tablet",
"language": "zh-CN"
}
---
@@ -24,7 +24,6 @@ specific language governing permissions and limitations
under the License.
-->
-# 重加载tablet
## Request
@@ -32,12 +31,12 @@ under the License.
## Description
-该功能用于重加载tablet数据。
+该功能用于重加载 tablet 数据。
## Query parameters
* `tablet_id`
- 需要重加载的table的id
+ 需要重加载的 table 的 id
* `schema_hash`
schema hash
@@ -52,13 +51,13 @@ under the License.
## Response
- ```
+ ```bash
load header succeed
```
## Examples
- ```
+ ```bash
curl "http://127.0.0.1:8040/api/reload_tablet?tablet_id=123456&schema_hash=1111111&path=/abc"
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-restore.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-restore.md
similarity index 89%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-restore.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-restore.md
index c738b8e6fd01..7496fc7f3802 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/tablet-restore.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/tablet-restore.md
@@ -1,6 +1,6 @@
---
{
- "title": "恢复tablet",
+ "title": "恢复 tablet",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 恢复tablet
+
## Request
@@ -32,12 +32,12 @@ under the License.
## Description
-该功能用于恢复trash目录中被误删的tablet数据。
+该功能用于恢复 trash 目录中被误删的 tablet 数据。
## Query parameters
* `tablet_id`
- 需要恢复的table的id
+ 需要恢复的 table 的 id
* `schema_hash`
schema hash
@@ -49,7 +49,7 @@ under the License.
## Response
- ```
+ ```json
{
msg: "OK",
code: 0
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/version-info.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/version-info.md
similarity index 94%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/version-info.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/version-info.md
index b527e977981e..7aee48f40691 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/be/version-info.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/be/version-info.md
@@ -1,6 +1,6 @@
---
{
- "title": "BE版本信息",
+ "title": "BE 版本信息",
"language": "zh-CN"
}
---
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# BE版本信息
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-用于获取be节点的版本信息。
+用于获取 be 节点的版本信息。
## Path parameters
@@ -48,7 +48,7 @@ under the License.
## Response
- ```
+ ```json
{
"msg":"success",
"code":0,
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/elastic-expansion.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/elastic-expansion.md
index 494cc30a0cac..257e09e333b6 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/elastic-expansion.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/elastic-expansion.md
@@ -25,7 +25,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 扩容缩容
+
Doris 可以很方便的扩容和缩容 FE、BE、Broker 实例。
@@ -33,7 +33,7 @@ Doris 可以很方便的扩容和缩容 FE、BE、Broker 实例。
可以通过将 FE 扩容至 3 个以上节点来实现 FE 的高可用。
-用户可以通过 mysql 客户端登陆 Master FE。通过:
+用户可以通过 MySQL 客户端登陆 Master FE。通过:
`SHOW PROC '/frontends';`
@@ -47,11 +47,11 @@ FE 节点的扩容和缩容过程,不影响当前系统运行。
### 增加 FE 节点
-FE 分为 Follower 和 Observer 两种角色,其中 Follower 角色会选举出一个 Follower 节点作为 Master。 默认一个集群,只能有一个 Master 状态的 Follower 角色,可以有多个 Follower 和 Observer,同时需保证 Follower 角色为奇数个。其中所有 Follower 角色组成一个选举组,如果 Master 状态的 Follower 宕机,则剩下的 Follower 会自动选出新的 Master,保证写入高可用。Observer 同步 Master 的数据,但是不参加选举。如果只部署一个 FE,则 FE 默认就是 Master。
+FE 分为 Follower 和 Observer 两种角色,其中 Follower 角色会选举出一个 Follower 节点作为 Master。默认一个集群,只能有一个 Master 状态的 Follower 角色,可以有多个 Follower 和 Observer,同时需保证 Follower 角色为奇数个。其中所有 Follower 角色组成一个选举组,如果 Master 状态的 Follower 宕机,则剩下的 Follower 会自动选出新的 Master,保证写入高可用。Observer 同步 Master 的数据,但是不参加选举。如果只部署一个 FE,则 FE 默认就是 Master。
第一个启动的 FE 自动成为 Master。在此基础上,可以添加若干 Follower 和 Observer。
-#### 配置及启动 Follower 或 Observer
+**配置及启动 Follower 或 Observer**
这里 Follower 和 Observer 的配置同 Master 的配置。
@@ -61,7 +61,7 @@ FE 分为 Follower 和 Observer 两种角色,其中 Follower 角色会选举
其中 leader\_fe\_host 为 Master 所在节点 ip, edit\_log\_port 在 Master 的配置文件 fe.conf 中。--helper 参数仅在 follower 和 observer 第一次启动时才需要。
-#### 将 Follower 或 Observer 加入到集群
+**将 Follower 或 Observer 加入到集群**
添加 Follower 或 Observer。使用 mysql-client 连接到已启动的 FE,并执行:
@@ -71,15 +71,21 @@ FE 分为 Follower 和 Observer 两种角色,其中 Follower 角色会选举
`ALTER SYSTEM ADD OBSERVER "observer_host:edit_log_port";`
-其中 follower\_host和observer\_host 为 Follower 或 Observer 所在节点 ip,edit\_log\_port 在其配置文件 fe.conf 中。
+其中 follower\_host 和 observer\_host 为 Follower 或 Observer 所在节点 ip,edit\_log\_port 在其配置文件 fe.conf 中。
查看 Follower 或 Observer 运行状态。使用 mysql-client 连接到任一已启动的 FE,并执行:SHOW PROC '/frontends'; 可以查看当前已加入集群的 FE 及其对应角色。
-> FE 扩容注意事项:
-> 1. Follower FE(包括 Master)的数量必须为奇数,建议最多部署 3 个组成高可用(HA)模式即可。
-> 2. 当 FE 处于高可用部署时(1个 Master,2个 Follower),我们建议通过增加 Observer FE 来扩展 FE 的读服务能力。当然也可以继续增加 Follower FE,但几乎是不必要的。
-> 3. 通常一个 FE 节点可以应对 10-20 台 BE 节点。建议总的 FE 节点数量在 10 个以下。而通常 3 个即可满足绝大部分需求。
-> 4. helper 不能指向 FE 自身,必须指向一个或多个已存在并且正常运行中的 Master/Follower FE。
+:::caution
+FE 扩容注意事项:
+
+1. Follower FE(包括 Master)的数量必须为奇数,建议最多部署 3 个组成高可用(HA)模式即可。
+
+2. 当 FE 处于高可用部署时(1 个 Master,2 个 Follower),我们建议通过增加 Observer FE 来扩展 FE 的读服务能力。当然也可以继续增加 Follower FE,但几乎是不必要的。
+
+3. 通常一个 FE 节点可以应对 10-20 台 BE 节点。建议总的 FE 节点数量在 10 个以下。而通常 3 个即可满足绝大部分需求。
+
+4. helper 不能指向 FE 自身,必须指向一个或多个已存在并且正常运行中的 Master/Follower FE。
+:::
### 删除 FE 节点
@@ -87,12 +93,15 @@ FE 分为 Follower 和 Observer 两种角色,其中 Follower 角色会选举
```ALTER SYSTEM DROP FOLLOWER[OBSERVER] "fe_host:edit_log_port";```
-> FE 缩容注意事项:
-> 1. 删除 Follower FE 时,确保最终剩余的 Follower(包括 Master)节点为奇数。
+:::caution
+FE 缩容注意事项:
+
+1. 删除 Follower FE 时,确保最终剩余的 Follower(包括 Master)节点为奇数。
+:::
## BE 扩容和缩容
-用户可以通过 mysql-client 登陆 Master FE。通过:
+用户可以通过 mysql-client 登陆 Master FE。通过:
```SHOW PROC '/backends';```
@@ -102,14 +111,17 @@ FE 分为 Follower 和 Observer 两种角色,其中 Follower 角色会选举
以上方式,都需要 Doris 的 root 用户权限。
-BE 节点的扩容和缩容过程,不影响当前系统运行以及正在执行的任务,并且不会影响当前系统的性能。数据均衡会自动进行。根据集群现有数据量的大小,集群会在几个小时到1天不等的时间内,恢复到负载均衡的状态。集群负载情况,可以参见 [Tablet 负载均衡文档](../maint-monitor/tablet-repair-and-balance.md)。
+BE 节点的扩容和缩容过程,不影响当前系统运行以及正在执行的任务,并且不会影响当前系统的性能。数据均衡会自动进行。根据集群现有数据量的大小,集群会在几个小时到 1 天不等的时间内,恢复到负载均衡的状态。集群负载情况,可以参见 [Tablet 负载均衡文档](../maint-monitor/tablet-repair-and-balance.md)。
### 增加 BE 节点
BE 节点的增加方式同 **BE 部署** 一节中的方式,通过 `ALTER SYSTEM ADD BACKEND` 命令增加 BE 节点。
-> BE 扩容注意事项:
-> 1. BE 扩容后,Doris 会自动根据负载情况,进行数据均衡,期间不影响使用。
+:::note
+BE 扩容注意事项:
+
+1. BE 扩容后,Doris 会自动根据负载情况,进行数据均衡,期间不影响使用。
+:::
### 删除 BE 节点
@@ -125,16 +137,25 @@ DECOMMISSION 语句如下:
```ALTER SYSTEM DECOMMISSION BACKEND "be_host:be_heartbeat_service_port";```
-> DECOMMISSION 命令说明:
-> 1. 该命令用于安全删除 BE 节点。命令下发后,Doris 会尝试将该 BE 上的数据向其他 BE 节点迁移,当所有数据都迁移完成后,Doris 会自动删除该节点。
-> 2. 该命令是一个异步操作。执行后,可以通过 ```SHOW PROC '/backends';``` 看到该 BE 节点的 `SystemDecommissioned` 状态为 true。表示该节点正在进行下线。
-> 3. 该命令**不一定执行成功**。比如剩余 BE 存储空间不足以容纳下线 BE 上的数据,或者剩余机器数量不满足最小副本数时,该命令都无法完成,并且 BE 会一直处于 `SystemDecommissioned` 为 true 的状态。
-> 4. DECOMMISSION 的进度,可以通过 ```SHOW PROC '/backends';``` 中的 TabletNum 查看,如果正在进行,TabletNum 将不断减少。
-> 5. 该操作可以通过:
- > ```CANCEL DECOMMISSION BACKEND "be_host:be_heartbeat_service_port";```
- > 命令取消。取消后,该 BE 上的数据将维持当前剩余的数据量。后续 Doris 重新进行负载均衡
+:::note
+DECOMMISSION 命令说明:
+
+1. 该命令用于安全删除 BE 节点。命令下发后,Doris 会尝试将该 BE 上的数据向其他 BE 节点迁移,当所有数据都迁移完成后,Doris 会自动删除该节点。
+
+2. 该命令是一个异步操作。执行后,可以通过 ```SHOW PROC '/backends';``` 看到该 BE 节点的 `SystemDecommissioned` 状态为 true。表示该节点正在进行下线。
+
+3. 该命令**不一定执行成功**。比如剩余 BE 存储空间不足以容纳下线 BE 上的数据,或者剩余机器数量不满足最小副本数时,该命令都无法完成,并且 BE 会一直处于 `SystemDecommissioned` 为 true 的状态。
+
+4. DECOMMISSION 的进度,可以通过 ```SHOW PROC '/backends';``` 中的 TabletNum 查看,如果正在进行,TabletNum 将不断减少。
+
+5. 该操作可以通过:
+
+ ```CANCEL DECOMMISSION BACKEND "be_host:be_heartbeat_service_port";```
+
+ 命令取消。取消后,该 BE 上的数据将维持当前剩余的数据量。后续 Doris 重新进行负载均衡
+:::
-**对于多租户部署环境下,BE 节点的扩容和缩容,请参阅 [多租户设计文档](../multi-tenant.md)。**
+**对于多租户部署环境下,BE 节点的扩容和缩容,请参阅 [多租户设计文档](../resource-admin/multi-tenant)。**
## Broker 扩容缩容
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/fqdn.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/fqdn.md
index 033e4f641982..0c6fd8b46bbe 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/fqdn.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/fqdn.md
@@ -24,11 +24,9 @@ specific language governing permissions and limitations
under the License.
-->
-# FQDN
-<version since="dev"></version>
-本文介绍如何启用基于 FQDN(Fully Qualified Domain Name,完全限定域名 )使用 Apache Doris。FQDN 是 Internet 上特定计算机或主机的完整域名。
+本文介绍如何启用基于 FQDN(Fully Qualified Domain Name,完全限定域名)使用 Apache Doris。FQDN 是 Internet 上特定计算机或主机的完整域名。
Doris 支持 FQDN 之后,各节点之间通信完全基于 FQDN。添加各类节点时应直接指定 FQDN,例如添加 BE 节点的命令为`ALTER SYSTEM ADD BACKEND "be_host:heartbeat_service_port"`,
@@ -37,8 +35,11 @@ Doris 支持 FQDN 之后,各节点之间通信完全基于 FQDN。添加各类
## 前置条件
1. fe.conf 文件 设置 `enable_fqdn_mode = true`。
+
2. 集群中的所有机器都必须配置有主机名。
+
3. 必须在集群中每台机器的 `/etc/hosts` 文件中指定集群中其他机器对应的 IP 地址和 FQDN。
+
4. /etc/hosts 文件中不能有重复的 IP 地址。
## 最佳实践
@@ -46,8 +47,10 @@ Doris 支持 FQDN 之后,各节点之间通信完全基于 FQDN。添加各类
### 新集群启用 FQDN
1. 准备机器,例如想部署 3FE 3BE 的集群,可以准备 6 台机器。
+
2. 每台机器执行`host`返回结果都唯一,假设六台机器的执行结果分别为 fe1,fe2,fe3,be1,be2,be3。
-3. 在 6 台机器的`/etc/hosts` 中配置 6 个 FQDN 对应的真实 IP,例如:
+
+3. 在 6 台机器的`/etc/hosts` 中配置 6 个 FQDN 对应的真实 IP,例如:
```
172.22.0.1 fe1
172.22.0.2 fe2
@@ -56,16 +59,20 @@ Doris 支持 FQDN 之后,各节点之间通信完全基于 FQDN。添加各类
172.22.0.5 be2
172.22.0.6 be3
```
+
4. 验证:可以在 FE1 上 `ping fe2` 等,能解析出正确的 IP 并且能 Ping 通,代表网络环境可用。
+
5. 每个 FE 节点的 fe.conf 设置 `enable_fqdn_mode = true`。
-6. 参考[标准部署](../../install/standard-deployment.md)
-7. 按需在六台机器上选择几台机器部署broker,执行`ALTER SYSTEM ADD BROKER broker_name "fe1:8000","be1:8000",...;`。
+
+6. 参考[手动部署](../../install/cluster-deployment/standard-deployment)
+
+7. 按需在六台机器上选择几台机器部署 broker,执行`ALTER SYSTEM ADD BROKER broker_name "fe1:8000","be1:8000",...;`。
### K8s 部署 Doris
Pod 意外重启后,K8s 不能保证 Pod 的 IP 不发生变化,但是能保证域名不变,基于这一特性,Doris 开启 FQDN 时,能保证 Pod 意外重启后,还能正常提供服务。
-K8s 部署 Doris 的方法请参考[K8s 部署 Doris](../../install/k8s-deploy/operator-deploy.md)
+K8s 部署 Doris 的方法请参考[K8s 部署 Doris](../../install/cluster-deployment/k8s-deploy/operator-deploy)
### 服务器变更 IP
@@ -76,23 +83,29 @@ K8s 部署 Doris 的方法请参考[K8s 部署 Doris](../../install/k8s-deploy/o
前提条件:当前程序支持`ALTER SYSTEM MODIFY FRONTEND "<fe_ip>:<edit_log_port>" HOSTNAME "<fe_hostname>"`语法,
如果不支持,需要升级到支持该语法的版本
->注意:
->
-> 至少有三台follower才能进行如下操作,否则会造成集群无法正常启动
+:::caution
+注意:
+
+至少有三台 follower 才能进行如下操作,否则会造成集群无法正常启动
+:::
接下来按照如下步骤操作:
-1. 逐一对 Follower、Observer 节点进行以下操作(最后操作 Master 节点):
+**1. 逐一对 Follower、Observer 节点进行以下操作 (最后操作 Master 节点):**
+
+1. 停止节点。
+
+2. 检查节点是否停止。通过 MySQL 客户端执行`show frontends`,查看该 FE 节点的 Alive 状态直至变为 false
+
+3. 为节点设置 FQDN: `ALTER SYSTEM MODIFY FRONTEND "<fe_ip>:<edit_log_port>" HOSTNAME "<fe_hostname>"`(停掉 master 后,会选举出新的 master 节点,用新的 master 节点来执行 sql 语句)
+
+4. 修改节点配置。修改 FE 根目录中的`conf/fe.conf`文件,添加配置:`enable_fqdn_mode = true`
- 1. 停止节点。
- 2. 检查节点是否停止。通过 MySQL 客户端执行`show frontends`,查看该 FE 节点的 Alive 状态直至变为 false
- 3. 为节点设置 FQDN: `ALTER SYSTEM MODIFY FRONTEND "<fe_ip>:<edit_log_port>" HOSTNAME "<fe_hostname>"`(停掉master后,会选举出新的master节点,用新的master节点来执行sql语句)
- 4. 修改节点配置。修改 FE 根目录中的`conf/fe.conf`文件,添加配置:`enable_fqdn_mode = true`
- 5. 启动节点。
+5. 启动节点。
-2. BE 节点启用 FQDN 只需要通过 MySQL 执行以下命令,不需要对 BE 执行重启操作。
+**2. BE 节点启用 FQDN 只需要通过 MySQL 执行以下命令,不需要对 BE 执行重启操作。**
- `ALTER SYSTEM MODIFY BACKEND "<backend_ip>:<backend_port>" HOSTNAME "<be_hostname>"`
+`ALTER SYSTEM MODIFY BACKEND "<backend_ip>:<backend_port>" HOSTNAME "<be_hostname>"`
## 常见问题
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/load-balancing.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/load-balancing.md
index 2cdde158b572..3ed1ccfdc414 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/load-balancing.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/load-balancing.md
@@ -25,7 +25,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 负载均衡
+
当部署多个 FE 节点时,用户可以在多个 FE 之上部署负载均衡层来实现 Doris 的高可用。
@@ -35,25 +35,26 @@ under the License.
## JDBC Connector
-如果使用 mysql jdbc connector 来连接 Doris,可以使用 jdbc 的自动重试机制:
+如果使用 mysql jdbc connector 来连接 Doris,可以使用 jdbc 的自动重试机制:
```
jdbc:mysql:loadbalance://[host:port],[host:port].../[database][?propertyName1][=propertyValue1][&propertyName2][=propertyValue
```
-详细可以参考[Mysql官网文档](https://dev.mysql.com/doc/connector-j/5.1/en/connector-j-usagenotes-j2ee-concepts-managing-load-balanced-connections.html)
+详细可以参考[Mysql 官网文档](https://dev.mysql.com/doc/connector-j/5.1/en/connector-j-usagenotes-j2ee-concepts-managing-load-balanced-connections.html)
## ProxySQL 方式
-ProxySQL是灵活强大的MySQL代理层, 是一个能实实在在用在生产环境的MySQL中间件,可以实现读写分离,支持 Query 路由功能,支持动态指定某个 SQL 进行 cache,支持动态加载配置、故障切换和一些 SQL的过滤功能。
+ProxySQL 是灵活强大的 MySQL 代理层,是一个能实实在在用在生产环境的 MySQL 中间件,可以实现读写分离,支持 Query 路由功能,支持动态指定某个 SQL 进行 Cache,支持动态加载配置、故障切换和一些 SQL 的过滤功能。
Doris 的 FE 进程负责接收用户连接和查询请求,其本身是可以横向扩展且高可用的,但是需要用户在多个 FE 上架设一层 proxy,来实现自动的连接负载均衡。
-### 安装ProxySQL (yum方式)
+### 安装 ProxySQL(yum 方式)
```bash
配置yum源
# vim /etc/yum.repos.d/proxysql.repo
+
[proxysql_repo]
name= ProxySQL YUM repository
baseurl=http://repo.proxysql.com/ProxySQL/proxysql-1.4.x/centos/\$releasever
@@ -64,13 +65,16 @@ gpgkey=http://repo.proxysql.com/ProxySQL/repo_pub_key
# yum clean all
# yum makecache
# yum -y install proxysql
+
查看版本
# proxysql --version
ProxySQL version 1.4.13-15-g69d4207, codename Truls
+
设置开机自启动
# systemctl enable proxysql
# systemctl start proxysql
# systemctl status proxysql
+
启动后会监听两个端口, 默认为6032和6033。6032端口是ProxySQL的管理端口,6033是ProxySQL对外提供服务的端口 (即连接到转发后端的真正数据库的转发端口)。
# netstat -tunlp
Active Internet connections (only servers)
@@ -81,13 +85,13 @@ tcp 0 0 0.0.0.0:6033 0.0.0.0:* LISTEN
### ProxySQL 配置
-ProxySQL 有配置文件 `/etc/proxysql.cnf` 和配置数据库文件`/var/lib/proxysql/proxysql.db`。**这里需要特别注意**:如果存在`"proxysql.db"`文件(在`/var/lib/proxysql`目录下),则 ProxySQL 服务只有在第一次启动时才会去读取`proxysql.cnf文件`并解析;后面启动会就不会读取`proxysql.cnf`文件了!如果想要让proxysql.cnf 文件里的配置在重启 proxysql 服务后生效(即想要让 proxysql 重启时读取并解析 proxysql.cnf配置文件),则需要先删除 `/var/lib/proxysql/proxysql.db`数据库文件,然后再重启 proxysql 服务。这样就相当于初始化启动 proxysql 服务了,会再次生产一个纯净的 proxysql.db 数据库文件(如果之前配置了 proxysql 相关路由规则等,则就会被抹掉)
+ProxySQL 有配置文件 `/etc/proxysql.cnf` 和配置数据库文件`/var/lib/proxysql/proxysql.db`。**这里需要特别注意**:如果存在`"proxysql.db"`文件 (在`/var/lib/proxysql`目录下),则 ProxySQL 服务只有在第一次启动时才会去读取`proxysql.cnf文件`并解析;后面启动会就不会读取`proxysql.cnf`文件了!如果想要让 proxysql.cnf 文件里的配置在重启 proxysql 服务后生效 (即想要让 proxysql 重启时读取并解析 proxysql.cnf 配置文件),则需要先删除 `/var/lib/proxysql/proxysql.db`数据库文件,然后再重启 proxysql 服务。这样就相当于初始化启动 proxysql 服务了,会再次生产一个纯净的 proxysql.db 数据库文件 (如果之前配置了 proxysql 相关路由规则等,则就会被抹掉)
-#### 查看及修改配置文件
+**查看及修改配置文件**
这里主要是几个参数,在下面已经注释出来了,可以根据自己的需要进行修改
-```
+```bash
# egrep -v "^#|^$" /etc/proxysql.cnf
datadir="/var/lib/proxysql" #数据目录
admin_variables=
@@ -138,11 +142,12 @@ mysql_replication_hostgroups=
)
```
-#### 连接 ProxySQL 管理端口测试
+**连接 ProxySQL 管理端口测试**
```sql
# mysql -uadmin -padmin -P6032 -hdoris01
-查看main库(默认登陆后即在此库)的global_variables表信息
+// 查看main库(默认登陆后即在此库)的global_variables表信息
+
MySQL [(none)]> show databases;
+-----+---------------+-------------------------------------+
| seq | name | file |
@@ -188,9 +193,9 @@ MySQL [main]> show tables;
```
-#### ProxySQL 配置后端 Doris FE
+**ProxySQL 配置后端 Doris FE**
-使用 insert 语句添加主机到 mysql_servers 表中,其中:hostgroup_id 为10表示写组,为20表示读组,我们这里不需要读写分离,无所谓随便设置哪一个都可以。
+使用 insert 语句添加主机到 mysql_servers 表中,其中:hostgroup_id 为 10 表示写组,为 20 表示读组,我们这里不需要读写分离,无所谓随便设置哪一个都可以。
```sql
[root@mysql-proxy ~]# mysql -uadmin -padmin -P6032 -h127.0.0.1
@@ -204,15 +209,15 @@ Query OK, 1 row affected (0.000 sec)
MySQL [(none)]> insert into mysql_servers(hostgroup_id,hostname,port) values(10,'192.168.9.213',9030);
Query OK, 1 row affected (0.000 sec)
-如果在插入过程中,出现报错:
+//如果在插入过程中,出现报错:
ERROR 1045 (#2800): UNIQUE constraint failed: mysql_servers.hostgroup_id, mysql_servers.hostname, mysql_servers.port
-说明可能之前就已经定义了其他配置,可以清空这张表 或者 删除对应host的配置
+//说明可能之前就已经定义了其他配置,可以清空这张表 或者 删除对应host的配置
MySQL [(none)]> select * from mysql_servers;
MySQL [(none)]> delete from mysql_servers;
Query OK, 6 rows affected (0.000 sec)
-查看这3个节点是否插入成功,以及它们的状态。
+//查看这 3 个节点是否插入成功,以及它们的状态。
MySQL [(none)]> select * from mysql_servers\G;
*************************** 1. row ***************************
hostgroup_id: 10
@@ -262,23 +267,23 @@ MySQL [(none)]> save mysql servers to disk;
Query OK, 0 rows affected (0.348 sec)
```
-#### 监控Doris FE节点配置
+**监控 Doris FE 节点配置**
-添 doris fe 节点之后,还需要监控这些后端节点。对于后端多个FE高可用负载均衡环境来说,这是必须的,因为 ProxySQL 需要通过每个节点的 read_only 值来自动调整
+添 Doris FE 节点之后,还需要监控这些后端节点。对于后端多个 FE 高可用负载均衡环境来说,这是必须的,因为 ProxySQL 需要通过每个节点的 read_only 值来自动调整
它们是属于读组还是写组。
-首先在后端master主数据节点上创建一个用于监控的用户名
+首先在后端 master 主数据节点上创建一个用于监控的用户名
```sql
-在doris fe master主数据库节点行执行:
+//在 Doris FE master 主数据库节点行执行:
# mysql -P9030 -uroot -p
mysql> create user monitor@'192.168.9.%' identified by 'P@ssword1!';
Query OK, 0 rows affected (0.03 sec)
mysql> grant ADMIN_PRIV on *.* to monitor@'192.168.9.%';
Query OK, 0 rows affected (0.02 sec)
-然后回到mysql-proxy代理层节点上配置监控
+//然后回到mysql-proxy代理层节点上配置监控
# mysql -uadmin -padmin -P6032 -h127.0.0.1
MySQL [(none)]> set mysql-monitor_username='monitor';
Query OK, 1 row affected (0.000 sec)
@@ -286,16 +291,19 @@ Query OK, 1 row affected (0.000 sec)
MySQL [(none)]> set mysql-monitor_password='P@ssword1!';
Query OK, 1 row affected (0.000 sec)
-修改后,加载到RUNTIME,并保存到disk
+//修改后,加载到 RUNTIME,并保存 disk
MySQL [(none)]> load mysql variables to runtime;
Query OK, 0 rows affected (0.001 sec)
MySQL [(none)]> save mysql variables to disk;
Query OK, 94 rows affected (0.079 sec)
-验证监控结果:ProxySQL监控模块的指标都保存在monitor库的log表中。
-以下是连接是否正常的监控(对connect指标的监控):
-注意:可能会有很多connect_error,这是因为没有配置监控信息时的错误,配置后如果connect_error的结果为NULL则表示正常。
+//验证监控结果:ProxySQL监控模块的指标都保存在monitor库的log表中。
+
+//以下是连接是否正常的监控(对connect指标的监控):
+
+//注意:可能会有很多connect_error,这是因为没有配置监控信息时的错误,配置后如果connect_error的结果为NULL则表示正常。
+
MySQL [(none)]> select * from mysql_server_connect_log;
+---------------+------+------------------+-------------------------+---------------+
| hostname | port | time_start_us | connect_success_time_us | connect_error |
@@ -313,7 +321,9 @@ MySQL [(none)]> select * from mysql_server_connect_log;
| 192.168.9.213 | 9030 | 1548665512938268 | 613 | NULL |
+---------------+------+------------------+-------------------------+---------------+
20 rows in set (0.000 sec)
-以下是对心跳信息的监控(对ping指标的监控)
+
+//以下是对心跳信息的监控(对ping指标的监控)
+
MySQL [(none)]> select * from mysql_server_ping_log;
+---------------+------+------------------+----------------------+------------+
| hostname | port | time_start_us | ping_success_time_us | ping_error |
@@ -326,19 +336,23 @@ MySQL [(none)]> select * from mysql_server_ping_log;
+---------------+------+------------------+----------------------+------------+
110 rows in set (0.001 sec)
-read_only日志此时也为空(正常来说,新环境配置时,这个只读日志是为空的)
+//read_only日志此时也为空(正常来说,新环境配置时,这个只读日志是为空的)
+
MySQL [(none)]> select * from mysql_server_read_only_log;
Empty set (0.000 sec)
-3个节点都在hostgroup_id=10的组中。
-现在,将刚才mysql_replication_hostgroups表的修改加载到RUNTIME生效。
+//3个节点都在hostgroup_id=10的组中。
+
+//现在,将刚才 mysql_replication_hostgroups 表的修改加载到RUNTIME生效。
+
MySQL [(none)]> load mysql servers to runtime;
Query OK, 0 rows affected (0.003 sec)
MySQL [(none)]> save mysql servers to disk;
Query OK, 0 rows affected (0.361 sec)
-现在看结果
+//现在看结果
+
MySQL [(none)]> select hostgroup_id,hostname,port,status,weight from mysql_servers;
+--------------+---------------+------+--------+--------+
| hostgroup_id | hostname | port | status | weight |
@@ -350,14 +364,15 @@ MySQL [(none)]> select hostgroup_id,hostname,port,status,weight from mysql_serve
3 rows in set (0.000 sec)
```
-#### 配置Doris用户
+**配置 Doris 用户**
上面的所有配置都是关于后端 Doris FE 节点的,现在可以配置关于 SQL 语句的,包括:发送 SQL 语句的用户、SQL 语句的路由规则、SQL 查询的缓存、SQL 语句的重写等等。
-本小节是 SQL 请求所使用的用户配置,例如 root 用户。这要求我们需要先在后端 Doris FE 节点添加好相关用户。这里以 root 和 doris 两个用户名为例.
+本小节是 SQL 请求所使用的用户配置,例如 root 用户。这要求我们需要先在后端 Doris FE 节点添加好相关用户。这里以 root 和 doris 两个用户名为例。
```sql
-首先,在Doris FE master主数据库节点上执行:
+//首先,在Doris FE master主数据库节点上执行:
+
# mysql -P9030 -uroot -p
.........
mysql> create user doris@'%' identified by 'P@ssword1!';
@@ -367,7 +382,8 @@ mysql> grant ADMIN_PRIV on *.* to doris@'%';
Query OK, 0 rows affected, 1 warning (0.03 sec)
-然后回到mysql-proxy代理层节点,配置mysql_users表,将刚才的两个用户添加到该表中。
+//然后回到 mysql-proxy 代理层节点,配置 mysql_users 表,将刚才的两个用户添加到该表中。
+
admin> insert into mysql_users(username,password,default_hostgroup) values('root','',10);
Query OK, 1 row affected (0.001 sec)
@@ -381,12 +397,15 @@ Query OK, 0 rows affected (0.001 sec)
admin> save mysql users to disk;
Query OK, 0 rows affected (0.108 sec)
-mysql_users表有不少字段,最主要的三个字段为username、password和default_hostgroup:
-- username:前端连接ProxySQL,以及ProxySQL将SQL语句路由给MySQL所使用的用户名。
-- password:用户名对应的密码。可以是明文密码,也可以是hash密码。如果想使用hash密码,可以先在某个MySQL节点上执行
+// mysql_users 表有不少字段,最主要的三个字段为 username、password 和default_hostgroup:
+
+//- username:前端连接ProxySQL,以及ProxySQL将SQL语句路由给MySQL所使用的用户名。
+//- password:用户名对应的密码。可以是明文密码,也可以是hash密码。如果想使用hash密码,可以先在某个MySQL节点上执行
+
select password(PASSWORD),然后将加密结果复制到该字段。
-- default_hostgroup:该用户名默认的路由目标。例如,指定root用户的该字段值为10时,则使用root用户发送的SQL语句默认
- 情况下将路由到hostgroup_id=10组中的某个节点。
+
+//- default_hostgroup:该用户名默认的路由目标。例如,指定root用户的该字段值为10时,则使用root用户发送的SQL语句默认
+// 情况下将路由到hostgroup_id=10组中的某个节点。
admin> select * from mysql_users\G
*************************** 1. row ***************************
@@ -417,7 +436,7 @@ transaction_persistent: 1
max_connections: 10000
2 rows in set (0.000 sec)
-虽然这里没有详细介绍mysql_users表,但只有active=1的用户才是有效的用户。
+//虽然这里没有详细介绍mysql_users表,但只有active=1的用户才是有效的用户。
MySQL [(none)]> load mysql users to runtime;
Query OK, 0 rows affected (0.001 sec)
@@ -425,23 +444,28 @@ Query OK, 0 rows affected (0.001 sec)
MySQL [(none)]> save mysql users to disk;
Query OK, 0 rows affected (0.123 sec)
-这样就可以通过sql客户端,使用doris的用户名密码去连接了ProxySQL了
+//这样就可以通过sql客户端,使用doris的用户名密码去连接了ProxySQL了
```
-#### 通过 ProxySQL 连接 Doris 进行测试
+**通过 ProxySQL 连接 Doris 进行测试**
-下面,分别使用 root 用户和 doris 用户测试下它们是否能路由到默认的 hostgroup_id=10 (它是一个写组)读数据。下面是通过转发端口 6033 连接的,连接的是转发到后端真正的数据库!
+下面,分别使用 root 用户和 doris 用户测试下它们是否能路由到默认的 hostgroup_id=10 (它是一个写组) 读数据。下面是通过转发端口 6033 连接的,连接的是转发到后端真正的数据库!
```sql
#mysql -uroot -p -P6033 -hdoris01 -e "show databases;"
Enter password:
ERROR 9001 (HY000) at line 1: Max connect timeout reached while reaching hostgroup 10 after 10000ms
-这个时候发现出错,并没有转发到后端真正的doris fe上
-通过日志看到有set autocommit=0 这样开启事务
-检查配置发现:
+
+//这个时候发现出错,并没有转发到后端真正的 Doris FE上
+
+//通过日志看到有set autocommit=0 这样开启事务
+
+//检查配置发现:
mysql-forward_autocommit=false
mysql-autocommit_false_is_transaction=false
-我们这里不需要读写分离,只需要将这两个参数通过下面语句直接搞成true就可以了
+
+//我们这里不需要读写分离,只需要将这两个参数通过下面语句直接搞成true就可以了
+
mysql> UPDATE global_variables SET variable_value='true' WHERE variable_name='mysql-forward_autocommit';
Query OK, 1 row affected (0.00 sec)
@@ -454,7 +478,8 @@ Query OK, 0 rows affected (0.00 sec)
mysql> SAVE MYSQL VARIABLES TO DISK;
Query OK, 98 rows affected (0.12 sec)
-然后我们在重新试一下,显示成功
+//然后我们在重新试一下,显示成功
+
[root@doris01 ~]# mysql -udoris -pP@ssword1! -P6033 -h192.168.9.211 -e "show databases;"
Warning: Using a password on the command line interface can be insecure.
+--------------------+
@@ -466,19 +491,19 @@ Warning: Using a password on the command line interface can be insecure.
+--------------------+
```
-OK,到此就结束了,你就可以用 Mysql 客户端,JDBC 等任何连接 mysql 的方式连接 ProxySQL 去操作你的 doris 了
+OK,到此就结束了,你就可以用 Mysql 客户端,JDBC 等任何连接 MySQL 的方式连接 ProxySQL 去操作你的 Doris 了
-## Nginx TCP反向代理方式
+## Nginx TCP 反向代理方式
### 概述
-Nginx能够实现HTTP、HTTPS协议的负载均衡,也能够实现TCP协议的负载均衡。那么,问题来了,可不可以通过Nginx实现Apache Doris数据库的负载均衡呢?答案是:可以。接下来,就让我们一起探讨下如何使用Nginx实现Apache Doris的负载均衡。
+Nginx 能够实现 HTTP、HTTPS 协议的负载均衡,也能够实现 TCP 协议的负载均衡。那么,问题来了,可不可以通过 Nginx 实现 Apache Doris 数据库的负载均衡呢?答案是:可以。接下来,就让我们一起探讨下如何使用 Nginx 实现 Apache Doris 的负载均衡。
### 环境准备
-**注意:使用Nginx实现Apache Doris数据库的负载均衡,前提是要搭建Apache Doris的环境,Apache Doris FE的IP和端口分别如下所示, 这里我是用一个FE来做演示的,多个FE只需要在配置里添加多个FE的IP地址和端口即可**
+**注意:使用 Nginx 实现 Apache Doris 数据库的负载均衡,前提是要搭建 Apache Doris 的环境,Apache Doris FE 的 IP 和端口分别如下所示,这里我是用一个 FE 来做演示的,多个 FE 只需要在配置里添加多个 FE 的 IP 地址和端口即可**
-通过Nginx访问MySQL的Apache Doris和端口如下所示。
+通过 Nginx 访问 MySQL 的 Apache Doris 和端口如下所示。
```
IP: 172.31.7.119
@@ -494,7 +519,7 @@ sudo apt-get install zlib1g-dev
sudo apt-get install openssl libssl-dev
```
-### 安装Nginx
+### 安装 Nginx
```bash
sudo wget http://nginx.org/download/nginx-1.18.0.tar.gz
@@ -534,7 +559,7 @@ stream {
}
```
-### 启动Nginx
+### 启动 Nginx
指定配置文件启动
@@ -549,11 +574,14 @@ cd /usr/local/nginx
mysql -uroot -P6030 -h172.31.7.119
```
-参数解释:
-> - -u 指定Doris用户名
-> - -p 指定Doris密码,我这里密码是空,所以没有
-> - -h 指定Nginx代理服务器IP
-> - -P 指定端口
+参数解释:
+- -u 指定 Doris 用户名
+
+- -p 指定 Doris 密码,我这里密码是空,所以没有
+
+- -h 指定 Nginx 代理服务器 IP
+
+- -P 指定端口
```sql
mysql -uroot -P6030 -h172.31.7.119
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/upgrade.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/upgrade.md
index 88fca9b29128..17298773f0d2 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/upgrade.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/cluster-management/upgrade.md
@@ -24,7 +24,6 @@ specific language governing permissions and limitations
under the License.
-->
-# 集群升级
## 概述
@@ -37,9 +36,9 @@ under the License.
Doris 升级请遵守**不要跨两个及以上关键节点版本升级**的原则,若要跨多个关键节点版本升级,先升级到最近的关键节点版本,随后再依次往后升级,若是非关键节点版本,则可忽略跳过。
关键节点版本:升级时必须要经历的版本,可能是单独一个版本,也可能是一个版本区间,如 `1.1.3 - 1.1.5`,则表示升级至该区间任意一版本即可继续后续升级。
-
:::
+
| 版本号 | 关键节点版本 | LTS 版本 |
| ------------------------ | ------------ | -------- |
| 0.12.x | 是 | 否 |
@@ -57,15 +56,15 @@ Doris 升级请遵守**不要跨两个及以上关键节点版本升级**的原
`0.12` -> `0.13` -> `0.14` -> `0.15` -> `1.1.3 - 1.1.5` 任意版本 -> `1.2.0 - 1.2.5` 任意版本 -> `2.0.0-beta`
-:::tip
+:::caution
-LTS 版本:Long-time Support,LTS 版本提供长期支持,会持续维护六个月以上,通常而言,**版本号第三位数越大的版本,稳定性越好**。
+- LTS 版本:Long-time Support,LTS 版本提供长期支持,会持续维护六个月以上,通常而言,**版本号第三位数越大的版本,稳定性越好**。
-Alpha 版本:内部测试版本,功能还未完全确定,或许存在重大 BUG,只推荐上测试集群做测试,**不推荐上生产集群!**
+- Alpha 版本:内部测试版本,功能还未完全确定,或许存在重大 BUG,只推荐上测试集群做测试,**不推荐上生产集群!**
-Beta 版本:公开测试版本,功能已基本确定,或许存在非重大 BUG,只推荐上测试集群做测试,**不推荐上生产集群!**
+- Beta 版本:公开测试版本,功能已基本确定,或许存在非重大 BUG,只推荐上测试集群做测试,**不推荐上生产集群!**
-Release 版本:公开发行版,已完成基本重要 BUG 的修复和功能性缺陷修复验证,推荐上生产集群。
+- Release 版本:公开发行版,已完成基本重要 BUG 的修复和功能性缺陷修复验证,推荐上生产集群。
:::
@@ -74,27 +73,34 @@ Release 版本:公开发行版,已完成基本重要 BUG 的修复和功能
### 升级说明
1. 在升级过程中,由于 Doris 的 RoutineLoad、Flink-Doris-Connector、Spark-Doris-Connector 都已在代码中实现了重试机制,所以在多 BE 节点的集群中,滚动升级不会导致任务失败。
+
2. StreamLoad 任务需要您在自己的代码中实现重试机制,否则会导致任务失败。
+
3. 集群副本修复和均衡功能在单次升级任务中务必要前置关闭和结束后打开,无论您集群节点是否全部升级完成。
### 升级流程概览
1. 元数据备份
+
2. 关闭集群副本修复和均衡功能
+
3. 兼容性测试
+
4. 升级 BE
+
5. 升级 FE
+
6. 打开集群副本修复和均衡功能
### 升级前置工作
请按升级流程顺次执行升级
-#### 元数据备份(重要)
+**01 元数据备份(重要)**
**将 FE-Master 节点的 `doris-meta` 目录进行完整备份!**
-#### 关闭集群副本修复和均衡功能
+**02 关闭集群副本修复和均衡功能**
升级过程中会有节点重启,所以可能会触发不必要的集群均衡和副本修复逻辑,先通过以下命令关闭:
@@ -104,15 +110,15 @@ admin set frontend config("disable_colocate_balance" = "true");
admin set frontend config("disable_tablet_scheduler" = "true");
```
-#### 兼容性测试
+**03 兼容性测试**
-:::tip
+:::caution
**元数据兼容非常重要,如果因为元数据不兼容导致的升级失败,那可能会导致数据丢失!建议每次升级前都进行元数据兼容性测试!**
:::
-##### FE 兼容性测试
+1. FE 兼容性测试
:::tip
@@ -121,17 +127,18 @@ admin set frontend config("disable_tablet_scheduler" = "true");
1. 建议在自己本地的开发机,或者 BE 节点做 FE 兼容性测试。
2. 不建议在 Follower 或者 Observer 节点上测试,避免出现链接异常
+
3. 如果一定在 Follower 或者 Observer 节点上,需要停止已启动的 FE 进程
:::
-1. 单独使用新版本部署一个测试用的 FE 进程
+a. 单独使用新版本部署一个测试用的 FE 进程
```shell
sh ${DORIS_NEW_HOME}/bin/start_fe.sh --daemon
```
-2. 修改测试用的 FE 的配置文件 fe.conf
+b. 修改测试用的 FE 的配置文件 fe.conf
```shell
vi ${DORIS_NEW_HOME}/conf/fe.conf
@@ -151,55 +158,58 @@ admin set frontend config("disable_tablet_scheduler" = "true");
保存并退出
-3. 修改 fe.conf
- - 在 fe.conf 添加 ClusterID 配置
+c. 修改 fe.conf
+
+ - 在 fe.conf 添加 ClusterID 配置
```shell
echo "cluster_id=123456" >> ${DORIS_NEW_HOME}/conf/fe.conf
```
- - 添加元数据故障恢复配置 (**2.0.2 + 版本无需进行此操作**)
+ - 添加元数据故障恢复配置(**2.0.2 + 版本无需进行此操作**)
+
```shell
echo "metadata_failure_recovery=true" >> ${DORIS_NEW_HOME}/conf/fe.conf
```
-4. 拷贝线上环境 Master FE 的元数据目录 doris-meta 到测试环境
+d. 拷贝线上环境 Master FE 的元数据目录 doris-meta 到测试环境
```shell
cp ${DORIS_OLD_HOME}/fe/doris-meta/* ${DORIS_NEW_HOME}/fe/doris-meta
```
-5. 将拷贝到测试环境中的 VERSION 文件中的 cluster_id 修改为 123456(即与第3步中相同)
+e. 将拷贝到测试环境中的 VERSION 文件中的 cluster_id 修改为 123456(即与第 3 步中相同)
```shell
vi ${DORIS_NEW_HOME}/fe/doris-meta/image/VERSION
clusterId=123456
```
-6. 在测试环境中,运行启动 FE (**请按照版本选择启动 FE 的方式**)
+f. 在测试环境中,运行启动 FE(**请按照版本选择启动 FE 的方式**)
-- 2.0.2(包含2.0.2) + 版本
+ - 2.0.2(包含 2.0.2) + 版本
```shell
sh ${DORIS_NEW_HOME}/bin/start_fe.sh --daemon --metadata_failure_recovery
```
-- 2.0.1(包含2.0.1) 以前的版本
- ```shell
- sh ${DORIS_NEW_HOME}/bin/start_fe.sh --daemon
- ```
+
+ - 2.0.1(包含 2.0.1)以前的版本
+ ```shell
+ sh ${DORIS_NEW_HOME}/bin/start_fe.sh --daemon
+ ```
-7. 通过 FE 日志 fe.log 观察是否启动成功
+g. 通过 FE 日志 fe.log 观察是否启动成功
```shell
tail -f ${DORIS_NEW_HOME}/log/fe.log
```
-8. 如果启动成功,则代表兼容性没有问题,停止测试环境的 FE 进程,准备升级
+h. 如果启动成功,则代表兼容性没有问题,停止测试环境的 FE 进程,准备升级
```
sh ${DORIS_NEW_HOME}/bin/stop_fe.sh
```
-##### BE 兼容性测试
+2. BE 兼容性测试
可利用灰度升级方案,先升级单个 BE,无异常和报错情况下即视为兼容性正常,可执行后续升级动作
@@ -207,7 +217,7 @@ admin set frontend config("disable_tablet_scheduler" = "true");
:::tip
-先升级 BE,后升级FE
+先升级 BE,后升级 FE
一般而言,Doris 只需要升级 FE 目录下的 `/bin` 和 `/lib` 以及 BE 目录下的 `/bin` 和 `/lib`
@@ -219,7 +229,7 @@ admin set frontend config("disable_tablet_scheduler" = "true");
:::
-#### 升级 BE
+**04 升级 BE**
:::tip
@@ -263,7 +273,7 @@ admin set frontend config("disable_tablet_scheduler" = "true");
6. 依次完成其他 BE 节点升级
-#### 升级 FE
+**05 升级 FE**
:::tip
@@ -309,7 +319,7 @@ admin set frontend config("disable_tablet_scheduler" = "true");
6. 依次完成其他 FE 节点升级,**最后完成 Master 节点的升级**
-#### 打开集群副本修复和均衡功能
+**06 打开集群副本修复和均衡功能**
升级完成,并且所有 BE 节点状态变为 `Alive` 后,打开集群副本修复和均衡功能:
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/advanced/best-practice/compaction.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/compaction.md
similarity index 77%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/advanced/best-practice/compaction.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/compaction.md
index 5b8562db5070..0c79b1d60f1d 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/advanced/best-practice/compaction.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/compaction.md
@@ -1,6 +1,6 @@
---
{
- "title": "Compaction",
+ "title": "Compaction 调整",
"language": "zh-CN"
}
---
@@ -24,45 +24,60 @@ specific language governing permissions and limitations
under the License.
-->
-# Compaction
+
Doris 通过类似 LSM-Tree 的结构写入数据,在后台通过 Compaction 机制不断将小文件合并成有序的大文件,同时也会处理数据的删除、更新等操作。适当的调整 Compaction 的策略,可以极大地提升导入效率和查询效率。
-Doris 提供如下2种compaction方式进行调优:
+Doris 提供如下 2 种 compaction 方式进行调优:
## Vertical compaction
-<version since="1.2.2">
-</version>
-Vertical compaction 是 Doris 1.2.2 版本中实现的新的 Compaction 算法,用于解决大宽表场景下的 Compaction 执行效率和资源开销问题。可以有效降低Compaction的内存开销,并提升 Compaction 的执行速度。
-实际测试中,Vertical compaction 使用内存仅为原有compaction算法的1/10,同时compaction速率提升15%。
-Vertical compaction中将按行合并的方式改变为按列组合并,每次参与合并的粒度变成列组,降低单次compaction内部参与的数据量,减少compaction期间的内存使用。
+:::note
+自 Doris 1.2.2 版本起支持 Vertical compaction
+:::
+
+Vertical compaction 是 Doris 1.2.2 版本中实现的新的 Compaction 算法,用于解决大宽表场景下的 Compaction 执行效率和资源开销问题。可以有效降低 Compaction 的内存开销,并提升 Compaction 的执行速度。
+
+实际测试中,Vertical compaction 使用内存仅为原有 compaction 算法的 1/10,同时 compaction 速率提升 15%。
+
+Vertical compaction 中将按行合并的方式改变为按列组合并,每次参与合并的粒度变成列组,降低单次 compaction 内部参与的数据量,减少 compaction 期间的内存使用。
-开启和配置方法(BE 配置):
+开启和配置方法 (BE 配置):
- `enable_vertical_compaction = true` 可以开启该功能
-- `vertical_compaction_num_columns_per_group = 5` 每个列组包含的列个数,经测试,默认5列一组compaction的效率及内存使用较友好
-- `vertical_compaction_max_segment_size` 用于配置vertical compaction之后落盘文件的大小,默认值268435456(字节)
+
+- `vertical_compaction_num_columns_per_group = 5` 每个列组包含的列个数,经测试,默认 5 列一组 compaction 的效率及内存使用较友好
+
+- `vertical_compaction_max_segment_size` 用于配置 vertical compaction 之后落盘文件的大小,默认值 268435456(字节)
## Segment compaction
-Segment compaction 主要应对单批次大数据量的导入场景。和 Vertical compaction 的触发机制不同,Segment compaction 是在导入过程中,针对一批次数据内,多个 Segment 进行的合并操作。这种机制可以有效减少最终生成的 Segment 数量,避免 -238 (OLAP_ERR_TOO_MANY_SEGMENTS)错误的出现。
+Segment compaction 主要应对单批次大数据量的导入场景。和 Vertical compaction 的触发机制不同,Segment compaction 是在导入过程中,针对一批次数据内,多个 Segment 进行的合并操作。这种机制可以有效减少最终生成的 Segment 数量,避免 -238(OLAP_ERR_TOO_MANY_SEGMENTS)错误的出现。
Segment compaction 有以下特点:
- 可以减少导入产生的 segment 数量
+
- 合并过程与导入过程并行,不会额外增加导入时间
+
- 导入过程中的内存和计算资源的使用量会有增加,但因为平摊在整个导入过程中所以涨幅较低
+
- 经过 Segment compaction 后的数据在进行后续查询以及标准 compaction 时会有资源和性能上的优势
-开启和配置方法(BE 配置):
+开启和配置方法 (BE 配置):
+
- `enable_segcompaction = true` 可以使能该功能
+
- `segcompaction_batch_size` 用于配置合并的间隔。默认 10 表示每生成 10 个 segment 文件将会进行一次 segment compaction。一般设置为 10 - 30,过大的值会增加 segment compaction 的内存用量。
如有以下场景或问题,建议开启此功能:
+
- 导入大量数据触发 OLAP_ERR_TOO_MANY_SEGMENTS (errcode -238) 错误导致导入失败。此时建议打开 segment compaction 的功能,在导入过程中对 segment 进行合并控制最终的数量。
+
- 导入过程中产生大量的小文件:虽然导入数据量不大,但因为低基数数据,或因为内存紧张触发 memtable 提前下刷,产生大量小 segment 文件也可能会触发 OLAP_ERR_TOO_MANY_SEGMENTS 导致导入失败。此时建议打开该功能。
+
- 导入大量数据后立即进行查询:刚导入完成、标准 compaction 还没有完成工作时,此时 segment 文件过多会影响后续查询效率。如果用户有导入后立即查询的需求,建议打开该功能。
+
- 导入后标准 compaction 压力大:segment compaction 本质上是把标准 compaction 的一部分压力放在了导入过程中进行处理,此时建议打开该功能。
不建议使用的情况:
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/be-config.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/be-config.md
index 7c8d9657dbc0..e5d49114cede 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/be-config.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/be-config.md
@@ -28,11 +28,11 @@ under the License.
<!-- Please sort the configuration alphabetically -->
-# BE 配置项
+
该文档主要介绍 BE 的相关配置项。
-BE 的配置文件 `be.conf` 通常存放在 BE 部署路径的 `conf/` 目录下。 而在 0.14 版本中会引入另一个配置文件 `be_custom.conf`。该配置文件用于记录用户在运行时动态配置并持久化的配置项。
+BE 的配置文件 `be.conf` 通常存放在 BE 部署路径的 `conf/` 目录下。而在 0.14 版本中会引入另一个配置文件 `be_custom.conf`。该配置文件用于记录用户在运行时动态配置并持久化的配置项。
BE 进程启动后,会先读取 `be.conf` 中的配置项,之后再读取 `be_custom.conf` 中的配置项。`be_custom.conf` 中的配置项会覆盖 `be.conf` 中相同的配置项。
@@ -132,23 +132,23 @@ BE 重启后该配置将失效。如果想持久化修改结果,使用如下
#### `enable_https`
* 类型:bool
-* 描述:是否支持https. 如果是,需要在be.conf中配置`ssl_certificate_path`和`ssl_private_key_path`
+* 描述:是否支持 https. 如果是,需要在 be.conf 中配置`ssl_certificate_path`和`ssl_private_key_path`
* 默认值:false
#### `priority_networks`
-* 描述: 为那些有很多 ip 的服务器声明一个选择策略。 请注意,最多应该有一个 ip 与此列表匹配。 这是一个以分号分隔格式的列表,用 CIDR 表示法,例如 10.10.10.0/24 , 如果没有匹配这条规则的ip,会随机选择一个。
-* 默认值: 空
+* 描述:为那些有很多 ip 的服务器声明一个选择策略。请注意,最多应该有一个 ip 与此列表匹配。这是一个以分号分隔格式的列表,用 CIDR 表示法,例如 10.10.10.0/24,如果没有匹配这条规则的 ip,会随机选择一个。
+* 默认值:空
#### `storage_root_path`
* 类型:string
-* 描述:BE数据存储的目录,多目录之间用英文状态的分号`;`分隔。可以通过路径区别存储目录的介质,HDD或SSD。可以添加容量限制在每个路径的末尾,通过英文状态逗号`,`隔开。如果用户不是SSD和HDD磁盘混合使用的情况,不需要按照如下示例一和示例二的配置方法配置,只需指定存储目录即可;也不需要修改FE的默认存储介质配置
+* 描述:BE 数据存储的目录,多目录之间用英文状态的分号`;`分隔。可以通过路径区别存储目录的介质,HDD 或 SSD。可以添加容量限制在每个路径的末尾,通过英文状态逗号`,`隔开。如果用户不是 SSD 和 HDD 磁盘混合使用的情况,不需要按照如下示例一和示例二的配置方法配置,只需指定存储目录即可;也不需要修改 FE 的默认存储介质配置
- 示例1如下:
+ 示例 1 如下:
- **注意:如果是SSD磁盘要在目录后面加上`.SSD`,HDD磁盘在目录后面加`.HDD`**
+ **注意:如果是 SSD 磁盘要在目录后面加上`.SSD`,HDD 磁盘在目录后面加`.HDD`**
`storage_root_path=/home/disk1/doris.HDD;/home/disk2/doris.SSD;/home/disk2/doris`
@@ -158,9 +158,9 @@ BE 重启后该配置将失效。如果想持久化修改结果,使用如下
- /home/disk2/doris.SSD,表示存储介质是SSD;
- /home/disk2/doris,存储介质默认为HDD
- 示例2如下:
+ 示例 2 如下:
- **注意:不论HHD磁盘目录还是SSD磁盘目录,都无需添加后缀,storage_root_path参数里指定medium即可**
+ **注意:不论 HHD 磁盘目录还是 SSD 磁盘目录,都无需添加后缀,storage_root_path 参数里指定 medium 即可**
`storage_root_path=/home/disk1/doris,medium:hdd;/home/disk2/doris,medium:ssd`
@@ -175,118 +175,118 @@ BE 重启后该配置将失效。如果想持久化修改结果,使用如下
#### `heartbeat_service_thread_count`
* 类型:int32
-* 描述:执行BE上心跳服务的线程数,默认为1,不建议修改
+* 描述:执行 BE 上心跳服务的线程数,默认为 1,不建议修改
* 默认值:1
#### `ignore_broken_disk`
* 类型:bool
-* 描述:当BE启动时,会检查``storage_root_path`` 配置下的所有路径。
+* 描述:当 BE 启动时,会检查``storage_root_path`` 配置下的所有路径。
- `ignore_broken_disk=true`
- 如果路径不存在或路径下无法进行读写文件(坏盘),将忽略此路径,如果有其他可用路径则不中断启动。
+ 如果路径不存在或路径下无法进行读写文件 (坏盘),将忽略此路径,如果有其他可用路径则不中断启动。
- `ignore_broken_disk=false`
- 如果路径不存在或路径下无法进行读写文件(坏盘),将中断启动失败退出。
+ 如果路径不存在或路径下无法进行读写文件 (坏盘),将中断启动失败退出。
* 默认值:false
#### `mem_limit`
* 类型:string
-* 描述:限制BE进程使用服务器最大内存百分比。用于防止BE内存挤占太多的机器内存,该参数必须大于0,当百分大于100%之后,该值会默认为100%。
+* 描述:限制 BE 进程使用服务器最大内存百分比。用于防止 BE 内存挤占太多的机器内存,该参数必须大于 0,当百分大于 100% 之后,该值会默认为 100%。
* 默认值:80%
#### `cluster_id`
* 类型:int32
-* 描述:配置BE的所属于的集群id。
- - 该值通常由FE通过心跳向BE下发,不需要额外进行配置。当确认某BE属于某一个确定的Drois集群时,可以进行配置,同时需要修改数据目录下的cluster_id文件,使二者相同。
+* 描述:配置 BE 的所属于的集群 id。
+ - 该值通常由 FE 通过心跳向 BE 下发,不需要额外进行配置。当确认某 BE 属于某一个确定的 Drois 集群时,可以进行配置,同时需要修改数据目录下的 cluster_id 文件,使二者相同。
* 默认值:-1
#### `custom_config_dir`
* 描述:配置 `be_custom.conf` 文件的位置。默认为 `conf/` 目录下。
- 在某些部署环境下,`conf/`目录可能因为系统的版本升级被覆盖掉。这会导致用户在运行是持久化修改的配置项也被覆盖。这时,我们可以将 `be_custom.conf` 存储在另一个指定的目录中,以防止配置文件被覆盖。
-* 默认值: 空
+* 默认值:空
#### `trash_file_expire_time_sec`
-* 描述:回收站清理的间隔,72个小时,当磁盘空间不足时,trash下的文件保存期可不遵守这个参数
-* 默认值: 259200
+* 描述:回收站清理的间隔,72 个小时,当磁盘空间不足时,trash 下的文件保存期可不遵守这个参数
+* 默认值:259200
#### `es_http_timeout_ms`
-* 描述:通过http连接ES的超时时间,默认是5秒
-* 默认值: 5000 (ms)
+* 描述:通过 http 连接 ES 的超时时间,默认是 5 秒
+* 默认值:5000 (ms)
#### `es_scroll_keepalive`
-* 描述:es scroll Keeplive保持时间,默认5分钟
-* 默认值: 5 (m)
+* 描述:es scroll Keeplive 保持时间,默认 5 分钟
+* 默认值:5 (m)
#### `external_table_connect_timeout_sec`
-* 类型: int32
-* 描述: 和外部表建立连接的超时时间。
-* 默认值: 5秒
+* 类型:int32
+* 描述:和外部表建立连接的超时时间。
+* 默认值:5 秒
#### `status_report_interval`
* 描述:配置文件报告之间的间隔;单位:秒
-* 默认值: 5
+* 默认值:5
#### `brpc_max_body_size`
* 描述:这个配置主要用来修改 brpc 的参数 `max_body_size`。
- - 有时查询失败,在 BE 日志中会出现 `body_size is too large` 的错误信息。这可能发生在 SQL 模式为 multi distinct + 无 group by + 超过1T 数据量的情况下。这个错误表示 brpc 的包大小超过了配置值。此时可以通过调大该配置避免这个错误。
+ - 有时查询失败,在 BE 日志中会出现 `body_size is too large` 的错误信息。这可能发生在 SQL 模式为 multi distinct + 无 group by + 超过 1T 数据量的情况下。这个错误表示 brpc 的包大小超过了配置值。此时可以通过调大该配置避免这个错误。
#### `brpc_socket_max_unwritten_bytes`
* 描述:这个配置主要用来修改 brpc 的参数 `socket_max_unwritten_bytes`。
- - 有时查询失败,BE 日志中会出现 `The server is overcrowded` 的错误信息,表示连接上有过多的未发送数据。当查询需要发送较大的bitmap字段时,可能会遇到该问题,此时可能通过调大该配置避免该错误。
+ - 有时查询失败,BE 日志中会出现 `The server is overcrowded` 的错误信息,表示连接上有过多的未发送数据。当查询需要发送较大的 bitmap 字段时,可能会遇到该问题,此时可能通过调大该配置避免该错误。
#### `transfer_large_data_by_brpc`
-* 类型: bool
-* 描述:该配置用来控制是否在 Tuple/Block data 长度大于1.8G时,将 protoBuf request 序列化后和 Tuple/Block data 一起嵌入到 controller attachment 后通过 http brpc 发送。为了避免 protoBuf request 的长度超过2G时的错误:Bad request, error_text=[E1003]Fail to compress request。在过去的版本中,曾将 Tuple/Block data 放入 attachment 后通过默认的 baidu_std brpc 发送,但 attachment 超过2G时将被截断,通过 http brpc 发送不存在2G的限制。
+* 类型:bool
+* 描述:该配置用来控制是否在 Tuple/Block data 长度大于 1.8G 时,将 protoBuf request 序列化后和 Tuple/Block data 一起嵌入到 controller attachment 后通过 http brpc 发送。为了避免 protoBuf request 的长度超过 2G 时的错误:Bad request, error_text=[E1003]Fail to compress request。在过去的版本中,曾将 Tuple/Block data 放入 attachment 后通过默认的 baidu_std brpc 发送,但 attachment 超过 2G 时将被截断,通过 http brpc 发送不存在 2G 的限制。
* 默认值:true
#### `brpc_num_threads`
-* 描述:该配置主要用来修改brpc中bthreads的数量. 该配置的默认值被设置为-1, 这意味着bthreads的数量将被设置为机器的cpu核数。
+* 描述:该配置主要用来修改 brpc 中 bthreads 的数量。该配置的默认值被设置为 -1, 这意味着 bthreads 的数量将被设置为机器的 cpu 核数。
- - 用户可以将该配置的值调大来获取更好的QPS性能。更多的信息可以参考`https://github.com/apache/incubator-brpc/blob/master/docs/cn/benchmark.md`。
+ - 用户可以将该配置的值调大来获取更好的 QPS 性能。更多的信息可以参考`https://github.com/apache/incubator-brpc/blob/master/docs/cn/benchmark.md`。
* 默认值:-1
#### `thrift_rpc_timeout_ms`
-* 描述:thrift默认超时时间
+* 描述:thrift 默认超时时间
* 默认值:60000
#### `thrift_client_retry_interval_ms`
* 类型:int64
-* 描述:用来为be的thrift客户端设置重试间隔, 避免fe的thrift server发生雪崩问题,单位为ms。
+* 描述:用来为 be 的 thrift 客户端设置重试间隔,避免 fe 的 thrift server 发生雪崩问题,单位为 ms。
* 默认值:1000
#### `thrift_connect_timeout_seconds`
-* 描述:默认thrift客户端连接超时时间
+* 描述:默认 thrift 客户端连接超时时间
* 默认值:3 (m)
#### `thrift_server_type_of_fe`
* 类型:string
-* 描述:该配置表示FE的Thrift服务使用的服务模型, 类型为string, 大小写不敏感,该参数需要和fe的thrift_server_type参数的设置保持一致。目前该参数的取值有两个,`THREADED`和`THREAD_POOL`。
+* 描述:该配置表示 FE 的 Thrift 服务使用的服务模型,类型为 string, 大小写不敏感,该参数需要和 fe 的 thrift_server_type 参数的设置保持一致。目前该参数的取值有两个,`THREADED`和`THREAD_POOL`。
- - 若该参数为`THREADED`, 该模型为非阻塞式I/O模型,
+ - 若该参数为`THREADED`, 该模型为非阻塞式 I/O 模型,
- - 若该参数为`THREAD_POOL`, 该模型为阻塞式I/O模型。
+ - 若该参数为`THREAD_POOL`, 该模型为阻塞式 I/O 模型。
#### `txn_commit_rpc_timeout_ms`
@@ -295,47 +295,47 @@ BE 重启后该配置将失效。如果想持久化修改结果,使用如下
#### `txn_map_shard_size`
-* 描述:txn_map_lock 分片大小,取值为2^n,n=0,1,2,3,4。这是一项增强功能,可提高管理 txn 的性能
+* 描述:txn_map_lock 分片大小,取值为 2^n,n=0,1,2,3,4。这是一项增强功能,可提高管理 txn 的性能
* 默认值:128
#### `txn_shard_size`
-* 描述:txn_lock 分片大小,取值为2^n,n=0,1,2,3,4, 这是一项增强功能,可提高提交和发布 txn 的性能
+* 描述:txn_lock 分片大小,取值为 2^n,n=0,1,2,3,4,这是一项增强功能,可提高提交和发布 txn 的性能
* 默认值:1024
#### `unused_rowset_monitor_interval`
-* 描述:清理过期Rowset的时间间隔
+* 描述:清理过期 Rowset 的时间间隔
* 默认值:30 (s)
#### `max_client_cache_size_per_host`
-* 描述:每个主机的最大客户端缓存数,BE 中有多种客户端缓存,但目前我们使用相同的缓存大小配置。 如有必要,使用不同的配置来设置不同的客户端缓存。
+* 描述:每个主机的最大客户端缓存数,BE 中有多种客户端缓存,但目前我们使用相同的缓存大小配置。如有必要,使用不同的配置来设置不同的客户端缓存。
* 默认值:10
#### `string_type_length_soft_limit_bytes`
-* 类型: int32
-* 描述: String 类型最大长度的软限,单位是字节
-* 默认值: 1048576
+* 类型:int32
+* 描述:String 类型最大长度的软限,单位是字节
+* 默认值:1048576
#### `big_column_size_buffer`
* 类型:int64
-* 描述:当使用odbc外表时,如果odbc源表的某一列类型为HLL, CHAR或者VARCHAR,并且列值长度超过该值,则查询报错'column value length longer than buffer length'. 可增大该值
+* 描述:当使用 odbc 外表时,如果 odbc 源表的某一列类型为 HLL, CHAR 或者 VARCHAR,并且列值长度超过该值,则查询报错'column value length longer than buffer length'. 可增大该值
* 默认值:65535
#### `small_column_size_buffer`
* 类型:int64
-* 描述:当使用odbc外表时,如果odbc源表的某一列类型不是HLL, CHAR或者VARCHAR,并且列值长度超过该值,则查询报错'column value length longer than buffer length'. 可增大该值
+* 描述:当使用 odbc 外表时,如果 odbc 源表的某一列类型不是 HLL, CHAR 或者 VARCHAR,并且列值长度超过该值,则查询报错'column value length longer than buffer length'. 可增大该值
* 默认值:100
#### `jsonb_type_length_soft_limit_bytes`
-* 类型: int32
-* 描述: JSONB 类型最大长度的软限,单位是字节
-* 默认值: 1048576
+* 类型:int32
+* 描述:JSONB 类型最大长度的软限,单位是字节
+* 默认值:1048576
### 查询
@@ -346,18 +346,18 @@ BE 重启后该配置将失效。如果想持久化修改结果,使用如下
#### `fragment_pool_thread_num_min`
-* 描述:查询线程数,默认最小启动64个线程。
+* 描述:查询线程数,默认最小启动 64 个线程。
* 默认值:64
#### `fragment_pool_thread_num_max`
-* 描述:后续查询请求动态创建线程,最大创建512个线程。
+* 描述:后续查询请求动态创建线程,最大创建 512 个线程。
* 默认值:2048
#### `doris_max_pushdown_conjuncts_return_rate`
* 类型:int32
-* 描述:BE在进行HashJoin时,会采取动态分区裁剪的方式将join条件下推到OlapScanner上。当OlapScanner扫描的数据大于32768行时,BE会进行过滤条件检查,如果该过滤条件的过滤率低于该配置,则Doris会停止使用动态分区裁剪的条件进行数据过滤。
+* 描述:BE 在进行 HashJoin 时,会采取动态分区裁剪的方式将 join 条件下推到 OlapScanner 上。当 OlapScanner 扫描的数据大于 32768 行时,BE 会进行过滤条件检查,如果该过滤条件的过滤率低于该配置,则 Doris 会停止使用动态分区裁剪的条件进行数据过滤。
* 默认值:90
#### `doris_max_scan_key_num`
@@ -370,13 +370,13 @@ BE 重启后该配置将失效。如果想持久化修改结果,使用如下
#### `doris_scan_range_row_count`
* 类型:int32
-* 描述:BE在进行数据扫描时,会将同一个扫描范围拆分为多个ScanRange。该参数代表了每个ScanRange代表扫描数据范围。通过该参数可以限制单个OlapScanner占用io线程的时间。
+* 描述:BE 在进行数据扫描时,会将同一个扫描范围拆分为多个 ScanRange。该参数代表了每个 ScanRange 代表扫描数据范围。通过该参数可以限制单个 OlapScanner 占用 io 线程的时间。
* 默认值:524288
#### `doris_scanner_queue_size`
* 类型:int32
-* 描述:TransferThread与OlapScanner之间RowBatch的缓存队列的长度。Doris进行数据扫描时是异步进行的,OlapScanner扫描上来的Rowbatch会放入缓存队列之中,等待上层TransferThread取走。
+* 描述:TransferThread 与 OlapScanner 之间 RowBatch 的缓存队列的长度。Doris 进行数据扫描时是异步进行的,OlapScanner 扫描上来的 Rowbatch 会放入缓存队列之中,等待上层 TransferThread 取走。
* 默认值:1024
#### `doris_scanner_row_num`
@@ -387,19 +387,19 @@ BE 重启后该配置将失效。如果想持久化修改结果,使用如下
#### `doris_scanner_row_bytes`
* 描述:每个扫描线程单次执行最多返回的数据字节
- - 说明:如果表的列数太多,遇到 `select *` 卡主,可以调整这个配置
+ - 说明:如果表的列数太多,遇到 `select *` 卡主,可以调整这个配置
* 默认值:10485760
#### `doris_scanner_thread_pool_queue_size`
* 类型:int32
-* 描述:Scanner线程池的队列长度。在Doris的扫描任务之中,每一个Scanner会作为一个线程task提交到线程池之中等待被调度,而提交的任务数目超过线程池队列的长度之后,后续提交的任务将阻塞直到队列之中有新的空缺。
+* 描述:Scanner 线程池的队列长度。在 Doris 的扫描任务之中,每一个 Scanner 会作为一个线程 task 提交到线程池之中等待被调度,而提交的任务数目超过线程池队列的长度之后,后续提交的任务将阻塞直到队列之中有新的空缺。
* 默认值:102400
#### `doris_scanner_thread_pool_thread_num`
* 类型:int32
-* 描述:Scanner线程池线程数目。在Doris的扫描任务之中,每一个Scanner会作为一个线程task提交到线程池之中等待被调度,该参数决定了Scanner线程池的大小。
+* 描述:Scanner 线程池线程数目。在 Doris 的扫描任务之中,每一个 Scanner 会作为一个线程 task 提交到线程池之中等待被调度,该参数决定了 Scanner 线程池的大小。
* 默认值:48
#### `doris_max_remote_scanner_thread_pool_thread_num`
@@ -411,19 +411,19 @@ BE 重启后该配置将失效。如果想持久化修改结果,使用如下
#### `enable_prefetch`
* 类型:bool
-* 描述:当使用PartitionedHashTable进行聚合和join计算时,是否进行HashBuket的预取,推荐设置为true。
+* 描述:当使用 PartitionedHashTable 进行聚合和 join 计算时,是否进行 HashBuket 的预取,推荐设置为 true。
* 默认值:true
#### `enable_quadratic_probing`
* 类型:bool
-* 描述:当使用PartitionedHashTable时发生Hash冲突时,是否采用平方探测法来解决Hash冲突。该值为false的话,则选用线性探测发来解决Hash冲突。关于平方探测法可参考:[quadratic_probing](https://en.wikipedia.org/wiki/Quadratic_probing)
+* 描述:当使用 PartitionedHashTable 时发生 Hash 冲突时,是否采用平方探测法来解决 Hash 冲突。该值为 false 的话,则选用线性探测发来解决 Hash 冲突。关于平方探测法可参考:[quadratic_probing](https://en.wikipedia.org/wiki/Quadratic_probing)
* 默认值:true
#### `exchg_node_buffer_size_bytes`
* 类型:int32
-* 描述:ExchangeNode节点Buffer队列的大小,单位为byte。来自Sender端发送的数据量大于ExchangeNode的Buffer大小之后,后续发送的数据将阻塞直到Buffer腾出可写入的空间。
+* 描述:ExchangeNode 节点 Buffer 队列的大小,单位为 byte。来自 Sender 端发送的数据量大于 ExchangeNode 的 Buffer 大小之后,后续发送的数据将阻塞直到 Buffer 腾出可写入的空间。
* 默认值:10485760
#### `max_pushdown_conditions_per_column`
@@ -446,136 +446,136 @@ BE 重启后该配置将失效。如果想持久化修改结果,使用如下
#### `doris_scan_range_max_mb`
-* 类型: int32
-* 描述: 每个OlapScanner 读取的最大数据量
-* 默认值: 1024
+* 类型:int32
+* 描述:每个 OlapScanner 读取的最大数据量
+* 默认值:1024
### compaction
#### `disable_auto_compaction`
* 类型:bool
-* 描述:关闭自动执行compaction任务
- - 一般需要为关闭状态,当调试或测试环境中想要手动操作compaction任务时,可以对该配置进行开启
+* 描述:关闭自动执行 compaction 任务
+ - 一般需要为关闭状态,当调试或测试环境中想要手动操作 compaction 任务时,可以对该配置进行开启
* 默认值:false
#### `enable_vertical_compaction`
-* 类型: bool
-* 描述: 是否开启列式compaction
-* 默认值: true
+* 类型:bool
+* 描述:是否开启列式 compaction
+* 默认值:true
#### `vertical_compaction_num_columns_per_group`
-* 类型: int32
-* 描述: 在列式compaction中, 组成一个合并组的列个数
-* 默认值: 5
+* 类型:int32
+* 描述:在列式 compaction 中,组成一个合并组的列个数
+* 默认值:5
#### `vertical_compaction_max_row_source_memory_mb`
-* 类型: int32
-* 描述: 在列式compaction中, row_source_buffer能使用的最大内存,单位是MB。
-* 默认值: 200
+* 类型:int32
+* 描述:在列式 compaction 中,row_source_buffer 能使用的最大内存,单位是 MB。
+* 默认值:200
#### `vertical_compaction_max_segment_size`
-* 类型: int32
-* 描述: 在列式compaction中, 输出的segment文件最大值,单位是m字节。
-* 默认值: 268435456
+* 类型:int32
+* 描述:在列式 compaction 中,输出的 segment 文件最大值,单位是 m 字节。
+* 默认值:268435456
#### `enable_ordered_data_compaction`
-* 类型: bool
-* 描述: 是否开启有序数据的compaction
-* 默认值: true
+* 类型:bool
+* 描述:是否开启有序数据的 compaction
+* 默认值:true
#### `ordered_data_compaction_min_segment_size`
-* 类型: int32
-* 描述: 在有序数据compaction中, 满足要求的最小segment大小,单位是m字节。
-* 默认值: 10485760
+* 类型:int32
+* 描述:在有序数据 compaction 中,满足要求的最小 segment 大小,单位是 m 字节。
+* 默认值:10485760
#### `max_base_compaction_threads`
* 类型:int32
-* 描述:Base Compaction线程池中线程数量的最大值。
+* 描述:Base Compaction 线程池中线程数量的最大值。
* 默认值:4
#### `generate_compaction_tasks_interval_ms`
-* 描述:生成compaction作业的最小间隔时间
-* 默认值:10 (ms)
+* 描述:生成 compaction 作业的最小间隔时间
+* 默认值:10(ms)
#### `base_compaction_min_rowset_num`
-* 描述:BaseCompaction触发条件之一:Cumulative文件数目要达到的限制,达到这个限制之后会触发BaseCompaction
+* 描述:BaseCompaction 触发条件之一:Cumulative 文件数目要达到的限制,达到这个限制之后会触发 BaseCompaction
* 默认值:5
#### `base_compaction_min_data_ratio`
-* 描述:BaseCompaction触发条件之一:Cumulative文件大小达到Base文件的比例。
-* 默认值:0.3 (30%)
+* 描述:BaseCompaction 触发条件之一:Cumulative 文件大小达到 Base 文件的比例。
+* 默认值:0.3(30%)
#### `total_permits_for_compaction_score`
* 类型:int64
-* 描述:被所有的compaction任务所能持有的 "permits" 上限,用来限制compaction占用的内存。
+* 描述:被所有的 compaction 任务所能持有的 "permits" 上限,用来限制 compaction 占用的内存。
* 默认值:10000
* 可动态修改:是
#### `compaction_promotion_size_mbytes`
* 类型:int64
-* 描述:cumulative compaction的输出rowset总磁盘大小超过了此配置大小,该rowset将用于base compaction。单位是m字节。
- - 一般情况下,配置在2G以内,为了防止cumulative compaction时间过长,导致版本积压。
+* 描述:cumulative compaction 的输出 rowset 总磁盘大小超过了此配置大小,该 rowset 将用于 base compaction。单位是 m 字节。
+ - 一般情况下,配置在 2G 以内,为了防止 cumulative compaction 时间过长,导致版本积压。
* 默认值:1024
#### `compaction_promotion_ratio`
* 类型:double
-* 描述:cumulative compaction的输出rowset总磁盘大小超过base版本rowset的配置比例时,该rowset将用于base compaction。
- - 一般情况下,建议配置不要高于0.1,低于0.02。
+* 描述:cumulative compaction 的输出 rowset 总磁盘大小超过 base 版本 rowset 的配置比例时,该 rowset 将用于 base compaction。
+ - 一般情况下,建议配置不要高于 0.1,低于 0.02。
* 默认值:0.05
#### `compaction_promotion_min_size_mbytes`
* 类型:int64
-* 描述:Cumulative compaction的输出rowset总磁盘大小低于此配置大小,该rowset将不进行base compaction,仍然处于cumulative compaction流程中。单位是m字节。
- - 一般情况下,配置在512m以内,配置过大会导致base版本早期的大小过小,一直不进行base compaction。
+* 描述:Cumulative compaction 的输出 rowset 总磁盘大小低于此配置大小,该 rowset 将不进行 base compaction,仍然处于 cumulative compaction 流程中。单位是 m 字节。
+ - 一般情况下,配置在 512m 以内,配置过大会导致 base 版本早期的大小过小,一直不进行 base compaction。
* 默认值:64
#### `compaction_min_size_mbytes`
* 类型:int64
-* 描述:cumulative compaction进行合并时,选出的要进行合并的rowset的总磁盘大小大于此配置时,才按级别策略划分合并。小于这个配置时,直接执行合并。单位是m字节。
- - 一般情况下,配置在128m以内,配置过大会导致cumulative compaction写放大较多。
+* 描述:cumulative compaction 进行合并时,选出的要进行合并的 rowset 的总磁盘大小大于此配置时,才按级别策略划分合并。小于这个配置时,直接执行合并。单位是 m 字节。
+ - 一般情况下,配置在 128m 以内,配置过大会导致 cumulative compaction 写放大较多。
* 默认值:64
#### `default_rowset_type`
* 类型:string
-* 描述:标识BE默认选择的存储格式,可配置的参数为:"**ALPHA**", "**BETA**"。主要起以下两个作用
- - 当建表的storage_format设置为Default时,通过该配置来选取BE的存储格式。
- - 进行Compaction时选择BE的存储格式
+* 描述:标识 BE 默认选择的存储格式,可配置的参数为:"**ALPHA**", "**BETA**"。主要起以下两个作用
+ - 当建表的 storage_format 设置为 Default 时,通过该配置来选取 BE 的存储格式。
+ - 进行 Compaction 时选择 BE 的存储格式
* 默认值:BETA
#### `cumulative_compaction_min_deltas`
-* 描述:cumulative compaction策略:最小增量文件的数量
+* 描述:cumulative compaction 策略:最小增量文件的数量
* 默认值:5
#### `cumulative_compaction_max_deltas`
-* 描述:cumulative compaction策略:最大增量文件的数量
+* 描述:cumulative compaction 策略:最大增量文件的数量
* 默认值:1000
#### `base_compaction_trace_threshold`
* 类型:int32
-* 描述:打印base compaction的trace信息的阈值,单位秒
+* 描述:打印 base compaction 的 trace 信息的阈值,单位秒
* 默认值:10
-base compaction是一个耗时较长的后台操作,为了跟踪其运行信息,可以调整这个阈值参数来控制trace日志的打印。打印信息如下:
+base compaction 是一个耗时较长的后台操作,为了跟踪其运行信息,可以调整这个阈值参数来控制 trace 日志的打印。打印信息如下:
```
W0610 11:26:33.804431 56452 storage_engine.cpp:552] execute base compaction cost 0.00319222
@@ -607,45 +607,45 @@ BaseCompaction:546859:
#### `cumulative_compaction_trace_threshold`
* 类型:int32
-* 描述:打印cumulative compaction的trace信息的阈值,单位秒
- - 与base_compaction_trace_threshold类似。
+* 描述:打印 cumulative compaction 的 trace 信息的阈值,单位秒
+ - 与 base_compaction_trace_threshold 类似。
* 默认值:2
#### `compaction_task_num_per_disk`
* 类型:int32
-* 描述:每个磁盘(HDD)可以并发执行的compaction任务数量。
+* 描述:每个磁盘(HDD)可以并发执行的 compaction 任务数量。
* 默认值:4
#### `compaction_task_num_per_fast_disk`
* 类型:int32
-* 描述:每个高速磁盘(SSD)可以并发执行的compaction任务数量。
+* 描述:每个高速磁盘(SSD)可以并发执行的 compaction 任务数量。
* 默认值:8
#### `cumulative_compaction_rounds_for_each_base_compaction_round`
* 类型:int32
-* 描述:Compaction任务的生产者每次连续生产多少轮cumulative compaction任务后生产一轮base compaction。
+* 描述:Compaction 任务的生产者每次连续生产多少轮 cumulative compaction 任务后生产一轮 base compaction。
* 默认值:9
#### `cumulative_compaction_policy`
* 类型:string
-* 描述:配置 cumulative compaction 阶段的合并策略,目前实现了两种合并策略,num_based和size_based
- - 详细说明,ordinary,是最初版本的cumulative compaction合并策略,做一次cumulative compaction之后直接base compaction流程。size_based,通用策略是ordinary策略的优化版本,仅当rowset的磁盘体积在相同数量级时才进行版本合并。合并之后满足条件的rowset进行晋升到base compaction阶段。能够做到在大量小批量导入的情况下:降低base compact的写入放大率,并在读取放大率和空间放大率之间进行权衡,同时减少了文件版本的数据。
+* 描述:配置 cumulative compaction 阶段的合并策略,目前实现了两种合并策略,num_based 和 size_based
+ - 详细说明,ordinary,是最初版本的 cumulative compaction 合并策略,做一次 cumulative compaction 之后直接 base compaction 流程。size_based,通用策略是 ordinary 策略的优化版本,仅当 rowset 的磁盘体积在相同数量级时才进行版本合并。合并之后满足条件的 rowset 进行晋升到 base compaction 阶段。能够做到在大量小批量导入的情况下:降低 base compact 的写入放大率,并在读取放大率和空间放大率之间进行权衡,同时减少了文件版本的数据。
* 默认值:size_based
#### `max_cumu_compaction_threads`
* 类型:int32
-* 描述:Cumulative Compaction线程池中线程数量的最大值。
+* 描述:Cumulative Compaction 线程池中线程数量的最大值。
* 默认值:10
#### `enable_segcompaction`
* 类型:bool
-* 描述:在导入时进行 segment compaction 来减少 segment 数量, 以避免出现写入时的 -238 错误
+* 描述:在导入时进行 segment compaction 来减少 segment 数量,以避免出现写入时的 -238 错误
* 默认值:true
#### `segcompaction_batch_size`
@@ -662,52 +662,52 @@ BaseCompaction:546859:
#### `segcompaction_batch_size`
-* 类型: int32
-* 描述: 单个 segment compaction 任务中的最大原始 segment 数量。
-* 默认值: 10
+* 类型:int32
+* 描述:单个 segment compaction 任务中的最大原始 segment 数量。
+* 默认值:10
#### `segcompaction_candidate_max_rows`
-* 类型: int32
-* 描述: segment compaction 任务中允许的单个原始 segment 行数,过大的 segment 将被跳过。
-* 默认值: 1048576
+* 类型:int32
+* 描述:segment compaction 任务中允许的单个原始 segment 行数,过大的 segment 将被跳过。
+* 默认值:1048576
#### `segcompaction_candidate_max_bytes`
-* 类型: int64
-* 描述: segment compaction 任务中允许的单个原始 segment 大小(字节),过大的 segment 将被跳过。
-* 默认值: 104857600
+* 类型:int64
+* 描述:segment compaction 任务中允许的单个原始 segment 大小(字节),过大的 segment 将被跳过。
+* 默认值:104857600
#### `segcompaction_task_max_rows`
-* 类型: int32
-* 描述: 单个 segment compaction 任务中允许的原始 segment 总行数。
-* 默认值: 1572864
+* 类型:int32
+* 描述:单个 segment compaction 任务中允许的原始 segment 总行数。
+* 默认值:1572864
#### `segcompaction_task_max_bytes`
-* 类型: int64
-* 描述: 单个 segment compaction 任务中允许的原始 segment 总大小(字节)。
-* 默认值: 157286400
+* 类型:int64
+* 描述:单个 segment compaction 任务中允许的原始 segment 总大小(字节)。
+* 默认值:157286400
#### `segcompaction_num_threads`
-* 类型: int32
-* 描述: segment compaction 线程池大小。
-* 默认值: 5
+* 类型:int32
+* 描述:segment compaction 线程池大小。
+* 默认值:5
#### `disable_compaction_trace_log`
-* 类型: bool
-* 描述: 关闭compaction的trace日志
- - 如果设置为true,`cumulative_compaction_trace_threshold` 和 `base_compaction_trace_threshold` 将不起作用。并且trace日志将关闭。
-* 默认值: true
+* 类型:bool
+* 描述:关闭 compaction 的 trace 日志
+ - 如果设置为 true,`cumulative_compaction_trace_threshold` 和 `base_compaction_trace_threshold` 将不起作用。并且 trace 日志将关闭。
+* 默认值:true
#### `pick_rowset_to_compact_interval_sec`
-* 类型: int64
-* 描述: 选取 rowset 去合并的时间间隔,单位为秒
-* 默认值: 86400
+* 类型:int64
+* 描述:选取 rowset 去合并的时间间隔,单位为秒
+* 默认值:86400
#### `max_single_replica_compaction_threads`
@@ -725,62 +725,62 @@ BaseCompaction:546859:
#### `enable_stream_load_record`
-* 类型: bool
-* 描述: 是否开启 stream load 操作记录,默认是不启用
-* 默认值: false
+* 类型:bool
+* 描述:是否开启 stream load 操作记录,默认是不启用
+* 默认值:false
#### `load_data_reserve_hours`
-* 描述: 用于mini load。mini load数据文件将在此时间后被删除
-* 默认值: 4(h)
+* 描述:用于 mini load。mini load 数据文件将在此时间后被删除
+* 默认值:4(h)
#### `push_worker_count_high_priority`
-* 描述: 导入线程数,用于处理HIGH优先级任务
-* 默认值: 3
+* 描述:导入线程数,用于处理 HIGH 优先级任务
+* 默认值:3
#### `push_worker_count_normal_priority`
-* 描述: 导入线程数,用于处理NORMAL优先级任务
-* 默认值: 3
+* 描述:导入线程数,用于处理 NORMAL 优先级任务
+* 默认值:3
#### `enable_single_replica_load`
-* 描述: 是否启动单副本数据导入功能
-* 默认值: true
+* 描述:是否启动单副本数据导入功能
+* 默认值:true
#### `load_error_log_reserve_hours`
-* 描述: load错误日志将在此时间后删除
-* 默认值: 48(h)
+* 描述:load 错误日志将在此时间后删除
+* 默认值:48(h)
#### `load_process_max_memory_limit_percent`
-* 描述: 单节点上所有的导入线程占据的内存上限比例
- - 将这些默认值设置得很大,因为我们不想在用户升级 Doris 时影响负载性能。 如有必要,用户应正确设置这些配置。
-* 默认值: 50 (%)
+* 描述:单节点上所有的导入线程占据的内存上限比例
+ - 将这些默认值设置得很大,因为我们不想在用户升级 Doris 时影响负载性能。如有必要,用户应正确设置这些配置。
+* 默认值:50(%)
#### `load_process_soft_mem_limit_percent`
-* 描述: soft limit是指站单节点导入内存上限的比例。例如所有导入任务导入的内存上限是20GB,则soft limit默认为该值的50%,即10GB。导入内存占用超过soft limit时,会挑选占用内存最大的作业进行下刷以提前释放内存空间。
-* 默认值: 50(%)
+* 描述:soft limit 是指站单节点导入内存上限的比例。例如所有导入任务导入的内存上限是 20GB,则 soft limit 默认为该值的 50%,即 10GB。导入内存占用超过 soft limit 时,会挑选占用内存最大的作业进行下刷以提前释放内存空间。
+* 默认值:50(%)
#### `routine_load_thread_pool_size`
-* 描述: routine load任务的线程池大小。 这应该大于 FE 配置 'max_concurrent_task_num_per_be'
-* 默认值: 10
+* 描述:routine load 任务的线程池大小。这应该大于 FE 配置 'max_concurrent_task_num_per_be'
+* 默认值:10
#### `slave_replica_writer_rpc_timeout_sec`
-* 类型: int32
-* 描述: 单副本数据导入功能中,Master副本和Slave副本之间通信的RPC超时时间。
-* 默认值: 60
+* 类型:int32
+* 描述:单副本数据导入功能中,Master 副本和 Slave 副本之间通信的 RPC 超时时间。
+* 默认值:60
#### `max_segment_num_per_rowset`
-* 类型: int32
-* 描述: 用于限制导入时,新产生的rowset中的segment数量。如果超过阈值,导入会失败并报错 -238。过多的 segment 会导致compaction占用大量内存引发 OOM 错误。
-* 默认值: 200
+* 类型:int32
+* 描述:用于限制导入时,新产生的 rowset 中的 segment 数量。如果超过阈值,导入会失败并报错 -238。过多的 segment 会导致 compaction 占用大量内存引发 OOM 错误。
+* 默认值:200
#### `high_priority_flush_thread_num_per_store`
@@ -801,9 +801,9 @@ BaseCompaction:546859:
* 默认值:200
#### `single_replica_load_download_num_workers`
-* 类型: int32
-* 描述: 单副本数据导入功能中,Slave副本通过HTTP从Master副本下载数据文件的工作线程数。导入并发增大时,可以适当调大该参数来保证Slave副本及时同步Master副本数据。必要时也应相应地调大`webserver_num_workers`来提高IO效率。
-* 默认值: 64
+* 类型:int32
+* 描述:单副本数据导入功能中,Slave 副本通过 HTTP 从 Master 副本下载数据文件的工作线程数。导入并发增大时,可以适当调大该参数来保证 Slave 副本及时同步 Master 副本数据。必要时也应相应地调大`webserver_num_workers`来提高 IO 效率。
+* 默认值:64
#### `load_task_high_priority_threshold_second`
@@ -814,31 +814,31 @@ BaseCompaction:546859:
#### `min_load_rpc_timeout_ms`
* 类型:int32
-* 描述:load 作业中各个rpc 的最小超时时间。
+* 描述:load 作业中各个 rpc 的最小超时时间。
* 默认:20
#### `kafka_api_version_request`
* 类型:bool
-* 描述:如果依赖的 kafka 版本低于0.10.0.0, 该值应该被设置为 false。
+* 描述:如果依赖的 kafka 版本低于 0.10.0.0, 该值应该被设置为 false。
* 默认:true
#### `kafka_broker_version_fallback`
-* 描述:如果依赖的 kafka 版本低于0.10.0.0, 当 kafka_api_version_request 值为 false 的时候,将使用回退版本 kafka_broker_version_fallback 设置的值,有效值为:0.9.0.x、0.8.x.y。
+* 描述:如果依赖的 kafka 版本低于 0.10.0.0, 当 kafka_api_version_request 值为 false 的时候,将使用回退版本 kafka_broker_version_fallback 设置的值,有效值为:0.9.0.x、0.8.x.y。
* 默认:0.10.0
#### `max_consumer_num_per_group`
-* 描述:一个数据消费者组中的最大消费者数量,用于routine load。
+* 描述:一个数据消费者组中的最大消费者数量,用于 routine load。
* 默认:3
#### `streaming_load_max_mb`
* 类型:int64
* 描述:用于限制数据格式为 csv 的一次 Stream load 导入中,允许的最大数据量。
- - Stream Load 一般适用于导入几个GB以内的数据,不适合导入过大的数据。
-* 默认值: 10240 (MB)
+ - Stream Load 一般适用于导入几个 GB 以内的数据,不适合导入过大的数据。
+* 默认值:10240(MB)
* 可动态修改:是
#### `streaming_load_json_max_mb`
@@ -846,7 +846,7 @@ BaseCompaction:546859:
* 类型:int64
* 描述:用于限制数据格式为 json 的一次 Stream load 导入中,允许的最大数据量。单位 MB。
- 一些数据格式,如 JSON,无法进行拆分处理,必须读取全部数据到内存后才能开始解析,因此,这个值用于限制此类格式数据单次导入最大数据量。
-* 默认值: 100
+* 默认值:100
* 可动态修改:是
### 线程
@@ -869,7 +869,7 @@ BaseCompaction:546859:
#### `be_service_threads`
* 类型:int32
-* 描述:BE 上 thrift server service的执行线程数,代表可以用于执行FE请求的线程数。
+* 描述:BE 上 thrift server service 的执行线程数,代表可以用于执行 FE 请求的线程数。
* 默认值:64
#### `download_worker_count`
@@ -879,17 +879,17 @@ BaseCompaction:546859:
#### `drop_tablet_worker_count`
-* 描述:删除tablet的线程数
+* 描述:删除 tablet 的线程数
* 默认值:3
#### `flush_thread_num_per_store`
-* 描述:每个store用于刷新内存表的线程数
+* 描述:每个 store 用于刷新内存表的线程数
* 默认值:2
#### `num_threads_per_core`
-* 描述:控制每个内核运行工作的线程数。 通常选择 2 倍或 3 倍的内核数量。 这使核心保持忙碌而不会导致过度抖动
+* 描述:控制每个内核运行工作的线程数。通常选择 2 倍或 3 倍的内核数量。这使核心保持忙碌而不会导致过度抖动
* 默认值:3
#### `num_threads_per_disk`
@@ -899,7 +899,7 @@ BaseCompaction:546859:
#### `number_slave_replica_download_threads`
-* 描述:每个BE节点上slave副本同步Master副本数据的线程数,用于单副本数据导入功能。
+* 描述:每个 BE 节点上 slave 副本同步 Master 副本数据的线程数,用于单副本数据导入功能。
* 默认值:64
#### `publish_version_worker_count`
@@ -914,19 +914,19 @@ BaseCompaction:546859:
#### `webserver_num_workers`
-* 描述:webserver默认工作线程数
+* 描述:webserver 默认工作线程数
* 默认值:48
#### `send_batch_thread_pool_thread_num`
* 类型:int32
-* 描述:SendBatch线程池线程数目。在NodeChannel的发送数据任务之中,每一个NodeChannel的SendBatch操作会作为一个线程task提交到线程池之中等待被调度,该参数决定了SendBatch线程池的大小。
+* 描述:SendBatch 线程池线程数目。在 NodeChannel 的发送数据任务之中,每一个 NodeChannel 的 SendBatch 操作会作为一个线程 task 提交到线程池之中等待被调度,该参数决定了 SendBatch 线程池的大小。
* 默认值:64
#### `send_batch_thread_pool_queue_size`
* 类型:int32
-* 描述:SendBatch线程池的队列长度。在NodeChannel的发送数据任务之中,每一个NodeChannel的SendBatch操作会作为一个线程task提交到线程池之中等待被调度,而提交的任务数目超过线程池队列的长度之后,后续提交的任务将阻塞直到队列之中有新的空缺。
+* 描述:SendBatch 线程池的队列长度。在 NodeChannel 的发送数据任务之中,每一个 NodeChannel 的 SendBatch 操作会作为一个线程 task 提交到线程池之中等待被调度,而提交的任务数目超过线程池队列的长度之后,后续提交的任务将阻塞直到队列之中有新的空缺。
* 默认值:102400
#### `make_snapshot_worker_count`
@@ -949,30 +949,30 @@ BaseCompaction:546859:
#### `buffer_pool_clean_pages_limit`
-* 描述:清理可能被缓冲池保存的Page
+* 描述:清理可能被缓冲池保存的 Page
* 默认值:50%
#### `buffer_pool_limit`
* 类型:string
-* 描述:buffer pool之中最大的可分配内存
- - BE缓存池最大的内存可用量,buffer pool是BE新的内存管理结构,通过buffer page来进行内存管理,并能够实现数据的落盘。并发的所有查询的内存申请都会通过buffer pool来申请。当前buffer pool仅作用在**AggregationNode**与**ExchangeNode**。
+* 描述:buffer pool 之中最大的可分配内存
+ - BE 缓存池最大的内存可用量,buffer pool 是 BE 新的内存管理结构,通过 buffer page 来进行内存管理,并能够实现数据的落盘。并发的所有查询的内存申请都会通过 buffer pool 来申请。当前 buffer pool 仅作用在**AggregationNode**与**ExchangeNode**。
* 默认值:20%
#### `chunk_reserved_bytes_limit`
-* 描述:Chunk Allocator的reserved bytes限制,通常被设置为 mem_limit 的百分比。默认单位字节,值必须是2的倍数,且必须大于0,如果大于物理内存,将被设置为物理内存大小。增加这个变量可以提高性能,但是会获得更多其他模块无法使用的空闲内存。
+* 描述:Chunk Allocator 的 reserved bytes 限制,通常被设置为 mem_limit 的百分比。默认单位字节,值必须是 2 的倍数,且必须大于 0,如果大于物理内存,将被设置为物理内存大小。增加这个变量可以提高性能,但是会获得更多其他模块无法使用的空闲内存。
* 默认值:20%
#### `madvise_huge_pages`
* 类型:bool
-* 描述:是否使用linux内存大页
+* 描述:是否使用 linux 内存大页
* 默认值:false
#### `max_memory_sink_batch_count`
-* 描述:最大外部扫描缓存批次计数,表示缓存max_memory_cache_batch_count * batch_size row,默认为20,batch_size的默认值为1024,表示将缓存20 * 1024行
+* 描述:最大外部扫描缓存批次计数,表示缓存 max_memory_cache_batch_count * batch_size row,默认为 20,batch_size 的默认值为 1024,表示将缓存 20 * 1024 行
* 默认值:20
#### `memory_max_alignment`
@@ -982,119 +982,119 @@ BaseCompaction:546859:
#### `mmap_buffers`
-* 描述:是否使用mmap分配内存
+* 描述:是否使用 mmap 分配内存
* 默认值:false
#### `memtable_mem_tracker_refresh_interval_ms`
-* 描述:memtable主动下刷时刷新内存统计的周期(毫秒)
+* 描述:memtable 主动下刷时刷新内存统计的周期(毫秒)
* 默认值:100
#### `download_cache_buffer_size`
-* 类型: int64
-* 描述: 下载缓存时用于接收数据的buffer的大小。
-* 默认值: 10485760
+* 类型:int64
+* 描述:下载缓存时用于接收数据的 buffer 的大小。
+* 默认值:10485760
#### `zone_map_row_num_threshold`
-* 类型: int32
-* 描述: 如果一个page中的行数小于这个值就不会创建zonemap,用来减少数据膨胀
-* 默认值: 20
+* 类型:int32
+* 描述:如果一个 page 中的行数小于这个值就不会创建 zonemap,用来减少数据膨胀
+* 默认值:20
#### `enable_tcmalloc_hook`
* 类型:bool
-* 描述:是否Hook TCmalloc new/delete,目前在Hook中统计thread local MemTracker。
+* 描述:是否 Hook TCmalloc new/delete,目前在Hook中统计thread local MemTracker。
* 默认值:true
#### `memory_mode`
* 类型:string
-* 描述:控制tcmalloc的回收。如果配置为performance,内存使用超过mem_limit的90%时,doris会释放tcmalloc cache中的内存,如果配置为compact,内存使用超过mem_limit的50%时,doris会释放tcmalloc cache中的内存。
+* 描述:控制 tcmalloc 的回收。如果配置为 performance,内存使用超过 mem_limit 的 90% 时,doris 会释放 tcmalloc cache 中的内存,如果配置为 compact,内存使用超过 mem_limit 的 50% 时,doris 会释放 tcmalloc cache 中的内存。
* 默认值:performance
#### `max_sys_mem_available_low_water_mark_bytes`
* 类型:int64
-* 描述:系统`/proc/meminfo/MemAvailable` 的最大低水位线,单位字节,默认1.6G,实际低水位线=min(1.6G,MemTotal * 10%),避免在大于16G的机器上浪费过多内存。调大max,在大于16G内存的机器上,将为Full GC预留更多的内存buffer;反之调小max,将尽可能充分使用内存。
+* 描述:系统`/proc/meminfo/MemAvailable` 的最大低水位线,单位字节,默认 1.6G,实际低水位线=min(1.6G,MemTotal * 10%),避免在大于 16G 的机器上浪费过多内存。调大 max,在大于 16G 内存的机器上,将为 Full GC 预留更多的内存 buffer;反之调小 max,将尽可能充分使用内存。
* 默认值:1717986918
#### `memory_limitation_per_thread_for_schema_change_bytes`
-* 描述:单个schema change任务允许占用的最大内存
+* 描述:单个 schema change 任务允许占用的最大内存
* 默认值:2147483648 (2GB)
#### `mem_tracker_consume_min_size_bytes`
-* 类型: int32
-* 描述: TCMalloc Hook consume/release MemTracker时的最小长度,小于该值的consume size会持续累加,避免频繁调用MemTracker的consume/release,减小该值会增加consume/release的频率,增大该值会导致MemTracker统计不准,理论上一个MemTracker的统计值与真实值相差 = (mem_tracker_consume_min_size_bytes * 这个MemTracker所在的BE线程数)。
-* 默认值: 1048576
+* 类型:int32
+* 描述:TCMalloc Hook consume/release MemTracker 时的最小长度,小于该值的 consume size 会持续累加,避免频繁调用 MemTracker 的 consume/release,减小该值会增加 consume/release 的频率,增大该值会导致 MemTracker 统计不准,理论上一个 MemTracker 的统计值与真实值相差 = (mem_tracker_consume_min_size_bytes * 这个 MemTracker 所在的 BE 线程数)。
+* 默认值:1048576
#### `cache_clean_interval`
-* 描述: 文件句柄缓存清理的间隔,用于清理长期不用的文件句柄。同时也是Segment Cache的清理间隔时间。
-* 默认值: 1800 (s)
+* 描述:文件句柄缓存清理的间隔,用于清理长期不用的文件句柄。同时也是 Segment Cache 的清理间隔时间。
+* 默认值:1800 (s)
#### `min_buffer_size`
-* 描述: 最小读取缓冲区大小
-* 默认值: 1024 (byte)
+* 描述:最小读取缓冲区大小
+* 默认值:1024 (byte)
#### `write_buffer_size`
-* 描述: 刷写前缓冲区的大小
+* 描述:刷写前缓冲区的大小
- 导入数据在 BE 上会先写入到一个内存块,当这个内存块达到阈值后才会写回磁盘。默认大小是 100MB。过小的阈值可能导致 BE 上存在大量的小文件。可以适当提高这个阈值减少文件数量。但过大的阈值可能导致 RPC 超时
-* 默认值: 104857600
+* 默认值:104857600
#### `remote_storage_read_buffer_mb`
-* 类型: int32
-* 描述: 读取hdfs或者对象存储上的文件时,使用的缓存大小。
+* 类型:int32
+* 描述:读取 hdfs 或者对象存储上的文件时,使用的缓存大小。
- 增大这个值,可以减少远端数据读取的调用次数,但会增加内存开销。
-* 默认值: 16MB
+* 默认值:16MB
#### `file_cache_type`
* 类型:string
-* 描述:缓存文件的类型。`whole_file_cache`:将segment文件整个下载,`sub_file_cache`:将segment文件按大小切分成多个文件。设置为"",则不缓存文件,需要缓存的时候请设置此参数。
+* 描述:缓存文件的类型。`whole_file_cache`:将 segment 文件整个下载,`sub_file_cache`:将 segment 文件按大小切分成多个文件。设置为"",则不缓存文件,需要缓存的时候请设置此参数。
* 默认值:""
#### `file_cache_alive_time_sec`
* 类型:int64
* 描述:缓存文件的保存时间,单位:秒
-* 默认值:604800(1个星期)
+* 默认值:604800(1 个星期)
#### `file_cache_max_size_per_disk`
* 类型:int64
-* 描述:缓存占用磁盘大小,一旦超过这个设置,会删除最久未访问的缓存,为0则不限制大小。单位字节
+* 描述:缓存占用磁盘大小,一旦超过这个设置,会删除最久未访问的缓存,为 0 则不限制大小。单位字节
* 默认值:0
#### `max_sub_cache_file_size`
* 类型:int64
-* 描述:缓存文件使用sub_file_cache时,切分文件的最大大小,单位B
+* 描述:缓存文件使用 sub_file_cache 时,切分文件的最大大小,单位 B
* 默认值:104857600(100MB)
#### `download_cache_thread_pool_thread_num`
-* 类型: int32
-* 描述: DownloadCache线程池线程数目. 在FileCache的缓存下载任务之中, 缓存下载操作会作为一个线程task提交到线程池之中等待被调度,该参数决定了DownloadCache线程池的大小。
+* 类型:int32
+* 描述:DownloadCache 线程池线程数目。在 FileCache 的缓存下载任务之中,缓存下载操作会作为一个线程 task 提交到线程池之中等待被调度,该参数决定了 DownloadCache 线程池的大小。
* 默认值:48
#### `download_cache_thread_pool_queue_size`
* Type: int32
-* 描述: DownloadCache线程池线程数目. 在FileCache的缓存下载任务之中, 缓存下载操作会作为一个线程task提交到线程池之中等待被调度,而提交的任务数目超过线程池队列的长度之后,后续提交的任务将阻塞直到队列之中有新的空缺。
+* 描述:DownloadCache 线程池线程数目。在 FileCache 的缓存下载任务之中,缓存下载操作会作为一个线程 task 提交到线程池之中等待被调度,而提交的任务数目超过线程池队列的长度之后,后续提交的任务将阻塞直到队列之中有新的空缺。
* 默认值:102400
#### `generate_cache_cleaner_task_interval_sec`
* 类型:int64
* 描述:缓存文件的清理间隔,单位:秒
-* 默认值:43200(12小时)
+* 默认值:43200(12 小时)
#### `path_gc_check`
@@ -1121,7 +1121,7 @@ BaseCompaction:546859:
#### `scan_context_gc_interval_min`
-* 描述:此配置用于上下文gc线程调度周期
+* 描述:此配置用于上下文 gc 线程调度周期
* 默认值:5 (分钟)
### 存储
@@ -1129,19 +1129,19 @@ BaseCompaction:546859:
#### `default_num_rows_per_column_file_block`
* 类型:int32
-* 描述:配置单个RowBlock之中包含多少行的数据。
+* 描述:配置单个 RowBlock 之中包含多少行的数据。
* 默认值:1024
#### `disable_storage_page_cache`
* 类型:bool
-* 描述:是否进行使用page cache进行index的缓存,该配置仅在BETA存储格式时生效
+* 描述:是否进行使用 page cache 进行 index 的缓存,该配置仅在 BETA 存储格式时生效
* 默认值:false
#### `disk_stat_monitor_interval`
* 描述:磁盘状态检查时间间隔
-* 默认值:5 (s)
+* 默认值:5(s)
#### `max_free_io_buffers`
@@ -1156,12 +1156,12 @@ BaseCompaction:546859:
#### `max_percentage_of_error_disk`
* 类型:int32
-* 描述:存储引擎允许存在损坏硬盘的百分比,损坏硬盘超过改比例后,BE将会自动退出。
+* 描述:存储引擎允许存在损坏硬盘的百分比,损坏硬盘超过改比例后,BE 将会自动退出。
* 默认值:0
#### `read_size`
-* 描述:读取大小是发送到 os 的读取大小。 在延迟和整个过程之间进行权衡,试图让磁盘保持忙碌但不引入寻道。 对于 8 MB 读取,随机 io 和顺序 io 的性能相似
+* 描述:读取大小是发送到 os 的读取大小。在延迟和整个过程之间进行权衡,试图让磁盘保持忙碌但不引入寻道。对于 8 MB 读取,随机 io 和顺序 io 的性能相似
* 默认值:8388608
#### `min_garbage_sweep_interval`
@@ -1171,7 +1171,7 @@ BaseCompaction:546859:
#### `pprof_profile_dir`
-* 描述:pprof profile保存目录
+* 描述:pprof profile 保存目录
* 默认值:${DORIS_HOME}/log
#### `small_file_dir`
@@ -1181,19 +1181,19 @@ BaseCompaction:546859:
#### `user_function_dir`
-* 描述:udf函数目录
+* 描述:udf 函数目录
* 默认值:${DORIS_HOME}/lib/udf
#### `storage_flood_stage_left_capacity_bytes`
-* 描述:数据目录应该剩下的最小存储空间,默认1G
+* 描述:数据目录应该剩下的最小存储空间,默认 1G
* 默认值:1073741824
#### `storage_flood_stage_usage_percent`
-* 描述:storage_flood_stage_usage_percent和storage_flood_stage_left_capacity_bytes两个配置限制了数据目录的磁盘容量的最大使用。 如果这两个阈值都达到,则无法将更多数据写入该数据目录。 数据目录的最大已用容量百分比
-* 默认值:90 (90%)
+* 描述:storage_flood_stage_usage_percent 和 storage_flood_stage_left_capacity_bytes 两个配置限制了数据目录的磁盘容量的最大使用。如果这两个阈值都达到,则无法将更多数据写入该数据目录。数据目录的最大已用容量百分比
+* 默认值:90(90%)
#### `storage_medium_migrate_count`
@@ -1207,7 +1207,7 @@ BaseCompaction:546859:
#### `storage_page_cache_shard_size`
-* 描述:StoragePageCache的分片大小,值为 2^n (n=0,1,2,...)。建议设置为接近BE CPU核数的值,可减少StoragePageCache的锁竞争。
+* 描述:StoragePageCache 的分片大小,值为 2^n (n=0,1,2,...)。建议设置为接近 BE CPU 核数的值,可减少 StoragePageCache 的锁竞争。
* 默认值:16
#### `index_page_cache_percentage`
@@ -1218,7 +1218,7 @@ BaseCompaction:546859:
#### `segment_cache_capacity`
* Type: int32
-* Description: segment元数据缓存(以rowset id为key)的最大rowset个数. -1代表向后兼容取值为fd_number * 2/5
+* Description: segment 元数据缓存(以 rowset id 为 key)的最大 rowset 个数。-1 代表向后兼容取值为 fd_number * 2/5
* Default value: -1
#### `storage_strict_check_incompatible_old_format`
@@ -1226,12 +1226,12 @@ BaseCompaction:546859:
* 类型:bool
* 描述:用来检查不兼容的旧版本格式时是否使用严格的验证方式
- 配置用来检查不兼容的旧版本格式时是否使用严格的验证方式,当含有旧版本的 hdr 格式时,使用严谨的方式时,程序会打出 fatal log 并且退出运行;否则,程序仅打印 warn log.
-* 默认值: true
+* 默认值:true
* 可动态修改:否
#### `sync_tablet_meta`
-* 描述:存储引擎是否开sync保留到磁盘上
+* 描述:存储引擎是否开 sync 保留到磁盘上
* 默认值:false
#### `pending_data_expire_time_sec`
@@ -1242,19 +1242,19 @@ BaseCompaction:546859:
#### `ignore_rowset_stale_inconsistent_delete`
* 类型:bool
-* 描述:用来决定当删除过期的合并过的rowset后无法构成一致的版本路径时,是否仍要删除。
- - 合并的过期 rowset 版本路径会在半个小时后进行删除。在异常下,删除这些版本会出现构造不出查询一致路径的问题,当配置为false时,程序检查比较严格,程序会直接报错退出。
- 当配置为true时,程序会正常运行,忽略这个错误。一般情况下,忽略这个错误不会对查询造成影响,仅会在fe下发了合并过的版本时出现-230错误。
+* 描述:用来决定当删除过期的合并过的 rowset 后无法构成一致的版本路径时,是否仍要删除。
+ - 合并的过期 rowset 版本路径会在半个小时后进行删除。在异常下,删除这些版本会出现构造不出查询一致路径的问题,当配置为 false 时,程序检查比较严格,程序会直接报错退出。
+ 当配置为 true 时,程序会正常运行,忽略这个错误。一般情况下,忽略这个错误不会对查询造成影响,仅会在 fe 下发了合并过的版本时出现 -230 错误。
* 默认值:false
#### `create_tablet_worker_count`
-* 描述:BE创建tablet的工作线程数
+* 描述:BE 创建 tablet 的工作线程数
* 默认值:3
#### `check_consistency_worker_count`
-* 描述:计算tablet的校验和(checksum)的工作线程数
+* 描述:计算 tablet 的校验和 (checksum) 的工作线程数
* 默认值:1
#### `max_tablet_version_num`
@@ -1265,71 +1265,71 @@ BaseCompaction:546859:
#### `number_tablet_writer_threads`
-* 描述:tablet写线程数
+* 描述:tablet 写线程数
* 默认值:16
#### `tablet_map_shard_size`
-* 描述:tablet_map_lock 分片大小,值为 2^n, n=0,1,2,3,4 ,这是为了更好地管理tablet
+* 描述:tablet_map_lock 分片大小,值为 2^n, n=0,1,2,3,4,这是为了更好地管理 tablet
* 默认值:4
#### `tablet_meta_checkpoint_min_interval_secs`
-* 描述:TabletMeta Checkpoint线程轮询的时间间隔
+* 描述:TabletMeta Checkpoint 线程轮询的时间间隔
* 默认值:600 (s)
#### `tablet_meta_checkpoint_min_new_rowsets_num`
-* 描述:TabletMeta Checkpoint的最小Rowset数目
+* 描述:TabletMeta Checkpoint 的最小 Rowset 数目
* 默认值:10
#### `tablet_stat_cache_update_interval_second`
-* 描述:tablet状态缓存的更新间隔
+* 描述:tablet 状态缓存的更新间隔
* 默认值:300 (s)
#### `tablet_rowset_stale_sweep_time_sec`
* 类型:int64
-* 描述:用来表示清理合并版本的过期时间,当当前时间 now() 减去一个合并的版本路径中rowset最近创建创建时间大于tablet_rowset_stale_sweep_time_sec时,对当前路径进行清理,删除这些合并过的rowset, 单位为s。
- - 当写入过于频繁,可能会引发fe查询不到已经合并过的版本,引发查询-230错误。可以通过调大该参数避免该问题。
+* 描述:用来表示清理合并版本的过期时间,当当前时间 now() 减去一个合并的版本路径中 rowset 最近创建创建时间大于 tablet_rowset_stale_sweep_time_sec 时,对当前路径进行清理,删除这些合并过的 rowset, 单位为 s。
+ - 当写入过于频繁,可能会引发 fe 查询不到已经合并过的版本,引发查询 -230 错误。可以通过调大该参数避免该问题。
* 默认值:300
#### `tablet_writer_open_rpc_timeout_sec`
-* 描述:在远程BE 中打开tablet writer的 rpc 超时。 操作时间短,可设置短超时时间
- - 导入过程中,发送一个 Batch(1024行)的 RPC 超时时间。默认 60 秒。因为该 RPC 可能涉及多个 分片内存块的写盘操作,所以可能会因为写盘导致 RPC 超时,可以适当调整这个超时时间来减少超时错误(如 send batch fail 错误)。同时,如果调大 write_buffer_size 配置,也需要适当调大这个参数
+* 描述:在远程 BE 中打开 tablet writer 的 rpc 超时。操作时间短,可设置短超时时间
+ - 导入过程中,发送一个 Batch(1024 行)的 RPC 超时时间。默认 60 秒。因为该 RPC 可能涉及多个 分片内存块的写盘操作,所以可能会因为写盘导致 RPC 超时,可以适当调整这个超时时间来减少超时错误(如 send batch fail 错误)。同时,如果调大 write_buffer_size 配置,也需要适当调大这个参数
* 默认值:60
#### `tablet_writer_ignore_eovercrowded`
* 类型:bool
-* 描述:写入时可忽略brpc的'[E1011]The server is overcrowded'错误。
- - 当遇到'[E1011]The server is overcrowded'的错误时,可以调整配置项`brpc_socket_max_unwritten_bytes`,但这个配置项不能动态调整。所以可通过设置此项为`true`来临时避免写失败。注意,此配置项只影响写流程,其他的rpc请求依旧会检查是否overcrowded。
+* 描述:写入时可忽略 brpc 的'[E1011]The server is overcrowded'错误。
+ - 当遇到'[E1011]The server is overcrowded'的错误时,可以调整配置项`brpc_socket_max_unwritten_bytes`,但这个配置项不能动态调整。所以可通过设置此项为`true`来临时避免写失败。注意,此配置项只影响写流程,其他的 rpc 请求依旧会检查是否 overcrowded。
* 默认值:false
#### `streaming_load_rpc_max_alive_time_sec`
-* 描述:TabletsChannel 的存活时间。如果此时通道没有收到任何数据, 通道将被删除。
+* 描述:TabletsChannel 的存活时间。如果此时通道没有收到任何数据,通道将被删除。
* 默认值:1200
#### `alter_tablet_worker_count`
-* 描述:进行schema change的线程数
+* 描述:进行 schema change 的线程数
* 默认值:3
### `alter_index_worker_count`
-* 描述:进行index change的线程数
+* 描述:进行 index change 的线程数
* 默认值:3
#### `ignore_load_tablet_failure`
* 类型:bool
-* 描述:用来决定在有tablet 加载失败的情况下是否忽略错误,继续启动be
+* 描述:用来决定在有 tablet 加载失败的情况下是否忽略错误,继续启动 be
* 默认值:false
-BE启动时,会对每个数据目录单独启动一个线程进行 tablet header 元信息的加载。默认配置下,如果某个数据目录有 tablet 加载失败,则启动进程会终止。同时会在 `be.INFO` 日志中看到如下错误信息:
+BE 启动时,会对每个数据目录单独启动一个线程进行 tablet header 元信息的加载。默认配置下,如果某个数据目录有 tablet 加载失败,则启动进程会终止。同时会在 `be.INFO` 日志中看到如下错误信息:
```
load tablets from header failed, failed tablets size: xxx, path=xxx
@@ -1337,7 +1337,7 @@ load tablets from header failed, failed tablets size: xxx, path=xxx
表示该数据目录共有多少 tablet 加载失败。同时,日志中也会有加载失败的 tablet 的具体信息。此时需要人工介入来对错误原因进行排查。排查后,通常有两种方式进行恢复:
-1. tablet 信息不可修复,在确保其他副本正常的情况下,可以通过 `meta_tool` 工具将错误的tablet删除。
+1. tablet 信息不可修复,在确保其他副本正常的情况下,可以通过 `meta_tool` 工具将错误的 tablet 删除。
2. 将 `ignore_load_tablet_failure` 设置为 true,则 BE 会忽略这些错误的 tablet,正常启动。
#### `report_disk_state_interval_seconds`
@@ -1353,12 +1353,12 @@ load tablets from header failed, failed tablets size: xxx, path=xxx
#### `snapshot_expire_time_sec`
* 描述:快照文件清理的间隔
-* 默认值:172800 (48小时)
+* 默认值:172800 (48 小时)
#### `compress_rowbatches`
* 类型:bool
-* 描述:序列化RowBatch时是否使用Snappy压缩算法进行数据压缩
+* 描述:序列化 RowBatch 时是否使用 Snappy 压缩算法进行数据压缩
* 默认值:true
<version since="1.2">
@@ -1376,7 +1376,7 @@ load tablets from header failed, failed tablets size: xxx, path=xxx
#### `sys_log_dir`
* 类型:string
-* 描述:BE日志数据的存储目录
+* 描述:BE 日志数据的存储目录
* 默认值:${DORIS_HOME}/log
#### `sys_log_level`
@@ -1386,7 +1386,7 @@ load tablets from header failed, failed tablets size: xxx, path=xxx
#### `sys_log_roll_mode`
-* 描述:日志拆分的大小,每1G拆分一个日志文件
+* 描述:日志拆分的大小,每 1G 拆分一个日志文件
* 默认值:SIZE-MB-1024
#### `sys_log_roll_num`
@@ -1396,18 +1396,18 @@ load tablets from header failed, failed tablets size: xxx, path=xxx
#### `sys_log_verbose_level`
-* 描述:日志显示的级别,用于控制代码中VLOG开头的日志输出
+* 描述:日志显示的级别,用于控制代码中 VLOG 开头的日志输出
* 默认值:10
#### `sys_log_verbose_modules`
-* 描述:日志打印的模块,写olap就只打印olap模块下的日志
+* 描述:日志打印的模块,写 olap 就只打印 olap 模块下的日志
* 默认值:空
#### `aws_log_level`
-* 类型: int32
-* 描述: AWS SDK 的日志级别
+* 类型:int32
+* 描述:AWS SDK 的日志级别
```
Off = 0,
Fatal = 1,
@@ -1417,123 +1417,123 @@ load tablets from header failed, failed tablets size: xxx, path=xxx
Debug = 5,
Trace = 6
```
-* 默认值: 3
+* 默认值:3
#### `log_buffer_level`
-* 描述: 日志刷盘的策略,默认保持在内存中
-* 默认值: 空
+* 描述:日志刷盘的策略,默认保持在内存中
+* 默认值:空
### 其他
#### `report_tablet_interval_seconds`
-* 描述: 代理向 FE 报告 olap 表的间隔时间
-* 默认值: 60 (s)
+* 描述:代理向 FE 报告 olap 表的间隔时间
+* 默认值:60 (s)
#### `report_task_interval_seconds`
-* 描述: 代理向 FE 报告任务签名的间隔时间
-* 默认值: 10 (s)
+* 描述:代理向 FE 报告任务签名的间隔时间
+* 默认值:10 (s)
#### `periodic_counter_update_period_ms`
-* 描述: 更新速率计数器和采样计数器的周期
-* 默认值: 500 (ms)
+* 描述:更新速率计数器和采样计数器的周期
+* 默认值:500 (ms)
#### `enable_metric_calculator`
-* 描述: 如果设置为 true,metric calculator 将运行,收集BE相关指标信息,如果设置成false将不运行
-* 默认值: true
+* 描述:如果设置为 true,metric calculator 将运行,收集 BE 相关指标信息,如果设置成 false 将不运行
+* 默认值:true
#### `enable_system_metrics`
-* 描述: 用户控制打开和关闭系统指标
-* 默认值: true
+* 描述:用户控制打开和关闭系统指标
+* 默认值:true
#### `enable_token_check`
-* 描述: 用于向前兼容,稍后将被删除
-* 默认值: true
+* 描述:用于向前兼容,稍后将被删除
+* 默认值:true
#### `max_runnings_transactions_per_txn_map`
-* 描述: txn 管理器中每个 txn_partition_map 的最大 txns 数,这是一种自我保护,以避免在管理器中保存过多的 txns
-* 默认值: 2000
+* 描述:txn 管理器中每个 txn_partition_map 的最大 txns 数,这是一种自我保护,以避免在管理器中保存过多的 txns
+* 默认值:2000
#### `max_download_speed_kbps`
-* 描述: 最大下载速度限制
-* 默认值: 50000 (kb/s)
+* 描述:最大下载速度限制
+* 默认值:50000(kb/s)
#### `download_low_speed_time`
-* 描述: 下载时间限制
-* 默认值: 300 (s)
+* 描述:下载时间限制
+* 默认值:300 (s)
#### `download_low_speed_limit_kbps`
-* 描述: 下载最低限速
-* 默认值: 50 (KB/s)
+* 描述:下载最低限速
+* 默认值:50 (KB/s)
#### `doris_cgroups`
-* 描述: 分配给doris的cgroups
-* 默认值: 空
+* 描述:分配给 doris 的 cgroups
+* 默认值:空
#### `priority_queue_remaining_tasks_increased_frequency`
-* 描述: BlockingPriorityQueue中剩余任务的优先级频率增加
+* 描述:BlockingPriorityQueue 中剩余任务的优先级频率增加
* 默认值:512
<version since="1.2">
#### `jdbc_drivers_dir`
-* 描述: 存放 jdbc driver 的默认目录。
-* 默认值: `${DORIS_HOME}/jdbc_drivers`
+* 描述:存放 jdbc driver 的默认目录。
+* 默认值:`${DORIS_HOME}/jdbc_drivers`
#### `enable_parse_multi_dimession_array`
-* 描述: 在动态表中是否解析多维数组,如果是false遇到多维数组则会报错。
-* 默认值: true
+* 描述:在动态表中是否解析多维数组,如果是 false 遇到多维数组则会报错。
+* 默认值:true
#### `enable_simdjson_reader`
-* 描述: 是否在导入json数据时用simdjson来解析。
-* 默认值: true
+* 描述:是否在导入 json 数据时用 simdjson 来解析。
+* 默认值:true
</version>
#### `enable_query_memory_overcommit`
-* 描述: 如果为true,则当内存未超过 exec_mem_limit 时,查询内存将不受限制;当进程内存超过 exec_mem_limit 且大于 2GB 时,查询会被取消。如果为false,则在使用的内存超过 exec_mem_limit 时取消查询。
-* 默认值: true
+* 描述:如果为 true,则当内存未超过 exec_mem_limit 时,查询内存将不受限制;当进程内存超过 exec_mem_limit 且大于 2GB 时,查询会被取消。如果为 false,则在使用的内存超过 exec_mem_limit 时取消查询。
+* 默认值:true
#### `user_files_secure_path`
-* 描述: `local` 表函数查询的文件的存储目录。
-* 默认值: `${DORIS_HOME}`
+* 描述:`local` 表函数查询的文件的存储目录。
+* 默认值:`${DORIS_HOME}`
#### `brpc_streaming_client_batch_bytes`
-* 描述: brpc streaming 客户端发送数据时的攒批大小(字节)
-* 默认值: 262144
+* 描述:brpc streaming 客户端发送数据时的攒批大小(字节)
+* 默认值:262144
#### `grace_shutdown_wait_seconds`
-* 描述: 在云原生的部署模式下,为了节省资源一个BE 可能会被频繁的加入集群或者从集群中移除。 如果在这个BE 上有正在运行的Query,那么这个Query 会失败。 用户可以使用 stop_be.sh --grace 的方式来关闭一个BE 节点,此时BE 会等待当前正在这个BE 上运行的所有查询都结束才会退出。 同时,在这个时间范围内FE 也不会分发新的query 到这个机器上。 如果超过grace_shutdown_wait_seconds这个阈值,那么BE 也会直接退出,防止一些查询长期不退出导致节点没法快速下掉的情况。
-* 默认值: 120
+* 描述:在云原生的部署模式下,为了节省资源一个 BE 可能会被频繁的加入集群或者从集群中移除。如果在这个 BE 上有正在运行的 Query,那么这个 Query 会失败。用户可以使用 stop_be.sh --grace 的方式来关闭一个 BE 节点,此时 BE 会等待当前正在这个 BE 上运行的所有查询都结束才会退出。同时,在这个时间范围内 FE 也不会分发新的 query 到这个机器上。如果超过 grace_shutdown_wait_seconds 这个阈值,那么 BE 也会直接退出,防止一些查询长期不退出导致节点没法快速下掉的情况。
+* 默认值:120
#### `enable_java_support`
-* Description: BE 是否开启使用java-jni,开启后允许 c++ 与 java 之间的相互调用。目前已经支持hudi、java-udf、jdbc、max-compute、paimon、preload、avro
+* Description: BE 是否开启使用 java-jni,开启后允许 c++ 与 java 之间的相互调用。目前已经支持 hudi、java-udf、jdbc、max-compute、paimon、preload、avro
* Default value: true
#### `be_thrift_max_pkg_bytes`
-* 描述: be节点thrift端口最大接收包大小(字节)
-* 默认值: 20000000
+* 描述:be 节点 thrift 端口最大接收包大小 (字节)
+* 默认值:20000000
#### `default_tzfiles_path`
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/config-dir.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/config-dir.md
index 46baf4e67e50..c3cfb971cdbd 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/config-dir.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/config-dir.md
@@ -24,13 +24,15 @@ specific language governing permissions and limitations
under the License.
-->
-# 配置文件目录
+
FE 和 BE 的配置文件目录为 `conf/`。这个目录除了存放默认的 fe.conf, be.conf 等文件外,也被用于公用的配置文件存放目录。
用户可以在其中存放一些配置文件,系统会自动读取。
-<version since="1.2.0">
+:::note
+自 Doris 1.2 版本后支持该功能
+:::
## hdfs-site.xml 和 hive-site.xml
@@ -46,4 +48,4 @@ FE 和 BE 的配置文件目录为 `conf/`。这个目录除了存放默认的 f
这样,用户仅需填写少量的配置,即可完成对 HDFS/Hive 的访问。
-</version>
+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/fe-config-template.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/fe-config-template.md
index a0fb6a62778a..dce5c1c2a104 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/fe-config-template.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/fe-config-template.md
@@ -27,11 +27,11 @@ specific language governing permissions and limitations
under the License.
-->
-# Doris FE配置参数
+# Doris FE 配置参数
该文档主要介绍 FE 的相关配置项。
-FE 的配置文件 `fe.conf` 通常存放在 FE 部署路径的 `conf/` 目录下。 而在 0.14 版本中会引入另一个配置文件 `fe_custom.conf`。该配置文件用于记录用户在运行时动态配置并持久化的配置项。
+FE 的配置文件 `fe.conf` 通常存放在 FE 部署路径的 `conf/` 目录下。而在 0.14 版本中会引入另一个配置文件 `fe_custom.conf`。该配置文件用于记录用户在运行时动态配置并持久化的配置项。
FE 进程启动后,会先读取 `fe.conf` 中的配置项,之后再读取 `fe_custom.conf` 中的配置项。`fe_custom.conf` 中的配置项会覆盖 `fe.conf` 中相同的配置项。
@@ -39,10 +39,10 @@ FE 进程启动后,会先读取 `fe.conf` 中的配置项,之后再读取 `f
## 注意事项
-**1.** 出于简化架构的目的,目前通过```mysql协议修改Config```的方式修改配置只会修改本地FE内存中的数据,而不会把变更同步到所有FE。
-对于只会在Master FE生效的Config项,修改请求会自动转发到Master节点
+**1.** 出于简化架构的目的,目前通过```mysql协议修改Config```的方式修改配置只会修改本地 FE 内存中的数据,而不会把变更同步到所有 FE。
+对于只会在 Master FE 生效的 Config 项,修改请求会自动转发到 Master 节点
-**2.** 需要注意```forward_to_master```选项会影响```admin show frontend config```的展示结果,如果```forward_to_master=true```,那么只会展示Master的配置(即使您此时连接的是Follower FE节点),这可能导致您无法看到对本地FE配置的修改;如果期望show config返回本地FE的配置项,那么执行命令```set forward_to_master=false```
+**2.** 需要注意```forward_to_master```选项会影响```admin show frontend config```的展示结果,如果```forward_to_master=true```,那么只会展示 Master 的配置(即使您此时连接的是 Follower FE 节点),这可能导致您无法看到对本地 FE 配置的修改;如果期望 show config 返回本地 FE 的配置项,那么执行命令```set forward_to_master=false```
## 查看配置项
@@ -63,7 +63,7 @@ FE 的配置项有两种方式进行查看:
- Key:配置项名称。
- Value:当前配置项的值。
- Type:配置项值类型,如果整型、字符串。
- - IsMutable:是否可以动态配置。如果为 true,表示该配置项可以在运行时进行动态配置。如果false,则表示该配置项只能在 `fe.conf` 中配置并且重启 FE 后生效。
+ - IsMutable:是否可以动态配置。如果为 true,表示该配置项可以在运行时进行动态配置。如果 false,则表示该配置项只能在 `fe.conf` 中配置并且重启 FE 后生效。
- MasterOnly:是否为 Master FE 节点独有的配置项。如果为 true,则表示该配置项仅在 Master FE 节点有意义,对其他类型的 FE 节点无意义。如果为 false,则表示该配置项在所有 FE 节点中均有意义。
- Comment:配置项的描述。
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/fe-config.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/fe-config.md
index 80e56ffec132..86bef3ec9ae7 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/fe-config.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/fe-config.md
@@ -27,11 +27,11 @@ specific language governing permissions and limitations
under the License.
-->
-# Doris FE配置参数
+
该文档主要介绍 FE 的相关配置项。
-FE 的配置文件 `fe.conf` 通常存放在 FE 部署路径的 `conf/` 目录下。 而在 0.14 版本中会引入另一个配置文件 `fe_custom.conf`。该配置文件用于记录用户在运行时动态配置并持久化的配置项。
+FE 的配置文件 `fe.conf` 通常存放在 FE 部署路径的 `conf/` 目录下。而在 0.14 版本中会引入另一个配置文件 `fe_custom.conf`。该配置文件用于记录用户在运行时动态配置并持久化的配置项。
FE 进程启动后,会先读取 `fe.conf` 中的配置项,之后再读取 `fe_custom.conf` 中的配置项。`fe_custom.conf` 中的配置项会覆盖 `fe.conf` 中相同的配置项。
@@ -54,10 +54,15 @@ FE 的配置项有两种方式进行查看:
结果中各列含义如下:
- Key:配置项名称。
+
- Value:当前配置项的值。
+
- Type:配置项值类型,如果整型、字符串。
- - IsMutable:是否可以动态配置。如果为 true,表示该配置项可以在运行时进行动态配置。如果false,则表示该配置项只能在 `fe.conf` 中配置并且重启 FE 后生效。
+
+ - IsMutable:是否可以动态配置。如果为 true,表示该配置项可以在运行时进行动态配置。如果 false,则表示该配置项只能在 `fe.conf` 中配置并且重启 FE 后生效。
+
- MasterOnly:是否为 Master FE 节点独有的配置项。如果为 true,则表示该配置项仅在 Master FE 节点有意义,对其他类型的 FE 节点无意义。如果为 false,则表示该配置项在所有 FE 节点中均有意义。
+
- Comment:配置项的描述。
## 设置配置项
@@ -84,7 +89,7 @@ FE 的配置项有两种方式进行配置:
3. 通过 HTTP 协议动态配置
- 具体请参阅 [Set Config Action](../http-actions/fe/set-config-action.md)
+ 具体请参阅 [Set Config Action](../fe/set-config-action)
该方式也可以持久化修改后的配置项。配置项将持久化在 `fe_custom.conf` 文件中,在 FE 重启后仍会生效。
@@ -125,97 +130,97 @@ FE 的配置项有两种方式进行配置:
### 元数据与集群管理
-#### `meta_dir`
+**`meta_dir`**
默认值:DorisFE.DORIS_HOME_DIR + "/doris-meta"
-Doris 元数据将保存在这里。 强烈建议将此目录的存储为:
+Doris 元数据将保存在这里。强烈建议将此目录的存储为:
1. 高写入性能(SSD)
2. 安全(RAID)
-#### `catalog_try_lock_timeout_ms`
+**`catalog_try_lock_timeout_ms`**
-默认值:5000 (ms)
+默认值:5000(ms)
是否可以动态配置:true
-元数据锁的 tryLock 超时配置。 通常它不需要改变,除非你需要测试一些东西。
+元数据锁的 tryLock 超时配置。通常它不需要改变,除非你需要测试一些东西。
-#### `enable_bdbje_debug_mode`
+**`enable_bdbje_debug_mode`**
默认值:false
如果设置为 true,FE 将在 BDBJE 调试模式下启动,在 Web 页面 `System->bdbje` 可以查看相关信息,否则不可以查看
-#### `max_bdbje_clock_delta_ms`
+**`max_bdbje_clock_delta_ms`**
-默认值:5000 (5秒)
+默认值:5000(5 秒)
-设置非主 FE 到主 FE 主机之间的最大可接受时钟偏差。 每当非主 FE 通过 BDBJE 建立到主 FE 的连接时,都会检查该值。 如果时钟偏差大于此值,则放弃连接。
+设置非主 FE 到主 FE 主机之间的最大可接受时钟偏差。每当非主 FE 通过 BDBJE 建立到主 FE 的连接时,都会检查该值。如果时钟偏差大于此值,则放弃连接。
-#### `metadata_failure_recovery`
+**`metadata_failure_recovery`**
默认值:false
-如果为 true,FE 将重置 bdbje 复制组(即删除所有可选节点信息)并应该作为 Master 启动。 如果所有可选节点都无法启动,我们可以将元数据复制到另一个节点并将此配置设置为 true 以尝试重新启动 FE。
+如果为 true,FE 将重置 bdbje 复制组(即删除所有可选节点信息)并应该作为 Master 启动。如果所有可选节点都无法启动,我们可以将元数据复制到另一个节点并将此配置设置为 true 以尝试重新启动 FE。
-#### `txn_rollback_limit`
+**`txn_rollback_limit`**
默认值:100
尝试重新加入组时 bdbje 可以回滚的最大 txn 数
-#### `bdbje_replica_ack_timeout_second`
+**`bdbje_replica_ack_timeout_second`**
默认值:10
元数据会同步写入到多个 Follower FE,这个参数用于控制 Master FE 等待 Follower FE 发送 ack 的超时时间。当写入的数据较大时,可能 ack 时间较长,如果超时,会导致写元数据失败,FE 进程退出。此时可以适当调大这个参数。
-#### `grpc_threadmgr_threads_nums`
+**`grpc_threadmgr_threads_nums`**
-默认值: 4096
+默认值:4096
-在grpc_threadmgr中处理grpc events的线程数量。
+在 grpc_threadmgr 中处理 grpc events 的线程数量。
-#### `bdbje_lock_timeout_second`
+**`bdbje_lock_timeout_second`**
默认值:5
bdbje 操作的 lock timeout 如果 FE WARN 日志中有很多 LockTimeoutException,可以尝试增加这个值
-#### `bdbje_heartbeat_timeout_second`
+**`bdbje_heartbeat_timeout_second`**
默认值:30
-master 和 follower 之间 bdbje 的心跳超时。 默认为 30 秒,与 bdbje 中的默认值相同。 如果网络遇到暂时性问题,一些意外的长 Java GC 使您烦恼,您可以尝试增加此值以减少错误超时的机会
+master 和 follower 之间 bdbje 的心跳超时。默认为 30 秒,与 bdbje 中的默认值相同。如果网络遇到暂时性问题,一些意外的长 Java GC 使您烦恼,您可以尝试增加此值以减少错误超时的机会
-#### `replica_ack_policy`
+**`replica_ack_policy`**
默认值:SIMPLE_MAJORITY
选项:ALL, NONE, SIMPLE_MAJORITY
-bdbje 的副本 ack 策略。 更多信息,请参见:http://docs.oracle.com/cd/E17277_02/html/java/com/sleepycat/je/Durability.ReplicaAckPolicy.html
+bdbje 的副本 ack 策略。更多信息,请参见:http://docs.oracle.com/cd/E17277_02/html/java/com/sleepycat/je/Durability.ReplicaAckPolicy.html
-#### `replica_sync_policy`
+**`replica_sync_policy`**
默认值:SYNC
选项:SYNC, NO_SYNC, WRITE_NO_SYNC
-bdbje 的Follower FE 同步策略。
+bdbje 的 Follower FE 同步策略。
-#### `master_sync_policy`
+**`master_sync_policy`**
默认值:SYNC
选项:SYNC, NO_SYNC, WRITE_NO_SYNC
-Master FE 的 bdbje 同步策略。 如果您只部署一个 Follower FE,请将其设置为“SYNC”。 如果你部署了超过 3 个 Follower FE,你可以将这个和下面的 `replica_sync_policy ` 设置为 WRITE_NO_SYNC。 更多信息,参见:http://docs.oracle.com/cd/E17277_02/html/java/com/sleepycat/je/Durability.SyncPolicy.html
+Master FE 的 bdbje 同步策略。如果您只部署一个 Follower FE,请将其设置为“SYNC”。如果你部署了超过 3 个 Follower FE,你可以将这个和下面的 `replica_sync_policy ` 设置为 WRITE_NO_SYNC。更多信息,参见:http://docs.oracle.com/cd/E17277_02/html/java/com/sleepycat/je/Durability.SyncPolicy.html
-#### `bdbje_reserved_disk_bytes`
+**`bdbje_reserved_disk_bytes`**
用于限制 bdbje 能够保留的文件的最大磁盘空间。
@@ -225,28 +230,28 @@ Master FE 的 bdbje 同步策略。 如果您只部署一个 Follower FE,请
是否为 Master FE 节点独有的配置项:false
-#### `ignore_meta_check`
+**`ignore_meta_check`**
默认值:false
是否可以动态配置:true
如果为 true,非主 FE 将忽略主 FE 与其自身之间的元数据延迟间隙,即使元数据延迟间隙超过 `meta_delay_toleration_second`。
-非主 FE 仍将提供读取服务。 当您出于某种原因尝试停止 Master FE 较长时间,但仍希望非 Master FE 可以提供读取服务时,这会很有帮助。
+非主 FE 仍将提供读取服务。当您出于某种原因尝试停止 Master FE 较长时间,但仍希望非 Master FE 可以提供读取服务时,这会很有帮助。
-#### `meta_delay_toleration_second`
+**`meta_delay_toleration_second`**
-默认值:300 (5分钟)
+默认值:300(5 分钟)
如果元数据延迟间隔超过 `meta_delay_toleration_second `,非主 FE 将停止提供服务
-#### `edit_log_port`
+**`edit_log_port`**
默认值:9010
-bdbje端口
+bdbje 端口
-#### `edit_log_type`
+**`edit_log_type`**
默认值:BDB
@@ -254,7 +259,7 @@ bdbje端口
BDB:将日志写入 bdbje
LOCAL:已弃用。
-#### `edit_log_roll_num`
+**`edit_log_roll_num`**
默认值:50000
@@ -264,7 +269,7 @@ LOCAL:已弃用。
Master FE will save image every `edit_log_roll_num ` meta journals.
-#### `force_do_metadata_checkpoint`
+**`force_do_metadata_checkpoint`**
默认值:false
@@ -274,9 +279,9 @@ Master FE will save image every `edit_log_roll_num ` meta journals.
如果设置为 true,则无论 jvm 内存使用百分比如何,检查点线程都会创建检查点
-#### `metadata_checkpoint_memory_threshold`
+**`metadata_checkpoint_memory_threshold`**
-默认值:60 (60%)
+默认值:60(60%)
是否可以动态配置:true
@@ -284,11 +289,11 @@ Master FE will save image every `edit_log_roll_num ` meta journals.
如果 jvm 内存使用百分比(堆或旧内存池)超过此阈值,则检查点线程将无法工作以避免 OOM。
-#### `max_same_name_catalog_trash_num`
+**`max_same_name_catalog_trash_num`**
用于设置回收站中同名元数据的最大个数,超过最大值时,最早删除的元数据将被彻底删除,不能再恢复。0 表示不保留同名对象。< 0 表示不做限制。
-注意:同名元数据的判断会局限在一定的范围内。比如同名database的判断会限定在相同cluster下,同名table的判断会限定在相同database(指相同database id)下,同名partition的判断会限定在相同database(指相同database id)并且相同table(指相同table id)下。
+注意:同名元数据的判断会局限在一定的范围内。比如同名 database 的判断会限定在相同 cluster 下,同名 table 的判断会限定在相同 database(指相同 database id)下,同名 partition 的判断会限定在相同 database(指相同 database id)并且相同 table(指相同 table id)下。
默认值:3
@@ -296,13 +301,13 @@ Master FE will save image every `edit_log_roll_num ` meta journals.
是否为 Master FE 节点独有的配置项:true
-#### `cluster_id`
+**`cluster_id`**
默认值:-1
-如果节点(FE 或 BE)具有相同的集群 id,则将认为它们属于同一个Doris 集群。 Cluster id 通常是主 FE 首次启动时生成的随机整数。 您也可以指定一个。
+如果节点(FE 或 BE)具有相同的集群 id,则将认为它们属于同一个 Doris 集群。Cluster id 通常是主 FE 首次启动时生成的随机整数。您也可以指定一个。
-#### `heartbeat_mgr_blocking_queue_size`
+**`heartbeat_mgr_blocking_queue_size`**
默认值:1024
@@ -310,7 +315,7 @@ Master FE will save image every `edit_log_roll_num ` meta journals.
在 heartbeat_mgr 中存储心跳任务的阻塞队列大小。
-#### `heartbeat_mgr_threads_num`
+**`heartbeat_mgr_threads_num`**
默认值:8
@@ -318,20 +323,23 @@ Master FE will save image every `edit_log_roll_num ` meta journals.
heartbeat_mgr 中处理心跳事件的线程数。
-#### `disable_cluster_feature`
+**`disable_cluster_feature`**
默认值:true
是否可以动态配置:true
-多集群功能将在 0.12 版本中弃用 ,将此配置设置为 true 将禁用与集群功能相关的所有操作,包括:
+多集群功能将在 0.12 版本中弃用,将此配置设置为 true 将禁用与集群功能相关的所有操作,包括:
1. 创建/删除集群
-2. 添加、释放BE/将BE添加到集群/停用集群balance
+
+2. 添加、释放 BE/将 BE 添加到集群/停用集群 balance
+
3. 更改集群的后端数量
+
4. 链接/迁移数据库
-#### `enable_deploy_manager`
+**`enable_deploy_manager`**
默认值:disable
@@ -340,33 +348,36 @@ heartbeat_mgr 中处理心跳事件的线程数。
有效的选项是:
- disable:没有部署管理器
+
- k8s:Kubernetes
+
- ambari:Ambari
+
- local:本地文件(用于测试或 Boxer2 BCC 版本)
-#### `with_k8s_certs`
+**`with_k8s_certs`**
默认值:false
如果在本地使用 k8s 部署管理器,请将其设置为 true 并准备证书文件
-#### `enable_fqdn_mode`
+**`enable_fqdn_mode`**
-此配置用于 k8s 部署环境。当 enable_fqdn_mode 为 true 时,将允许更改 be 的重建 pod的 ip。
+此配置用于 k8s 部署环境。当 enable_fqdn_mode 为 true 时,将允许更改 be 的重建 pod 的 ip。
-默认值: false
+默认值:false
是否可以动态配置:false
是否为 Master FE 节点独有的配置项:true
-#### `enable_token_check`
+**`enable_token_check`**
默认值:true
-为了向前兼容,稍后将被删除。 下载image文件时检查令牌。
+为了向前兼容,稍后将被删除。下载 image 文件时检查令牌。
-#### `enable_multi_tags`
+**`enable_multi_tags`**
默认值:false
@@ -374,13 +385,13 @@ heartbeat_mgr 中处理心跳事件的线程数。
是否为 Master FE 节点独有的配置项:true
-是否开启单BE的多标签功能
+是否开启单 BE 的多标签功能
-#### `initial_root_password`
+**`initial_root_password`**
-设置 root 用户初始化2阶段 SHA-1 加密密码,默认为'',即不设置 root 密码。后续 root 用户的 `set password` 操作会将 root 初始化密码覆盖。
+设置 root 用户初始化 2 阶段 SHA-1 加密密码,默认为'',即不设置 root 密码。后续 root 用户的 `set password` 操作会将 root 初始化密码覆盖。
-示例:如要配置密码的明文是 `root@123`,可在Doris执行SQL `select password('root@123')` 获取加密密码 `*A00C34073A26B40AB4307650BFB9309D6BFA6999`。
+示例:如要配置密码的明文是 `root@123`,可在 Doris 执行 SQL `select password('root@123')` 获取加密密码 `*A00C34073A26B40AB4307650BFB9309D6BFA6999`。
默认值:空字符串
@@ -390,100 +401,100 @@ heartbeat_mgr 中处理心跳事件的线程数。
### 服务
-#### `query_port`
+**`query_port`**
默认值:9030
Doris FE 通过 mysql 协议查询连接端口
-#### `arrow_flight_sql_port`
+**`arrow_flight_sql_port`**
默认值:-1
Doris FE 通过 Arrow Flight SQL 协议查询连接端口
-#### `frontend_address`
+**`frontend_address`**
-状态:已弃用,不建议使用。
+状态:已弃用,不建议使用。
类型:string
-描述:显式配置FE的IP地址,不使用*InetAddress。getByName*获取IP地址。通常在*InetAddress中。getByName*当无法获得预期结果时。只支持IP地址,不支持主机名。
+描述:显式配置 FE 的 IP 地址,不使用*InetAddress。getByName*获取 IP 地址。通常在*InetAddress 中。getByName*当无法获得预期结果时。只支持 IP 地址,不支持主机名。
默认值:0.0.0.0
-#### `priority_networks`
+**`priority_networks`**
默认值:空
-为那些有很多 ip 的服务器声明一个选择策略。 请注意,最多应该有一个 ip 与此列表匹配。 这是一个以分号分隔格式的列表,用 CIDR 表示法,例如 10.10.10.0/24。 如果没有匹配这条规则的ip,会随机选择一个。
+为那些有很多 ip 的服务器声明一个选择策略。请注意,最多应该有一个 ip 与此列表匹配。这是一个以分号分隔格式的列表,用 CIDR 表示法,例如 10.10.10.0/24。如果没有匹配这条规则的 ip,会随机选择一个。
-#### `http_port`
+**`http_port`**
默认值:8030
FE http 端口,当前所有 FE http 端口都必须相同
-#### `https_port`
+**`https_port`**
默认值:8050
FE https 端口,当前所有 FE https 端口都必须相同
-#### `enable_https`
+**`enable_https`**
默认值:false
FE https 使能标志位,false 表示支持 http,true 表示同时支持 http 与 https,并且会自动将 http 请求重定向到 https
如果 enable_https 为 true,需要在 fe.conf 中配置 ssl 证书信息
-#### `enable_ssl`
+**`enable_ssl`**
-默认值: true
+默认值:true
-如果设置为 ture,doris 将与 mysql服务 建立基于 SSL 协议的加密通道。
+如果设置为 ture,doris 将与 mysql 服务 建立基于 SSL 协议的加密通道。
-#### `qe_max_connection`
+**`qe_max_connection`**
默认值:1024
每个 FE 的最大连接数
-#### `check_java_version`
+**`check_java_version`**
默认值:true
-Doris 将检查已编译和运行的 Java 版本是否兼容,如果不兼容将抛出Java版本不匹配的异常信息,并终止启动
+Doris 将检查已编译和运行的 Java 版本是否兼容,如果不兼容将抛出 Java 版本不匹配的异常信息,并终止启动
-#### `rpc_port`
+**`rpc_port`**
默认值:9020
-FE Thrift Server的端口
+FE Thrift Server 的端口
-#### `thrift_server_type`
+**`thrift_server_type`**
-该配置表示FE的Thrift服务使用的服务模型, 类型为string, 大小写不敏感。
+该配置表示 FE 的 Thrift 服务使用的服务模型,类型为 string, 大小写不敏感。
-若该参数为 `SIMPLE`, 则使用 `TSimpleServer` 模型, 该模型一般不适用于生产环境,仅限于测试使用。
+若该参数为 `SIMPLE`, 则使用 `TSimpleServer` 模型,该模型一般不适用于生产环境,仅限于测试使用。
-若该参数为 `THREADED`, 则使用 `TThreadedSelectorServer` 模型,该模型为非阻塞式I/O模型,即主从 Reactor 模型,该模型能及时响应大量的并发连接请求,在多数场景下有较好的表现。
+若该参数为 `THREADED`, 则使用 `TThreadedSelectorServer` 模型,该模型为非阻塞式 I/O 模型,即主从 Reactor 模型,该模型能及时响应大量的并发连接请求,在多数场景下有较好的表现。
-若该参数为 `THREAD_POOL`, 则使用 `TThreadPoolServer` 模型,该模型为阻塞式I/O模型,使用线程池处理用户连接,并发连接数受限于线程池的数量,如果能提前预估并发请求的数量,并且能容忍足够多的线程资源开销,该模型会有较好的性能表现,默认使用该服务模型
+若该参数为 `THREAD_POOL`, 则使用 `TThreadPoolServer` 模型,该模型为阻塞式 I/O 模型,使用线程池处理用户连接,并发连接数受限于线程池的数量,如果能提前预估并发请求的数量,并且能容忍足够多的线程资源开销,该模型会有较好的性能表现,默认使用该服务模型
-#### `thrift_server_max_worker_threads`
+**`thrift_server_max_worker_threads`**
默认值:4096
-Thrift Server最大工作线程数
+Thrift Server 最大工作线程数
-#### `thrift_backlog_num`
+**`thrift_backlog_num`**
默认值:1024
thrift 服务器的 backlog_num 当你扩大这个 backlog_num 时,你应该确保它的值大于 linux `/proc/sys/net/core/somaxconn` 配置
-#### `thrift_client_timeout_ms`
+**`thrift_client_timeout_ms`**
默认值:0
@@ -491,32 +502,32 @@ thrift 服务器的连接超时和套接字超时配置
thrift_client_timeout_ms 的默认值设置为零以防止读取超时
-#### `use_compact_thrift_rpc`
+**`use_compact_thrift_rpc`**
默认值:true
-是否使用压缩格式发送查询计划结构体。开启后,可以降低约50%的查询计划结构体大小,从而避免一些 "send fragment timeout" 错误。
-但是在某些高并发小查询场景下,可能会降低约10%的并发度。
+是否使用压缩格式发送查询计划结构体。开启后,可以降低约 50% 的查询计划结构体大小,从而避免一些 "send fragment timeout" 错误。
+但是在某些高并发小查询场景下,可能会降低约 10% 的并发度。
-#### `grpc_max_message_size_bytes`
+**`grpc_max_message_size_bytes`**
默认值:1G
用于设置 GRPC 客户端通道的初始流窗口大小,也用于设置最大消息大小。当结果集较大时,可能需要增大该值。
-#### `max_mysql_service_task_threads_num`
+**`max_mysql_service_task_threads_num`**
默认值:4096
mysql 中处理任务的最大线程数。
-#### `mysql_service_io_threads_num`
+**`mysql_service_io_threads_num`**
默认值:4
mysql 中处理 io 事件的线程数。
-#### `mysql_nio_backlog_num`
+**`mysql_nio_backlog_num`**
默认值:1024
@@ -524,13 +535,13 @@ mysql nio server 的 backlog_num 当你放大这个 backlog_num 时,你应该
#### `broker_timeout_ms`
-默认值:10000 (10秒)
+默认值:10000(10 秒)
Broker rpc 的默认超时时间
#### `backend_rpc_timeout_ms`
-FE向BE的BackendService发送rpc请求时的超时时间,单位:毫秒。
+FE 向 BE 的 BackendService 发送 rpc 请求时的超时时间,单位:毫秒。
默认值:60000
@@ -546,9 +557,9 @@ FE向BE的BackendService发送rpc请求时的超时时间,单位:毫秒。
是否为 Master FE 节点独有的配置项:true
-该配置用于控制系统在成功下线(Decommission) BE 后,是否 Drop 该 BE。如果为 true,则在 BE 成功下线后,会删除掉该 BE 节点。如果为 false,则在 BE 成功下线后,该 BE 会一直处于 DECOMMISSION 状态,但不会被删除。
+该配置用于控制系统在成功下线(Decommission)BE 后,是否 Drop 该 BE。如果为 true,则在 BE 成功下线后,会删除掉该 BE 节点。如果为 false,则在 BE 成功下线后,该 BE 会一直处于 DECOMMISSION 状态,但不会被删除。
-该配置在某些场景下可以发挥作用。假设一个 Doris 集群的初始状态为每个 BE 节点有一块磁盘。运行一段时间后,系统进行了纵向扩容,即每个 BE 节点新增2块磁盘。因为 Doris 当前还不支持 BE 内部各磁盘间的数据均衡,所以会导致初始磁盘的数据量可能一直远高于新增磁盘的数据量。此时我们可以通过以下操作进行人工的磁盘间均衡:
+该配置在某些场景下可以发挥作用。假设一个 Doris 集群的初始状态为每个 BE 节点有一块磁盘。运行一段时间后,系统进行了纵向扩容,即每个 BE 节点新增 2 块磁盘。因为 Doris 当前还不支持 BE 内部各磁盘间的数据均衡,所以会导致初始磁盘的数据量可能一直远高于新增磁盘的数据量。此时我们可以通过以下操作进行人工的磁盘间均衡:
1. 将该配置项置为 false。
2. 对某一个 BE 节点,执行 decommission 操作,该操作会将该 BE 上的数据全部迁移到其他节点中。
@@ -557,7 +568,7 @@ FE向BE的BackendService发送rpc请求时的超时时间,单位:毫秒。
#### `max_backend_down_time_second`
-默认值:3600 (1小时)
+默认值:3600(1 小时)
是否可以动态配置:true
@@ -567,7 +578,7 @@ FE向BE的BackendService发送rpc请求时的超时时间,单位:毫秒。
#### `disable_backend_black_list`
-用于禁止BE黑名单功能。禁止该功能后,如果向BE发送查询请求失败,也不会将这个BE添加到黑名单。
+用于禁止 BE 黑名单功能。禁止该功能后,如果向 BE 发送查询请求失败,也不会将这个 BE 添加到黑名单。
该参数适用于回归测试环境,以减少偶发的错误导致大量回归测试失败。
默认值:false
@@ -578,7 +589,7 @@ FE向BE的BackendService发送rpc请求时的超时时间,单位:毫秒。
#### `max_backend_heartbeat_failure_tolerance_count`
-最大可容忍的BE节点心跳失败次数。如果连续心跳失败次数超过这个值,则会将BE状态置为 dead。
+最大可容忍的 BE 节点心跳失败次数。如果连续心跳失败次数超过这个值,则会将 BE 状态置为 dead。
该参数适用于回归测试环境,以减少偶发的心跳失败导致大量回归测试失败。
默认值:1
@@ -605,9 +616,9 @@ FE向BE的BackendService发送rpc请求时的超时时间,单位:毫秒。
是否为 Master FE 节点独有的配置项:true
-当代理任务的创建时间被设置的时候,此配置将决定是否重新发送代理任务, 当且仅当当前时间减去创建时间大于 `agent_task_task_resend_wait_time_ms` 时,ReportHandler可以重新发送代理任务。
+当代理任务的创建时间被设置的时候,此配置将决定是否重新发送代理任务,当且仅当当前时间减去创建时间大于 `agent_task_task_resend_wait_time_ms` 时,ReportHandler 可以重新发送代理任务。
-该配置目前主要用来解决 `PUBLISH_VERSION` 代理任务的重复发送问题, 目前该配置的默认值是5000,是个实验值。
+该配置目前主要用来解决 `PUBLISH_VERSION` 代理任务的重复发送问题,目前该配置的默认值是 5000,是个实验值。
由于把代理任务提交到代理任务队列和提交到 BE 存在一定的时间延迟,所以调大该配置的值可以有效解决代理任务的重复发送问题,
@@ -623,11 +634,11 @@ FE向BE的BackendService发送rpc请求时的超时时间,单位:毫秒。
#### `remote_fragment_exec_timeout_ms`
-默认值:30000 (ms)
+默认值:30000(ms)
是否可以动态配置:true
-异步执行远程 fragment 的超时时间。 在正常情况下,异步远程 fragment 将在短时间内执行。 如果系统处于高负载状态,请尝试将此超时设置更长的时间。
+异步执行远程 fragment 的超时时间。在正常情况下,异步远程 fragment 将在短时间内执行。如果系统处于高负载状态,请尝试将此超时设置更长的时间。
#### `auth_token`
@@ -639,7 +650,7 @@ FE向BE的BackendService发送rpc请求时的超时时间,单位:毫秒。
默认值:从官方 0.14.0 release 版之后默认是 true,之前默认 false
-HTTP Server V2 由 SpringBoot 实现, 并采用前后端分离的架构。只有启用 httpv2,用户才能使用新的前端 UI 界面
+HTTP Server V2 由 SpringBoot 实现,并采用前后端分离的架构。只有启用 httpv2,用户才能使用新的前端 UI 界面
#### `http_api_extra_base_path`
@@ -660,9 +671,9 @@ HTTP Server V2 由 SpringBoot 实现, 并采用前后端分离的架构。只有
默认值:0
-Jetty 的线程数量由以上三个参数控制。Jetty的线程架构模型非常简单,分为 acceptors、selectors 和 workers 三个线程池。acceptors 负责接受新连接,然后交给 selectors 处理HTTP消息协议的解包,最后由 workers 处理请求。前两个线程池采用非阻塞模型,一个线程可以处理很多 socket 的读写,所以线程池数量较小。
+Jetty 的线程数量由以上三个参数控制。Jetty 的线程架构模型非常简单,分为 acceptors、selectors 和 workers 三个线程池。acceptors 负责接受新连接,然后交给 selectors 处理 HTTP 消息协议的解包,最后由 workers 处理请求。前两个线程池采用非阻塞模型,一个线程可以处理很多 socket 的读写,所以线程池数量较小。
-大多数项目,acceptors 线程只需要1~2个,selectors 线程配置2~4个足矣。workers 是阻塞性的业务逻辑,往往有较多的数据库操作,需要的线程数量较多,具体数量随应用程序的 QPS 和 IO 事件占比而定。QPS 越高,需要的线程数量越多,IO 占比越高,等待的线程数越多,需要的总线程数也越多。
+大多数项目,acceptors 线程只需要 1~2 个,selectors 线程配置 2~4 个足矣。workers 是阻塞性的业务逻辑,往往有较多的数据库操作,需要的线程数量较多,具体数量随应用程序的 QPS 和 IO 事件占比而定。QPS 越高,需要的线程数量越多,IO 占比越高,等待的线程数越多,需要的总线程数也越多。
workers 线程池默认不做设置,根据自己需要进行设置
@@ -674,7 +685,7 @@ workers 线程池默认不做设置,根据自己需要进行设置
#### `jetty_server_max_http_header_size`
-默认值:1048576 (1M)
+默认值:1048576(1M)
http header size 配置参数
@@ -682,13 +693,13 @@ http header size 配置参数
默认值:2
-http请求处理/api/query中sql任务的最大线程池
+http 请求处理/api/query 中 sql 任务的最大线程池
#### `http_load_submitter_max_worker_threads`
默认值:2
-http请求处理/api/upload任务的最大线程池
+http 请求处理/api/upload 任务的最大线程池
### 查询引擎
@@ -696,7 +707,7 @@ http请求处理/api/upload任务的最大线程池
默认值:-1
-用户属性max_query_instances小于等于0时,使用该配置,用来限制单个用户同一时刻可使用的查询instance个数。该参数小于等于0表示无限制。
+用户属性 max_query_instances 小于等于 0 时,使用该配置,用来限制单个用户同一时刻可使用的查询 instance 个数。该参数小于等于 0 表示无限制。
#### `max_query_retry_time`
@@ -704,7 +715,7 @@ http请求处理/api/upload任务的最大线程池
是否可以动态配置:true
-查询重试次数。 如果我们遇到 RPC 异常并且没有将结果发送给用户,则可能会重试查询。 您可以减少此数字以避免雪崩灾难。
+查询重试次数。如果我们遇到 RPC 异常并且没有将结果发送给用户,则可能会重试查询。您可以减少此数字以避免雪崩灾难。
#### `max_dynamic_partition_num`
@@ -714,7 +725,7 @@ http请求处理/api/upload任务的最大线程池
是否为 Master FE 节点独有的配置项:true
-用于限制创建动态分区表时可以创建的最大分区数,避免一次创建过多分区。 数量由动态分区参数中的“开始”和“结束”决定。
+用于限制创建动态分区表时可以创建的最大分区数,避免一次创建过多分区。数量由动态分区参数中的“开始”和“结束”决定。
#### `dynamic_partition_enable`
@@ -728,7 +739,7 @@ http请求处理/api/upload任务的最大线程池
#### `dynamic_partition_check_interval_seconds`
-默认值:600秒,10分钟
+默认值:600 秒,10 分钟
是否可以动态配置:true
@@ -758,7 +769,7 @@ http请求处理/api/upload任务的最大线程池
是否为 Master FE 节点独有的配置项:true
-使用此参数设置 multi partition 的分区名前缀,仅仅multi partition 生效,不作用于动态分区,默认前缀是“p_”。
+使用此参数设置 multi partition 的分区名前缀,仅仅 multi partition 生效,不作用于动态分区,默认前缀是“p_”。
#### `partition_in_memory_update_interval_secs`
@@ -813,7 +824,7 @@ http请求处理/api/upload任务的最大线程池
是否为 Master FE 节点独有的配置项:false
-如果设置为 true,SQL 查询结果集将被缓存。如果查询中所有表的所有分区最后一次访问版本时间的间隔大于cache_last_version_interval_second,且结果集行数小于cache_result_max_row_count,且数据大小小于cache_result_max_data_size,则结果集会被缓存,下一条相同的SQL会命中缓存
+如果设置为 true,SQL 查询结果集将被缓存。如果查询中所有表的所有分区最后一次访问版本时间的间隔大于 cache_last_version_interval_second,且结果集行数小于 cache_result_max_row_count,且数据大小小于 cache_result_max_data_size,则结果集会被缓存,下一条相同的 SQL 会命中缓存
如果设置为 true,FE 会启用 sql 结果缓存,该选项适用于离线数据更新场景
@@ -850,7 +861,7 @@ http请求处理/api/upload任务的最大线程池
是否为 Master FE 节点独有的配置项:false
-设置可以缓存的最大数据大小,单位Bytes
+设置可以缓存的最大数据大小,单位 Bytes
#### `cache_last_version_interval_second`
@@ -900,7 +911,7 @@ http请求处理/api/upload任务的最大线程池
是否为 Master FE 节点独有的配置项:false
-这将限制哈希分布修剪器的最大递归深度。 例如:其中 a in(5 个元素)和 b in(4 个元素)和 c in(3 个元素)和 d in(2 个元素)。 a/b/c/d 是分布式列,所以递归深度为 5 * 4 * 3 * 2 = 120,大于 100, 因此该分发修剪器将不起作用,只会返回所有 buckets。 增加深度可以支持更多元素的分布修剪,但可能会消耗更多的 CPU
+这将限制哈希分布修剪器的最大递归深度。例如:其中 a in(5 个元素)和 b in(4 个元素)和 c in(3 个元素)和 d in(2 个元素)。a/b/c/d 是分布式列,所以递归深度为 5 * 4 * 3 * 2 = 120,大于 100,因此该分发修剪器将不起作用,只会返回所有 buckets。增加深度可以支持更多元素的分布修剪,但可能会消耗更多的 CPU
通过 `ADMIN SHOW FRONTEND CONFIG;` 可以查看到该配置项可以动态配置(`IsMutable` 为 true)。并且不是 Master FE 独有配置。
@@ -917,7 +928,7 @@ http请求处理/api/upload任务的最大线程池
1. N 个主机,部署了 N 个 BE 和 N 个 FE。
-2. 数据有N个副本。
+2. 数据有 N 个副本。
3. 高并发查询均匀发送到所有 Frontends
@@ -937,7 +948,7 @@ http请求处理/api/upload任务的最大线程池
是否可以动态配置:true
-限制 expr 树的深度。 超过此限制可能会导致在持有 db read lock 时分析时间过长。
+限制 expr 树的深度。超过此限制可能会导致在持有 db read lock 时分析时间过长。
#### `expr_children_limit`
@@ -945,28 +956,28 @@ http请求处理/api/upload任务的最大线程池
是否可以动态配置:true
-限制 expr 树的 expr 子节点的数量。 超过此限制可能会导致在持有数据库读锁时分析时间过长。
+限制 expr 树的 expr 子节点的数量。超过此限制可能会导致在持有数据库读锁时分析时间过长。
#### `be_exec_version`
-用于定义fragment之间传递block的序列化格式。
+用于定义 fragment 之间传递 block 的序列化格式。
-有时我们的一些代码改动会改变block的数据格式,为了使得BE在滚动升级的过程中能够相互兼容数据格式,我们需要从FE下发一个数据版本来决定以什么格式发送数据。
+有时我们的一些代码改动会改变 block 的数据格式,为了使得 BE 在滚动升级的过程中能够相互兼容数据格式,我们需要从 FE 下发一个数据版本来决定以什么格式发送数据。
-具体的来说,例如集群中有2个BE,其中一台经过升级能够支持最新的$v_1$,而另一台只支持$v_0$,此时由于FE还未升级,所以统一下发$v_0$,BE之间以旧的数据格式进行交互。待BE都升级完成,我们再升级FE,此时新的FE会下发$v_1$,集群统一切换到新的数据格式。
+具体的来说,例如集群中有 2 个 BE,其中一台经过升级能够支持最新的$v_1$,而另一台只支持$v_0$,此时由于 FE 还未升级,所以统一下发$v_0$,BE 之间以旧的数据格式进行交互。待 BE 都升级完成,我们再升级 FE,此时新的 FE 会下发$v_1$,集群统一切换到新的数据格式。
默认值为`max_be_exec_version`,如果有特殊需要,我们可以手动设置将格式版本降低,但不应低于`min_be_exec_version`。
-需要注意的是,我们应该始终保持该变量的值处于**所有**BE的`BeExecVersionManager::min_be_exec_version`和`BeExecVersionManager::max_be_exec_version`之间。(也就是说如果一个已经完成更新的集群如果需要降级,应该保证先降级FE再降级BE的顺序,或者手动在设置中将该变量调低再降级BE)
+需要注意的是,我们应该始终保持该变量的值处于**所有**BE 的`BeExecVersionManager::min_be_exec_version`和`BeExecVersionManager::max_be_exec_version`之间。(也就是说如果一个已经完成更新的集群如果需要降级,应该保证先降级 FE 再降级 BE 的顺序,或者手动在设置中将该变量调低再降级 BE)
#### `max_be_exec_version`
-目前支持的最新数据版本,不可修改,应与配套版本的BE中的`BeExecVersionManager::max_be_exec_version`一致。
+目前支持的最新数据版本,不可修改,应与配套版本的 BE 中的`BeExecVersionManager::max_be_exec_version`一致。
#### `min_be_exec_version`
-目前支持的最旧数据版本,不可修改,应与配套版本的BE中的`BeExecVersionManager::min_be_exec_version`一致。
+目前支持的最旧数据版本,不可修改,应与配套版本的 BE 中的`BeExecVersionManager::min_be_exec_version`一致。
#### `max_query_profile_num`
@@ -980,13 +991,13 @@ http请求处理/api/upload任务的最大线程池
#### `publish_version_interval_ms`
-默认值:10 (ms)
+默认值:10(ms)
两个发布版本操作之间的最小间隔
#### `publish_version_timeout_second`
-默认值:30 (s)
+默认值:30(s)
是否可以动态配置:true
@@ -1009,7 +1020,7 @@ colocate join PlanFragment instance 的 memory_limit = exec_mem_limit / min (que
该变量为 session variable,session 级别生效。
- 类型:boolean
-- 描述:**仅对于 AGG 模型的表来说**,当变量为 true 时,用户查询时包含 count(distinct c1) 这类聚合函数时,如果 c1 列本身类型为 bitmap,则 count distnct 会改写为 bitmap_union_count(c1)。 当 c1 列本身类型为 hll,则 count distinct 会改写为 hll_union_agg(c1) 如果变量为 false,则不发生任何改写。
+- 描述:**仅对于 AGG 模型的表来说**,当变量为 true 时,用户查询时包含 count(distinct c1) 这类聚合函数时,如果 c1 列本身类型为 bitmap,则 count distnct 会改写为 bitmap_union_count(c1)。当 c1 列本身类型为 hll,则 count distinct 会改写为 hll_union_agg(c1) 如果变量为 false,则不发生任何改写。
### 导入与导出
@@ -1033,7 +1044,7 @@ colocate join PlanFragment instance 的 memory_limit = exec_mem_limit / min (que
是否为 Master FE 节点独有的配置项:true
-可过滤数据(由于数据不规则等原因)的最大百分比。默认值为0,表示严格模式,只要数据有一条被过滤掉整个导入失败
+可过滤数据(由于数据不规则等原因)的最大百分比。默认值为 0,表示严格模式,只要数据有一条被过滤掉整个导入失败
#### `max_running_txn_num_per_db`
@@ -1053,7 +1064,7 @@ current running txns on db xxx is xx, larger than limit xx
该遇到该错误时,说明当前集群内正在运行的导入任务超过了该配置值。此时建议在业务侧进行等待并重试导入任务。
-如果使用Connector方式写入,该参数的值可以适当调大,上千也没有问题
+如果使用 Connector 方式写入,该参数的值可以适当调大,上千也没有问题
#### `using_old_load_usage_pattern`
@@ -1063,7 +1074,7 @@ current running txns on db xxx is xx, larger than limit xx
是否为 Master FE 节点独有的配置项:true
-如果设置为 true,处理错误的 insert stmt 仍将返回一个标签给用户。 用户可以使用此标签来检查导入作业的状态。 默认值为 false,表示插入操作遇到错误,不带导入标签,直接抛出异常给用户客户端。
+如果设置为 true,处理错误的 insert stmt 仍将返回一个标签给用户。用户可以使用此标签来检查导入作业的状态。默认值为 false,表示插入操作遇到错误,不带导入标签,直接抛出异常给用户客户端。
#### `disable_load_job`
@@ -1098,7 +1109,7 @@ current running txns on db xxx is xx, larger than limit xx
是否为 Master FE 节点独有的配置项:true
-最大加载任务数,包括 PENDING、ETL、LOADING、QUORUM_FINISHED。 如果超过此数量,则不允许提交导入作业。
+最大加载任务数,包括 PENDING、ETL、LOADING、QUORUM_FINISHED。如果超过此数量,则不允许提交导入作业。
#### `db_used_data_quota_update_interval_secs`
@@ -1152,7 +1163,7 @@ current running txns on db xxx is xx, larger than limit xx
是否为 Master FE 节点独有的配置项:true
-broker scanner 程序可以在一个 broker 加载作业中处理的最大字节数。 通常,每个 BE 都有一个 broker scanner 程序。
+broker scanner 程序可以在一个 broker 加载作业中处理的最大字节数。通常,每个 BE 都有一个 broker scanner 程序。
#### `default_load_parallelism`
@@ -1162,8 +1173,8 @@ broker scanner 程序可以在一个 broker 加载作业中处理的最大字节
是否为 Master FE 节点独有的配置项:true
-单个节点broker load导入的默认并发度。
-如果用户在提交broker load任务时,在properties中自行指定了并发度,则采用用户自定义的并发度。
+单个节点 broker load 导入的默认并发度。
+如果用户在提交 broker load 任务时,在 properties 中自行指定了并发度,则采用用户自定义的并发度。
此参数将与`max_broker_concurrency`、`min_bytes_per_broker_scanner`等多个配置共同决定导入任务的并发度。
#### `max_broker_concurrency`
@@ -1188,7 +1199,7 @@ broker scanner 的最大并发数。
#### `period_of_auto_resume_min`
-默认值:5 (s)
+默认值:5(s)
是否可以动态配置:true
@@ -1204,7 +1215,7 @@ broker scanner 的最大并发数。
是否为 Master FE 节点独有的配置项:true
-只要有一个BE宕机,Routine Load 就无法自动恢复
+只要有一个 BE 宕机,Routine Load 就无法自动恢复
#### `max_routine_load_task_num_per_be`
@@ -1214,7 +1225,7 @@ broker scanner 的最大并发数。
是否为 Master FE 节点独有的配置项:true
-每个 BE 的最大并发例 Routine Load 任务数。 这是为了限制发送到 BE 的 Routine Load 任务的数量,并且它也应该小于 BE config `routine_load_thread_pool_size`(默认 10),这是 BE 上的 Routine Load 任务线程池大小。
+每个 BE 的最大并发例 Routine Load 任务数。这是为了限制发送到 BE 的 Routine Load 任务的数量,并且它也应该小于 BE config `routine_load_thread_pool_size`(默认 10),这是 BE 上的 Routine Load 任务线程池大小。
#### `max_routine_load_task_concurrent_num`
@@ -1240,7 +1251,7 @@ broker scanner 的最大并发数。
是否为 Master FE 节点独有的配置项:true
-routine load V2 版本加载的默认等待作业数 ,这是一个理想的数字。 在某些情况下,例如切换 master,当前数量可能超过` desired_max_waiting_jobs`
+routine load V2 版本加载的默认等待作业数,这是一个理想的数字。在某些情况下,例如切换 master,当前数量可能超过` desired_max_waiting_jobs`
#### `disable_hadoop_load`
@@ -1250,7 +1261,7 @@ routine load V2 版本加载的默认等待作业数 ,这是一个理想的数
是否为 Master FE 节点独有的配置项:true
-默认不禁用,将来不推荐使用 hadoop 集群 load。 设置为 true 以禁用这种 load 方式。
+默认不禁用,将来不推荐使用 hadoop 集群 load。设置为 true 以禁用这种 load 方式。
#### `enable_spark_load`
@@ -1262,13 +1273,13 @@ routine load V2 版本加载的默认等待作业数 ,这是一个理想的数
是否临时启用 spark load,默认不启用
-**注意:** 这个参数在1.2版本中已经删除,默认开启spark_load
+**注意:** 这个参数在 1.2 版本中已经删除,默认开启 spark_load
#### `spark_load_checker_interval_second`
默认值:60
-Spark 负载调度程序运行间隔,默认 60 秒
+Spark 负载调度程序运行间隔,默认 60 秒
#### `async_loading_load_task_pool_size`
@@ -1278,7 +1289,7 @@ Spark 负载调度程序运行间隔,默认 60 秒
是否为 Master FE 节点独有的配置项:true
-`loading_load`任务执行程序池大小。 该池大小限制了正在运行的最大 `loading_load`任务数。
+`loading_load`任务执行程序池大小。该池大小限制了正在运行的最大 `loading_load`任务数。
当前,它仅限制 `broker load`的 `loading_load`任务的数量。
@@ -1290,7 +1301,7 @@ Spark 负载调度程序运行间隔,默认 60 秒
是否为 Master FE 节点独有的配置项:true
-`pending_load`任务执行程序池大小。 该池大小限制了正在运行的最大 `pending_load`任务数。
+`pending_load`任务执行程序池大小。该池大小限制了正在运行的最大 `pending_load`任务数。
当前,它仅限制 `broker load`和 `spark load`的 `pending_load`任务的数量。
@@ -1318,17 +1329,17 @@ Spark 负载调度程序运行间隔,默认 60 秒
#### `min_load_timeout_second`
-默认值:1 (1秒)
+默认值:1(1 秒)
是否可以动态配置:true
是否为 Master FE 节点独有的配置项:true
-最小超时时间,适用于所有类型的load
+最小超时时间,适用于所有类型的 load
#### `max_stream_load_timeout_second`
-默认值:259200 (3天)
+默认值:259200(3 天)
是否可以动态配置:true
@@ -1338,7 +1349,7 @@ stream load 和 mini load 最大超时时间
#### `max_load_timeout_second`
-默认值:259200 (3天)
+默认值:259200(3 天)
是否可以动态配置:true
@@ -1348,7 +1359,7 @@ load 最大超时时间,适用于除 stream load 之外的所有类型的加
#### `stream_load_default_timeout_second`
-默认值:86400 * 3 (3天)
+默认值:86400 * 3(3 天)
是否可以动态配置:true
@@ -1368,7 +1379,7 @@ load 最大超时时间,适用于除 stream load 之外的所有类型的加
#### `insert_load_default_timeout_second`
-默认值:3600(1小时)
+默认值:3600(1 小时)
是否可以动态配置:true
@@ -1378,7 +1389,7 @@ load 最大超时时间,适用于除 stream load 之外的所有类型的加
#### `mini_load_default_timeout_second`
-默认值:3600(1小时)
+默认值:3600(1 小时)
是否可以动态配置:true
@@ -1388,7 +1399,7 @@ load 最大超时时间,适用于除 stream load 之外的所有类型的加
#### `broker_load_default_timeout_second`
-默认值:14400(4小时)
+默认值:14400(4 小时)
是否可以动态配置:true
@@ -1398,7 +1409,7 @@ Broker load 的默认超时时间
#### `spark_load_default_timeout_second`
-默认值:86400 (1天)
+默认值:86400 (1 天)
是否可以动态配置:true
@@ -1408,7 +1419,7 @@ Broker load 的默认超时时间
#### `hadoop_load_default_timeout_second`
-默认值:86400 * 3 (3天)
+默认值:86400 * 3 (3 天)
是否可以动态配置:true
@@ -1424,7 +1435,7 @@ Hadoop 导入超时时间
是否为 Master FE 节点独有的配置项:true
-Load 任务数量限制,默认0,无限制
+Load 任务数量限制,默认 0,无限制
#### `load_input_size_limit_gb`
@@ -1434,7 +1445,7 @@ Load 任务数量限制,默认0,无限制
是否为 Master FE 节点独有的配置项:true
-Load 作业输入的数据大小,默认是0,无限制
+Load 作业输入的数据大小,默认是 0,无限制
#### `load_etl_thread_num_normal_priority`
@@ -1458,13 +1469,13 @@ NORMAL 优先级挂起加载作业的并发数。
默认值:3
-高优先级挂起加载作业的并发数。 加载作业优先级定义为 HIGH 或 NORMAL。 所有小批量加载作业都是 HIGH 优先级,其他类型的加载作业是 NORMAL 优先级。 设置优先级是为了避免慢加载作业长时间占用线程。 这只是内部优化的调度策略。 目前,您无法手动指定作业优先级。
+高优先级挂起加载作业的并发数。加载作业优先级定义为 HIGH 或 NORMAL。所有小批量加载作业都是 HIGH 优先级,其他类型的加载作业是 NORMAL 优先级。设置优先级是为了避免慢加载作业长时间占用线程。这只是内部优化的调度策略。目前,您无法手动指定作业优先级。
#### `load_checker_interval_second`
-默认值:5 (s)
+默认值:5(s)
-负载调度器运行间隔。 加载作业将其状态从 PENDING 转移到 LOADING 到 FINISHED。 加载调度程序将加载作业从 PENDING 转移到 LOADING 而 txn 回调会将加载作业从 LOADING 转移到 FINISHED。 因此,当并发未达到上限时,加载作业最多需要一个时间间隔才能完成。
+负载调度器运行间隔。加载作业将其状态从 PENDING 转移到 LOADING 到 FINISHED。加载调度程序将加载作业从 PENDING 转移到 LOADING 而 txn 回调会将加载作业从 LOADING 转移到 FINISHED。因此,当并发未达到上限时,加载作业最多需要一个时间间隔才能完成。
#### `load_straggler_wait_second`
@@ -1478,7 +1489,7 @@ NORMAL 优先级挂起加载作业的并发数。
例如:
有 3 个副本 A, B, C
load 已经在 t1 时仲裁完成 (A,B) 并且 C 没有完成,
- 如果 (current_time-t1)> 300s,那么 doris会将 C 视为故障节点,
+ 如果 (current_time-t1)> 300s,那么 doris 会将 C 视为故障节点,
将调用事务管理器提交事务并告诉事务管理器 C 失败。
这也用于等待发布任务时
@@ -1487,7 +1498,7 @@ NORMAL 优先级挂起加载作业的并发数。
#### `label_keep_max_second`
-默认值:3 * 24 * 3600 (3天)
+默认值:3 * 24 * 3600 (3 天)
是否可以动态配置:true
@@ -1496,23 +1507,23 @@ NORMAL 优先级挂起加载作业的并发数。
`label_keep_max_second `后将删除已完成或取消的加载作业的标签,
1. 去除的标签可以重复使用。
-2. 设置较短的时间会降低 FE 内存使用量 (因为所有加载作业的信息在被删除之前都保存在内存中)
+2. 设置较短的时间会降低 FE 内存使用量(因为所有加载作业的信息在被删除之前都保存在内存中)
-在高并发写的情况下,如果出现大量作业积压,出现 `call frontend service failed`的情况,查看日志如果是元数据写占用锁的时间太长,可以将这个值调成12小时,或者更小6小时
+在高并发写的情况下,如果出现大量作业积压,出现 `call frontend service failed`的情况,查看日志如果是元数据写占用锁的时间太长,可以将这个值调成 12 小时,或者更小 6 小时
#### `streaming_label_keep_max_second`
-默认值:43200 (12小时)
+默认值:43200(12 小时)
是否可以动态配置:true
是否为 Master FE 节点独有的配置项:true
-对于一些高频负载工作,例如:INSERT、STREAMING LOAD、ROUTINE_LOAD_TASK 。 如果过期,则删除已完成的作业或任务。
+对于一些高频负载工作,例如:INSERT、STREAMING LOAD、ROUTINE_LOAD_TASK。如果过期,则删除已完成的作业或任务。
#### `label_clean_interval_second`
-默认值:1 * 3600 (1小时)
+默认值:1 * 3600(1 小时)
load 标签清理器将每隔 `label_clean_interval_second` 运行一次以清理过时的作业。
@@ -1520,7 +1531,7 @@ load 标签清理器将每隔 `label_clean_interval_second` 运行一次以清
默认值:30
-如果事务 visible 或者 aborted 状态,事务将在 `transaction_clean_interval_second` 秒后被清除 ,我们应该让这个间隔尽可能短,每个清洁周期都尽快
+如果事务 visible 或者 aborted 状态,事务将在 `transaction_clean_interval_second` 秒后被清除,我们应该让这个间隔尽可能短,每个清洁周期都尽快
#### `sync_commit_interval_second`
@@ -1546,7 +1557,7 @@ load 标签清理器将每隔 `label_clean_interval_second` 运行一次以清
#### `min_sync_commit_size`
-提交事务需满足的最小 event 数量。若 Fe 接收到的 event 数量小于它,会继续等待下一批数据直到时间超过了 `sync_commit_interval_second ` 为止。默认值是 10000 个 events,如果你想修改此配置,请确保此值小于 canal 端的 `canal.instance.memory.buffer.size` 配置(默认16384),否则在 ack 前Fe会尝试获取比 store 队列长度更多的 event,导致 store 队列阻塞至超时为止。
+提交事务需满足的最小 event 数量。若 Fe 接收到的 event 数量小于它,会继续等待下一批数据直到时间超过了 `sync_commit_interval_second ` 为止。默认值是 10000 个 events,如果你想修改此配置,请确保此值小于 canal 端的 `canal.instance.memory.buffer.size` 配置(默认 16384),否则在 ack 前 Fe 会尝试获取比 store 队列长度更多的 event,导致 store 队列阻塞至超时为止。
默认值:10000
@@ -1566,7 +1577,7 @@ load 标签清理器将每隔 `label_clean_interval_second` 运行一次以清
#### `max_bytes_sync_commit`
-数据同步作业线程池中的最大线程数量。此线程池整个FE中只有一个,用于处理FE中所有数据同步作业向BE发送数据的任务 task,线程池的实现在 `SyncTaskPool` 类。
+数据同步作业线程池中的最大线程数量。此线程池整个 FE 中只有一个,用于处理 FE 中所有数据同步作业向 BE 发送数据的任务 task,线程池的实现在 `SyncTaskPool` 类。
默认值:10
@@ -1592,7 +1603,7 @@ load 标签清理器将每隔 `label_clean_interval_second` 运行一次以清
#### `export_task_default_timeout_second`
-默认值:2 * 3600 (2小时)
+默认值:2 * 3600(2 小时)
是否可以动态配置:true
@@ -1620,7 +1631,7 @@ load 标签清理器将每隔 `label_clean_interval_second` 运行一次以清
#### `log_roll_size_mb`
-默认值:1024 (1G)
+默认值:1024(1G)
一个系统日志和审计日志的最大大小
@@ -1630,9 +1641,9 @@ load 标签清理器将每隔 `label_clean_interval_second` 运行一次以清
sys_log_dir:
-这指定了 FE 日志目录。 FE 将产生 2 个日志文件:
+这指定了 FE 日志目录。FE 将产生 2 个日志文件:
-1. fe.log:FE进程的所有日志。
+1. fe.log:FE 进程的所有日志。
2. fe.warn.log FE 进程的所有警告和错误日志。
#### `sys_log_level`
@@ -1645,13 +1656,13 @@ sys_log_dir:
默认值:10
-要保存在 `sys_log_roll_interval ` 内的最大 FE 日志文件。 默认为 10,表示一天最多有 10 个日志文件
+要保存在 `sys_log_roll_interval ` 内的最大 FE 日志文件。默认为 10,表示一天最多有 10 个日志文件
#### `sys_log_verbose_modules`
默认值:{}
-详细模块。 VERBOSE 级别由 log4j DEBUG 级别实现。
+详细模块。VERBOSE 级别由 log4j DEBUG 级别实现。
例如:
sys_log_verbose_modules = org.apache.doris.catalog
@@ -1661,7 +1672,7 @@ sys_log_dir:
默认值:DAY
-可选项:
+可选项:
- DAY: log 前缀是 yyyyMMdd
- HOUR: log 前缀是 yyyyMMddHH
@@ -1683,13 +1694,13 @@ sys_log_dir:
默认值:SIZE-MB-1024
-日志拆分的大小,每1G拆分一个日志文件
+日志拆分的大小,每 1G 拆分一个日志文件
#### `sys_log_enable_compress`
默认值:false
-控制是否压缩fe log, 包括fe.log 及 fe.warn.log。如果开启,则使用gzip算法进行压缩。
+控制是否压缩 fe log, 包括 fe.log 及 fe.warn.log。如果开启,则使用 gzip 算法进行压缩。
#### `audit_log_dir`
@@ -1713,7 +1724,7 @@ sys_log_dir:
#### `qe_slow_log_ms`
-默认值:5000 (5秒)
+默认值:5000(5 秒)
如果查询的响应时间超过此阈值,则会在审计日志中记录为 slow_query。
@@ -1721,8 +1732,8 @@ sys_log_dir:
默认值:DAY
-DAY: log前缀是:yyyyMMdd
-HOUR: log前缀是:yyyyMMddHH
+DAY: log 前缀是:yyyyMMdd
+HOUR: log 前缀是:yyyyMMddHH
#### `audit_log_delete_age`
@@ -1732,7 +1743,7 @@ HOUR: log前缀是:yyyyMMddHH
支持格式:
- 7d 7 天
-- 10小时 10 小时
+- 10 小时 10 小时
- 60m 60 分钟
- 120s 120 秒
@@ -1740,7 +1751,7 @@ HOUR: log前缀是:yyyyMMddHH
默认值:false
-控制是否压缩 fe.audit.log。如果开启,则使用gzip算法进行压缩。
+控制是否压缩 fe.audit.log。如果开启,则使用 gzip 算法进行压缩。
### 存储
@@ -1748,7 +1759,7 @@ HOUR: log前缀是:yyyyMMddHH
默认值:1
-用于设置单个tablet的最小replication数量。
+用于设置单个 tablet 的最小 replication 数量。
#### `max_replication_num_per_tablet`
@@ -1781,7 +1792,7 @@ show data (其他用法:HELP SHOW DATA)
是否为 Master FE 节点独有的配置项:true
-用于设置默认数据库Replica数量配额大小,设置单个数据库配额大小可以使用:
+用于设置默认数据库 Replica 数量配额大小,设置单个数据库配额大小可以使用:
```
设置数据库Replica数量配额
@@ -1798,19 +1809,19 @@ show data (其他用法:HELP SHOW DATA)
是否为 Master FE 节点独有的配置项:true
-在某些情况下,某些 tablet 可能会损坏或丢失所有副本。 此时数据已经丢失,损坏的 tablet 会导致整个查询失败,无法查询剩余的健康 tablet。
+在某些情况下,某些 tablet 可能会损坏或丢失所有副本。此时数据已经丢失,损坏的 tablet 会导致整个查询失败,无法查询剩余的健康 tablet。
-在这种情况下,您可以将此配置设置为 true。 系统会将损坏的 tablet 替换为空 tablet,以确保查询可以执行。 (但此时数据已经丢失,所以查询结果可能不准确)
+在这种情况下,您可以将此配置设置为 true。系统会将损坏的 tablet 替换为空 tablet,以确保查询可以执行。 (但此时数据已经丢失,所以查询结果可能不准确)
#### `min_clone_task_timeout_sec` 和 `max_clone_task_timeout_sec`
-默认值:最小3分钟,最大两小时
+默认值:最小 3 分钟,最大两小时
是否可以动态配置:true
是否为 Master FE 节点独有的配置项:true
-`min_clone_task_timeout_sec` 和 `max_clone_task_timeout_sec` 用于限制克隆任务的最小和最大超时间。 一般情况下,克隆任务的超时时间是通过数据量和最小传输速度(5MB/s)来估计的。 但在特殊情况下,您可能需要手动设置这两个配置,以确保克隆任务不会因超时而失败。
+`min_clone_task_timeout_sec` 和 `max_clone_task_timeout_sec` 用于限制克隆任务的最小和最大超时间。一般情况下,克隆任务的超时时间是通过数据量和最小传输速度(5MB/s)来估计的。但在特殊情况下,您可能需要手动设置这两个配置,以确保克隆任务不会因超时而失败。
#### `disable_storage_medium_check`
@@ -1820,19 +1831,19 @@ show data (其他用法:HELP SHOW DATA)
是否为 Master FE 节点独有的配置项:true
-如果 disable_storage_medium_check 为true, ReportHandler 将不会检查 tablet 的存储介质, 并使得存储冷却功能失效,默认值为false。当您不关心 tablet 的存储介质是什么时,可以将值设置为true 。
+如果 disable_storage_medium_check 为 true,ReportHandler 将不会检查 tablet 的存储介质,并使得存储冷却功能失效,默认值为 false。当您不关心 tablet 的存储介质是什么时,可以将值设置为 true。
#### `decommission_tablet_check_threshold`
-默认值: 5000
+默认值:5000
-是否可以动态配置: true
+是否可以动态配置:true
是否为 Master FE 节点独有的配置项:true
-该配置用于控制FE是否执行检测(Decommission)BE上Tablets状态的阈值。如果(Decommission)BE上的Tablets个数大于0但小于该阈值,FE会定时对该BE开启一项检测,
+该配置用于控制 FE 是否执行检测(Decommission)BE 上 Tablets 状态的阈值。如果(Decommission)BE 上的 Tablets 个数大于 0 但小于该阈值,FE 会定时对该 BE 开启一项检测,
-如果该BE上的Tablets数量大于0但是所有Tablets均处于被回收的状态,那么FE会立即下线该(Decommission)BE。注意,不要把该值配置的太大,不然在Decommission阶段可能会对FE造成性能压力。
+如果该 BE 上的 Tablets 数量大于 0 但是所有 Tablets 均处于被回收的状态,那么 FE 会立即下线该(Decommission)BE。注意,不要把该值配置的太大,不然在 Decommission 阶段可能会对 FE 造成性能压力。
#### `partition_rebalance_max_moves_num_per_selection`
@@ -1842,7 +1853,7 @@ show data (其他用法:HELP SHOW DATA)
是否为 Master FE 节点独有的配置项:true
-仅在使用 PartitionRebalancer 时有效 ,
+仅在使用 PartitionRebalancer 时有效,
#### `partition_rebalance_move_expire_after_access`
@@ -1852,7 +1863,7 @@ show data (其他用法:HELP SHOW DATA)
是否为 Master FE 节点独有的配置项:true
-仅在使用 PartitionRebalancer 时有效。 如果更改,缓存的移动将被清除
+仅在使用 PartitionRebalancer 时有效。如果更改,缓存的移动将被清除
#### tablet_rebalancer_type
@@ -1860,7 +1871,7 @@ show data (其他用法:HELP SHOW DATA)
是否为 Master FE 节点独有的配置项:true
-rebalancer 类型(忽略大小写):BeLoad、Partition。 如果类型解析失败,默认使用 BeLoad
+rebalancer 类型(忽略大小写):BeLoad、Partition。如果类型解析失败,默认使用 BeLoad
#### `max_balancing_tablets`
@@ -1880,7 +1891,7 @@ rebalancer 类型(忽略大小写):BeLoad、Partition。 如果类型解
是否为 Master FE 节点独有的配置项:true
-如果 TabletScheduler 中调度的 tablet 数量超过 `max_scheduling_tablets`, 则跳过检查。
+如果 TabletScheduler 中调度的 tablet 数量超过 `max_scheduling_tablets`,则跳过检查。
#### `disable_balance`
@@ -1900,7 +1911,7 @@ rebalancer 类型(忽略大小写):BeLoad、Partition。 如果类型解
是否为 Master FE 节点独有的配置项:true
-如果设置为 true,TabletScheduler 将不会做单个BE上磁盘之间的 balance
+如果设置为 true,TabletScheduler 将不会做单个 BE 上磁盘之间的 balance
#### `balance_load_score_threshold`
@@ -1910,17 +1921,17 @@ rebalancer 类型(忽略大小写):BeLoad、Partition。 如果类型解
是否为 Master FE 节点独有的配置项:true
-集群 balance 百分比的阈值,如果一个BE的负载分数比平均分数低10%,这个后端将被标记为低负载,如果负载分数比平均分数高10%,将被标记为高负载。
+集群 balance 百分比的阈值,如果一个 BE 的负载分数比平均分数低 10%,这个后端将被标记为低负载,如果负载分数比平均分数高 10%,将被标记为高负载。
#### `capacity_used_percent_high_water`
-默认值:0.75 (75%)
+默认值:0.75(75%)
是否可以动态配置:true
是否为 Master FE 节点独有的配置项:true
-磁盘容量的高水位使用百分比。 这用于计算后端的负载分数
+磁盘容量的高水位使用百分比。这用于计算后端的负载分数
#### `clone_distribution_balance_threshold`
@@ -1930,7 +1941,7 @@ rebalancer 类型(忽略大小写):BeLoad、Partition。 如果类型解
是否为 Master FE 节点独有的配置项:true
-BE副本数的平衡阈值。
+BE 副本数的平衡阈值。
#### `clone_capacity_balance_threshold`
@@ -1944,11 +1955,11 @@ BE副本数的平衡阈值。
平衡算法为:
- 1. 计算整个集群的平均使用容量(AUC)(总数据大小/BE数)
+ 1. 计算整个集群的平均使用容量(AUC)(总数据大小/BE 数)
- 2. 高水位为(AUC * (1 + clone_capacity_balance_threshold))
+ 2. 高水位为 (AUC * (1 + clone_capacity_balance_threshold))
- 3. 低水位为(AUC * (1 - clone_capacity_balance_threshold))
+ 3. 低水位为 (AUC * (1 - clone_capacity_balance_threshold))
4. 克隆检查器将尝试将副本从高水位 BE 移动到低水位 BE。
@@ -1960,7 +1971,7 @@ BE副本数的平衡阈值。
是否为 Master FE 节点独有的配置项:true
-此配置可以设置为 true 以禁用自动 colocate 表的重新定位和平衡。 如果 `disable_colocate_balance'`设置为 true,则 ColocateTableBalancer 将不会重新定位和平衡并置表。
+此配置可以设置为 true 以禁用自动 colocate 表的重新定位和平衡。如果 `disable_colocate_balance'`设置为 true,则 ColocateTableBalancer 将不会重新定位和平衡并置表。
**注意:**
@@ -1986,7 +1997,7 @@ balance 时每个路径的默认 slot 数量
是否为 Master FE 节点独有的配置项:true
-如果设置为true,将关闭副本修复和均衡逻辑。
+如果设置为 true,将关闭副本修复和均衡逻辑。
#### `enable_force_drop_redundant_replica`
@@ -2007,8 +2018,8 @@ balance 时每个路径的默认 slot 数量
是否为 Master FE 节点独有的配置项:true
-重分布一个 Colocation Group 可能涉及大量的tablet迁移。因此,我们需要一个更保守的策略来避免不必要的 Colocation 重分布。
-重分布通常发生在 Doris 检测到有 BE 节点宕机后。这个参数用于推迟对BE宕机的判断。如默认参数下,如果 BE 节点能够在 1800 秒内恢复,则不会触发 Colocation 重分布。
+重分布一个 Colocation Group 可能涉及大量的 tablet 迁移。因此,我们需要一个更保守的策略来避免不必要的 Colocation 重分布。
+重分布通常发生在 Doris 检测到有 BE 节点宕机后。这个参数用于推迟对 BE 宕机的判断。如默认参数下,如果 BE 节点能够在 1800 秒内恢复,则不会触发 Colocation 重分布。
#### `allow_replica_on_same_host`
@@ -2028,7 +2039,7 @@ balance 时每个路径的默认 slot 数量
是否为 Master FE 节点独有的配置项:true
-如果设置为 true,会自动检测compaction比较慢的副本,并将迁移到其他机器,检测条件是 最慢副本的版本计数超过 `min_version_count_indicate_replica_compaction_too_slow` 的值, 且与最快副本的版本计数差异所占比例超过 `valid_version_count_delta_ratio_between_replicas` 的值
+如果设置为 true,会自动检测 compaction 比较慢的副本,并将迁移到其他机器,检测条件是 最慢副本的版本计数超过 `min_version_count_indicate_replica_compaction_too_slow` 的值,且与最快副本的版本计数差异所占比例超过 `valid_version_count_delta_ratio_between_replicas` 的值
#### `min_version_count_indicate_replica_compaction_too_slow`
@@ -2048,7 +2059,7 @@ balance 时每个路径的默认 slot 数量
是否为 Master FE 节点独有的配置项:false
-如果设置为true,则在选择可查询副本时,将跳过 compaction 较慢的副本
+如果设置为 true,则在选择可查询副本时,将跳过 compaction 较慢的副本
#### `valid_version_count_delta_ratio_between_replicas`
@@ -2078,7 +2089,7 @@ tablet 调度程序中每个路径的默认 slot 数量
#### `tablet_repair_delay_factor_second`
-默认值:60 (s)
+默认值:60(s)
是否可以动态配置:true
@@ -2093,14 +2104,14 @@ tablet 调度程序中每个路径的默认 slot 数量
#### `tablet_stat_update_interval_second`
-默认值:300,(5分钟)
+默认值:300,(5 分钟)
tablet 状态更新间隔
所有 FE 将在每个时间间隔从所有 BE 获取 tablet 统计信息
#### `storage_flood_stage_usage_percent`
-默认值:95 (95%)
+默认值:95(95%)
是否可以动态配置:true
@@ -2108,7 +2119,7 @@ tablet 状态更新间隔
#### `storage_flood_stage_left_capacity_bytes`
-默认值: 1 * 1024 * 1024 * 1024 (1GB)
+默认值:1 * 1024 * 1024 * 1024 (1GB)
是否可以动态配置:true
@@ -2135,31 +2146,31 @@ tablet 状态更新间隔
是否为 Master FE 节点独有的配置项:true
-`storage_high_watermark_usage_percent` 限制 BE 端存储路径使用最大容量百的分比。 `storage_min_left_capacity_bytes`限制 BE 端存储路径的最小剩余容量。 如果达到这两个限制,则不能选择此存储路径作为 tablet 存储目的地。 但是对于 tablet 恢复,我们可能会超过这些限制以尽可能保持数据完整性。
+`storage_high_watermark_usage_percent` 限制 BE 端存储路径使用最大容量百的分比。 `storage_min_left_capacity_bytes`限制 BE 端存储路径的最小剩余容量。如果达到这两个限制,则不能选择此存储路径作为 tablet 存储目的地。但是对于 tablet 恢复,我们可能会超过这些限制以尽可能保持数据完整性。
#### `catalog_trash_expire_second`
-默认值:86400L (1天)
+默认值:86400L (1 天)
是否可以动态配置:true
是否为 Master FE 节点独有的配置项:true
-删除数据库(表/分区)后,您可以使用 RECOVER stmt 恢复它。 这指定了最大数据保留时间。 一段时间后,数据将被永久删除。
+删除数据库(表/分区)后,您可以使用 RECOVER stmt 恢复它。这指定了最大数据保留时间。一段时间后,数据将被永久删除。
#### `storage_cooldown_second`
<version deprecated="2.0"></version>
-默认值:`30 * 24 * 3600L` (30天)
+默认值:`30 * 24 * 3600L` (30 天)
-创建表(或分区)时,可以指定其存储介质(HDD 或 SSD)。 如果设置为 SSD,这将指定tablet在 SSD 上停留的默认时间。 之后,tablet将自动移动到 HDD。 您可以在 `CREATE TABLE stmt` 中设置存储冷却时间。
+创建表(或分区)时,可以指定其存储介质(HDD 或 SSD)。如果设置为 SSD,这将指定 tablet 在 SSD 上停留的默认时间。之后,tablet 将自动移动到 HDD。您可以在 `CREATE TABLE stmt` 中设置存储冷却时间。
#### `default_storage_medium`
默认值:HDD
-创建表(或分区)时,可以指定其存储介质(HDD 或 SSD)。 如果未设置,则指定创建时的默认介质。
+创建表(或分区)时,可以指定其存储介质(HDD 或 SSD)。如果未设置,则指定创建时的默认介质。
#### `enable_storage_policy`
@@ -2173,13 +2184,13 @@ tablet 状态更新间隔
#### `check_consistency_default_timeout_second`
-默认值:600 (10分钟)
+默认值:600(10 分钟)
是否可以动态配置:true
是否为 Master FE 节点独有的配置项:true
-单个一致性检查任务的默认超时。 设置足够长以适合您的tablet大小。
+单个一致性检查任务的默认超时。设置足够长以适合您的 tablet 大小。
#### `consistency_check_start_time`
@@ -2245,17 +2256,17 @@ tablet 状态更新间隔
#### `alter_table_timeout_second`
-默认值:86400 * 30 (1月)
+默认值:86400 * 30(1 月)
是否可以动态配置:true
是否为 Master FE 节点独有的配置项:true
-ALTER TABLE 请求的最大超时时间。 设置足够长以适合您的表格数据大小
+ALTER TABLE 请求的最大超时时间。设置足够长以适合您的表格数据大小
#### `max_replica_count_when_schema_change`
-OlapTable在做schema change时,允许的最大副本数,副本数过大会导致FE OOM。
+OlapTable 在做 schema change 时,允许的最大副本数,副本数过大会导致 FE OOM。
默认值:100000
@@ -2265,17 +2276,17 @@ OlapTable在做schema change时,允许的最大副本数,副本数过大会
#### `history_job_keep_max_second`
-默认值:`7 * 24 * 3600` (7天)
+默认值:`7 * 24 * 3600` (7 天)
是否可以动态配置:true
是否为 Master FE 节点独有的配置项:true
-某些作业的最大保留时间。 像 schema 更改和 Rollup 作业。
+某些作业的最大保留时间。像 schema 更改和 Rollup 作业。
#### `max_create_table_timeout_second`
-默认值:1 * 3600 (1小时)
+默认值:1 * 3600(1 小时)
是否可以动态配置:true
@@ -2317,7 +2328,7 @@ multi catalog 并发文件扫描大小
`ADMIN SET FRONTEND CONFIG("key"="value") `方式进行设置
-**注意:** 这个参数在1.2版本中已经删除,默认启用ODBC外表,并且会在以后的某个版本中删除ODBC外表,推荐使用JDBC外表
+**注意:** 这个参数在 1.2 版本中已经删除,默认启用 ODBC 外表,并且会在以后的某个版本中删除 ODBC 外表,推荐使用 JDBC 外表
#### `disable_iceberg_hudi_table`
@@ -2327,7 +2338,7 @@ multi catalog 并发文件扫描大小
是否为 Master FE 节点独有的配置项:false
-从 1.2 版本开始,我们不再支持创建hudi和iceberg外表。请改用multi catalog功能。
+从 1.2 版本开始,我们不再支持创建 hudi 和 iceberg 外表。请改用 multi catalog 功能。
#### `iceberg_table_creation_interval_second`
@@ -2337,7 +2348,7 @@ multi catalog 并发文件扫描大小
是否为 Master FE 节点独有的配置项:false
-fe 将每隔 iceberg_table_creation_interval_second 创建iceberg table
+fe 将每隔 iceberg_table_creation_interval_second 创建 iceberg table
#### `iceberg_table_creation_strict_mode`
@@ -2352,7 +2363,7 @@ fe 将每隔 iceberg_table_creation_interval_second 创建iceberg table
#### `max_iceberg_table_creation_record_size`
-内存中可以存储的最近iceberg库表创建记录的默认最大数量
+内存中可以存储的最近 iceberg 库表创建记录的默认最大数量
默认值:2000
@@ -2470,7 +2481,7 @@ FE 会在每隔 es_state_sync_interval_secs 调用 es api 获取 es 索引分片
#### `spark_launcher_log_dir`
-默认值: sys_log_dir + "/spark_launcher_log"
+默认值:sys_log_dir + "/spark_launcher_log"
指定的 Spark 启动器日志目录
@@ -2498,7 +2509,7 @@ Spark 默认版本号
默认值:DorisFE.DORIS_HOME_DIR + "/temp_dir"
-temp dir 用于保存某些过程的中间结果,例如备份和恢复过程。 这些过程完成后,将清除此目录中的文件。
+temp dir 用于保存某些过程的中间结果,例如备份和恢复过程。这些过程完成后,将清除此目录中的文件。
#### `custom_config_dir`
@@ -2560,7 +2571,7 @@ SmallFileMgr 中存储的最大文件数
#### `report_queue_size`
-默认值: 100
+默认值:100
是否可以动态配置:true
@@ -2575,7 +2586,7 @@ SmallFileMgr 中存储的最大文件数
#### `backup_job_default_timeout_ms`
-默认值:86400 * 1000 (1天)
+默认值:86400 * 1000 (1 天)
是否可以动态配置:true
@@ -2635,7 +2646,7 @@ FE 将自动将 DecimalV2 转换为 DecimalV3。
是否为 Master FE 节点独有的配置项:false
-在ODBC、JDBC的MYSQL外部表查询时,是否将带函数的过滤条件下推到MYSQL中执行
+在 ODBC、JDBC 的 MYSQL 外部表查询时,是否将带函数的过滤条件下推到 MYSQL 中执行
#### `jdbc_drivers_dir`
@@ -2651,11 +2662,11 @@ FE 将自动将 DecimalV2 转换为 DecimalV3。
默认值:3;
-是否可以动态配置: true
+是否可以动态配置:true
是否为 Master FE 节点独有的配置项:true
-broker load job 保存的失败tablet 信息的最大数量
+broker load job 保存的失败 tablet 信息的最大数量
#### `default_db_max_running_txn_num`
@@ -2730,19 +2741,19 @@ show data (其他用法:HELP SHOW DATA)
默认值:4
-此变量表示增加与/运算符执行的除法操作结果规模的位数。默认为4。
+此变量表示增加与/运算符执行的除法操作结果规模的位数。默认为 4。
#### `enable_convert_light_weight_schema_change`
默认值:true
-暂时性配置项,开启后会启动后台线程自动将所有的olap表修改为可light schema change,修改结果可通过命令`show convert_light_schema_change [from db]` 来查看,将会展示所有非light schema change表的转换结果
+暂时性配置项,开启后会启动后台线程自动将所有的 olap 表修改为可 light schema change,修改结果可通过命令`show convert_light_schema_change [from db]` 来查看,将会展示所有非 light schema change 表的转换结果
#### `disable_local_deploy_manager_drop_node`
默认值:true
-禁止LocalDeployManager删除节点,防止cluster.info文件有误导致节点被删除。
+禁止 LocalDeployManager 删除节点,防止 cluster.info 文件有误导致节点被删除。
#### `mysqldb_replace_name`
@@ -2754,7 +2765,7 @@ Doris 为了兼用 mysql 周边工具生态,会内置一个名为 mysql 的数
默认值:2000
-对于自动分区表,防止用户意外创建大量分区,每个OLAP表允许的分区数量为`max_auto_partition_num`。默认2000。
+对于自动分区表,防止用户意外创建大量分区,每个 OLAP 表允许的分区数量为`max_auto_partition_num`。默认 2000。
#### `fe_thrift_max_pkg_bytes`
@@ -2764,4 +2775,4 @@ Doris 为了兼用 mysql 周边工具生态,会内置一个名为 mysql 的数
是否为 Master FE 节点独有的配置项:false
-用于限制fe节点thrift端口可以接收的最大包长度,避免接收到过大或者错误的包导致OOM
+用于限制 fe 节点 thrift 端口可以接收的最大包长度,避免接收到过大或者错误的包导致 OOM
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/user-property.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/user-property.md
index ff5723429672..84dfb3a4a07e 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/user-property.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/config/user-property.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# User 配置项
+
该文档主要介绍了 User 级别的相关配置项。User 级别的配置生效范围为单个用户。每个用户都可以设置自己的 User property。相互不影响。
@@ -38,7 +38,7 @@ FE 启动后,在 MySQL 客户端,通过下面命令查看 User 的配置项
## 设置配置项
-FE 启动后,在MySQL 客户端,通过下面命令修改 User 的配置项:
+FE 启动后,在 MySQL 客户端,通过下面命令修改 User 的配置项:
`SET PROPERTY [FOR 'user'] 'key' = 'value' [, 'key' = 'value']`
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/backup.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/backup.md
index fd577d57534f..7ccaf398b28e 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/backup.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/backup.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 数据备份
+
Doris 支持将当前数据以文件的形式,通过 broker 备份到远端存储系统中。之后可以通过 恢复 命令,从远端存储系统中将数据恢复到任意 Doris 集群。通过这个功能,Doris 可以支持将数据定期的进行快照备份。也可以通过这个功能,在不同集群间进行数据迁移。
@@ -46,7 +46,7 @@ Doris 支持将当前数据以文件的形式,通过 broker 备份到远端存
3. 动态分区表说明
- 如果该表是动态分区表,备份之后会自动禁用动态分区属性,在做恢复的时候需要手动将该表的动态分区属性启用,命令如下:
+ 如果该表是动态分区表,备份之后会自动禁用动态分区属性,在做恢复的时候需要手动将该表的动态分区属性启用,命令如下:
```sql
ALTER TABLE tbl1 SET ("dynamic_partition.enable"="true")
@@ -83,10 +83,11 @@ Doris 支持将当前数据以文件的形式,通过 broker 备份到远端存
"AWS_REGION" = "xxx"
);
```
-
- >注意:
- >
- >ON LOCATION 这里后面跟的是 Bucket Name
+ :::caution
+ 注意:
+
+ ON LOCATION 这里后面跟的是 Bucket Name
+ :::
2. 全量备份 example_db 下的表 example_tbl 到仓库 example_repo 中:
@@ -143,7 +144,7 @@ Doris 支持将当前数据以文件的形式,通过 broker 备份到远端存
1 row in set (0.15 sec)
```
-BACKUP的更多用法可参考 [这里](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/BACKUP.md)。
+BACKUP 的更多用法可参考 [这里](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/BACKUP)。
## 最佳实践
@@ -160,74 +161,103 @@ BACKUP的更多用法可参考 [这里](../../sql-manual/sql-reference/Data-Defi
## 重点说明
1. 备份恢复相关的操作目前只允许拥有 ADMIN 权限的用户执行。
+
2. 一个 Database 内,只允许有一个正在执行的备份或恢复作业。
+
3. 备份和恢复都支持最小分区(Partition)级别的操作,当表的数据量很大时,建议按分区分别执行,以降低失败重试的代价。
+
4. 因为备份恢复操作,操作的都是实际的数据文件。所以当一个表的分片过多,或者一个分片有过多的小版本时,可能即使总数据量很小,依然需要备份或恢复很长时间。用户可以通过 `SHOW PARTITIONS FROM table_name;` 和 `SHOW TABLETS FROM table_name;` 来查看各个分区的分片数量,以及各个分片的文件版本数量,来预估作业执行时间。文件数量对作业执行的时间影响非常大,所以建议在建表时,合理规划分区分桶,以避免过多的分片。
+
5. 当通过 `SHOW BACKUP` 或者 `SHOW RESTORE` 命令查看作业状态时。有可能会在 `TaskErrMsg` 一列中看到错误信息。但只要 `State` 列不为 `CANCELLED`,则说明作业依然在继续。这些 Task 有可能会重试成功。当然,有些 Task 错误,也会直接导致作业失败。
+
常见的`TaskErrMsg`错误如下:
- Q1:备份到HDFS,状态显示UPLOADING,TaskErrMsg 错误信息:[13333: Close broker writer failed, broker:TNetworkAddress(hostname=10.10.0.0,port=8000) msg:errors while close file output stream, cause by: DataStreamer Exception: ]
+ Q1:备份到 HDFS,状态显示 UPLOADING,TaskErrMsg 错误信息:[13333: Close broker writer failed, broker:TNetworkAddress(hostname=10.10.0.0,port=8000) msg:errors while close file output stream, cause by: DataStreamer Exception: ]
这个一般是网络通信问题,查看broker日志,看某个ip 或者端口不通,如果是云服务,则需要查看是否访问了内网,如果是,则可以在borker/conf文件夹下添加hdfs-site.xml,还需在hdfs-site.xml配置文件下添加dfs.client.use.datanode.hostname=true,并在broker节点上配置HADOOP集群的主机名映射。
+
6. 如果恢复作业是一次覆盖操作(指定恢复数据到已经存在的表或分区中),那么从恢复作业的 `COMMIT` 阶段开始,当前集群上被覆盖的数据有可能不能再被还原。此时如果恢复作业失败或被取消,有可能造成之前的数据已损坏且无法访问。这种情况下,只能通过再次执行恢复操作,并等待作业完成。因此,我们建议,如无必要,尽量不要使用覆盖的方式恢复数据,除非确认当前数据已不再使用。
## 相关命令
和备份恢复功能相关的命令如下。以下命令,都可以通过 mysql-client 连接 Doris 后,使用 `help cmd;` 的方式查看详细帮助。
-1. CREATE REPOSITORY
+**1. CREATE REPOSITORY**
+
+创建一个远端仓库路径,用于备份或恢复。该命令需要借助 Broker 进程访问远端存储,不同的 Broker 需要提供不同的参数,具体请参阅 [Broker 文档](../../data-operate/import/broker-load-manual),也可以直接通过 S3 协议备份到支持 AWS S3 协议的远程存储上去,也可以直接备份到 HDFS,具体参考 [创建远程仓库文档](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/CREATE-REPOSITORY)
+
+**2. BACKUP**
+
+执行一次备份操作。
+
+**3. SHOW BACKUP**
+
+查看最近一次 backup 作业的执行情况,包括:
+
+- JobId:本次备份作业的 id。
+
+- SnapshotName:用户指定的本次备份作业的名称(Label)。
+
+- DbName:备份作业对应的 Database。
+
+- State:备份作业当前所在阶段:
+
+ - PENDING:作业初始状态。
+
+ - SNAPSHOTING:正在进行快照操作。
+
+ - UPLOAD_SNAPSHOT:快照结束,准备上传。
+
+ - UPLOADING:正在上传快照。
+
+ - SAVE_META:正在本地生成元数据文件。
+
+ - UPLOAD_INFO:上传元数据文件和本次备份作业的信息。
+
+ - FINISHED:备份完成。
+
+ - CANCELLED:备份失败或被取消。
+
+- BackupObjs:本次备份涉及的表和分区的清单。
+
+- CreateTime:作业创建时间。
+
+- SnapshotFinishedTime:快照完成时间。
+
+- UploadFinishedTime:快照上传完成时间。
+
+- FinishedTime:本次作业完成时间。
+
+- UnfinishedTasks:在 `SNAPSHOTTING`,`UPLOADING` 等阶段,会有多个子任务在同时进行,这里展示的当前阶段,未完成的子任务的 task id。
- 创建一个远端仓库路径,用于备份或恢复。该命令需要借助 Broker 进程访问远端存储,不同的 Broker 需要提供不同的参数,具体请参阅 [Broker文档](../../advanced/broker.md),也可以直接通过S3 协议备份到支持AWS S3协议的远程存储上去,也可以直接备份到HDFS,具体参考 [创建远程仓库文档](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/CREATE-REPOSITORY.md)
+- TaskErrMsg:如果有子任务执行出错,这里会显示对应子任务的错误信息。
-2. BACKUP
+- Status:用于记录在整个作业过程中,可能出现的一些状态信息。
- 执行一次备份操作。
+- Timeout:作业的超时时间,单位是秒。
-3. SHOW BACKUP
+**4. SHOW SNAPSHOT**
- 查看最近一次 backup 作业的执行情况,包括:
+查看远端仓库中已存在的备份。
- - JobId:本次备份作业的 id。
- - SnapshotName:用户指定的本次备份作业的名称(Label)。
- - DbName:备份作业对应的 Database。
- - State:备份作业当前所在阶段:
- - PENDING:作业初始状态。
- - SNAPSHOTING:正在进行快照操作。
- - UPLOAD_SNAPSHOT:快照结束,准备上传。
- - UPLOADING:正在上传快照。
- - SAVE_META:正在本地生成元数据文件。
- - UPLOAD_INFO:上传元数据文件和本次备份作业的信息。
- - FINISHED:备份完成。
- - CANCELLED:备份失败或被取消。
- - BackupObjs:本次备份涉及的表和分区的清单。
- - CreateTime:作业创建时间。
- - SnapshotFinishedTime:快照完成时间。
- - UploadFinishedTime:快照上传完成时间。
- - FinishedTime:本次作业完成时间。
- - UnfinishedTasks:在 `SNAPSHOTTING`,`UPLOADING` 等阶段,会有多个子任务在同时进行,这里展示的当前阶段,未完成的子任务的 task id。
- - TaskErrMsg:如果有子任务执行出错,这里会显示对应子任务的错误信息。
- - Status:用于记录在整个作业过程中,可能出现的一些状态信息。
- - Timeout:作业的超时时间,单位是秒。
+- Snapshot:备份时指定的该备份的名称(Label)。
-4. SHOW SNAPSHOT
+- Timestamp:备份的时间戳。
- 查看远端仓库中已存在的备份。
+- Status:该备份是否正常。
- - Snapshot:备份时指定的该备份的名称(Label)。
- - Timestamp:备份的时间戳。
- - Status:该备份是否正常。
+如果在 `SHOW SNAPSHOT` 后指定了 where 子句,则可以显示更详细的备份信息。
- 如果在 `SHOW SNAPSHOT` 后指定了 where 子句,则可以显示更详细的备份信息。
+- Database:备份时对应的 Database。
- - Database:备份时对应的 Database。
- - Details:展示了该备份完整的数据目录结构。
+- Details:展示了该备份完整的数据目录结构。
-5. CANCEL BACKUP
+**5. CANCEL BACKUP**
- 取消当前正在执行的备份作业。
+取消当前正在执行的备份作业。
-6. DROP REPOSITORY
+**6. DROP REPOSITORY**
- 删除已创建的远端仓库。删除仓库,仅仅是删除该仓库在 Doris 中的映射,不会删除实际的仓库数据。
+删除已创建的远端仓库。删除仓库,仅仅是删除该仓库在 Doris 中的映射,不会删除实际的仓库数据。
## 更多帮助
- 关于 BACKUP 使用的更多详细语法及最佳实践,请参阅 [BACKUP](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/BACKUP.md) 命令手册,你也可以在 MySql 客户端命令行下输入 `HELP BACKUP` 获取更多帮助信息。
+ 关于 BACKUP 使用的更多详细语法及最佳实践,请参阅 [BACKUP](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/BACKUP) 命令手册,你也可以在 MySql 客户端命令行下输入 `HELP BACKUP` 获取更多帮助信息。
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/ccr.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/ccr.md
new file mode 100644
index 000000000000..38cd422b8330
--- /dev/null
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/ccr.md
@@ -0,0 +1,637 @@
+---
+{
+ "title": "跨集群数据同步",
+ "language": "zh-CN"
+}
+---
+
+<!--
+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.
+-->
+
+## 概览
+
+CCR(Cross Cluster Replication) 是跨级群数据同步,能够在库/表级别将源集群的数据变更同步到目标集群,可用于在线服务的数据可用性、隔离在离线负载、建设两地三中心。
+
+CCR 通常被用于容灾备份、读写分离、集团与公司间数据传输和隔离升级等场景。
+
+- 容灾备份:通常是将企业的数据备份到另一个集群与机房中,当突发事件导致业务中断或丢失时,可以从备份中恢复数据或快速进行主备切换。一般在对 SLA 要求比较高的场景中,都需要进行容灾备份,比如在金融、医疗、电子商务等领域中比较常见。
+
+- 读写分离:读写分离是将数据的查询操作和写入操作进行分离,目的是降低读写操作的相互影响并提升资源的利用率。比如在数据库写入压力过大或在高并发场景中,采用读写分离可以将读/写操作分散到多个地域的只读/只写的数据库案例上,减少读写间的互相影响,有效保证数据库的性能及稳定性。
+
+- 集团与分公司间数据传输:集团总部为了对集团内数据进行统一管控和分析,通常需要分布在各地域的分公司及时将数据传输同步到集团总部,避免因为数据不一致而引起的管理混乱和决策错误,有利于提高集团的管理效率和决策质量。
+
+- 隔离升级:当在对系统集群升级时,有可能因为某些原因需要进行版本回滚,传统的升级模式往往会因为元数据不兼容的原因无法回滚。而使用 CCR 可以解决该问题,先构建一个备用的集群进行升级并双跑验证,用户可以依次升级各个集群,同时 CCR 也不依赖特定版本,使版本的回滚变得可行。
+
+## 原理
+
+### 名词解释
+
+源集群:源头集群,业务数据写入的集群,需要 2.0 版本
+
+目标集群:跨集群同步的目标集群,需要 2.0 版本
+
+binlog:源集群的变更日志,包括 schema 和数据变更
+
+syncer:一个轻量级的进程
+
+### 架构说明
+
+
+
+
+CCR 工具主要依赖一个轻量级进程:Syncers。Syncers 会从源集群获取 binlog,直接将元数据应用于目标集群,通知目标集群从源集群拉取数据。从而实现全量和增量迁移。
+
+## 使用
+
+使用非常简单,只需把 Syncers 服务启动,给他发一个命令,剩下的交给 Syncers 完成就行。
+
+**1. 部署源 Doris 集群**
+
+**2. 部署目标 Doris 集群**
+
+**3. 首先源集群和目标集群都需要打开 binlog,在源集群和目标集群的 fe.conf 和 be.conf 中配置如下信息:**
+
+```sql
+enable_feature_binlog=true
+```
+
+**4. 部署 syncers**
+
+1. 构建 CCR syncer
+
+ ```Bash
+ git clone https://github.com/selectdb/ccr-syncer
+
+ cd ccr-syncer
+
+ bash build.sh <-j NUM_OF_THREAD> <--output SYNCER_OUTPUT_DIR>
+
+ cd SYNCER_OUTPUT_DIR# 联系相关同学免费获取 ccr 二进制包
+ ```
+
+2. 启动和停止 syncer
+
+ ```Bash
+ # 启动
+ cd bin && sh start_syncer.sh --daemon
+
+ # 停止
+ sh stop_syncer.sh
+ ```
+
+**5. 打开源集群中同步库/表的 Binlog**
+
+```Bash
+-- 如果是整库同步,可以执行如下脚本,使得该库下面所有的表都要打开 binlog.enable
+vim shell/enable_db_binlog.sh
+修改源集群的 host、port、user、password、db
+或者 ./enable_db_binlog.sh --host $host --port $port --user $user --password $password --db $db
+
+-- 如果是单表同步,则只需要打开 table 的 binlog.enable,在源集群上执行:
+ALTER TABLE enable_binlog SET ("binlog.enable" = "true");
+```
+
+**6. 向 syncer 发起同步任务**
+
+```Bash
+curl -X POST -H "Content-Type: application/json" -d '{
+ "name": "ccr_test",
+ "src": {
+ "host": "localhost",
+ "port": "9030",
+ "thrift_port": "9020",
+ "user": "root",
+ "password": "",
+ "database": "your_db_name",
+ "table": "your_table_name"
+ },
+ "dest": {
+ "host": "localhost",
+ "port": "9030",
+ "thrift_port": "9020",
+ "user": "root",
+ "password": "",
+ "database": "your_db_name",
+ "table": "your_table_name"
+ }
+}' http://127.0.0.1:9190/create_ccr
+```
+
+同步任务的参数说明:
+
+```Bash
+name: CCR同步任务的名称,唯一即可
+host、port:对应集群 Master FE的host和mysql(jdbc) 的端口
+user、password:syncer以何种身份去开启事务、拉取数据等
+database、table:
+如果是db级别的同步,则填入your_db_name,your_table_name为空
+如果是表级别同步,则需要填入your_db_name,your_table_name
+向syncer发起同步任务中的name只能使用一次
+```
+
+## Syncer 详细操作手册
+
+### 启动 Syncer 说明
+
+根据配置选项启动 Syncer,并且在默认或指定路径下保存一个 pid 文件,pid 文件的命名方式为`host_port.pid`。
+
+**输出路径下的文件结构**
+
+在编译完成后的输出路径下,文件结构大致如下所示:
+
+```sql
+output_dir
+ bin
+ ccr_syncer
+ enable_db_binlog.sh
+ start_syncer.sh
+ stop_syncer.sh
+ db
+ [ccr.db] # 默认配置下运行后生成
+ log
+ [ccr_syncer.log] # 默认配置下运行后生成
+```
+
+:::caution
+**后文中的 start_syncer.sh 指的是该路径下的 start_syncer.sh!!!**
+:::
+
+**启动选项**
+
+1. --daemon
+
+后台运行 Syncer,默认为 false
+
+```sql
+bash bin/start_syncer.sh --daemon
+```
+
+2. --db_type
+
+Syncer 目前能够使用两种数据库来保存自身的元数据,分别为`sqlite3`(对应本地存储)和`mysql`(本地或远端存储)
+
+```sql
+bash bin/start_syncer.sh --db_type mysql
+```
+
+默认值为 sqlite3
+
+在使用 mysql 存储元数据时,Syncer 会使用`CREATE IF NOT EXISTS`来创建一个名为`ccr`的库,ccr 相关的元数据表都会保存在其中
+
+3. --db_dir
+
+**这个选项仅在 db 使用****`sqlite3`****时生效**
+
+可以通过此选项来指定 sqlite3 生成的 db 文件名及路径。
+
+```sql
+bash bin/start_syncer.sh --db_dir /path/to/ccr.db
+```
+
+默认路径为`SYNCER_OUTPUT_DIR/db`,文件名为`ccr.db`
+
+4. --db_host & db_port & db_user & db_password
+
+**这个选项仅在 db 使用****`mysql`****时生效**
+
+```sql
+bash bin/start_syncer.sh --db_host 127.0.0.1 --db_port 3306 --db_user root --db_password "qwe123456"
+```
+
+db_host、db_port 的默认值如例子中所示,db_user、db_password 默认值为空
+
+5. --log_dir
+
+日志的输出路径
+
+```sql
+bash bin/start_syncer.sh --log_dir /path/to/ccr_syncer.log
+```
+
+默认路径为`SYNCER_OUTPUT_DIR/log`,文件名为`ccr_syncer.log`
+
+6. --log_level
+
+用于指定 Syncer 日志的输出等级。
+
+```sql
+bash bin/start_syncer.sh --log_level info
+```
+
+日志的格式如下,其中 hook 只会在`log_level > info`的时候打印:
+
+```sql
+# time level msg hooks
+[2023-07-18 16:30:18] TRACE This is trace type. ccrName=xxx line=xxx
+[2023-07-18 16:30:18] DEBUG This is debug type. ccrName=xxx line=xxx
+[2023-07-18 16:30:18] INFO This is info type. ccrName=xxx line=xxx
+[2023-07-18 16:30:18] WARN This is warn type. ccrName=xxx line=xxx
+[2023-07-18 16:30:18] ERROR This is error type. ccrName=xxx line=xxx
+[2023-07-18 16:30:18] FATAL This is fatal type. ccrName=xxx line=xxx
+```
+
+在--daemon 下,log_level 默认值为`info`
+
+在前台运行时,log_level 默认值为`trace`,同时日志会通过 tee 来保存到 log_dir
+
+6. --host && --port
+
+用于指定 Syncer 的 host 和 port,其中 host 只起到在集群中的区分自身的作用,可以理解为 Syncer 的 name,集群中 Syncer 的名称为`host:port`
+
+```sql
+bash bin/start_syncer.sh --host 127.0.0.1 --port 9190
+```
+
+host 默认值为 127.0.0.1,port 的默认值为 9190
+
+7. --pid_dir
+
+用于指定 pid 文件的保存路径
+
+pid 文件是 stop_syncer.sh 脚本用于关闭 Syncer 的凭据,里面保存了对应 Syncer 的进程号,为了方便 Syncer 的集群化管理,可以指定 pid 文件的保存路径
+
+```sql
+bash bin/start_syncer.sh --pid_dir /path/to/pids
+```
+
+默认值为`SYNCER_OUTPUT_DIR/bin`
+
+### Syncer 停止说明
+
+根据默认或指定路径下 pid 文件中的进程号关闭对应 Syncer,pid 文件的命名方式为`host_port.pid`。
+
+**输出路径下的文件结构**
+
+在编译完成后的输出路径下,文件结构大致如下所示:
+
+```Bash
+output_dir
+ bin
+ ccr_syncer
+ enable_db_binlog.sh
+ start_syncer.sh
+ stop_syncer.sh
+ db
+ [ccr.db] # 默认配置下运行后生成
+ log
+ [ccr_syncer.log] # 默认配置下运行后生成
+```
+:::caution
+**后文中的 stop_syncer.sh 指的是该路径下的 stop_syncer.sh!!!**
+:::
+
+**停止选项**
+
+有三种关闭方法:
+
+1. 关闭目录下单个 Syncer
+
+ 指定要关闭 Syncer 的 host && port,注意要与 start_syncer 时指定的 host 一致
+
+2. 批量关闭目录下指定 Syncer
+
+ 指定要关闭的 pid 文件名,以空格分隔,用`" "`包裹
+
+3. 关闭目录下所有 Syncer
+
+ 默认即可
+
+1. --pid_dir
+
+指定 pid 文件所在目录,上述三种关闭方法都依赖于 pid 文件的所在目录执行
+
+```Bash
+bash bin/stop_syncer.sh --pid_dir /path/to/pids
+```
+
+例子中的执行效果就是关闭`/path/to/pids`下所有 pid 文件对应的 Syncers(**方法 3**),`--pid_dir`可与上面三种关闭方法组合使用。
+
+默认值为`SYNCER_OUTPUT_DIR/bin`
+
+2. --host && --port
+
+关闭 pid_dir 路径下 host:port 对应的 Syncer
+
+```Bash
+bash bin/stop_syncer.sh --host 127.0.0.1 --port 9190
+```
+
+host 的默认值为 127.0.0.1,port 默认值为空
+
+即,单独指定 host 时**方法 1**不生效,会退化为**方法 3**。
+
+host 与 port 都不为空时**方法 1**才能生效
+
+3. --files
+
+关闭 pid_dir 路径下指定 pid 文件名对应的 Syncer
+
+```Bash
+bash bin/stop_syncer.sh --files "127.0.0.1_9190.pid 127.0.0.1_9191.pid"
+```
+
+文件之间用空格分隔,整体需要用`" "`包裹住
+
+### Syncer 操作列表
+
+**请求的通用模板**
+
+```Bash
+curl -X POST -H "Content-Type: application/json" -d {json_body} http://ccr_syncer_host:ccr_syncer_port/operator
+```
+
+json_body: 以 json 的格式发送操作所需信息
+
+operator:对应 Syncer 的不同操作
+
+所以接口返回都是 json, 如果成功则是其中 success 字段为 true, 类似,错误的时候,是 false,然后存在`ErrMsgs`字段
+
+```JSON
+{"success":true}
+
+or
+
+{"success":false,"error_msg":"job ccr_test not exist"}
+```
+
+### operators
+
+- create_ccr
+
+ 创建 CCR 任务
+
+ ```Bash
+ curl -X POST -H "Content-Type: application/json" -d '{
+ "name": "ccr_test",
+ "src": {
+ "host": "localhost",
+ "port": "9030",
+ "thrift_port": "9020",
+ "user": "root",
+ "password": "",
+ "database": "demo",
+ "table": "example_tbl"
+ },
+ "dest": {
+ "host": "localhost",
+ "port": "9030",
+ "thrift_port": "9020",
+ "user": "root",
+ "password": "",
+ "database": "ccrt",
+ "table": "copy"
+ }
+ }' http://127.0.0.1:9190/create_ccr
+ ```
+
+- name: CCR 同步任务的名称,唯一即可
+
+- host、port:对应集群 master 的 host 和 mysql(jdbc) 的端口
+
+- thrift_port:对应 FE 的 rpc_port
+
+- user、password:syncer 以何种身份去开启事务、拉取数据等
+
+- database、table:
+
+ - 如果是 db 级别的同步,则填入 dbName,tableName 为空
+
+ - 如果是表级别同步,则需要填入 dbName、tableName
+
+- get_lag
+
+ 查看同步进度
+
+ ```Bash
+ curl -X POST -H "Content-Type: application/json" -d '{
+ "name": "job_name"
+ }' http://ccr_syncer_host:ccr_syncer_port/get_lag
+ ```
+
+ 其中 job_name 是 create_ccr 时创建的 name
+
+- pause
+
+ 暂停同步任务
+
+ ```Bash
+ curl -X POST -H "Content-Type: application/json" -d '{
+ "name": "job_name"
+ }' http://ccr_syncer_host:ccr_syncer_port/pause
+ ```
+
+- resume
+
+ 恢复同步任务
+
+ ```Bash
+ curl -X POST -H "Content-Type: application/json" -d '{
+ "name": "job_name"
+ }' http://ccr_syncer_host:ccr_syncer_port/resume
+ ```
+
+- delete
+
+ 删除同步任务
+
+ ```Bash
+ curl -X POST -H "Content-Type: application/json" -d '{
+ "name": "job_name"
+ }' http://ccr_syncer_host:ccr_syncer_port/delete
+ ```
+
+- version
+
+ 获取版本信息
+
+ ```Bash
+ curl http://ccr_syncer_host:ccr_syncer_port/version
+
+ # > return
+ {"version": "2.0.1"}
+ ```
+
+- job status
+
+ 查看 job 的状态
+
+ ```Bash
+ curl -X POST -H "Content-Type: application/json" -d '{
+ "name": "job_name"
+ }' http://ccr_syncer_host:ccr_syncer_port/job_status
+
+ {
+ "success": true,
+ "status": {
+ "name": "ccr_db_table_alias",
+ "state": "running",
+ "progress_state": "TableIncrementalSync"
+ }
+ }
+ ```
+
+- desync job
+
+ 不做 sync,此时用户可以将源和目的集群互换
+
+ ```Bash
+ curl -X POST -H "Content-Type: application/json" -d '{
+ "name": "job_name"
+ }' http://ccr_syncer_host:ccr_syncer_port/desync
+ ```
+
+- list_jobs
+
+ 展示已经创建的所有任务
+
+ ```Bash
+ curl http://ccr_syncer_host:ccr_syncer_port/list_jobs
+
+ {"success":true,"jobs":["ccr_db_table_alias"]}
+ ```
+
+### 开启库中所有表的 binlog
+
+**输出路径下的文件结构**
+
+在编译完成后的输出路径下,文件结构大致如下所示:
+
+```Bash
+output_dir
+ bin
+ ccr_syncer
+ enable_db_binlog.sh
+ start_syncer.sh
+ stop_syncer.sh
+ db
+ [ccr.db] # 默认配置下运行后生成
+ log
+ [ccr_syncer.log] # 默认配置下运行后生成
+```
+:::caution
+**后文中的 enable_db_binlog.sh 指的是该路径下的 enable_db_binlog.sh!!!**
+:::
+
+**使用说明**
+
+```Bash
+bash bin/enable_db_binlog.sh -h host -p port -u user -P password -d db
+```
+
+## Syncer 高可用
+
+Syncer 高可用依赖 mysql,如果使用 mysql 作为后端存储,Syncer 可以发现其它 syncer,如果一个 crash 了,其他会分担他的任务
+
+### 权限要求
+
+1. Select_priv 对数据库、表的只读权限。
+
+2. Load_priv 对数据库、表的写权限。包括 Load、Insert、Delete 等。
+
+3. Alter_priv 对数据库、表的更改权限。包括重命名 库/表、添加/删除/变更 列、添加/删除 分区等操作。
+
+4. Create_priv 创建数据库、表、视图的权限。
+
+5. Drop_priv 删除数据库、表、视图的权限。
+
+加上 Admin 权限 (之后考虑彻底移除), 这个是用来检测 enable binlog config 的,现在需要 admin
+
+## 使用限制
+
+### 网络约束
+
+- 需要 Syncer 与上下游的 FE 和 BE 都是通的
+
+- 下游 BE 与上游 BE 是通的
+
+- 对外 IP 和 Doris 内部 IP 是一样的,也就是说`show frontends/backends`看到的,和能直接连的 IP 是一致的,要是直连,不能是 IP 转发或者 nat
+
+### ThriftPool 限制
+
+开大 thrift thread pool 大小,最好是超过一次 commit 的 bucket 数目大小
+
+### 版本要求
+
+版本最低要求:v2.0.3
+
+### 不支持的操作
+
+- rename table 支持有点问题
+
+- 不支持一些 trash 的操作,比如 table 的 drop-recovery 操作
+
+- 和 rename table 有关的,replace partition 与
+
+- 不能发生在同一个 db 上同时 backup/restore
+
+## Feature
+
+### 限速
+
+BE 端配置参数
+
+```Bash
+download_binlog_rate_limit_kbs=1024 # 这就是限制到1MB,这个是单个be对所有关于binlog 包括local snapshot的配置
+```
+
+## IS_BEING_SYNCED 属性
+
+从 Doris v2.0 "is_being_synced" = "true"
+
+CCR 功能在建立同步时,会在目标集群中创建源集群同步范围中表(后称源表,位于源集群)的副本表(后称目标表,位于目标集群),但是在创建副本表时需要失效或者擦除一些功能和属性以保证同步过程中的正确性。
+
+如:
+
+- 源表中包含了可能没有被同步到目标集群的信息,如`storage_policy`等,可能会导致目标表创建失败或者行为异常。
+
+- 源表中可能包含一些动态功能,如动态分区等,可能导致目标表的行为不受 syncer 控制导致 partition 不一致。
+
+在被复制时因失效而需要擦除的属性有:
+
+- `storage_policy`
+
+- `colocate_with`
+
+在被同步时需要失效的功能有:
+
+- 自动分桶
+
+- 动态分区
+
+### 实现
+
+在创建目标表时,这条属性将会由 syncer 控制添加或者删除,在 CCR 功能中,创建一个目标表有两个途径:
+
+1. 在表同步时,syncer 通过 backup/restore 的方式对源表进行全量复制来得到目标表。
+
+2. 在库同步时,对于存量表而言,syncer 同样通过 backup/restore 的方式来得到目标表,对于增量表而言,syncer 会通过携带有 CreateTableRecord 的 binlog 来创建目标表。
+
+综上,对于插入`is_being_synced`属性有两个切入点:全量同步中的 restore 过程和增量同步时的 getDdlStmt。
+
+在全量同步的 restore 过程中,syncer 会通过 rpc 发起对原集群中 snapshot 的 restore,在这个过程中为会为 RestoreStmt 添加`is_being_synced`属性,并在最终的 restoreJob 中生效,执行`isBeingSynced`的相关逻辑。在增量同步时的 getDdlStmt 中,为 getDdlStmt 方法添加参数`boolean getDdlForSync`,以区分是否为受控转化为目标表 ddl 的操作,并在创建目标表时执行`isBeingSynced`的相关逻辑。
+
+对于失效属性的擦除无需多言,对于上述功能的失效需要进行说明:
+
+- 自动分桶 自动分桶会在创建表时生效,计算当前合适的 bucket 数量,这就可能导致源表和目的表的 bucket 数目不一致。因此在同步时需要获得源表的 bucket 数目,并且也要获得源表是否为自动分桶表的信息以便结束同步后恢复功能。当前的做法是在获取 distribution 信息时默认 autobucket 为 false,在恢复表时通过检查`_auto_bucket`属性来判断源表是否为自动分桶表,如是则将目标表的 autobucket 字段设置为 true,以此来达到跳过计算 bucket 数量,直接应用源表 bucket 数量的目的。
+
+- 动态分区 动态分区则是通过将`olapTable.isBeingSynced()`添加到是否执行 add/drop partition 的判断中来实现的,这样目标表在被同步的过程中就不会周期性的执行 add/drop partition 操作。
+
+### 注意
+
+在未出现异常时,`is_being_synced`属性应该完全由 syncer 控制开启或关闭,用户不要自行修改该属性。
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/data-recovery.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/data-recovery.md
index 1cff225d7e60..e885a4e2111c 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/data-recovery.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/data-recovery.md
@@ -1,6 +1,6 @@
---
{
- "title": "数据恢复",
+ "title": "主键表数据修复",
"language": "zh-CN"
}
---
@@ -26,7 +26,7 @@ under the License.
# 数据恢复
-对于Unique Key Merge on Write表,在某些Doris的版本中存在bug,可能会导致系统在计算delete bitmap时出现错误,导致出现重复主键,此时可以利用full compaction功能进行数据的修复。本功能对于非Unique Key Merge on Write表无效。
+对于 Unique Key Merge on Write 表,在某些 Doris 的版本中存在 bug,可能会导致系统在计算 delete bitmap 时出现错误,导致出现重复主键,此时可以利用 full compaction 功能进行数据的修复。本功能对于非 Unique Key Merge on Write 表无效。
该功能需要 Doris 版本 2.0+。
@@ -34,7 +34,7 @@ under the License.
## 简要原理说明
-执行full compaction后,会对delete bitmap进行重新计算,将错误的delete bitmap数据删除,以完成数据的修复。
+执行 full compaction 后,会对 delete bitmap 进行重新计算,将错误的 delete bitmap 数据删除,以完成数据的修复。
## 使用说明
@@ -44,7 +44,7 @@ under the License.
`POST /api/compaction/run?table_id={int}&compact_type=full`
-注意,tablet_id和table_id只能指定一个,不能够同时指定,指定table_id后会自动对此table下所有tablet执行full_compaction。
+注意,tablet_id 和 table_id 只能指定一个,不能够同时指定,指定 table_id 后会自动对此 table 下所有 tablet 执行 full_compaction。
## 使用例子
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/delete-recover.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/delete-recover.md
index dc3f5c28b902..5cd287e1b6a7 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/delete-recover.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/delete-recover.md
@@ -1,6 +1,6 @@
---
{
- "title": "数据删除恢复",
+ "title": "数据删除的恢复",
"language": "zh-CN"
}
---
@@ -24,32 +24,33 @@ specific language governing permissions and limitations
under the License.
-->
-# 数据删除恢复
+
数据删除恢复包含两种情况:
-1. 用户执行命令`drop database/table/partition`之后,再使用命令`recover`来恢复整个数据库/表/分区的所有数据。这种修复将会把FE上的数据库/表/分区的结构,从catalog回收站里恢复过来,把它们从不可见状态,重新变回可见,并且原来的数据也恢复可见;
-2. 用户因为某些误操作或者线上bug,导致BE上部分tablet被删除,通过运维工具把这些tablet从BE回收站中抢救回来。
+1. 用户执行命令`drop database/table/partition`之后,再使用命令`recover`来恢复整个数据库/表/分区的所有数据。这种修复将会把 FE 上的数据库/表/分区的结构,从 catalog 回收站里恢复过来,把它们从不可见状态,重新变回可见,并且原来的数据也恢复可见;
+
+2. 用户因为某些误操作或者线上 bug,导致 BE 上部分 tablet 被删除,通过运维工具把这些 tablet 从 BE 回收站中抢救回来。
-上面两个,前者针对的是数据库/表/分区在FE上已经不可见,且数据库/表/分区的元数据尚保留在FE的catalog回收站里。而后者针对的是数据库/表/分区在FE上可见,但部分BE tablet数据被删除。
+上面两个,前者针对的是数据库/表/分区在 FE 上已经不可见,且数据库/表/分区的元数据尚保留在 FE 的 catalog 回收站里。而后者针对的是数据库/表/分区在 FE 上可见,但部分 BE tablet 数据被删除。
下面分别阐述这两种恢复。
## Drop 恢复
-Doris为了避免误操作造成的灾难,支持对误删除的数据库/表/分区进行数据恢复,在drop table或者 drop database 或者 drop partition之后,Doris不会立刻对数据进行物理删除,而是在FE的catalog回收站中保留一段时间(默认1天,可通过fe.conf中`catalog_trash_expire_second`参数配置),管理员可以通过RECOVER命令对误删除的数据进行恢复。
+Doris 为了避免误操作造成的灾难,支持对误删除的数据库/表/分区进行数据恢复,在 drop table 或者 drop database 或者 drop partition 之后,Doris 不会立刻对数据进行物理删除,而是在 FE 的 catalog 回收站中保留一段时间(默认 1 天,可通过 fe.conf 中`catalog_trash_expire_second`参数配置),管理员可以通过 RECOVER 命令对误删除的数据进行恢复。
**注意,如果是使用`drop force`进行删除的,则是直接删除,无法再恢复。**
### 查看可恢复数据
-查看FE上哪些数据可恢复
+查看 FE 上哪些数据可恢复
```sql
SHOW CATALOG RECYCLE BIN [ WHERE NAME [ = "name" | LIKE "name_matcher"] ]
```
-这里name可以是数据库/表/分区名。
+这里 name 可以是数据库/表/分区名。
关于该命令使用的更多详细语法及最佳实践,请参阅 [SHOW-CATALOG-RECYCLE-BIN](../../sql-manual/sql-reference/Show-Statements/SHOW-CATALOG-RECYCLE-BIN.md) 命令手册,你也可以在 MySql 客户端命令行下输入 `help SHOW CATALOG RECYCLE BIN ` 获取更多帮助信息。
@@ -82,38 +83,41 @@ RECOVER PARTITION p1 FROM example_tbl;
### 从 BE 回收站中恢复数据
-用户在使用Doris的过程中,可能会发生因为一些误操作或者线上bug,导致一些有效的tablet被删除(包括元数据和数据)。
+用户在使用 Doris 的过程中,可能会发生因为一些误操作或者线上 bug,导致一些有效的 tablet 被删除(包括元数据和数据)。
-为了防止在这些异常情况出现数据丢失,Doris提供了回收站机制,来保护用户数据。
+为了防止在这些异常情况出现数据丢失,Doris 提供了回收站机制,来保护用户数据。
-用户删除的tablet数据在BE端不会被直接删除,会被放在回收站中存储一段时间,在一段时间之后会有定时清理机制将过期的数据删除。默认情况下,在磁盘空间占用不超过81%(BE配置`config.storage_flood_stage_usage_percent` * 0.9 * 100%)时,BE回收站中的数据最长保留3天(见BE配置`config.trash_file_expire_time_sec`)。
+用户删除的 tablet 数据在 BE 端不会被直接删除,会被放在回收站中存储一段时间,在一段时间之后会有定时清理机制将过期的数据删除。默认情况下,在磁盘空间占用不超过 81%(BE 配置`config.storage_flood_stage_usage_percent` * 0.9 * 100%)时,BE 回收站中的数据最长保留 3 天(见 BE 配置`config.trash_file_expire_time_sec`)。
-BE回收站中的数据包括:tablet的data文件(.dat),tablet的索引文件(.idx)和tablet的元数据文件(.hdr)。数据将会存放在如下格式的路径:
+BE 回收站中的数据包括:tablet 的 data 文件 (.dat),tablet 的索引文件 (.idx) 和 tablet 的元数据文件 (.hdr)。数据将会存放在如下格式的路径:
```
/root_path/trash/time_label/tablet_id/schema_hash/
```
-* `root_path`:对应BE节点的某个数据根目录。
+* `root_path`:对应 BE 节点的某个数据根目录。
+
* `trash`:回收站的目录。
+
* `time_label`:时间标签,为了回收站中数据目录的唯一性,同时记录数据时间,使用时间标签作为子目录。
-当用户发现线上的数据被误删除,需要从回收站中恢复被删除的tablet,需要用到这个tablet数据恢复功能。
+当用户发现线上的数据被误删除,需要从回收站中恢复被删除的 tablet,需要用到这个 tablet 数据恢复功能。
+
+BE 提供 http 接口和 `restore_tablet_tool.sh` 脚本实现这个功能,支持单 tablet 操作(single mode)和批量操作模式(batch mode)。
-BE提供http接口和 `restore_tablet_tool.sh` 脚本实现这个功能,支持单tablet操作(single mode)和批量操作模式(batch mode)。
+* 在 single mode 下,支持单个 tablet 的数据恢复。
-* 在single mode下,支持单个tablet的数据恢复。
-* 在batch mode下,支持批量tablet的数据恢复。
+* 在 batch mode 下,支持批量 tablet 的数据恢复。
-另外,用户可以使用命令 `show trash`查看BE中的trash数据,可以使用命令`admin clean trash`来清楚BE的trash数据。
+另外,用户可以使用命令 `show trash`查看 BE 中的 trash 数据,可以使用命令`admin clean trash`来清楚 BE 的 trash 数据。
-#### 操作
+**操作**
-##### single mode
+**1. single mode**
-1. http请求方式
+- http 请求方式
- BE中提供单个tablet数据恢复的http接口,接口如下:
+ BE 中提供单个 tablet 数据恢复的 http 接口,接口如下:
```
curl -X POST "http://be_host:be_webserver_port/api/restore_tablet?tablet_id=11111\&schema_hash=12345"
@@ -131,20 +135,20 @@ BE提供http接口和 `restore_tablet_tool.sh` 脚本实现这个功能,支持
{"status": "Failed", "msg": "create link path failed"}
```
-2. 脚本方式
+- 脚本方式
- `restore_tablet_tool.sh` 可用来实现单tablet数据恢复的功能。
+ `restore_tablet_tool.sh` 可用来实现单 tablet 数据恢复的功能。
```
sh tools/restore_tablet_tool.sh -b "http://127.0.0.1:8040" -t 12345 -s 11111
sh tools/restore_tablet_tool.sh --backend "http://127.0.0.1:8040" --tablet_id 12345 --schema_hash 11111
```
-##### batch mode
+**2. batch mode**
-批量恢复模式用于实现恢复多个tablet数据的功能。
+批量恢复模式用于实现恢复多个 tablet 数据的功能。
-使用的时候需要预先将恢复的tablet id和schema hash按照逗号分隔的格式放在一个文件中,一个tablet一行。
+使用的时候需要预先将恢复的 tablet id 和 schema hash 按照逗号分隔的格式放在一个文件中,一个 tablet 一行。
格式如下:
@@ -154,7 +158,7 @@ BE提供http接口和 `restore_tablet_tool.sh` 脚本实现这个功能,支持
12347,11111
```
-然后如下的命令进行恢复(假设文件名为:`tablets.txt`):
+然后如下的命令进行恢复 (假设文件名为:`tablets.txt`):
```
sh restore_tablet_tool.sh -b "http://127.0.0.1:8040" -f tablets.txt
@@ -163,9 +167,11 @@ sh restore_tablet_tool.sh --backend "http://127.0.0.1:8040" --file tablets.txt
### 修复缺失或损坏的 Tablet
-在某些极特殊情况下,如代码BUG、或人为误操作等,可能导致部分分片的全部副本都丢失。这种情况下,数据已经实质性的丢失。但是在某些场景下,业务依然希望能够在即使有数据丢失的情况下,保证查询正常不报错,降低用户层的感知程度。此时,我们可以通过使用空白Tablet填充丢失副本的功能,来保证查询能够正常执行。
+在某些极特殊情况下,如代码 BUG、或人为误操作等,可能导致部分分片的全部副本都丢失。这种情况下,数据已经实质性的丢失。但是在某些场景下,业务依然希望能够在即使有数据丢失的情况下,保证查询正常不报错,降低用户层的感知程度。此时,我们可以通过使用空白 Tablet 填充丢失副本的功能,来保证查询能够正常执行。
+:::caution
**注:该操作仅用于规避查询因无法找到可查询副本导致报错的问题,无法恢复已经实质性丢失的数据**
+:::
1. 查看 Master FE 日志 `fe.log`
@@ -185,7 +191,7 @@ sh restore_tablet_tool.sh --backend "http://127.0.0.1:8040" --file tablets.txt
ADMIN SET FRONTEND CONFIG ("recover_with_empty_tablet" = "true");
```
- * 注:可以先通过 `ADMIN SHOW FRONTEND CONFIG;` 命令查看当前版本是否支持该参数。
+ 注:可以先通过 `ADMIN SHOW FRONTEND CONFIG;` 命令查看当前版本是否支持该参数。
3. 设置完成几分钟后,应该会在 Master FE 日志 `fe.log` 中看到如下日志:
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/restore.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/restore.md
index ce96ce05feaf..5579970a81b2 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/restore.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/data-admin/restore.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 数据备份恢复
+
Doris 支持将当前数据以文件的形式,通过 broker 备份到远端存储系统中。之后可以通过 恢复 命令,从远端存储系统中将数据恢复到任意 Doris 集群。通过这个功能,Doris 可以支持将数据定期的进行快照备份。也可以通过这个功能,在不同集群间进行数据迁移。
@@ -40,7 +40,7 @@ Doris 支持将当前数据以文件的形式,通过 broker 备份到远端存
这一步首先会在本地集群中,创建恢复对应的表分区等结构。创建完成后,该表可见,但是不可访问。
-2. 本地snapshot
+2. 本地 snapshot
这一步是将上一步创建的表做一个快照。这其实是一个空快照(因为刚创建的表是没有数据的),其目的主要是在 Backend 上产生对应的快照目录,用于之后接收从远端仓库下载的快照文件。
@@ -83,7 +83,7 @@ Doris 支持将当前数据以文件的形式,通过 broker 备份到远端存
);
```
-3. 查看 restore 作业的执行情况:
+3. 查看 restore 作业的执行情况:
```sql
mysql> SHOW RESTORE\G;
@@ -126,69 +126,94 @@ Doris 支持将当前数据以文件的形式,通过 broker 备份到远端存
1 row in set (0.01 sec)
```
-RESTORE的更多用法可参考 [这里](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/RESTORE.md)。
+RESTORE 的更多用法可参考 [这里](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/RESTORE.md)。
## 相关命令
和备份恢复功能相关的命令如下。以下命令,都可以通过 mysql-client 连接 Doris 后,使用 `help cmd;` 的方式查看详细帮助。
-1. CREATE REPOSITORY
+**1. CREATE REPOSITORY**
- 创建一个远端仓库路径,用于备份或恢复。该命令需要借助 Broker 进程访问远端存储,不同的 Broker 需要提供不同的参数,具体请参阅 [Broker文档](../../advanced/broker.md),也可以直接通过S3 协议备份到支持AWS S3协议的远程存储上去,也可以直接备份到HDFS,具体参考 [创建远程仓库文档](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/CREATE-REPOSITORY.md)
+创建一个远端仓库路径,用于备份或恢复。该命令需要借助 Broker 进程访问远端存储,不同的 Broker 需要提供不同的参数,具体请参阅 [Broker 文档](../../data-operate/import/broker-load-manual),也可以直接通过 S3 协议备份到支持 AWS S3 协议的远程存储上去,也可以直接备份到 HDFS,具体参考 [创建远程仓库文档](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/CREATE-REPOSITORY)
-2. RESTORE
+**2. RESTORE**
- 执行一次恢复操作。
+执行一次恢复操作。
3. SHOW RESTORE
- 查看最近一次 restore 作业的执行情况,包括:
-
- - JobId:本次恢复作业的 id。
- - Label:用户指定的仓库中备份的名称(Label)。
- - Timestamp:用户指定的仓库中备份的时间戳。
- - DbName:恢复作业对应的 Database。
- - State:恢复作业当前所在阶段:
- - PENDING:作业初始状态。
- - SNAPSHOTING:正在进行本地新建表的快照操作。
- - DOWNLOAD:正在发送下载快照任务。
- - DOWNLOADING:快照正在下载。
- - COMMIT:准备生效已下载的快照。
- - COMMITTING:正在生效已下载的快照。
- - FINISHED:恢复完成。
- - CANCELLED:恢复失败或被取消。
- - AllowLoad:恢复期间是否允许导入。
- - ReplicationNum:恢复指定的副本数。
- - RestoreObjs:本次恢复涉及的表和分区的清单。
- - CreateTime:作业创建时间。
- - MetaPreparedTime:本地元数据生成完成时间。
- - SnapshotFinishedTime:本地快照完成时间。
- - DownloadFinishedTime:远端快照下载完成时间。
- - FinishedTime:本次作业完成时间。
- - UnfinishedTasks:在 `SNAPSHOTTING`,`DOWNLOADING`, `COMMITTING` 等阶段,会有多个子任务在同时进行,这里展示的当前阶段,未完成的子任务的 task id。
- - TaskErrMsg:如果有子任务执行出错,这里会显示对应子任务的错误信息。
- - Status:用于记录在整个作业过程中,可能出现的一些状态信息。
- - Timeout:作业的超时时间,单位是秒。
-
-4. CANCEL RESTORE
-
- 取消当前正在执行的恢复作业。
-
-5. DROP REPOSITORY
-
- 删除已创建的远端仓库。删除仓库,仅仅是删除该仓库在 Doris 中的映射,不会删除实际的仓库数据。
+查看最近一次 restore 作业的执行情况,包括:
+
+- JobId:本次恢复作业的 id。
+
+- Label:用户指定的仓库中备份的名称(Label)。
+
+- Timestamp:用户指定的仓库中备份的时间戳。
+
+- DbName:恢复作业对应的 Database。
+
+- State:恢复作业当前所在阶段:
+
+ - PENDING:作业初始状态。
+
+ - SNAPSHOTING:正在进行本地新建表的快照操作。
+
+ - DOWNLOAD:正在发送下载快照任务。
+
+ - DOWNLOADING:快照正在下载。
+
+ - COMMIT:准备生效已下载的快照。
+
+ - COMMITTING:正在生效已下载的快照。
+
+ - FINISHED:恢复完成。
+
+ - CANCELLED:恢复失败或被取消。
+
+- AllowLoad:恢复期间是否允许导入。
+
+- ReplicationNum:恢复指定的副本数。
+
+- RestoreObjs:本次恢复涉及的表和分区的清单。
+
+- CreateTime:作业创建时间。
+
+- MetaPreparedTime:本地元数据生成完成时间。
+
+- SnapshotFinishedTime:本地快照完成时间。
+
+- DownloadFinishedTime:远端快照下载完成时间。
+
+- FinishedTime:本次作业完成时间。
+
+- UnfinishedTasks:在 `SNAPSHOTTING`,`DOWNLOADING`, `COMMITTING` 等阶段,会有多个子任务在同时
+进行,这里展示的当前阶段,未完成的子任务的 task id。
+
+- TaskErrMsg:如果有子任务执行出错,这里会显示对应子任务的错误信息。
+
+- Status:用于记录在整个作业过程中,可能出现的一些状态信息。
+
+- Timeout:作业的超时时间,单位是秒。
+
+**4. CANCEL RESTORE**
+
+取消当前正在执行的恢复作业。
+
+**5. DROP REPOSITORY**
+
+删除已创建的远端仓库。删除仓库,仅仅是删除该仓库在 Doris 中的映射,不会删除实际的仓库数据。
## 常见错误
-1. RESTORE报错:[20181: invalid md5 of downloaded file:/data/doris.HDD/snapshot/20220607095111.862.86400/19962/668322732/19962.hdr, expected: f05b63cca5533ea0466f62a9897289b5, get: d41d8cd98f00b204e9800998ecf8427e]
+1. RESTORE 报错:[20181: invalid md5 of downloaded file:/data/doris.HDD/snapshot/20220607095111.862.86400/19962/668322732/19962.hdr, expected: f05b63cca5533ea0466f62a9897289b5, get: d41d8cd98f00b204e9800998ecf8427e]
- 备份和恢复的表的副本数不一致导致的,执行恢复命令时需指定副本个数,具体命令请参阅[RESTORE](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/RESTORE.md) 命令手册
+ 备份和恢复的表的副本数不一致导致的,执行恢复命令时需指定副本个数,具体命令请参阅[RESTORE](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/RESTORE) 命令手册
-2. RESTORE报错:[COMMON_ERROR, msg: Could not set meta version to 97 since it is lower than minimum required version 100]
+2. RESTORE 报错:[COMMON_ERROR, msg: Could not set meta version to 97 since it is lower than minimum required version 100]
- 备份和恢复不是同一个版本导致的,使用指定的 meta_version 来读取之前备份的元数据。注意,该参数作为临时方案,仅用于恢复老版本 Doris 备份的数据。最新版本的备份数据中已经包含 meta version,无需再指定,针对上述错误具体解决方案指定meta_version = 100,具体命令请参阅[RESTORE](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/RESTORE.md) 命令手册
+ 备份和恢复不是同一个版本导致的,使用指定的 meta_version 来读取之前备份的元数据。注意,该参数作为临时方案,仅用于恢复老版本 Doris 备份的数据。最新版本的备份数据中已经包含 meta version,无需再指定,针对上述错误具体解决方案指定 meta_version = 100,具体命令请参阅[RESTORE](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/RESTORE) 命令手册
## 更多帮助
-关于 RESTORE 使用的更多详细语法及最佳实践,请参阅 [RESTORE](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/RESTORE.md) 命令手册,你也可以在 MySql 客户端命令行下输入 `HELP RESTORE` 获取更多帮助信息。
+关于 RESTORE 使用的更多详细语法及最佳实践,请参阅 [RESTORE](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/RESTORE) 命令手册,你也可以在 MySql 客户端命令行下输入 `HELP RESTORE` 获取更多帮助信息。
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/backends-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/backends-action.md
similarity index 91%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/backends-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/backends-action.md
index 3c76675cbf76..d834408d4c0f 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/backends-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/backends-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Backends Action
+
## Request
@@ -44,7 +44,7 @@ Backends Action 返回 Backends 列表,包括 Backend 的 IP、PORT 等信息
* `is_alive`
- 可选参数。是否返回存活的 BE 节点。默认为false,即返回所有 BE 节点。
+ 可选参数。是否返回存活的 BE 节点。默认为 false,即返回所有 BE 节点。
## Request body
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/bootstrap-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/bootstrap-action.md
similarity index 83%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/bootstrap-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/bootstrap-action.md
index d767aa1cc526..84842b0c0846 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/bootstrap-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/bootstrap-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Bootstrap Action
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-用于判断FE是否启动完成。当不提供任何参数时,仅返回是否启动成功。如果提供了 `token` 和 `cluster_id`,则返回更多详细信息。
+用于判断 FE 是否启动完成。当不提供任何参数时,仅返回是否启动成功。如果提供了 `token` 和 `cluster_id`,则返回更多详细信息。
## Path parameters
@@ -42,11 +42,11 @@ under the License.
* `cluster_id`
- 集群id。可以在 `doris-meta/image/VERSION` 文件中查看。
+ 集群 id。可以在 `doris-meta/image/VERSION` 文件中查看。
* `token`
- 集群token。可以在 `doris-meta/image/VERSION` 文件中查看。
+ 集群 token。可以在 `doris-meta/image/VERSION` 文件中查看。
## Request body
@@ -65,7 +65,7 @@ under the License.
}
```
- code 为 0 表示FE节点启动成功。非 0 的错误码表示其他错误。
+ code 为 0 表示 FE 节点启动成功。非 0 的错误码表示其他错误。
* 提供 `token` 和 `cluster_id`
@@ -85,7 +85,7 @@ under the License.
* `queryPort` 是 FE 节点的 MySQL 协议端口。
* `rpcPort` 是 FE 节点的 thrift RPC 端口。
- * `maxReplayedJournal` 表示 FE 节点当前回放的最大元数据日志id。
+ * `maxReplayedJournal` 表示 FE 节点当前回放的最大元数据日志 id。
* `arrowFlightSqlPort` 是 FE 节点的 Arrow Flight SQL 协议端口。
## Examples
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/cancel-load-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/cancel-load-action.md
similarity index 82%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/cancel-load-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/cancel-load-action.md
index 0635a07382b0..1c853c9eac04 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/cancel-load-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/cancel-load-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Cancel Load Action
+
## Request
@@ -32,11 +32,11 @@ under the License.
## Description
-用于取消掉指定label的导入任务。
-执行完成后,会以Json格式返回这次导入的相关内容。当前包括以下字段
- Status: 是否成功cancel
- Success: 成功cancel事务
- 其他: cancel失败
+用于取消掉指定 label 的导入任务。
+执行完成后,会以 Json 格式返回这次导入的相关内容。当前包括以下字段
+ Status: 是否成功 cancel
+ Success: 成功 cancel 事务
+ 其他:cancel 失败
Message: 具体的失败信息
## Path parameters
@@ -49,7 +49,7 @@ under the License.
* `<label>`
- 指定导入label
+ 指定导入 label
## Request body
@@ -81,7 +81,7 @@ under the License.
## Examples
-1. 取消指定label的导入事务
+1. 取消指定 label 的导入事务
```
POST /api/example_db/_cancel?label=my_label1
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/check-decommission-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/check-decommission-action.md
similarity index 82%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/check-decommission-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/check-decommission-action.md
index 6aa5e057dfa3..5464b25163c2 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/check-decommission-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/check-decommission-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Check Decommission Action
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-用于判断指定的BE是否能够被下线。比如判断节点下线后,剩余的节点是否能够满足空间要求和副本数要求等。
+用于判断指定的 BE 是否能够被下线。比如判断节点下线后,剩余的节点是否能够满足空间要求和副本数要求等。
## Path parameters
@@ -42,7 +42,7 @@ under the License.
* `host_ports`
- 指定一个多个BE,由逗号分隔。如:`ip1:port1,ip2:port2,...`。
+ 指定一个多个 BE,由逗号分隔。如:`ip1:port1,ip2:port2,...`。
其中 port 为 BE 的 heartbeat port。
@@ -65,7 +65,7 @@ under the License.
## Examples
-1. 查看指定BE节点是否可以下线
+1. 查看指定 BE 节点是否可以下线
```
GET /api/check_decommission?host_ports=192.168.10.11:9050,192.168.10.11:9050
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/check-storage-type-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/check-storage-type-action.md
similarity index 98%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/check-storage-type-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/check-storage-type-action.md
index a2769287b0d4..bcbdb9847b3a 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/check-storage-type-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/check-storage-type-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Check Storage Type Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/cluster-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/cluster-action.md
similarity index 96%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/cluster-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/cluster-action.md
index a6f67b14faf5..4c90ca4d490a 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/cluster-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/cluster-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Cluster Action
+
## Request
@@ -36,7 +36,7 @@ under the License.
### Description
-用于获取集群http、mysql连接信息。
+用于获取集群 http、mysql 连接信息。
## Path parameters
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/colocate-meta-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/colocate-meta-action.md
similarity index 91%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/colocate-meta-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/colocate-meta-action.md
index 988380830f7a..c44bb2859d26 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/colocate-meta-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/colocate-meta-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Colocate Meta Action
+
## Request
@@ -34,7 +34,7 @@ under the License.
## Description
-获取/修改colocate group信息。
+获取/修改 colocate group 信息。
## Path parameters
@@ -44,11 +44,11 @@ under the License.
* `db_id`
- 指定数据库id
+ 指定数据库 id
* `group_id`
- 指定组id
+ 指定组 id
## Request body
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/config-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/config-action.md
similarity index 99%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/config-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/config-action.md
index 3c6487cd72c4..dcea9897b937 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/config-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/config-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Config Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/connection-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/connection-action.md
similarity index 98%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/connection-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/connection-action.md
index 31df6a2127fb..dcbd226b4c23 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/connection-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/connection-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Connection Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/debug-point-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/debug-point-action.md
similarity index 93%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/debug-point-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/debug-point-action.md
index a1c9a59a35b7..1ac0ff79136c 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/debug-point-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/debug-point-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 代码打桩
+
代码打桩是代码测试使用的。激活木桩后,可以执行木桩代码。木桩的名字是任意取的。
@@ -37,7 +37,7 @@ FE 桩子示例代码
```java
private Status foo() {
// dbug_fe_foo_do_nothing 是一个木桩名字,
- // 打开这个木桩之后,DebugPointUtil.isEnable("dbug_fe_foo_do_nothing") 将会返回true
+ // 打开这个木桩之后,DebugPointUtil.isEnable("dbug_fe_foo_do_nothing") 将会返回 true
if (DebugPointUtil.isEnable("dbug_fe_foo_do_nothing")) {
return Status.Nothing;
}
@@ -85,10 +85,10 @@ void Status foo() {
木桩名字。必填。
* `timeout`
- 超时时间,单位为秒。超时之后,木桩失活。默认值-1表示永远不超时。可填。
+ 超时时间,单位为秒。超时之后,木桩失活。默认值 -1 表示永远不超时。可填。
* `execute`
- 木桩最大激活次数。默认值-1表示不限激活次数。可填。
+ 木桩最大激活次数。默认值 -1 表示不限激活次数。可填。
### Request body
@@ -107,7 +107,7 @@ void Status foo() {
### Examples
-打开木桩 `foo`,最多激活5次。
+打开木桩 `foo`,最多激活 5 次。
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/extra-basepath-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/extra-basepath-action.md
similarity index 95%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/extra-basepath-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/extra-basepath-action.md
index 8b872a5cf75a..12024c8a6682 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/extra-basepath-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/extra-basepath-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Extra Basepath Action
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-获取http 的basepath。
+获取 http 的 basepath。
## Path parameters
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/fe-version-info-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/fe-version-info-action.md
similarity index 97%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/fe-version-info-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/fe-version-info-action.md
index fc03b6a116dc..864d58e4e9ce 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/fe-version-info-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/fe-version-info-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Fe Version Info Action
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-用于获取fe节点的版本信息。
+用于获取 fe 节点的版本信息。
## Path parameters
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-ddl-stmt-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-ddl-stmt-action.md
similarity index 94%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-ddl-stmt-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-ddl-stmt-action.md
index 7979ce54d507..21274c5f4468 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-ddl-stmt-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-ddl-stmt-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Get DDL Statement Action
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-用于获取指定表的建表语句、建分区语句和建rollup语句。
+用于获取指定表的建表语句、建分区语句和建 rollup 语句。
## Path parameters
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-load-info-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-load-info-action.md
similarity index 94%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-load-info-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-load-info-action.md
index 6f47c9c74699..ab0200e10ff9 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-load-info-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-load-info-action.md
@@ -25,7 +25,7 @@ under the License.
-->
-# Get Load Info Action
+
## Request
@@ -33,7 +33,7 @@ under the License.
## Description
-用于获取指定label的导入作业的信息。
+用于获取指定 label 的导入作业的信息。
## Path parameters
@@ -45,7 +45,7 @@ under the License.
* `label`
- 指定导入Label
+ 指定导入 Label
## Request body
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-load-state.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-load-state.md
similarity index 67%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-load-state.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-load-state.md
index 903d9bb7e12e..301466251d67 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-load-state.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-load-state.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Get Load State
+
## Request
@@ -32,17 +32,17 @@ under the License.
## Description
-返回指定label的导入事务的状态
-执行完毕后,会以Json格式返回这次导入的相关内容。当前包括以下字段:
+返回指定 label 的导入事务的状态
+执行完毕后,会以 Json 格式返回这次导入的相关内容。当前包括以下字段:
Label:本次导入的 label,如果没有指定,则为一个 uuid
- Status:此命令是否成功执行,Success表示成功执行
- Message: 具体的执行信息
- State: 只有在Status为Success时才有意义
- UNKNOWN: 没有找到对应的Label
- PREPARE: 对应的事务已经prepare,但尚未提交
- COMMITTED: 事务已经提交,不能被cancel
- VISIBLE: 事务提交,并且数据可见,不能被cancel
- ABORTED: 事务已经被ROLLBACK,导入已经失败
+ Status:此命令是否成功执行,Success 表示成功执行
+ Message:具体的执行信息
+ State: 只有在 Status 为 Success 时才有意义
+ UNKNOWN: 没有找到对应的 Label
+ PREPARE: 对应的事务已经 prepare,但尚未提交
+ COMMITTED: 事务已经提交,不能被 cancel
+ VISIBLE: 事务提交,并且数据可见,不能被 cancel
+ ABORTED: 事务已经被 ROLLBACK,导入已经失败
## Path parameters
@@ -54,7 +54,7 @@ under the License.
* `label`
- 指定导入label
+ 指定导入 label
## Request body
@@ -71,7 +71,7 @@ under the License.
}
```
-如label不存在,则返回:
+如 label 不存在,则返回:
```
{
@@ -84,7 +84,7 @@ under the License.
## Examples
-1. 获取指定label的导入事务的状态。
+1. 获取指定 label 的导入事务的状态。
```
GET /api/example_db/get_load_state?label=my_label
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-log-file-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-log-file-action.md
similarity index 99%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-log-file-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-log-file-action.md
index 2cb1031112a2..578fe87d8816 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-log-file-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-log-file-action.md
@@ -25,7 +25,7 @@ under the License.
-->
-# Get FE log file
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-small-file.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-small-file.md
similarity index 87%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-small-file.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-small-file.md
index 680902afb203..7004f84dcc0f 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/get-small-file.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/get-small-file.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Get Small File
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-通过文件id,下载在文件管理器中的文件。
+通过文件 id,下载在文件管理器中的文件。
## Path parameters
无
@@ -41,11 +41,11 @@ under the License.
* `token`
- 集群的token。可以在 `doris-meta/image/VERSION` 文件中查看。
+ 集群的 token。可以在 `doris-meta/image/VERSION` 文件中查看。
* `file_id`
- 文件管理器中显示的文件id。文件id可以通过 `SHOW FILE` 命令查看。
+ 文件管理器中显示的文件 id。文件 id 可以通过 `SHOW FILE` 命令查看。
## Request body
@@ -78,7 +78,7 @@ under the License.
## Examples
-1. 下载指定id的文件
+1. 下载指定 id 的文件
```
GET /api/get_small_file?token=98e8c0a6-3a41-48b8-a72b-0432e42a7fe5&file_id=11002
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/ha-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/ha-action.md
similarity index 99%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/ha-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/ha-action.md
index 1d7e2f93960c..b668223b6618 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/ha-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/ha-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# HA Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/hardware-info-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/hardware-info-action.md
similarity index 92%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/hardware-info-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/hardware-info-action.md
index f71a981f45f3..d5bcd9a2c38c 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/hardware-info-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/hardware-info-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Hardware Info Action
+
## Request
@@ -34,7 +34,7 @@ GET /rest/v1/hardware_info/fe/
## Description
-Hardware Info Action 用于获取当前FE的硬件信息。
+Hardware Info Action 用于获取当前 FE 的硬件信息。
## Path parameters
@@ -77,4 +77,4 @@ Hardware Info Action 用于获取当前FE的硬件信息。
}
```
-* 其中 `HarewareInfo` 字段中的各个值的内容,都是以html格式展现的硬件信息文本。
+* 其中 `HarewareInfo` 字段中的各个值的内容,都是以 html 格式展现的硬件信息文本。
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/health-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/health-action.md
similarity index 98%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/health-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/health-action.md
index 64e07742e2a4..8b643ed7b08c 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/health-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/health-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Health Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/help-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/help-action.md
similarity index 93%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/help-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/help-action.md
index 0fb43404baa6..4aa1f5dd41a4 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/help-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/help-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Help Action
+
## Request
@@ -42,7 +42,7 @@ under the License.
* `query`
- 需要进行匹配的关键词,如array、select等。
+ 需要进行匹配的关键词,如 array、select 等。
## Request body
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/import-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/import-action.md
similarity index 94%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/import-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/import-action.md
index 0ebadff383d4..cfe6b26858c7 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/import-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/import-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Import Action
+
## Request
@@ -33,7 +33,7 @@ under the License.
## Description
-查看格式为CSV或PARQUET的文件内容。
+查看格式为 CSV 或 PARQUET 的文件内容。
## Path parameters
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/log-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/log-action.md
similarity index 99%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/log-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/log-action.md
index 042ed8ffd073..dff0ce1ce1e5 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/log-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/log-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Log Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/login-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/login-action.md
similarity index 98%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/login-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/login-action.md
index e12d759609bf..b8b0f45f8683 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/login-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/login-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Login Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/logout-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/logout-action.md
similarity index 98%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/logout-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/logout-action.md
index b0c8f11889d2..8950b52ed2b0 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/logout-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/logout-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Logout Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-action.md
similarity index 97%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-action.md
index dec839e5defb..fda116c8eb9e 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-action.md
@@ -24,9 +24,9 @@ specific language governing permissions and limitations
under the License.
-->
-# Meta Action
-## Request
+
+
```
GET /image
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-info-action-V2.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-info-action-V2.md
similarity index 98%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-info-action-V2.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-info-action-V2.md
index 9ff3b7892f57..951041f79d29 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-info-action-V2.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-info-action-V2.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Meta Info Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-info-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-info-action.md
similarity index 97%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-info-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-info-action.md
index 4f293976809c..9d8f0be41802 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-info-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-info-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Meta Action
+
Meta Info Action 用于获取集群内的元数据信息。如数据库列表,表结构等。
@@ -146,7 +146,7 @@ GET /api/meta/namespaces/<ns_name>/databases/<db_name>/tables/<tbl_name>/schema
* `with_mv`
- 可选项,如果未指定,默认返回 base 表的表结构。如果指定,则还会返回所有rollup的信息。
+ 可选项,如果未指定,默认返回 base 表的表结构。如果指定,则还会返回所有 rollup 的信息。
### Request body
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-replay-state-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-replay-state-action.md
similarity index 97%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-replay-state-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-replay-state-action.md
index 4f88a51267f2..0ba8888cc442 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/meta-replay-state-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/meta-replay-state-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Meta Replay State Action
+
(未实现)
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/metrics-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/metrics-action.md
similarity index 82%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/metrics-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/metrics-action.md
index f08eb8f9d923..7616ddc7e7f1 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/metrics-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/metrics-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Metrics Action
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-获取doris metrics信息。
+获取 doris metrics 信息。
## Path parameters
@@ -42,9 +42,9 @@ under the License.
* `type`
- 可选参数。默认输出全部metrics信息,有以下取值:
- - `core` 输出核心metrics信息
- - `json` 以json格式输出metrics信息
+ 可选参数。默认输出全部 metrics 信息,有以下取值:
+ - `core` 输出核心 metrics 信息
+ - `json` 以 json 格式输出 metrics 信息
## Request body
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/node-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/node-action.md
similarity index 96%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/node-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/node-action.md
index 53cc693b6f98..a4183b8c7c89 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/node-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/node-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Node Action
+
## Request
@@ -52,7 +52,7 @@ under the License.
</version>
-## 获取fe, be, broker节点信息
+## 获取 fe, be, broker 节点信息
`GET /rest/v2/manager/node/frontends`
@@ -62,7 +62,7 @@ under the License.
### Description
-用于获取集群获取fe, be, broker节点信息。
+用于获取集群获取 fe, be, broker 节点信息。
### Response
@@ -192,7 +192,7 @@ configuration_info 用于获取节点配置详细信息。
`POST /rest/v2/manager/node/configuration_info`
* type
- 值为 fe 或 be, 用于指定获取fe的配置信息或be的配置信息。
+ 值为 fe 或 be,用于指定获取 fe 的配置信息或 be 的配置信息。
### Request body
@@ -304,7 +304,7 @@ node 用于指定返回哪些节点的配置项信息,默认为全部fe节点
### Examples
-1. 获取fe agent_task_resend_wait_time_ms 配置项信息:
+1. 获取 fe agent_task_resend_wait_time_ms 配置项信息:
POST /rest/v2/manager/node/configuration_info?type=fe
body:
@@ -355,7 +355,7 @@ node 用于指定返回哪些节点的配置项信息,默认为全部fe节点
### Description
-用于修改fe或be节点配置值
+用于修改 fe 或 be 节点配置值
### Request body
```
@@ -399,7 +399,7 @@ failed 表示修改失败的配置信息。
### Examples
-1. 修改fe 127.0.0.1:8030 节点中 agent_task_resend_wait_time_ms 和alter_table_timeout_second 配置值:
+1. 修改 fe 127.0.0.1:8030 节点中 agent_task_resend_wait_time_ms 和 alter_table_timeout_second 配置值:
POST /rest/v2/manager/node/set_config/fe
body:
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/profile-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/profile-action.md
similarity index 97%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/profile-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/profile-action.md
index f02380d125b4..eebf828126e0 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/profile-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/profile-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Profile Action
+
## Request
@@ -33,8 +33,8 @@ under the License.
## Description
用于获取指定 query id 的 query profile
-如果query_id不存在, 直接返回404 NOT FOUND错误
-如果query_id存在,返回下列文本的profile:
+如果 query_id 不存在,直接返回 404 NOT FOUND 错误
+如果 query_id 存在,返回下列文本的 profile:
```
Query:
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-detail-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-detail-action.md
similarity index 98%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-detail-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-detail-action.md
index 432d5264fbdf..4ddeb22bd129 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-detail-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-detail-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Query Detail Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-profile-action-controller.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-profile-action-controller.md
similarity index 97%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-profile-action-controller.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-profile-action-controller.md
index 68e222f6567d..92e8044c8507 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-profile-action-controller.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-profile-action-controller.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Query Profile Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-profile-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-profile-action.md
similarity index 85%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-profile-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-profile-action.md
index c88a1c57b0c1..b187f45dc063 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-profile-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-profile-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Query Profile Action
+
## Request
@@ -58,7 +58,7 @@ under the License.
* `query_id`
- 可选,指定返回查询的queryID, 默认返回所有查询的信息。
+ 可选,指定返回查询的 queryID,默认返回所有查询的信息。
* `search`
@@ -66,7 +66,7 @@ under the License.
* `is_all_node`
- 可选,若为 true 则返回所有fe节点的查询信息,若为 false 则返回当前fe节点的查询信息。默认为true。
+ 可选,若为 true 则返回所有 fe 节点的查询信息,若为 false 则返回当前 fe 节点的查询信息。默认为 true。
### Response
@@ -191,7 +191,7 @@ Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己
</version>
-## 获取指定查询的sql和文本profile
+## 获取指定查询的 sql 和文本 profile
`GET /rest/v2/manager/query/sql/{query_id}`
@@ -199,19 +199,19 @@ Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己
### Description
-用于获取指定query id的sql和profile文本。
+用于获取指定 query id 的 sql 和 profile 文本。
### Path parameters
* `query_id`
- query id。
+ query id.
### Query parameters
* `is_all_node`
- 可选,若为 true 则在所有fe节点中查询指定query id的信息,若为 false 则在当前连接的fe节点中查询指定query id的信息。默认为true。
+ 可选,若为 true 则在所有 fe 节点中查询指定 query id 的信息,若为 false 则在当前连接的 fe 节点中查询指定 query id 的信息。默认为 true。
### Response
@@ -270,25 +270,25 @@ Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己
}
```
-## 获取指定查询fragment和instance信息
+## 获取指定查询 fragment 和 instance 信息
`GET /rest/v2/manager/query/profile/fragments/{query_id}`
### Description
-用于获取指定query id的fragment名称,instance id、主机IP及端口和执行时长。
+用于获取指定 query id 的 fragment 名称,instance id、主机 IP 及端口和执行时长。
### Path parameters
* `query_id`
- query id。
+ query id.
### Query parameters
* `is_all_node`
- 可选,若为 true 则在所有fe节点中查询指定query id的信息,若为 false 则在当前连接的fe节点中查询指定query id的信息。默认为true。
+ 可选,若为 true 则在所有 fe 节点中查询指定 query id 的信息,若为 false 则在当前连接的 fe 节点中查询指定 query id 的信息。默认为 true。
### Response
@@ -376,31 +376,31 @@ Response:
}
```
-## 获取指定query id树状profile信息
+## 获取指定 query id 树状 profile 信息
`GET /rest/v2/manager/query/profile/graph/{query_id}`
### Description
-获取指定query id树状profile信息,同 `show query profile` 指令。
+获取指定 query id 树状 profile 信息,同 `show query profile` 指令。
### Path parameters
* `query_id`
- query id。
+ query id.
### Query parameters
* `fragment_id` 和 `instance_id`
可选,这两个参数需同时指定或同时不指定。
- 同时不指定则返回profile 简易树形图,相当于`show query profile '/query_id'`;
- 同时指定则返回指定instance详细profile树形图,相当于`show query profile '/query_id/fragment_id/instance_id'`.
+ 同时不指定则返回 profile 简易树形图,相当于`show query profile '/query_id'`;
+ 同时指定则返回指定 instance 详细 profile 树形图,相当于`show query profile '/query_id/fragment_id/instance_id'`.
* `is_all_node`
- 可选,若为 true 则在所有fe节点中查询指定query id的信息,若为 false 则在当前连接的fe节点中查询指定query id的信息。默认为true。
+ 可选,若为 true 则在所有 fe 节点中查询指定 query id 的信息,若为 false 则在当前连接的 fe 节点中查询指定 query id 的信息。默认为 true。
### Response
@@ -430,7 +430,7 @@ Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己
</version>
-## 正在执行的query
+## 正在执行的 query
`GET /rest/v2/manager/query/current_queries`
@@ -444,7 +444,7 @@ Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己
* `is_all_node`
- 可选,若为 true 则返回所有FE节点当前正在执行的 query 信息。默认为 true。
+ 可选,若为 true 则返回所有 FE 节点当前正在执行的 query 信息。默认为 true。
### Response
@@ -463,7 +463,7 @@ Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己
}
```
-## 取消query
+## 取消 query
`POST /rest/v2/manager/query/kill/{query_id}`
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-schema-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-schema-action.md
similarity index 91%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-schema-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-schema-action.md
index b5855c008d0e..c37befe0934f 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-schema-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-schema-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Query Schema Action
+
## Request
@@ -42,7 +42,7 @@ Query Schema Action 可以返回给定的 SQL 有关的表的建表语句。可
* `<db_name>`
- 指定数据库名称。该数据库会被视为当前session的默认数据库,如果在 SQL 中的表名没有限定数据库名称的话,则使用该数据库。
+ 指定数据库名称。该数据库会被视为当前 session 的默认数据库,如果在 SQL 中的表名没有限定数据库名称的话,则使用该数据库。
## Query parameters
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-stats-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-stats-action.md
similarity index 85%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-stats-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-stats-action.md
index 29a029768610..043f305f1f52 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/query-stats-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/query-stats-action.md
@@ -24,9 +24,9 @@ specific language governing permissions and limitations
under the License.
-->
-# Query Stats Action
-<version since="dev"></version>
+
+
## Request
@@ -43,13 +43,13 @@ delete api/query_stats/<catalog_name>/<db_name>/<tbl_name>
## Description
-获取或者删除指定的catalog 数据库或者表中的统计信息, 如果是doris catalog 可以使用default_cluster
+获取或者删除指定的 catalog 数据库或者表中的统计信息,如果是 doris catalog 可以使用 default_cluster
## Path parameters
* `<catalog_name>`
- 指定的catalog 名称
+ 指定的 catalog 名称
* `<db_name>`
指定的数据库名称
@@ -59,7 +59,7 @@ delete api/query_stats/<catalog_name>/<db_name>/<tbl_name>
## Query parameters
* `summary`
-如果为true 则只返回summary信息, 否则返回所有的表的详细统计信息,只在get 时使用
+如果为 true 则只返回 summary 信息,否则返回所有的表的详细统计信息,只在 get 时使用
## Request body
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/row-count-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/row-count-action.md
similarity index 97%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/row-count-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/row-count-action.md
index fc243bb3fcb6..76fffc3124e7 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/row-count-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/row-count-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Row Count Action
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-用于手动更新指定表的行数统计信息。在更新行数统计信息的同时,也会以 JSON 格式返回表以及对应rollup的行数
+用于手动更新指定表的行数统计信息。在更新行数统计信息的同时,也会以 JSON 格式返回表以及对应 rollup 的行数
## Path parameters
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/session-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/session-action.md
similarity index 94%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/session-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/session-action.md
index 0a67a16bd4f2..efb9484d4768 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/session-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/session-action.md
@@ -24,17 +24,17 @@ specific language governing permissions and limitations
under the License.
-->
-# Session Action
+
## Request
`GET /rest/v1/session`
-<version since="dev">
+
`GET /rest/v1/session/all`
-</version>
+
## Description
@@ -52,7 +52,7 @@ Session Action 用于获取当前的会话信息。
无
-## 获取当前FE的会话信息
+## 获取当前 FE 的会话信息
`GET /rest/v1/session`
@@ -80,7 +80,7 @@ Session Action 用于获取当前的会话信息。
}
```
-## 获取所有FE的会话信息
+## 获取所有 FE 的会话信息
`GET /rest/v1/session/all`
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/set-config-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/set-config-action.md
similarity index 97%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/set-config-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/set-config-action.md
index ffe1caa140f2..5eed1acf3cca 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/set-config-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/set-config-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Set Config Action
+
## Request
@@ -117,7 +117,7 @@ under the License.
storage_min_left_capacity_bytes 设置成功;
replica_ack_policy 设置失败,原因是该配置项不支持动态修改;
- agent_task_resend_wait_time_ms 设置失败,因为该配置项类型为long, 设置boolean类型失败。
+ agent_task_resend_wait_time_ms 设置失败,因为该配置项类型为 long,设置 boolean 类型失败。
```
2. 设置 `max_bytes_per_broker_scanner` 并持久化
@@ -139,7 +139,7 @@ under the License.
}
```
- fe/conf 目录生成fe_custom.conf:
+ fe/conf 目录生成 fe_custom.conf:
```
#THIS IS AN AUTO GENERATED CONFIG FILE.
#You can modify this file manually, and the configurations in this file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-data-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-data-action.md
similarity index 99%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-data-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-data-action.md
index 416ed87b1539..378168d08654 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-data-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-data-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Show Data Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-meta-info-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-meta-info-action.md
similarity index 98%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-meta-info-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-meta-info-action.md
index 1a620eace88c..be89aa1dfecc 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-meta-info-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-meta-info-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Show Meta Info Action
+
## Request
@@ -113,7 +113,7 @@ under the License.
}
```
-2. 查看FE选举组情况
+2. 查看 FE 选举组情况
```
GET /api/show_meta_info?action=show_ha
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-proc-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-proc-action.md
similarity index 98%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-proc-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-proc-action.md
index 9e4c6501e5bd..34d4d7fdf900 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-proc-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-proc-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Show Proc Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-runtime-info-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-runtime-info-action.md
similarity index 98%
copy from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-runtime-info-action.md
copy to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-runtime-info-action.md
index 16d793cce503..73997e1c0f7a 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-runtime-info-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-runtime-info-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Show Runtime Info Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-table-data-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-table-data-action.md
similarity index 95%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-table-data-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-table-data-action.md
index 97bb3dcf3b86..ba2c98267c53 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/show-table-data-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/show-table-data-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Show Table Data Action
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-用于获取所有internal源下所有数据库所有表的数据量,或者指定数据库或指定表的数据量。单位字节。
+用于获取所有 internal 源下所有数据库所有表的数据量,或者指定数据库或指定表的数据量。单位字节。
## Path parameters
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/statement-execution-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/statement-execution-action.md
similarity index 91%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/statement-execution-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/statement-execution-action.md
index a11a960bc8cf..ed41c8b0e254 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/statement-execution-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/statement-execution-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Statement Execution Action
+
## Request
@@ -41,7 +41,7 @@ Statement Execution Action 用于执行语句并返回结果。
* `<db_name>`
- 指定数据库名称。该数据库会被视为当前session的默认数据库,如果在 SQL 中的表名没有限定数据库名称的话,则使用该数据库。
+ 指定数据库名称。该数据库会被视为当前 session 的默认数据库,如果在 SQL 中的表名没有限定数据库名称的话,则使用该数据库。
## Query parameters
diff --git a/versioned_docs/version-2.0/admin-manual/http-actions/fe/statistic-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/statistic-action.md
similarity index 98%
rename from versioned_docs/version-2.0/admin-manual/http-actions/fe/statistic-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/statistic-action.md
index af80ed780059..3f5f6008bb8a 100644
--- a/versioned_docs/version-2.0/admin-manual/http-actions/fe/statistic-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/statistic-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Statistic Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/system-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/system-action.md
similarity index 96%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/system-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/system-action.md
index 6a80a71c6b4b..a6055b4f079f 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/system-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/system-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# System Action
+
## Request
@@ -90,4 +90,4 @@ System Action 用于 Doris 内置的 Proc 系统的相关信息。
}
```
-其中 data 部分的 `column_names` 是表头信息,`href_columns` 表示表中的哪些列是超链接列。`rows` 数组中的每个元素表示一行。其中 `__hrefPaths ` 不是表数据,而是超链接列的链接URL,和 `href_columns` 中的列一一对应。
+其中 data 部分的 `column_names` 是表头信息,`href_columns` 表示表中的哪些列是超链接列。`rows` 数组中的每个元素表示一行。其中 `__hrefPaths ` 不是表数据,而是超链接列的链接 URL,和 `href_columns` 中的列一一对应。
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/table-query-plan-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/table-query-plan-action.md
similarity index 99%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/table-query-plan-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/table-query-plan-action.md
index c894e3d564bf..7bfc810e0ad7 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/table-query-plan-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/table-query-plan-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Table Query Plan Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/table-row-count-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/table-row-count-action.md
similarity index 98%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/table-row-count-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/table-row-count-action.md
index 8d3af60a6dd7..276358975fbe 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/table-row-count-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/table-row-count-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Table Row Count Action
+
## Request
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/table-schema-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/table-schema-action.md
similarity index 88%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/table-schema-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/table-schema-action.md
index a4ae8f6e187e..47da31042471 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/table-schema-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/table-schema-action.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Table Schema Action
+
## Request
@@ -32,7 +32,7 @@ under the License.
## Description
-用于获取指定表的表结构信息。该接口目前用于 Spark/Flink Doris Connector 中, 获取 Doris 的表结构信息。
+用于获取指定表的表结构信息。该接口目前用于 Spark/Flink Doris Connector 中,获取 Doris 的表结构信息。
## Path parameters
@@ -53,7 +53,7 @@ under the License.
无
## Response
-* http接口返回如下:
+* http 接口返回如下:
```
{
"msg": "success",
@@ -76,7 +76,7 @@ under the License.
"count": 0
}
```
-* http v2接口返回如下:
+* http v2 接口返回如下:
```
{
"msg": "success",
@@ -97,11 +97,11 @@ under the License.
"count": 0
}
```
-注意:区别为`http`方式比`http v2`方式多返回`aggregation_type`字段,`http v2`开启是通过`enable_http_server_v2`进行设置,具体参数说明详见[fe参数设置](../../config/fe-config.md)
+注意:区别为`http`方式比`http v2`方式多返回`aggregation_type`字段,`http v2`开启是通过`enable_http_server_v2`进行设置,具体参数说明详见[fe 参数设置](../../config/fe-config.md)
## Examples
-1. 通过http获取指定表的表结构信息。
+1. 通过 http 获取指定表的表结构信息。
```
GET /api/db1/tbl1/_schema
@@ -128,7 +128,7 @@ under the License.
"count": 0
}
```
-2. 通过http v2获取指定表的表结构信息。
+2. 通过 http v2 获取指定表的表结构信息。
```
GET /api/db1/tbl1/_schema
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/upload-action.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/upload-action.md
similarity index 85%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/upload-action.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/upload-action.md
index 45f703bef35d..553bdcc5c6fe 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/http-actions/fe/upload-action.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/fe/upload-action.md
@@ -24,13 +24,13 @@ specific language governing permissions and limitations
under the License.
-->
-# Upload Action
-Upload Action 目前主要服务于FE的前端页面,用于用户导入一些测试性质的小文件。
+
+Upload Action 目前主要服务于 FE 的前端页面,用于用户导入一些测试性质的小文件。
## 上传导入文件
-用于将文件上传到FE节点,可在稍后用于导入该文件。目前仅支持上传最大100MB的文件。
+用于将文件上传到 FE 节点,可在稍后用于导入该文件。目前仅支持上传最大 100MB 的文件。
### Request
@@ -60,7 +60,7 @@ POST /api/<namespace>/<db>/<tbl>/upload
* `preview`
- 可选项,如果设置为 `true`,则返回结果中会显示最多10行根据 `column_separator` 切分好的数据行。
+ 可选项,如果设置为 `true`,则返回结果中会显示最多 10 行根据 `column_separator` 切分好的数据行。
### Request body
@@ -110,11 +110,11 @@ PUT /api/<namespace>/<db>/<tbl>/upload
* `file_id`
- 指定导入的文件id,文件id由上传导入文件的API返回。
+ 指定导入的文件 id,文件 id 由上传导入文件的 API 返回。
* `file_uuid`
- 指定导入的文件uuid,文件uuid由上传导入文件的API返回。
+ 指定导入的文件 uuid,文件 uuid 由上传导入文件的 API 返回。
### Header
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/automatic-service-start.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/automatic-service-start.md
index 09d1fac22826..fabebd86d1cf 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/automatic-service-start.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/automatic-service-start.md
@@ -24,15 +24,15 @@ specific language governing permissions and limitations
under the License.
-->
-# 服务自动拉起
-本文档主要介绍如何配置Doris集群的自动拉起,保证生产环境中出现特殊情况导致服务宕机后未及时拉起服务从而影响到业务的正常运行。
-Doris集群必须完全搭建完成后再配置FE和BE的自动拉起服务。
+本文档主要介绍如何配置 Doris 集群的自动拉起,保证生产环境中出现特殊情况导致服务宕机后未及时拉起服务从而影响到业务的正常运行。
-## Systemd配置Doris服务
+Doris 集群必须完全搭建完成后再配置 FE 和 BE 的自动拉起服务。
-systemd具体使用以及参数解析可以参考[这里](https://systemd.io/)
+## Systemd 配置 Doris 服务
+
+systemd 具体使用以及参数解析可以参考[这里](https://systemd.io/)
### sudo 权限控制
@@ -47,14 +47,14 @@ doris ALL=(ALL) NOPASSWD:DORISCTL
```
### 配置步骤
-1. 分别在fe.conf和be.conf中添加 JAVA_HOME变量配置,否则使用systemctl start 将无法启动服务
+1. 分别在 fe.conf 和 be.conf 中添加 JAVA_HOME 变量配置,否则使用 systemctl start 将无法启动服务
```
echo "JAVA_HOME=your_java_home" >> /home/doris/fe/conf/fe.conf
echo "JAVA_HOME=your_java_home" >> /home/doris/be/conf/be.conf
```
-2. 下载doris-fe.service文件: [doris-fe.service](https://github.com/apache/doris/blob/master/tools/systemd/doris-fe.service)
+2. 下载 doris-fe.service 文件:[doris-fe.service](https://github.com/apache/doris/blob/master/tools/systemd/doris-fe.service)
-3. doris-fe.service具体内容如下:
+3. doris-fe.service 具体内容如下:
```
# Licensed to the Apache Software Foundation (ASF) under one
@@ -97,14 +97,17 @@ doris ALL=(ALL) NOPASSWD:DORISCTL
WantedBy=multi-user.target
```
-#### 注意事项
+ :::caution
+ **注意事项**
-- ExecStart、ExecStop根据实际部署的fe的路径进行配置
+ - ExecStart、ExecStop 根据实际部署的 fe 的路径进行配置
+ :::
-4. 下载doris-be.service文件: [doris-be.service](https://github.com/apache/doris/blob/master/tools/systemd/doris-be.service)
+4. 下载 doris-be.service 文件:[doris-be.service](https://github.com/apache/doris/blob/master/tools/systemd/doris-be.service)
-5. doris-be.service具体内容如下:
- ```
+5. doris-be.service 具体内容如下:
+
+ ```shell
# 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
@@ -145,73 +148,75 @@ doris ALL=(ALL) NOPASSWD:DORISCTL
WantedBy=multi-user.target
```
-#### 注意事项
+ :::caution
+ **注意事项**
-- ExecStart、ExecStop根据实际部署的be的路径进行配置
+ - ExecStart、ExecStop 根据实际部署的 be 的路径进行配置
+ :::
6. 服务配置
- 将doris-fe.service、doris-be.service两个文件放到 /usr/lib/systemd/system 目录下
+ 将 doris-fe.service、doris-be.service 两个文件放到 /usr/lib/systemd/system 目录下
7. 设置自启动
添加或修改配置文件后,需要重新加载
- ```
+ ```bash
systemctl daemon-reload
```
设置自启动,实质就是在 /etc/systemd/system/multi-user.target.wants/ 添加服务文件的链接
- ```
+ ```bash
systemctl enable doris-fe
systemctl enable doris-be
```
8. 服务启动
- ```
+ ```bash
systemctl start doris-fe
systemctl start doris-be
```
-## Supervisor配置Doris服务
+## Supervisor 配置 Doris 服务
Supervisor 具体使用以及参数解析可以参考[这里](http://supervisord.org/)
-Supervisor 配置自动拉起可以使用 yum 命令直接安装,也可以通过pip手工安装,pip手工安装流程比较复杂,只展示yum方式部署,手工部署请参考[这里](http://supervisord.org/installing.html)进行安装部署。
+Supervisor 配置自动拉起可以使用 yum 命令直接安装,也可以通过 pip 手工安装,pip 手工安装流程比较复杂,只展示 yum 方式部署,手工部署请参考[这里](http://supervisord.org/installing.html)进行安装部署。
### 配置步骤
-1. yum安装supervisor
+1. yum 安装 supervisor
- ```
+ ```bash
yum install epel-release
yum install -y supervisor
```
2. 启动服务并查看状态
- ```
+ ```bash
systemctl enable supervisord # 开机自启动
- systemctl start supervisord # 启动supervisord服务
- systemctl status supervisord # 查看supervisord服务状态
- ps -ef|grep supervisord # 查看是否存在supervisord进程
+ systemctl start supervisord # 启动 supervisord 服务
+ systemctl status supervisord # 查看 supervisord 服务状态
+ ps -ef|grep supervisord # 查看是否存在 supervisord 进程
```
-3. 配置BE进程管理
+3. 配置 BE 进程管理
- ```
- 修改start_be.sh脚本,去掉最后的 & 符号
+ ```bash
+ 修改 start_be.sh 脚本,去掉最后的 & 符号
vim /path/doris/be/bin/start_be.sh
将 nohup $LIMIT ${DORIS_HOME}/lib/palo_be "$@" >> $LOG_DIR/be.out 2>&1 </dev/null &
修改为 nohup $LIMIT ${DORIS_HOME}/lib/palo_be "$@" >> $LOG_DIR/be.out 2>&1 </dev/null
```
- 创建 BE 的 supervisor进程管理配置文件
+ 创建 BE 的 supervisor 进程管理配置文件
- ```
+ ```bash
vim /etc/supervisord.d/doris-be.ini
[program:doris_be]
@@ -232,19 +237,19 @@ Supervisor 配置自动拉起可以使用 yum 命令直接安装,也可以通
#stdout_logfile=/var/log/supervisor-palo_be.log
```
-4. 配置FE进程管理
+4. 配置 FE 进程管理
- ```
- 修改start_fe.sh脚本,去掉最后的 & 符号
+ ```bash
+ 修改 start_fe.sh 脚本,去掉最后的 & 符号
vim /path/doris/fe/bin/start_fe.sh
将 nohup $LIMIT $JAVA $final_java_opt org.apache.doris.PaloFe ${HELPER} "$@" >> $LOG_DIR/fe.out 2>&1 </dev/null &
修改为 nohup $LIMIT $JAVA $final_java_opt org.apache.doris.PaloFe ${HELPER} "$@" >> $LOG_DIR/fe.out 2>&1 </dev/null
```
- 创建 FE 的 supervisor进程管理配置文件
+ 创建 FE 的 supervisor 进程管理配置文件
- ```
+ ```bash
vim /etc/supervisord.d/doris-fe.ini
[program:PaloFe]
@@ -266,9 +271,9 @@ Supervisor 配置自动拉起可以使用 yum 命令直接安装,也可以通
#stdout_logfile=/var/log/supervisor-PaloFe.log
```
-5. 配置Broker进程管理
+5. 配置 Broker 进程管理
- ```
+ ```bash
修改 start_broker.sh 脚本,去掉最后的 & 符号
vim /path/apache_hdfs_broker/bin/start_broker.sh
@@ -276,9 +281,9 @@ Supervisor 配置自动拉起可以使用 yum 命令直接安装,也可以通
修改为 nohup $LIMIT $JAVA $JAVA_OPTS org.apache.doris.broker.hdfs.BrokerBootstrap "$@" >> $BROKER_LOG_DIR/apache_hdfs_broker.out 2>&1 </dev/null
```
- 创建 Broker 的 supervisor进程管理配置文件
+ 创建 Broker 的 supervisor 进程管理配置文件
- ```
+ ```bash
vim /etc/supervisord.d/doris-broker.ini
[program:BrokerBootstrap]
@@ -300,27 +305,28 @@ Supervisor 配置自动拉起可以使用 yum 命令直接安装,也可以通
#stdout_logfile=/var/log/supervisor-BrokerBootstrap.log
```
-6. 首先确定Doris服务是停止状态,然后使用supervisor将Doris自动拉起,然后确定进程是否正常启动
+6. 首先确定 Doris 服务是停止状态,然后使用 supervisor 将 Doris 自动拉起,然后确定进程是否正常启动
- ```
- supervisorctl reload # 重新加载Supervisor中的所有配置文件
- supervisorctl status # 查看supervisor状态,验证Doris服务进程是否正常启动
+ ```bash
+ supervisorctl reload # 重新加载 Supervisor 中的所有配置文件
+ supervisorctl status # 查看 supervisor 状态,验证 Doris 服务进程是否正常启动
其他命令 :
supervisorctl start all # supervisorctl start 可以开启进程
- supervisorctl stop doris-be # 通过supervisorctl stop,停止进程
+ supervisorctl stop doris-be # 通过 supervisorctl stop,停止进程
```
-#### 注意事项:
+:::caution
+注意事项:
- 如果使用 yum 安装的 supervisor 启动报错 : pkg_resources.DistributionNotFound: The 'supervisor==3.4.0' distribution was not found
-```
-这个是 python 版本不兼容问题,通过yum命令直接安装的 supervisor 只支持 python2 版本,所以需要将 /usr/bin/supervisord 和 /usr/bin/supervisorctl 中文件内容开头 #!/usr/bin/python 改为 #!/usr/bin/python2 ,前提是要装 python2 版本
-```
-
-- 如果配置了 supervisor 对 Doris 进程进行自动拉起,此时如果 Doris 出现非正常因素导致BE节点宕机,那么此时本来应该输出到 be.out 中的错误堆栈信息会被supervisor 拦截,需要在 supervisor 的log中查找来进一步分析。
+ ```bash
+ 这个是 python 版本不兼容问题,通过 yum 命令直接安装的 supervisor 只支持 python2 版本,所以需要将 /usr/bin/supervisord 和 /usr/bin/supervisorctl 中文件内容开头 #!/usr/bin/python 改为 #!/usr/bin/python2,前提是要装 python2 版本
+ ```
+- 如果配置了 supervisor 对 Doris 进程进行自动拉起,此时如果 Doris 出现非正常因素导致 BE 节点宕机,那么此时本来应该输出到 be.out 中的错误堆栈信息会被 supervisor 拦截,需要在 supervisor 的 log 中查找来进一步分析。
+:::
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/be-olap-error-code.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/be-olap-error-code.md
index e69871005152..cfdc2f1bdb24 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/be-olap-error-code.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/be-olap-error-code.md
@@ -1,6 +1,6 @@
---
{
- "title": "BE端OLAP函数的返回值说明",
+ "title": "BE 端 OLAP 函数的返回值说明",
"language": "zh-CN"
}
@@ -25,7 +25,7 @@ specific language governing permissions and limitations
under the License.
-->
-# BE端OLAP函数的返回值说明
+
| 返回值名称 | 返回值 | 返回值说明 |
| ------------------------------------------------ | ------ | ------------------------------------------------------------ |
@@ -39,9 +39,9 @@ under the License.
| OLAP_ERR_CREATE_FILE_ERROR | -103 | 创建文件错误 |
| OLAP_ERR_MALLOC_ERROR | -104 | 内存分配错误 |
| OLAP_ERR_STL_ERROR | -105 | 标准模板库错误 |
-| OLAP_ERR_IO_ERROR | -106 | IO错误 |
+| OLAP_ERR_IO_ERROR | -106 | IO 错误 |
| OLAP_ERR_MUTEX_ERROR | -107 | 互斥锁错误 |
-| OLAP_ERR_PTHREAD_ERROR | -108 | POSIX thread错误 |
+| OLAP_ERR_PTHREAD_ERROR | -108 | POSIX thread 错误 |
| OLAP_ERR_NETWORK_ERROR | -109 | 网络异常错误 |
| OLAP_ERR_UB_FUNC_ERROR | -110 | |
| OLAP_ERR_COMPRESS_ERROR | -111 | 数据压缩错误 |
@@ -59,39 +59,39 @@ under the License.
| 通用错误代码 | | |
| OLAP_ERR_NOT_INITED | -200 | 不能初始化异常 |
| OLAP_ERR_FUNC_NOT_IMPLEMENTED | -201 | 函数不能执行异常 |
-| OLAP_ERR_CALL_SEQUENCE_ERROR | -202 | 调用SEQUENCE异常 |
+| OLAP_ERR_CALL_SEQUENCE_ERROR | -202 | 调用 SEQUENCE 异常 |
| OLAP_ERR_INPUT_PARAMETER_ERROR | -203 | 输入参数错误 |
| OLAP_ERR_BUFFER_OVERFLOW | -204 | 内存缓冲区溢出错误 |
| OLAP_ERR_CONFIG_ERROR | -205 | 配置错误 |
| OLAP_ERR_INIT_FAILED | -206 | 初始化失败 |
-| OLAP_ERR_INVALID_SCHEMA | -207 | 无效的Schema |
+| OLAP_ERR_INVALID_SCHEMA | -207 | 无效的 Schema |
| OLAP_ERR_CHECKSUM_ERROR | -208 | 检验值错误 |
| OLAP_ERR_SIGNATURE_ERROR | -209 | 签名错误 |
| OLAP_ERR_CATCH_EXCEPTION | -210 | 捕捉到异常 |
-| OLAP_ERR_PARSE_PROTOBUF_ERROR | -211 | 解析Protobuf出错 |
-| OLAP_ERR_SERIALIZE_PROTOBUF_ERROR | -212 | Protobuf序列化错误 |
-| OLAP_ERR_WRITE_PROTOBUF_ERROR | -213 | Protobuf写错误 |
-| OLAP_ERR_VERSION_NOT_EXIST | -214 | tablet版本不存在错误 |
-| OLAP_ERR_TABLE_NOT_FOUND | -215 | 未找到tablet错误 |
+| OLAP_ERR_PARSE_PROTOBUF_ERROR | -211 | 解析 Protobuf 出错 |
+| OLAP_ERR_SERIALIZE_PROTOBUF_ERROR | -212 | Protobuf 序列化错误 |
+| OLAP_ERR_WRITE_PROTOBUF_ERROR | -213 | Protobuf 写错误 |
+| OLAP_ERR_VERSION_NOT_EXIST | -214 | tablet 版本不存在错误 |
+| OLAP_ERR_TABLE_NOT_FOUND | -215 | 未找到 tablet 错误 |
| OLAP_ERR_TRY_LOCK_FAILED | -216 | 尝试锁失败 |
| OLAP_ERR_OUT_OF_BOUND | -218 | 内存越界 |
-| OLAP_ERR_UNDERFLOW | -219 | underflow错误 |
+| OLAP_ERR_UNDERFLOW | -219 | underflow 错误 |
| OLAP_ERR_FILE_DATA_ERROR | -220 | 文件数据错误 |
| OLAP_ERR_TEST_FILE_ERROR | -221 | 测试文件错误 |
| OLAP_ERR_INVALID_ROOT_PATH | -222 | 无效的根目录 |
| OLAP_ERR_NO_AVAILABLE_ROOT_PATH | -223 | 没有有效的根目录 |
| OLAP_ERR_CHECK_LINES_ERROR | -224 | 检查行数错误 |
-| OLAP_ERR_INVALID_CLUSTER_INFO | -225 | 无效的Cluster信息 |
+| OLAP_ERR_INVALID_CLUSTER_INFO | -225 | 无效的 Cluster 信息 |
| OLAP_ERR_TRANSACTION_NOT_EXIST | -226 | 事务不存在 |
| OLAP_ERR_DISK_FAILURE | -227 | 磁盘错误 |
| OLAP_ERR_TRANSACTION_ALREADY_COMMITTED | -228 | 交易已提交 |
| OLAP_ERR_TRANSACTION_ALREADY_VISIBLE | -229 | 事务可见 |
| OLAP_ERR_VERSION_ALREADY_MERGED | -230 | 版本已合并 |
-| OLAP_ERR_LZO_DISABLED | -231 | LZO已禁用 |
+| OLAP_ERR_LZO_DISABLED | -231 | LZO 已禁用 |
| OLAP_ERR_DISK_REACH_CAPACITY_LIMIT | -232 | 磁盘到达容量限制 |
| OLAP_ERR_TOO_MANY_TRANSACTIONS | -233 | 太多事务积压未完成 |
| OLAP_ERR_INVALID_SNAPSHOT_VERSION | -234 | 无效的快照版本 |
-| OLAP_ERR_TOO_MANY_VERSION | -235 | tablet的数据版本超过了最大限制(默认500) |
+| OLAP_ERR_TOO_MANY_VERSION | -235 | tablet 的数据版本超过了最大限制(默认 500) |
| OLAP_ERR_NOT_INITIALIZED | -236 | 不能初始化 |
| OLAP_ERR_ALREADY_CANCELLED | -237 | 已经被取消 |
| OLAP_ERR_TOO_MANY_SEGMENTS | -238 | 通常出现在同一批导入数据量过大的情况,从而导致某一个 tablet 的 Segment 文件过多 |
@@ -101,161 +101,161 @@ under the License.
| OLAP_ERR_CE_CMD_NOT_VALID | -302 | 无效的命令 |
| OLAP_ERR_CE_LOAD_TABLE_ERROR | -303 | 加载数据表错误 |
| OLAP_ERR_CE_NOT_FINISHED | -304 | 命令没有执行成功 |
-| OLAP_ERR_CE_TABLET_ID_EXIST | -305 | tablet Id不存在错误 |
+| OLAP_ERR_CE_TABLET_ID_EXIST | -305 | tablet Id 不存在错误 |
| OLAP_ERR_CE_TRY_CE_LOCK_ERROR | -306 | 尝试获取执行命令锁错误 |
-| Tablet错误异常代码 | | |
+| Tablet 错误异常代码 | | |
| OLAP_ERR_TABLE_VERSION_DUPLICATE_ERROR | -400 | tablet 副本版本错误 |
| OLAP_ERR_TABLE_VERSION_INDEX_MISMATCH_ERROR | -401 | tablet 版本索引不匹配异常 |
-| OLAP_ERR_TABLE_INDEX_VALIDATE_ERROR | -402 | 这里不检查tablet的初始版本,因为如果在一个tablet进行schema-change时重新启动 BE,我们可能会遇到空tablet异常 |
-| OLAP_ERR_TABLE_INDEX_FIND_ERROR | -403 | 无法获得第一个Block块位置 或者找到最后一行Block块失败会引发此异常 |
-| OLAP_ERR_TABLE_CREATE_FROM_HEADER_ERROR | -404 | 无法加载Tablet的时候会触发此异常 |
-| OLAP_ERR_TABLE_CREATE_META_ERROR | -405 | 无法创建Tablet(更改schema),Base tablet不存在 ,会触发此异常 |
-| OLAP_ERR_TABLE_ALREADY_DELETED_ERROR | -406 | tablet已经被删除 |
+| OLAP_ERR_TABLE_INDEX_VALIDATE_ERROR | -402 | 这里不检查 tablet 的初始版本,因为如果在一个 tablet 进行 schema-change 时重新启动 BE,我们可能会遇到空 tablet 异常 |
+| OLAP_ERR_TABLE_INDEX_FIND_ERROR | -403 | 无法获得第一个 Block 块位置 或者找到最后一行 Block 块失败会引发此异常 |
+| OLAP_ERR_TABLE_CREATE_FROM_HEADER_ERROR | -404 | 无法加载 Tablet 的时候会触发此异常 |
+| OLAP_ERR_TABLE_CREATE_META_ERROR | -405 | 无法创建 Tablet(更改 schema),Base tablet 不存在,会触发此异常 |
+| OLAP_ERR_TABLE_ALREADY_DELETED_ERROR | -406 | tablet 已经被删除 |
| 存储引擎错误代码 | | |
-| OLAP_ERR_ENGINE_INSERT_EXISTS_TABLE | -500 | 添加相同的tablet两次,添加tablet到相同数据目录两次,新tablet为空,旧tablet存在。会触发此异常 |
+| OLAP_ERR_ENGINE_INSERT_EXISTS_TABLE | -500 | 添加相同的 tablet 两次,添加 tablet 到相同数据目录两次,新 tablet 为空,旧 tablet 存在。会触发此异常 |
| OLAP_ERR_ENGINE_DROP_NOEXISTS_TABLE | -501 | 删除不存在的表 |
-| OLAP_ERR_ENGINE_LOAD_INDEX_TABLE_ERROR | -502 | 加载tablet_meta失败,cumulative rowset无效的segment group meta,会引发此异常 |
+| OLAP_ERR_ENGINE_LOAD_INDEX_TABLE_ERROR | -502 | 加载 tablet_meta 失败,cumulative rowset 无效的 segment group meta,会引发此异常 |
| OLAP_ERR_TABLE_INSERT_DUPLICATION_ERROR | -503 | 表插入重复 |
| OLAP_ERR_DELETE_VERSION_ERROR | -504 | 删除版本错误 |
-| OLAP_ERR_GC_SCAN_PATH_ERROR | -505 | GC扫描路径错误 |
-| OLAP_ERR_ENGINE_INSERT_OLD_TABLET | -506 | 当 BE 正在重新启动并且较旧的tablet已添加到垃圾收集队列但尚未删除时,在这种情况下,由于 data_dirs 是并行加载的,稍后加载的tablet可能比以前加载的tablet旧,这不应被确认为失败,所以此时返回改代码 |
-| Fetch Handler错误代码 | | |
-| OLAP_ERR_FETCH_OTHER_ERROR | -600 | FetchHandler其他错误 |
-| OLAP_ERR_FETCH_TABLE_NOT_EXIST | -601 | FetchHandler表不存在 |
-| OLAP_ERR_FETCH_VERSION_ERROR | -602 | FetchHandler版本错误 |
-| OLAP_ERR_FETCH_SCHEMA_ERROR | -603 | FetchHandler Schema错误 |
-| OLAP_ERR_FETCH_COMPRESSION_ERROR | -604 | FetchHandler压缩错误 |
-| OLAP_ERR_FETCH_CONTEXT_NOT_EXIST | -605 | FetchHandler上下文不存在 |
-| OLAP_ERR_FETCH_GET_READER_PARAMS_ERR | -606 | FetchHandler GET读参数错误 |
-| OLAP_ERR_FETCH_SAVE_SESSION_ERR | -607 | FetchHandler保存会话错误 |
-| OLAP_ERR_FETCH_MEMORY_EXCEEDED | -608 | FetchHandler内存超出异常 |
+| OLAP_ERR_GC_SCAN_PATH_ERROR | -505 | GC 扫描路径错误 |
+| OLAP_ERR_ENGINE_INSERT_OLD_TABLET | -506 | 当 BE 正在重新启动并且较旧的 tablet 已添加到垃圾收集队列但尚未删除时,在这种情况下,由于 data_dirs 是并行加载的,稍后加载的 tablet 可能比以前加载的 tablet 旧,这不应被确认为失败,所以此时返回改代码 |
+| Fetch Handler 错误代码 | | |
+| OLAP_ERR_FETCH_OTHER_ERROR | -600 | FetchHandler 其他错误 |
+| OLAP_ERR_FETCH_TABLE_NOT_EXIST | -601 | FetchHandler 表不存在 |
+| OLAP_ERR_FETCH_VERSION_ERROR | -602 | FetchHandler 版本错误 |
+| OLAP_ERR_FETCH_SCHEMA_ERROR | -603 | FetchHandler Schema 错误 |
+| OLAP_ERR_FETCH_COMPRESSION_ERROR | -604 | FetchHandler 压缩错误 |
+| OLAP_ERR_FETCH_CONTEXT_NOT_EXIST | -605 | FetchHandler 上下文不存在 |
+| OLAP_ERR_FETCH_GET_READER_PARAMS_ERR | -606 | FetchHandler GET 读参数错误 |
+| OLAP_ERR_FETCH_SAVE_SESSION_ERR | -607 | FetchHandler 保存会话错误 |
+| OLAP_ERR_FETCH_MEMORY_EXCEEDED | -608 | FetchHandler 内存超出异常 |
| 读异常错误代码 | | |
| OLAP_ERR_READER_IS_UNINITIALIZED | -700 | 读不能初始化 |
| OLAP_ERR_READER_GET_ITERATOR_ERROR | -701 | 获取读迭代器错误 |
-| OLAP_ERR_CAPTURE_ROWSET_READER_ERROR | -702 | 当前Rowset读错误 |
-| OLAP_ERR_READER_READING_ERROR | -703 | 初始化列数据失败,cumulative rowset 的列数据无效 ,会返回该异常代码 |
+| OLAP_ERR_CAPTURE_ROWSET_READER_ERROR | -702 | 当前 Rowset 读错误 |
+| OLAP_ERR_READER_READING_ERROR | -703 | 初始化列数据失败,cumulative rowset 的列数据无效,会返回该异常代码 |
| OLAP_ERR_READER_INITIALIZE_ERROR | -704 | 读初始化失败 |
-| BaseCompaction异常代码信息 | | |
+| BaseCompaction 异常代码信息 | | |
| OLAP_ERR_BE_VERSION_NOT_MATCH | -800 | BE Compaction 版本不匹配错误 |
| OLAP_ERR_BE_REPLACE_VERSIONS_ERROR | -801 | BE Compaction 替换版本错误 |
-| OLAP_ERR_BE_MERGE_ERROR | -802 | BE Compaction合并错误 |
-| OLAP_ERR_CAPTURE_ROWSET_ERROR | -804 | 找不到Rowset对应的版本 |
-| OLAP_ERR_BE_SAVE_HEADER_ERROR | -805 | BE Compaction保存Header错误 |
-| OLAP_ERR_BE_INIT_OLAP_DATA | -806 | BE Compaction 初始化OLAP数据错误 |
+| OLAP_ERR_BE_MERGE_ERROR | -802 | BE Compaction 合并错误 |
+| OLAP_ERR_CAPTURE_ROWSET_ERROR | -804 | 找不到 Rowset 对应的版本 |
+| OLAP_ERR_BE_SAVE_HEADER_ERROR | -805 | BE Compaction 保存 Header 错误 |
+| OLAP_ERR_BE_INIT_OLAP_DATA | -806 | BE Compaction 初始化 OLAP 数据错误 |
| OLAP_ERR_BE_TRY_OBTAIN_VERSION_LOCKS | -807 | BE Compaction 尝试获得版本锁错误 |
| OLAP_ERR_BE_NO_SUITABLE_VERSION | -808 | BE Compaction 没有合适的版本 |
-| OLAP_ERR_BE_TRY_BE_LOCK_ERROR | -809 | 其他base compaction正在运行,尝试获取锁失败 |
-| OLAP_ERR_BE_INVALID_NEED_MERGED_VERSIONS | -810 | 无效的Merge版本 |
-| OLAP_ERR_BE_ERROR_DELETE_ACTION | -811 | BE执行删除操作错误 |
-| OLAP_ERR_BE_SEGMENTS_OVERLAPPING | -812 | cumulative point有重叠的Rowset异常 |
-| OLAP_ERR_BE_CLONE_OCCURRED | -813 | 将压缩任务提交到线程池后可能会发生克隆任务,并且选择用于压缩的行集可能会发生变化。 在这种情况下,不应执行当前的压缩任务。 返回该代码 |
-| PUSH异常代码 | | |
+| OLAP_ERR_BE_TRY_BE_LOCK_ERROR | -809 | 其他 base compaction 正在运行,尝试获取锁失败 |
+| OLAP_ERR_BE_INVALID_NEED_MERGED_VERSIONS | -810 | 无效的 Merge 版本 |
+| OLAP_ERR_BE_ERROR_DELETE_ACTION | -811 | BE 执行删除操作错误 |
+| OLAP_ERR_BE_SEGMENTS_OVERLAPPING | -812 | cumulative point 有重叠的 Rowset 异常 |
+| OLAP_ERR_BE_CLONE_OCCURRED | -813 | 将压缩任务提交到线程池后可能会发生克隆任务,并且选择用于压缩的行集可能会发生变化。在这种情况下,不应执行当前的压缩任务。返回该代码 |
+| PUSH 异常代码 | | |
| OLAP_ERR_PUSH_INIT_ERROR | -900 | 无法初始化读取器,无法创建表描述符,无法初始化内存跟踪器,不支持的文件格式类型,无法打开扫描仪,无法获取元组描述符,为元组分配内存失败,都会返回该代码 |
| OLAP_ERR_PUSH_DELTA_FILE_EOF | -901 | |
-| OLAP_ERR_PUSH_VERSION_INCORRECT | -902 | PUSH版本不正确 |
-| OLAP_ERR_PUSH_SCHEMA_MISMATCH | -903 | PUSH Schema不匹配 |
-| OLAP_ERR_PUSH_CHECKSUM_ERROR | -904 | PUSH校验值错误 |
+| OLAP_ERR_PUSH_VERSION_INCORRECT | -902 | PUSH 版本不正确 |
+| OLAP_ERR_PUSH_SCHEMA_MISMATCH | -903 | PUSH Schema 不匹配 |
+| OLAP_ERR_PUSH_CHECKSUM_ERROR | -904 | PUSH 校验值错误 |
| OLAP_ERR_PUSH_ACQUIRE_DATASOURCE_ERROR | -905 | PUSH 获取数据源错误 |
-| OLAP_ERR_PUSH_CREAT_CUMULATIVE_ERROR | -906 | PUSH 创建CUMULATIVE错误代码 |
+| OLAP_ERR_PUSH_CREAT_CUMULATIVE_ERROR | -906 | PUSH 创建 CUMULATIVE 错误代码 |
| OLAP_ERR_PUSH_BUILD_DELTA_ERROR | -907 | 推送的增量文件有错误的校验码 |
-| OLAP_ERR_PUSH_VERSION_ALREADY_EXIST | -908 | PUSH的版本已经存在 |
-| OLAP_ERR_PUSH_TABLE_NOT_EXIST | -909 | PUSH的表不存在 |
-| OLAP_ERR_PUSH_INPUT_DATA_ERROR | -910 | PUSH的数据无效,可能是长度,数据类型等问题 |
-| OLAP_ERR_PUSH_TRANSACTION_ALREADY_EXIST | -911 | 将事务提交给引擎时,发现Rowset存在,但Rowset ID 不一样 |
+| OLAP_ERR_PUSH_VERSION_ALREADY_EXIST | -908 | PUSH 的版本已经存在 |
+| OLAP_ERR_PUSH_TABLE_NOT_EXIST | -909 | PUSH 的表不存在 |
+| OLAP_ERR_PUSH_INPUT_DATA_ERROR | -910 | PUSH 的数据无效,可能是长度,数据类型等问题 |
+| OLAP_ERR_PUSH_TRANSACTION_ALREADY_EXIST | -911 | 将事务提交给引擎时,发现 Rowset 存在,但 Rowset ID 不一样 |
| OLAP_ERR_PUSH_BATCH_PROCESS_REMOVED | -912 | 删除了推送批处理过程 |
| OLAP_ERR_PUSH_COMMIT_ROWSET | -913 | PUSH Commit Rowset |
-| OLAP_ERR_PUSH_ROWSET_NOT_FOUND | -914 | PUSH Rowset没有发现 |
-| SegmentGroup异常代码 | | |
+| OLAP_ERR_PUSH_ROWSET_NOT_FOUND | -914 | PUSH Rowset 没有发现 |
+| SegmentGroup 异常代码 | | |
| OLAP_ERR_INDEX_LOAD_ERROR | -1000 | 加载索引错误 |
| OLAP_ERR_INDEX_EOF | -1001 | |
-| OLAP_ERR_INDEX_CHECKSUM_ERROR | -1002 | 校验码验证错误,加载索引对应的Segment 错误。 |
+| OLAP_ERR_INDEX_CHECKSUM_ERROR | -1002 | 校验码验证错误,加载索引对应的 Segment 错误。 |
| OLAP_ERR_INDEX_DELTA_PRUNING | -1003 | 索引增量修剪 |
-| OLAPData异常代码信息 | | |
-| OLAP_ERR_DATA_ROW_BLOCK_ERROR | -1100 | 数据行Block块错误 |
+| OLAPData 异常代码信息 | | |
+| OLAP_ERR_DATA_ROW_BLOCK_ERROR | -1100 | 数据行 Block 块错误 |
| OLAP_ERR_DATA_FILE_TYPE_ERROR | -1101 | 数据文件类型错误 |
| OLAP_ERR_DATA_EOF | -1102 | |
-| OLAP数据写错误代码 | | |
+| OLAP 数据写错误代码 | | |
| OLAP_ERR_WRITER_INDEX_WRITE_ERROR | -1200 | 索引写错误 |
| OLAP_ERR_WRITER_DATA_WRITE_ERROR | -1201 | 数据写错误 |
-| OLAP_ERR_WRITER_ROW_BLOCK_ERROR | -1202 | Row Block块写错误 |
-| OLAP_ERR_WRITER_SEGMENT_NOT_FINALIZED | -1203 | 在添加新Segment之前,上一Segment未完成 |
-| RowBlock错误代码 | | |
-| OLAP_ERR_ROWBLOCK_DECOMPRESS_ERROR | -1300 | Rowblock解压缩错误 |
-| OLAP_ERR_ROWBLOCK_FIND_ROW_EXCEPTION | -1301 | 获取Block Entry失败 |
-| Tablet元数据错误 | | |
-| OLAP_ERR_HEADER_ADD_VERSION | -1400 | tablet元数据增加版本 |
-| OLAP_ERR_HEADER_DELETE_VERSION | -1401 | tablet元数据删除版本 |
-| OLAP_ERR_HEADER_ADD_PENDING_DELTA | -1402 | tablet元数据添加待处理增量 |
-| OLAP_ERR_HEADER_ADD_INCREMENTAL_VERSION | -1403 | tablet元数据添加自增版本 |
-| OLAP_ERR_HEADER_INVALID_FLAG | -1404 | tablet元数据无效的标记 |
-| OLAP_ERR_HEADER_PUT | -1405 | tablet元数据PUT操作 |
-| OLAP_ERR_HEADER_DELETE | -1406 | tablet元数据DELETE操作 |
-| OLAP_ERR_HEADER_GET | -1407 | tablet元数据GET操作 |
-| OLAP_ERR_HEADER_LOAD_INVALID_KEY | -1408 | tablet元数据加载无效Key |
+| OLAP_ERR_WRITER_ROW_BLOCK_ERROR | -1202 | Row Block 块写错误 |
+| OLAP_ERR_WRITER_SEGMENT_NOT_FINALIZED | -1203 | 在添加新 Segment 之前,上一 Segment 未完成 |
+| RowBlock 错误代码 | | |
+| OLAP_ERR_ROWBLOCK_DECOMPRESS_ERROR | -1300 | Rowblock 解压缩错误 |
+| OLAP_ERR_ROWBLOCK_FIND_ROW_EXCEPTION | -1301 | 获取 Block Entry 失败 |
+| Tablet 元数据错误 | | |
+| OLAP_ERR_HEADER_ADD_VERSION | -1400 | tablet 元数据增加版本 |
+| OLAP_ERR_HEADER_DELETE_VERSION | -1401 | tablet 元数据删除版本 |
+| OLAP_ERR_HEADER_ADD_PENDING_DELTA | -1402 | tablet 元数据添加待处理增量 |
+| OLAP_ERR_HEADER_ADD_INCREMENTAL_VERSION | -1403 | tablet 元数据添加自增版本 |
+| OLAP_ERR_HEADER_INVALID_FLAG | -1404 | tablet 元数据无效的标记 |
+| OLAP_ERR_HEADER_PUT | -1405 | tablet 元数据 PUT 操作 |
+| OLAP_ERR_HEADER_DELETE | -1406 | tablet 元数据 DELETE 操作 |
+| OLAP_ERR_HEADER_GET | -1407 | tablet 元数据 GET 操作 |
+| OLAP_ERR_HEADER_LOAD_INVALID_KEY | -1408 | tablet 元数据加载无效 Key |
| OLAP_ERR_HEADER_FLAG_PUT | -1409 | |
-| OLAP_ERR_HEADER_LOAD_JSON_HEADER | -1410 | tablet元数据加载JSON Header |
-| OLAP_ERR_HEADER_INIT_FAILED | -1411 | tablet元数据Header初始化失败 |
-| OLAP_ERR_HEADER_PB_PARSE_FAILED | -1412 | tablet元数据 Protobuf解析失败 |
-| OLAP_ERR_HEADER_HAS_PENDING_DATA | -1413 | tablet元数据有待处理的数据 |
-| TabletSchema异常代码信息 | | |
-| OLAP_ERR_SCHEMA_SCHEMA_INVALID | -1500 | Tablet Schema无效 |
+| OLAP_ERR_HEADER_LOAD_JSON_HEADER | -1410 | tablet 元数据加载 JSON Header |
+| OLAP_ERR_HEADER_INIT_FAILED | -1411 | tablet 元数据 Header 初始化失败 |
+| OLAP_ERR_HEADER_PB_PARSE_FAILED | -1412 | tablet 元数据 Protobuf 解析失败 |
+| OLAP_ERR_HEADER_HAS_PENDING_DATA | -1413 | tablet 元数据有待处理的数据 |
+| TabletSchema 异常代码信息 | | |
+| OLAP_ERR_SCHEMA_SCHEMA_INVALID | -1500 | Tablet Schema 无效 |
| OLAP_ERR_SCHEMA_SCHEMA_FIELD_INVALID | -1501 | Tablet Schema 字段无效 |
-| SchemaHandler异常代码信息 | | |
+| SchemaHandler 异常代码信息 | | |
| OLAP_ERR_ALTER_MULTI_TABLE_ERR | -1600 | ALTER 多表错误 |
-| OLAP_ERR_ALTER_DELTA_DOES_NOT_EXISTS | -1601 | 获取所有数据源失败,Tablet无版本 |
+| OLAP_ERR_ALTER_DELTA_DOES_NOT_EXISTS | -1601 | 获取所有数据源失败,Tablet 无版本 |
| OLAP_ERR_ALTER_STATUS_ERR | -1602 | 检查行号失败,内部排序失败,行块排序失败,这些都会返回该代码 |
-| OLAP_ERR_PREVIOUS_SCHEMA_CHANGE_NOT_FINISHED | -1603 | 先前的Schema更改未完成 |
-| OLAP_ERR_SCHEMA_CHANGE_INFO_INVALID | -1604 | Schema变更信息无效 |
+| OLAP_ERR_PREVIOUS_SCHEMA_CHANGE_NOT_FINISHED | -1603 | 先前的 Schema 更改未完成 |
+| OLAP_ERR_SCHEMA_CHANGE_INFO_INVALID | -1604 | Schema 变更信息无效 |
| OLAP_ERR_QUERY_SPLIT_KEY_ERR | -1605 | 查询 Split key 错误 |
| OLAP_ERR_DATA_QUALITY_ERROR | -1606 | 模式更改/物化视图期间因数据质量问题或内存使用超出限制导致的错误 |
-| Column File错误代码 | | |
+| Column File 错误代码 | | |
| OLAP_ERR_COLUMN_DATA_LOAD_BLOCK | -1700 | 加载列数据块错误 |
| OLAP_ERR_COLUMN_DATA_RECORD_INDEX | -1701 | 加载数据记录索引错误 |
| OLAP_ERR_COLUMN_DATA_MAKE_FILE_HEADER | -1702 | |
-| OLAP_ERR_COLUMN_DATA_READ_VAR_INT | -1703 | 无法从Stream中读取列数据 |
+| OLAP_ERR_COLUMN_DATA_READ_VAR_INT | -1703 | 无法从 Stream 中读取列数据 |
| OLAP_ERR_COLUMN_DATA_PATCH_LIST_NUM | -1704 | |
| OLAP_ERR_COLUMN_STREAM_EOF | -1705 | 如果数据流结束,返回该代码 |
-| OLAP_ERR_COLUMN_READ_STREAM | -1706 | 块大小大于缓冲区大小,压缩剩余大小小于Stream头大小,读取流失败 这些情况下会抛出该异常 |
-| OLAP_ERR_COLUMN_STREAM_NOT_EXIST | -1707 | Stream为空,不存在,未找到数据流 等情况下返回该异常代码 |
+| OLAP_ERR_COLUMN_READ_STREAM | -1706 | 块大小大于缓冲区大小,压缩剩余大小小于 Stream 头大小,读取流失败 这些情况下会抛出该异常 |
+| OLAP_ERR_COLUMN_STREAM_NOT_EXIST | -1707 | Stream 为空,不存在,未找到数据流 等情况下返回该异常代码 |
| OLAP_ERR_COLUMN_VALUE_NULL | -1708 | 列值为空异常 |
-| OLAP_ERR_COLUMN_SEEK_ERROR | -1709 | 如果通过schema变更添加列,由于schema变更可能导致列索引存在,返回这个异常代码 |
-| DeleteHandler错误代码 | | |
+| OLAP_ERR_COLUMN_SEEK_ERROR | -1709 | 如果通过 schema 变更添加列,由于 schema 变更可能导致列索引存在,返回这个异常代码 |
+| DeleteHandler 错误代码 | | |
| OLAP_ERR_DELETE_INVALID_CONDITION | -1900 | 删除条件无效 |
-| OLAP_ERR_DELETE_UPDATE_HEADER_FAILED | -1901 | 删除更新Header错误 |
-| OLAP_ERR_DELETE_SAVE_HEADER_FAILED | -1902 | 删除保存header错误 |
+| OLAP_ERR_DELETE_UPDATE_HEADER_FAILED | -1901 | 删除更新 Header 错误 |
+| OLAP_ERR_DELETE_SAVE_HEADER_FAILED | -1902 | 删除保存 header 错误 |
| OLAP_ERR_DELETE_INVALID_PARAMETERS | -1903 | 删除参数无效 |
| OLAP_ERR_DELETE_INVALID_VERSION | -1904 | 删除版本无效 |
-| Cumulative Handler错误代码 | | |
-| OLAP_ERR_CUMULATIVE_NO_SUITABLE_VERSIONS | -2000 | Cumulative没有合适的版本 |
+| Cumulative Handler 错误代码 | | |
+| OLAP_ERR_CUMULATIVE_NO_SUITABLE_VERSIONS | -2000 | Cumulative 没有合适的版本 |
| OLAP_ERR_CUMULATIVE_REPEAT_INIT | -2001 | Cumulative Repeat 初始化错误 |
-| OLAP_ERR_CUMULATIVE_INVALID_PARAMETERS | -2002 | Cumulative参数无效 |
-| OLAP_ERR_CUMULATIVE_FAILED_ACQUIRE_DATA_SOURCE | -2003 | Cumulative获取数据源失败 |
-| OLAP_ERR_CUMULATIVE_INVALID_NEED_MERGED_VERSIONS | -2004 | Cumulative无有效需要合并版本 |
-| OLAP_ERR_CUMULATIVE_ERROR_DELETE_ACTION | -2005 | Cumulative删除操作错误 |
-| OLAP_ERR_CUMULATIVE_MISS_VERSION | -2006 | rowsets缺少版本 |
-| OLAP_ERR_CUMULATIVE_CLONE_OCCURRED | -2007 | 将压缩任务提交到线程池后可能会发生克隆任务,并且选择用于压缩的行集可能会发生变化。 在这种情况下,不应执行当前的压缩任务。否则会触发改异常 |
-| OLAPMeta异常代码 | | |
+| OLAP_ERR_CUMULATIVE_INVALID_PARAMETERS | -2002 | Cumulative 参数无效 |
+| OLAP_ERR_CUMULATIVE_FAILED_ACQUIRE_DATA_SOURCE | -2003 | Cumulative 获取数据源失败 |
+| OLAP_ERR_CUMULATIVE_INVALID_NEED_MERGED_VERSIONS | -2004 | Cumulative 无有效需要合并版本 |
+| OLAP_ERR_CUMULATIVE_ERROR_DELETE_ACTION | -2005 | Cumulative 删除操作错误 |
+| OLAP_ERR_CUMULATIVE_MISS_VERSION | -2006 | rowsets 缺少版本 |
+| OLAP_ERR_CUMULATIVE_CLONE_OCCURRED | -2007 | 将压缩任务提交到线程池后可能会发生克隆任务,并且选择用于压缩的行集可能会发生变化。在这种情况下,不应执行当前的压缩任务。否则会触发改异常 |
+| OLAPMeta 异常代码 | | |
| OLAP_ERR_META_INVALID_ARGUMENT | -3000 | 元数据参数无效 |
-| OLAP_ERR_META_OPEN_DB | -3001 | 打开DB元数据错误 |
-| OLAP_ERR_META_KEY_NOT_FOUND | -3002 | 元数据key没发现 |
-| OLAP_ERR_META_GET | -3003 | GET元数据错误 |
-| OLAP_ERR_META_PUT | -3004 | PUT元数据错误 |
+| OLAP_ERR_META_OPEN_DB | -3001 | 打开 DB 元数据错误 |
+| OLAP_ERR_META_KEY_NOT_FOUND | -3002 | 元数据 key 没发现 |
+| OLAP_ERR_META_GET | -3003 | GET 元数据错误 |
+| OLAP_ERR_META_PUT | -3004 | PUT 元数据错误 |
| OLAP_ERR_META_ITERATOR | -3005 | 元数据迭代器错误 |
| OLAP_ERR_META_DELETE | -3006 | 删除元数据错误 |
| OLAP_ERR_META_ALREADY_EXIST | -3007 | 元数据已经存在错误 |
-| Rowset错误代码 | | |
-| OLAP_ERR_ROWSET_WRITER_INIT | -3100 | Rowset写初始化错误 |
-| OLAP_ERR_ROWSET_SAVE_FAILED | -3101 | Rowset保存失败 |
-| OLAP_ERR_ROWSET_GENERATE_ID_FAILED | -3102 | Rowset生成ID失败 |
-| OLAP_ERR_ROWSET_DELETE_FILE_FAILED | -3103 | Rowset删除文件失败 |
-| OLAP_ERR_ROWSET_BUILDER_INIT | -3104 | Rowset初始化构建失败 |
-| OLAP_ERR_ROWSET_TYPE_NOT_FOUND | -3105 | Rowset类型没有发现 |
-| OLAP_ERR_ROWSET_ALREADY_EXIST | -3106 | Rowset已经存在 |
-| OLAP_ERR_ROWSET_CREATE_READER | -3107 | Rowset创建读对象失败 |
-| OLAP_ERR_ROWSET_INVALID | -3108 | Rowset无效 |
-| OLAP_ERR_ROWSET_READER_INIT | -3110 | Rowset读对象初始化失败 |
-| OLAP_ERR_ROWSET_INVALID_STATE_TRANSITION | -3112 | Rowset无效的事务状态 |
-| OLAP_ERR_ROWSET_RENAME_FILE_FAILED | -3116 | Rowset重命名文件失败 |
-| OLAP_ERR_SEGCOMPACTION_INIT_READER | -3117 | SegmentCompaction初始化Reader失败 |
-| OLAP_ERR_SEGCOMPACTION_INIT_WRITER | -3118 | SegmentCompaction初始化Writer失败 |
-| OLAP_ERR_SEGCOMPACTION_FAILED | -3119 | SegmentCompaction失败 |
+| Rowset 错误代码 | | |
+| OLAP_ERR_ROWSET_WRITER_INIT | -3100 | Rowset 写初始化错误 |
+| OLAP_ERR_ROWSET_SAVE_FAILED | -3101 | Rowset 保存失败 |
+| OLAP_ERR_ROWSET_GENERATE_ID_FAILED | -3102 | Rowset 生成 ID 失败 |
+| OLAP_ERR_ROWSET_DELETE_FILE_FAILED | -3103 | Rowset 删除文件失败 |
+| OLAP_ERR_ROWSET_BUILDER_INIT | -3104 | Rowset 初始化构建失败 |
+| OLAP_ERR_ROWSET_TYPE_NOT_FOUND | -3105 | Rowset 类型没有发现 |
+| OLAP_ERR_ROWSET_ALREADY_EXIST | -3106 | Rowset 已经存在 |
+| OLAP_ERR_ROWSET_CREATE_READER | -3107 | Rowset 创建读对象失败 |
+| OLAP_ERR_ROWSET_INVALID | -3108 | Rowset 无效 |
+| OLAP_ERR_ROWSET_READER_INIT | -3110 | Rowset 读对象初始化失败 |
+| OLAP_ERR_ROWSET_INVALID_STATE_TRANSITION | -3112 | Rowset 无效的事务状态 |
+| OLAP_ERR_ROWSET_RENAME_FILE_FAILED | -3116 | Rowset 重命名文件失败 |
+| OLAP_ERR_SEGCOMPACTION_INIT_READER | -3117 | SegmentCompaction 初始化 Reader 失败 |
+| OLAP_ERR_SEGCOMPACTION_INIT_WRITER | -3118 | SegmentCompaction 初始化 Writer 失败 |
+| OLAP_ERR_SEGCOMPACTION_FAILED | -3119 | SegmentCompaction 失败 |
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/advanced/best-practice/debug-log.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/debug-log.md
similarity index 89%
rename from i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/advanced/best-practice/debug-log.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/debug-log.md
index e90ded282bef..4112aec9bc86 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/advanced/best-practice/debug-log.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/debug-log.md
@@ -24,13 +24,15 @@ specific language governing permissions and limitations
under the License.
-->
-# 如何开启Debug日志
-Doris 的 FE 和 BE 节点的系统运行日志默认为 INFO 级别。通常可以满足对系统行为的分析和基本问题的定位。但是某些情况下,可能需要开启 DEBUG 级别的日志来进一步排查问题。本文档主要介绍如何开启 FE、BE节点的 DEBUG 日志级别。
->不建议将日志级别调整为 WARN 或更高级别,这不利于系统行为的分析和问题的定位。
+Doris 的 FE 和 BE 节点的系统运行日志默认为 INFO 级别。通常可以满足对系统行为的分析和基本问题的定位。但是某些情况下,可能需要开启 DEBUG 级别的日志来进一步排查问题。本文档主要介绍如何开启 FE、BE 节点的 DEBUG 日志级别。
->开启 DEBUG 日志可能会导致大量日志产生,**生产环境请谨慎开启**。
+:::tip
+- 不建议将日志级别调整为 WARN 或更高级别,这不利于系统行为的分析和问题的定位。
+
+- 开启 DEBUG 日志可能会导致大量日志产生,**生产环境请谨慎开启**。
+:::
## 开启 FE Debug 日志
@@ -65,8 +67,10 @@ FE 的 Debug 级别日志可以通过修改配置文件开启,也可以通过
你也可以在 Delete 输入框中输入包名或者具体的类名,来关闭对应的 Debug 日志。
- > 这里的修改只会影响对应的 FE 节点的日志级别。不会影响其他 FE 节点的日志级别。
-
+ :::note
+ 这里的修改只会影响对应的 FE 节点的日志级别。不会影响其他 FE 节点的日志级别。
+ :::
+
3. 通过 API 修改
通过以下 API 也可以在运行时修改日志级别。无需重启 FE 节点。
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/disk-capacity.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/disk-capacity.md
index e995658ddc6d..a8a308fb0eee 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/disk-capacity.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/disk-capacity.md
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 磁盘空间管理
+
本文档主要介绍和磁盘存储空间有关的系统参数和处理策略。
@@ -54,7 +54,9 @@ storage_min_left_capacity_bytes 默认 2GB。
当磁盘空间使用率**大于** `storage_high_watermark_usage_percent`,**或者** 磁盘空间剩余大小**小于** `storage_min_left_capacity_bytes` 时,该磁盘不会再被作为以下操作的目的路径:
- Tablet 均衡操作(Balance)
+
- Colocation 表数据分片的重分布(Relocation)
+
- Decommission
**危险水位:**
@@ -67,9 +69,13 @@ storage_flood_stage_left_capacity_bytes 默认 1GB。
当磁盘空间使用率**大于** `storage_flood_stage_usage_percent`,**并且** 磁盘空间剩余大小**小于** `storage_flood_stage_left_capacity_bytes` 时,该磁盘不会再被作为以下操作的目的路径,并禁止某些操作:
- Tablet 均衡操作(Balance)
+
- Colocation 表数据分片的重分布(Relocation)
+
- 副本补齐
+
- 恢复操作(Restore)
+
- 数据导入(Load/Insert)
## BE 参数
@@ -84,10 +90,15 @@ storage_flood_stage_left_capacity_bytes 默认 1GB。
当磁盘空间使用率**大于** `storage_flood_stage_usage_percent`,**并且** 磁盘空间剩余大小**小于** `storage_flood_stage_left_capacity_bytes` 时,该磁盘上的以下操作会被禁止:
- Base/Cumulative Compaction。
+
- 数据写入。包括各种导入操作。
+
- Clone Task。通常发生于副本修复或均衡时。
+
- Push Task。发生在 Hadoop 导入的 Loading 阶段,下载文件。
+
- Alter Task。Schema Change 或 Rollup 任务。
+
- Download Task。恢复操作的 Downloading 阶段。
## 磁盘空间释放
@@ -109,7 +120,7 @@ storage_flood_stage_left_capacity_bytes 默认 1GB。
- 修改表或分区的副本
- 可以将表或分区的副本数降低。比如默认3副本可以降低为2副本。该方法虽然降低了数据的可靠性,但是能够快速的降低磁盘使用率,使集群恢复正常。该方法通常用于紧急恢复系统。请在恢复后,通过扩容或删除数据等方式,降低磁盘使用率后,将副本数恢复为 3。
+ 可以将表或分区的副本数降低。比如默认 3 副本可以降低为 2 副本。该方法虽然降低了数据的可靠性,但是能够快速的降低磁盘使用率,使集群恢复正常。该方法通常用于紧急恢复系统。请在恢复后,通过扩容或删除数据等方式,降低磁盘使用率后,将副本数恢复为 3。
修改副本操作为瞬间生效,后台会自动异步的删除多余的副本。
@@ -122,19 +133,22 @@ storage_flood_stage_left_capacity_bytes 默认 1GB。
当 BE 进程已经因为磁盘写满而挂掉并无法启动时(此现象可能因 FE 或 BE 检测不及时而发生)。需要通过删除数据目录下的一些临时文件,保证 BE 进程能够启动。以下目录中的文件可以直接删除:
- log/:日志目录下的日志文件。
+
- snapshot/: 快照目录下的快照文件。
+
- trash/:回收站中的文件。
**这种操作会对 [从 BE 回收站中恢复数据](../data-admin/delete-recover.md) 产生影响。**
- 如果BE还能够启动,则可以使用`ADMIN CLEAN TRASH ON(BackendHost:BackendHeartBeatPort);`来主动清理临时文件,会清理 **所有** trash文件和过期snapshot文件,**这将影响从回收站恢复数据的操作** 。
+ 如果 BE 还能够启动,则可以使用`ADMIN CLEAN TRASH ON(BackendHost:BackendHeartBeatPort);`来主动清理临时文件,会清理 **所有** trash 文件和过期 snapshot 文件,**这将影响从回收站恢复数据的操作** 。
如果不手动执行`ADMIN CLEAN TRASH`,系统仍将会在几分钟至几十分钟内自动执行清理,这里分为两种情况:
- - 如果磁盘占用未达到 **危险水位(Flood Stage)** 的90%,则会清理过期trash文件和过期snapshot文件,此时会保留一些近期文件而不影响恢复数据。
- - 如果磁盘占用已达到 **危险水位(Flood Stage)** 的90%,则会清理 **所有** trash文件和过期snapshot文件, **此时会影响从回收站恢复数据的操作** 。 自动执行的时间间隔可以通过配置项中的`max_garbage_sweep_interval`和`min_garbage_sweep_interval`更改。
+ - 如果磁盘占用未达到 **危险水位 (Flood Stage)** 的 90%,则会清理过期 trash 文件和过期 snapshot 文件,此时会保留一些近期文件而不影响恢复数据。
+
+ - 如果磁盘占用已达到 **危险水位 (Flood Stage)** 的 90%,则会清理 **所有** trash 文件和过期 snapshot 文件, **此时会影响从回收站恢复数据的操作** 。自动执行的时间间隔可以通过配置项中的`max_garbage_sweep_interval`和`min_garbage_sweep_interval`更改。
- 出现由于缺少trash文件而导致恢复失败的情况时,可能返回如下结果:
+ 出现由于缺少 trash 文件而导致恢复失败的情况时,可能返回如下结果:
```text
{"status": "Fail","msg": "can find tablet path in trash"}
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/doris-error-code.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/doris-error-code.md
index 4f9e57deb335..a82e6a8d346c 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/doris-error-code.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/admin-manual/maint-monitor/doris-error-code.md
@@ -1,6 +1,6 @@
---
{
- "title": "Doris错误代码表",
+ "title": "Doris 错误代码表",
"language": "zh-CN"
}
@@ -25,7 +25,7 @@ specific language governing permissions and limitations
under the License.
-->
-# Doris错误代码表
+
| 错误码 | 错误信息 |
| :----- | :----------------------------------------------------------- |
@@ -40,23 +40,23 @@ under the License.
| 1050 | 数据表已经存在 |
| 1051 | 无效的数据表 |
| 1052 | 指定的列名有歧义,不能唯一确定对应列 |
-| 1053 | 为Semi-Join/Anti-Join查询指定了非法的数据列 |
+| 1053 | 为 Semi-Join/Anti-Join 查询指定了非法的数据列 |
| 1054 | 指定的列在表中不存在 |
| 1058 | 查询语句中选择的列数目与查询结果的列数目不一致 |
| 1060 | 列名重复 |
-| 1064 | 没有存活的Backend节点 |
+| 1064 | 没有存活的 Backend 节点 |
| 1066 | 查询语句中出现了重复的表别名 |
-| 1094 | 线程ID无效 |
+| 1094 | 线程 ID 无效 |
| 1095 | 非线程的拥有者不能终止线程的运行 |
| 1096 | 查询语句没有指定要查询或操作的数据表 |
| 1102 | 数据库名不正确 |
| 1104 | 数据表名不正确 |
| 1105 | 其它错误 |
| 1110 | 子查询中指定了重复的列 |
-| 1111 | 在Where从句中非法使用聚合函数 |
+| 1111 | 在 Where 从句中非法使用聚合函数 |
| 1113 | 新建表的列集合不能为空 |
| 1115 | 使用了不支持的字符集 |
-| 1130 | 客户端使用了未被授权的IP地址来访问系统 |
+| 1130 | 客户端使用了未被授权的 IP 地址来访问系统 |
| 1132 | 无权限修改用户密码 |
| 1141 | 撤销用户权限时指定了用户不具备的权限 |
| 1142 | 用户执行了未被授权的操作 |
@@ -65,55 +65,55 @@ under the License.
| 1203 | 用户使用的活跃连接数超过了限制 |
| 1211 | 不允许创建新用户 |
| 1227 | 拒绝访问,用户执行了无权限的操作 |
-| 1228 | 会话变量不能通过SET GLOBAL指令来修改 |
-| 1229 | 全局变量应通过SET GLOBAL指令来修改 |
+| 1228 | 会话变量不能通过 SET GLOBAL 指令来修改 |
+| 1229 | 全局变量应通过 SET GLOBAL 指令来修改 |
| 1230 | 相关的系统变量没有缺省值 |
| 1231 | 给某系统变量设置了无效值 |
| 1232 | 给某系统变量设置了错误数据类型的值 |
| 1248 | 没有给内联视图设置别名 |
-| 1251 | 客户端不支持服务器请求的身份验证协议;请升级MySQL客户端 |
+| 1251 | 客户端不支持服务器请求的身份验证协议;请升级 MySQL 客户端 |
| 1286 | 配置的存储引擎不正确 |
| 1298 | 配置的时区不正确 |
| 1347 | 对象与期望的类型不匹配 |
-| 1353 | SELECT和视图的字段列表具有不同的列数 |
-| 1364 | 字段不允许NULL值,但是没有设置缺省值 |
+| 1353 | SELECT 和视图的字段列表具有不同的列数 |
+| 1364 | 字段不允许 NULL 值,但是没有设置缺省值 |
| 1372 | 密码长度不够 |
| 1396 | 用户执行的操作运行失败 |
| 1471 | 指定表不允许插入数据 |
... 51542 lines suppressed ...
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org