Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Frontmatter 22 #35250

Merged
merged 1 commit into from
Nov 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 4 additions & 0 deletions docs/en/administration/Authentication.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Authentication methods

In addition to the authentication method of "username+password", StarRocks also supports LDAP.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Backup_and_restore.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Backup and Recovery

StarRocks supports backing up the current data as a file to a remote storage system via the broker (the broker is an optional process in the StarRocks cluster, mainly used to support StarRocks to read and write files and directories on the remote storage, please refer to the [Broker Load documentation](../loading/BrokerLoad.md). The backup data can be restored from the remote storage system to any StarRocks cluster with the restore command. This feature supports periodic snapshot backup of data. It also allows migrating data between clusters.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Blacklist.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Blacklist Management

In some cases, administrators need to disable certain patterns of SQL to avoid SQL from triggering cluster crashes or unexpected high concurrent queries.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Build_in_docker.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Introduction of the dev-env image

## Download the image
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Cluster_administration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Manage a cluster

This topic explains how to manage a cluster.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Configuration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Parameter Configuration

After the service is started, you may adjust the configuration parameters to meet the business requirements. You need to reboot the BE and Fe to apply the changes.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Data_recovery.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Data Recovery

StarRocks supports data recovery for mistakenly deleted databases/tables/partitions. After `drop table` or `drop database`, StarRocks will not physically delete the data immediately, but keep it in Trash for a period of time (1 day by default). Administrators can recover the mistakenly deleted data with the `RECOVER` command.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Load_balance.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Load Balancing

When deploying multiple FE nodes, users can deploy a load balancing layer on top of the FEs to achieve high availability.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Memory_management.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Memory Management

This section briefly introduces memory classification and StarRocks’ methods of managing memory.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Metadata_recovery.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Restore FEs

This topic describes how to restore the frontends (FEs) in your StarRocks cluster if the cluster is unavailable due to one of the following issues:
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Monitor_and_Alert.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Monitor and Alerting

You can build your own monitoring services, or use the Prometheus + Grafana solution. StarRocks provides a Prometheus-compatible interface that directly links to the HTTP port of the BE and FE to obtain monitoring information from the cluster.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Profiling.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Performance Optimization

## Table Creation
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Query_management.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Query Management

## Number of user connections
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Query_planning.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Query analysis

How to optimize query performance is a frequently asked question. Slow queries impair user experience as well as cluster performance. It is important to analyze and optimize query performance.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Replica.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Replica management

## Terminology
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/Scale_up_down.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Scale in and out

This topic describes how to scale in and out the node of StarRocks.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/User_privilege.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# User Privilege

Based on MySQL's permission management mechanism, StarRocks permission management system supports fine-grained permission control at table level, role-based access control, and whitelisting.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/filemanager.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# File manager

With file manager, you can create, view, and delete files, such as the files that are used to access external data sources: public key files, private key files, and certificate files. You can reference or access the created files by using commands.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/resource_group.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# [Preview] Resource group

This topic describes the resource group feature that StarRocks has started to provide since v2.2.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/administration/timezone.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Configure a time zone

This topic describes how to configure a time zone.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/benchmarking/SSB_Benchmarking.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# SSB Flat-table Benchmarking

Star schema benchmark (SSB) is designed to test basic performance metrics of OLAP database products. SSB uses a star schema test set that is widely applied in academia and industry. For more information, see the paper [Star Schema Benchmark](https://www.cs.umb.edu/~poneil/StarSchemaB.PDF).
Expand Down
4 changes: 4 additions & 0 deletions docs/en/benchmarking/TPC-H_Benchmarking.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# TPC-H Benchmarking

TPC-H is a decision support benchmark developed by the Transaction Processing Performance Council (TPC). It consists of a suite of business oriented ad-hoc queries and concurrent data modifications.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/data_source/External_table.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# External tables

StarRocks supports access to other data sources by using external tables. External tables are created based on data tables that are stored in other data sources. StarRocks only stores the metadata of the data tables. You can use external tables to directly query data in other data sources. StarRocks supports the following data sources: MySQL, Elasticsearch, Hive, StarRocks, Apache Iceberg, and Apache Hudi. **Currently, you can only write data from another StarRocks cluster into the current StarRocks cluster. You cannot read data from it. For data sources other than StarRocks, you can only read data from these data sources.**
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/Deploy_faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Deployment

This topic provides answers to some frequently asked questions about deployment.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/Exporting_faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Data Export

## Alibaba cloud OSS backup and restore
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/Others.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Others FAQs

This topic provides answers to some general questions.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/Sql_faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# SQL

This topic provides answers to some frequently asked questions about SQL.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/loading/Broker_load_faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Broker Load

## In Broker Load, can a task that has already been executed successfully (State: FINISHED) be executed again?
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/loading/DataX_faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# DataX

## Why datax writer does not have writemode parameter? Why must the tables be created in the update mode?
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/loading/Flink_connector_faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Flink Connector

## flink-connector-jdbc_2.11sink is 8 hours late in StarRocks
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/loading/Insert_into_faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Insert Into

## When performing data insert, each insert in SQL takes up 50 to 100ms. Is there any way to increase efficiency?
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/loading/Loading_faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Loading

## Common issues in loading
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/loading/Routine_load_faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Routine Load

## Does mysql binlog data produced by kafka count as text format data?
Expand Down
4 changes: 4 additions & 0 deletions docs/en/faq/loading/Stream_load_faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Stream Load

## Does Stream Load identify the column name of the first row in a text file? Or can I specify the first row not to be read?
Expand Down
4 changes: 4 additions & 0 deletions docs/en/introduction/StarRocks_intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Introduction

## What is StarRocks
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/BrokerLoad.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Load data from HDFS or cloud storage

StarRocks provides the loading method MySQL-based Broker Load to help you load dozens to hundreds of gigabytes of data from HDFS or cloud storage into StarRocks.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/DataX-starrocks-writer.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# DataX writer

## Introduction
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/Etl_in_loading.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Transform data at loading

StarRocks supports data transformation at loading.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/Flink-connector-starrocks.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Continuously load data from Apache Flink®

This topic describes how to load data from Apache Flink® to StarRocks.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/Flink_cdc_load.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Synchronize data from MySQL

This topic describes how to synchronize data from MySQL to StarRocks in seconds by using Flink CDC Connector, flink-starrocks-connector, and StarRocks Migration Tools (SMT).
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/InsertInto.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Insert Into Loading

The Insert Into statement is used similarly to the Insert Into statement in databases (e.g. MySQL).
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/Json_loading.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Introduction

You can import semi-structured data (for example, JSON) by using stream load or routine load.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/Load_to_Primary_Key_tables.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Change data through loading

The [Primary Key](../table_design/Data_model.md#primary-key-model) model provided by StarRocks allows you to make data changes to StarRocks tables by running [Stream Load](../loading/StreamLoad.md), [Broker Load](../loading/BrokerLoad.md), or [Routine Load](../loading/RoutineLoad.md) jobs. These data changes include inserts, updates, and deletions.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/Loading_intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Overview of data loading

Data loading is the process of cleansing and transforming raw data from various data sources based on your business requirements and loading the resulting data into StarRocks to facilitate blazing-fast data analytics.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/RoutineLoad.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Routine Load

The Routine load method supports continuous import of data from Kafka. Routine load can be paused, restarted, stopped by SQL. This section introduces the basic principle and usage of this method.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/SparkLoad.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Spark Load

This load uses external Apache Spark™ resources to pre-process imported data, which improves import performance and saves compute resources. It is mainly used for **initial migration** and **large data import** into StarRocks (data volume up to TB level).
Expand Down
4 changes: 4 additions & 0 deletions docs/en/loading/StreamLoad.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Load data from a local file system or a streaming data source using HTTP push

StarRocks provides the loading method HTTP-based Stream Load to help you load data from a local file system or a streaming data source.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/quick_start/Architecture.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Architecture

## System Architecture Diagram
Expand Down
4 changes: 4 additions & 0 deletions docs/en/quick_start/Concepts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Basic Concepts of StarRocks

* FE: The StarRocks frontend node is responsible for metadata management, management of client connectors, query planning, query scheduling, and so on.
Expand Down
4 changes: 4 additions & 0 deletions docs/en/quick_start/Data_flow_and_control_flow.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
displayed_sidebar: "English"
---

# Data Flow and Control Flow

## Query
Expand Down
Loading
Loading