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

[Enhancement] Add a tool for capitalizing all titles and do it #1376

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion docs/admin-manual/cluster-management/load-balancing.md
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ cd /usr/local/nginx
/usr/local/nginx/sbin/nginx -c conf.d/default.conf
```

### verify
### Verify

```
mysql -uroot -P6030 -h172.31.7.119
Expand Down
12 changes: 6 additions & 6 deletions docs/admin-manual/config/user-property.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,18 @@ User-level configuration items will only take effect for the specified users, an

## Configuration item list

### max_user_connections
### Max_user_connections

The maximum number of user connections, the default value is 100 In general, this parameter does not need to be changed unless the number of concurrent queries exceeds the default value.

### max_query_instances
### Max_query_instances

The maximum number of instances that the user can use at a certain point in time, The default value is -1, negative number means use default_max_query_instances config.

### resource
### Resource

### quota
### Quota

### default_load_cluster
### Default_load_cluster

### load_cluster
### Load_cluster
4 changes: 2 additions & 2 deletions docs/admin-manual/data-admin/recyclebin.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ In addition, users can use the command `show trash` to view the trash data capac

#### Operation

##### single mode
##### Single mode

1. http request method

Expand Down Expand Up @@ -132,7 +132,7 @@ In addition, users can use the command `show trash` to view the trash data capac
sh tools/restore_tablet_tool.sh --backend "http://127.0.0.1:8040" --tablet_id 12345 --schema_hash 11111
```

##### batch mode
##### Batch mode

The batch recovery mode is used to realize the function of recovering multiple tablet data.

Expand Down
2 changes: 1 addition & 1 deletion docs/admin-manual/maint-monitor/automatic-service-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The automatic pull-up service of FE and BE must be configured after the Doris cl

For details about systemd usage and parameter parsing, see [here](https://systemd.io/)

### sudo permission control
### Sudo permission control

sudo permissions are required to control the doris service using systemd. To ensure the minimum granularity of sudo permission assignment, you can assign the systemd control permission of doris-fe and doris-be services to specified non-root users. Configure the systemctl management permission for doris-fe and doris-be in visudo.

Expand Down
2 changes: 1 addition & 1 deletion docs/admin-manual/resource-admin/workload-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Doris supports analyzing workloads in the cluster through the Workload system ta

## Workload Table
All tables are in the database```information_schema```.
### active_queries
### Active_queries
```active_queries``` records quereis in FE:
* query_id, query's id
* query_start_time, the time when the query starts executing; if the query was queued, it represents the time when execution begins after the queuing ends.
Expand Down
4 changes: 2 additions & 2 deletions docs/admin-manual/system-tables/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ under the License.

Apache Doris cluster has multiple built-in system databases to store metadata information about the Doris system itself.

### information_schema
### Information_schema

All tables under the `information_schema` database are virtual tables and do not have physical entities. These system tables contain metadata about the Doris cluster and all its database objects, including databases, tables, columns, permissions, etc. They also include functional status information like Workload Group, Task, etc.

Expand All @@ -36,7 +36,7 @@ All tables in the `information_schema` database are read-only, and users cannot

By default, all users have read permissions for all tables in this database, but the query results will vary based on the user's actual permission. For example, if User A only has permissions for `db1.table1`, querying the `information_schema.tables` table will only return information related to `db1.table1`.

### mysql
### Mysql

All tables under the `mysql` database are virtual tables and do not have physical entities. These system tables contain information such as permissions and are mainly used for MySQL ecosystem compatibility.

Expand Down
48 changes: 24 additions & 24 deletions docs/compute-storage-decoupled/meta-service-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ For certain fields, special attention should be paid to their allowed value rang
| cloud_unique_id | A configuration in `be.conf` and `fe.conf` in the compute-storage decoupled mode; should be provided in a create_cluster request; the format of it is `1:<instance_id>:<string>`, in which the `string` should conform to the format of `[0-9a-zA-Z_-]+`. The value for each node should be different. | Example: `1:regression_instance0:regression-cloud-unique-id-1` |
| cluster_name | In the compute-storage decoupled mode, this field is required when describing a compute cluster. It must be a unique identifier and its format should match the pattern ` [a-zA-Z][0-9a-zA-Z_]+` | Example: `write_cluster`, `read_cluster0` |

## create_instance (multiple storage vaults)
## Create_instance (multiple storage vaults)

### Description

Expand Down Expand Up @@ -232,7 +232,7 @@ Content-Type: text/plain
}
```

## create_instance (one storage vault)
## Create_instance (one storage vault)

:::caution

Expand Down Expand Up @@ -351,7 +351,7 @@ Content-Type: text/plain
}
```

## drop_instance
## Drop_instance

### Description

Expand Down Expand Up @@ -412,7 +412,7 @@ Content-Type: text/plain
}
```

## get_instance
## Get_instance

### Description

Expand Down Expand Up @@ -585,7 +585,7 @@ Content-Type: text/plain
}
```

## set_instance_status
## Set_instance_status

### Description

Expand Down Expand Up @@ -637,7 +637,7 @@ curl '127.0.0.1:5000/MetaService/http/set_instance_status?token=greedisgood9999'
}
```

## get_obj_store_info
## Get_obj_store_info

### Description

Expand Down Expand Up @@ -710,7 +710,7 @@ Content-Type: text/plain
}
```

## update_ak_sk
## Update_ak_sk

### Description

Expand Down Expand Up @@ -813,7 +813,7 @@ Content-Type: text/plain
}
```

## legacy_update_ak_sk
## Legacy_update_ak_sk

:::caution

Expand Down Expand Up @@ -894,7 +894,7 @@ Content-Type: text/plain
}
```

## add_obj_info
## Add_obj_info

### Description

Expand Down Expand Up @@ -978,7 +978,7 @@ Content-Type: text/plain
}
```

## add_cluster
## Add_cluster

### Description

Expand Down Expand Up @@ -1075,7 +1075,7 @@ Content-Type: text/plain
}
```

## get_cluster
## Get_cluster

### Description

Expand Down Expand Up @@ -1160,7 +1160,7 @@ Content-Type: text/plain
}
```

## drop_cluster
## Drop_cluster

### Description

Expand Down Expand Up @@ -1232,7 +1232,7 @@ Content-Type: text/plain
}
```

## rename_cluster
## Rename_cluster

### Description

Expand Down Expand Up @@ -1304,7 +1304,7 @@ Content-Type: text/plain
}
```

## add_node
## Add_node

### Description

Expand Down Expand Up @@ -1412,7 +1412,7 @@ Content-Type: text/plain
}
```

## drop_node
## Drop_node

### Description

Expand Down Expand Up @@ -1512,7 +1512,7 @@ Content-Type: text/plain
}
```

## update_cluster_mysql_user_name
## Update_cluster_mysql_user_name

### Description

Expand Down Expand Up @@ -1592,7 +1592,7 @@ Content-Type: text/plain
}
```

## cloud_cluster_status
## Cloud_cluster_status

### Description

Expand Down Expand Up @@ -1669,7 +1669,7 @@ curl -u root: http://127.0.0.1:12100/rest/v2/manager/cluster/cluster_info/cloud_
}
```

## enable_instance_sse
## Enable_instance_sse

### Description

Expand Down Expand Up @@ -1730,7 +1730,7 @@ Content-Type: text/plain
}
```

## get_cluster_status
## Get_cluster_status

### Description

Expand Down Expand Up @@ -1811,7 +1811,7 @@ Content-Type: text/plain
}
```

## set_cluster_status
## Set_cluster_status

### Description

Expand Down Expand Up @@ -1890,7 +1890,7 @@ Attempts to execute status transitions other than those listed above will incur
}
```

## decode_key
## Decode_key

### Description

Expand Down Expand Up @@ -1932,7 +1932,7 @@ Content-Type: text/plain
0110696e7374616e636500011072656772657373696f6e5f696e7374616e6365300001
```

## get_tablet_stats
## Get_tablet_stats

### Description

Expand Down Expand Up @@ -2009,7 +2009,7 @@ tablet_stats {
}
```

## abort_txn
## Abort_txn

### Description

Expand Down Expand Up @@ -2065,7 +2065,7 @@ status {
}
```

## abort_tablet_job
## Abort_tablet_job

### Description

Expand Down
2 changes: 1 addition & 1 deletion docs/data-operate/import/import-way/broker-load-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -719,7 +719,7 @@ Processing Volume per BE for this Import = Source File Size / Import Concurrency

- The default broker load timeout in seconds.

### session variables
### Session variables

**exec_mem_limit**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ When loading data, vertically cut the bitmap value range of the user. For exampl

Note: The orthogonal bitmap function cannot be used in the partitioned table. Because the partitions of the partitioned table are orthogonal, the data between partitions cannot be guaranteed to be orthogonal, so the calculation result cannot be estimated.

#### orthogonal_bitmap_intersect
#### Orthogonal_bitmap_intersect

The bitmap intersection function

Expand All @@ -112,7 +112,7 @@ select BITMAP_COUNT(orthogonal_bitmap_intersect(user_id, tag, 13080800, 11110200

```

#### orthogonal_bitmap_intersect_count
#### Orthogonal_bitmap_intersect_count

To calculate the bitmap intersection count function, the syntax is the same as the original Intersect_Count, but the implementation is different

Expand All @@ -129,7 +129,7 @@ Explain:
on the basis of this table schema, the query planning aggregation is divided into two layers. In the first layer, be nodes (update and serialize) first press filter_ Values are used to hash aggregate the keys, and then the intersection of bitmaps of all keys is performed, and then the intersection results are counted. The count values are serialized and sent to the second level be nodes (merge and finalize). In the second level be nodes, the sum of all the count values from the first level nodes is calculated circularly


#### orthogonal_bitmap_union_count
#### Orthogonal_bitmap_union_count

Figure out the bitmap union count function, syntax with the original bitmap_union_count, but the implementation is different.

Expand All @@ -141,7 +141,7 @@ Explain:

on the basis of this table schema, this function is divided into two layers. In the first layer, be nodes (update and serialize) merge all the bitmaps, and then count the resulting bitmaps. The count values are serialized and sent to the second level be nodes (merge and finalize). In the second layer, the be nodes are used to calculate the sum of all the count values from the first level nodes

#### orthogonal_bitmap_expr_calculate
#### Orthogonal_bitmap_expr_calculate

Compute the function by computing the intersection, union and difference set of the expression bitmap.

Expand All @@ -159,7 +159,7 @@ Explain:

the aggregation of query planning is divided into two layers. The first layer of be aggregation node calculation includes init, update, and serialize steps. The second layer of be aggregation node calculation includes merge and finalize steps. In the first layer of be node, the input string is parsed in the init phase, which is converted into a suffix expression (inverse Polish), parses the calculated key value, and initializes it in the map<key, bitmap>structure; In the update phase, the underlying kernel scan dimension column (filter_column) calls back the update function, and then aggregates the bitmap in the map structure of the previous step in the unit of computing key; In the serialize stage, the bitmap of the key column is parsed according to the suffix expression, and the bitmap intersection, merge and difference set is calculated using the first in, last out principle of the stack structure. Then the final bitmap is serialized and sent to the aggregation be node in the second layer. Aggregates be nodes in the second layer, finds the union set of all bitmap values from the first layer nodes, and returns the final bitmap results

#### orthogonal_bitmap_expr_calculate_count
#### Orthogonal_bitmap_expr_calculate_count

Compute the count function by computing the intersection, union and difference set of the expression bitmap. The syntax and parameters is the same as orthogonal_bitmap_expr_calculate

Expand Down
6 changes: 3 additions & 3 deletions docs/sql-manual/sql-data-types/aggregate/AGG-STATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ under the License.
-->

## AGG_STATE
### description
### Description
AGG_STATE cannot be used as a key column, and the signature of the aggregation function must be declared at the same time when creating the table.
User does not need to specify length and default value. The actual stored data size is related to the function implementation.

Expand All @@ -37,7 +37,7 @@ under the License.

**Note: Because agg_state stores the intermediate result of the aggregation function, the read and write process is strongly dependent on the specific implementation of the aggregation function, if the implementation of the aggregation function is modified during the Doris version upgrade, it may cause incompatible situations. If the incompatibility occurs, the materialized view using the corresponding agg_state needs to be dropped and recreated, and the underlying aggregation table involved will be directly unavailable, so you need to use agg_state with caution.**

### example
### Example

Create table example:
```sql
Expand Down Expand Up @@ -96,6 +96,6 @@ If you need to get the actual result, you need to use the corresponding [merge](
If you want to aggregate only the agg_state without getting the actual result during the process, you can use the [union](../..//sql-functions/combinators/union.md) function.

For more examples, see [datatype_p0/agg_state](https://github.com/apache/doris/tree/master/regression-test/suites/datatype_p0/agg_state)
### keywords
### Keywords

AGG_STATE
4 changes: 2 additions & 2 deletions docs/sql-manual/sql-data-types/aggregate/BITMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ And the BITMAP column can only be queried or used by supporting functions such a
The use of BITMAP in offline scenarios will affect the import speed. In the case of a large amount of data, the query speed will be slower than HLL and better than Count Distinct.
Note: If BITMAP does not use a global dictionary in real-time scenarios, using bitmap_hash() may cause an error of about one-thousandth. If the error rate is not tolerable, bitmap_hash64 can be used instead.

### example
### Example

Create table example:

Expand Down Expand Up @@ -70,5 +70,5 @@ Query data example:

When querying, BITMAP can cooperate with `return_object_data_as_binary`. For details, please refer to [variables](../../../advanced/variables.md).

### keywords
### Keywords
BITMAP
Loading
Loading