Skip to content

Commit

Permalink
[doc] Fix subhead links (#21296)
Browse files Browse the repository at this point in the history
* links

* links

* lint

* links in develop

* Apply suggestions from code review

Co-authored-by: Aishwarya Chakravarthy  <[email protected]>

* minor edits

---------

Co-authored-by: Aishwarya Chakravarthy <[email protected]>
  • Loading branch information
ddhodge and aishwarya24 authored Mar 6, 2024
1 parent 3aef557 commit 19c131f
Show file tree
Hide file tree
Showing 32 changed files with 86 additions and 71 deletions.
4 changes: 4 additions & 0 deletions .github/vale-styles/Yugabyte/spelling-exceptions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ backport
backported
backporting
backports
backquote
backtrace
backtraced
backtraces
Expand Down Expand Up @@ -138,6 +139,7 @@ crosslinked
crosslinking
crosslinks
Crossplane
crosstab
CrowdIn
CSV
Cutover
Expand Down Expand Up @@ -878,6 +880,8 @@ YBase
ycqlsh
YouTrack
ysqlsh
ysql_dump
ysql_dumpall
ytt
Yubico
Yugabyte
Expand Down
2 changes: 1 addition & 1 deletion docs/content/preview/admin/yb-ctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ For details and examples, see [Create a local cluster with custom flags](#create

**Example**

To enable [YSQL authentication](../../secure/enable-authentication/ysql/), you can use the `--tserver_flags` flag to add the `yb-tserver` [`--ysql_enable-auth`](../yb-tserver/#ysql-enable-auth) flag to the `yb-ctl create | start | restart` commands.
To enable [YSQL authentication](../../secure/enable-authentication/ysql/), you can use the `--tserver_flags` flag to add the `yb-tserver` [`--ysql_enable_auth`](../yb-tserver/#ysql-enable-auth) flag to the `yb-ctl create | start | restart` commands.

```sh
$./bin/yb-ctl create --tserver_flags "ysql_enable_auth=true"
Expand Down
13 changes: 6 additions & 7 deletions docs/content/preview/admin/yb-ts-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ yb-ts-cli [ --server_address=<host>:<port> ] compact_tablet <tablet_id>

##### count_intents

Print the count of uncommitted intents (or [provisional records](../../../architecture/transactions/distributed-txns/#provisional-records)). Useful for debugging transactional workloads.
Print the count of uncommitted intents (or [provisional records](../../architecture/transactions/distributed-txns/#provisional-records)). Helpful for debugging transactional workloads.

**Syntax**

Expand All @@ -118,7 +118,7 @@ yb-ts-cli [ --server_address=<host>:<port> ] count_intents

##### current_hybrid_time

Prints the value of the current [hybrid time](../../../architecture/transactions/single-row-transactions/#hybrid-time-as-an-mvcc-timestamp).
Prints the value of the current [hybrid time](../../architecture/transactions/transactions-overview/#mvcc-using-hybrid-time).

**Syntax**

Expand All @@ -140,7 +140,7 @@ yb-ts-cli [ --server_address=<host>:<port> ] delete_tablet <tablet_id> "<reason

* *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`.
* *tablet_id*: The identifier (ID) for the tablet.
* *reason-string*: Text string providing useful information on why the tablet was deleted.
* *reason-string*: Text string providing information on why the tablet was deleted.

##### dump_tablet

Expand Down Expand Up @@ -232,14 +232,14 @@ yb-ts-cli [ --server_address=<host>:<port> ] set_flag [ --force ] <flag> <value>

* *host*:*port*: The *host* and *port* of the tablet server. Default is `localhost:9100`.
* `--force`: Flag to allow a change to a flag that is not explicitly marked as runtime-settable. Note that the change may be ignored on the server or may cause the server to crash, if unsafe values are provided. See [--force](#force).
* *flag*: The `yb-tserver` configuration flag (without the `--` prefix) to be set. See [`yb-tserver`](../../reference/configuration/yb-tserver/#configuration-flags)
* *flag*: The `yb-tserver` configuration flag (without the `--` prefix) to be set. See [`yb-tserver`](../../reference/configuration/yb-tserver/)
* *value*: The value to be applied.

{{< note title="Important" >}}

The `set_flag` command changes the in-memory value of the specified flag, atomically, for a running server and can alter its behavior. **The change does NOT persist across restarts.**

In practice, there are some flags that are runtime safe to change (runtime-settable) and some that are not. For example, the bind address of the server cannot be changed at runtime, since the server binds just once at startup. While most of the flags are probably runtime-settable, you need to review the flags and note in the configuration pages which flags are not runtime-settable. (See GitHub issue [#3534](https://github.com/yugabyte/yugabyte-db/issues/3534)).
In practice, there are some flags that are runtime safe to change (runtime-settable) and some that are not. For example, the bind address of the server cannot be changed at runtime, because the server binds just once at startup. While most of the flags are probably runtime-settable, you need to review the flags and note in the configuration pages which flags are not runtime-settable. (See GitHub issue [#3534](https://github.com/yugabyte/yugabyte-db/issues/3534)).

One typical operational flow is that you can use this to modify runtime flags in memory and then out of band also modify the configuration file that the server uses to start. This allows for flags to be changed on running servers, without executing a restart of the server.

Expand All @@ -261,7 +261,7 @@ For an example, see [Return the status of a tablet server](#return-the-status-of

##### refresh_flags

Refresh flags that are loaded from the configuration file. Works on both YB-Master (port 9100) and YB-TServer (port 7100) process. No parameters needed.
Refresh flags that are loaded from the configuration file. Works on both YB-Master (port 9100) and YB-TServer (port 7100) process. No parameters needed.

Each process needs to have the following command issued, for example, issuing the command on one YB-TServer won't update the flags on the other YB-TServers.

Expand Down Expand Up @@ -301,7 +301,6 @@ To connect to a cluster with TLS enabled, you must include the `--certs_dir_name

Default: `""`


## Examples

### Return the status of a tablet server
Expand Down
2 changes: 1 addition & 1 deletion docs/content/preview/admin/ycqlsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ ycqlsh [flags] [host [port]]
Where
- `host` is the IP address of the host on which [YB-TServer](../../architecture/concepts/universe/#yb-tserver-process) is run. The default is local host at `127.0.0.1`.
- `host` is the IP address of the host on which [YB-TServer](../../architecture/concepts/universe/#component-services) is run. The default is local host at `127.0.0.1`.
- `port` is the TCP port at which YB-TServer listens for YCQL connections. The default is `9042`.
### Example
Expand Down
10 changes: 5 additions & 5 deletions docs/content/preview/admin/ysql-dump.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ysql_dump is a utility for backing up a YugabyteDB database into a plain-text, S

ysql_dump only dumps a single database. To backup global objects that are common to all databases in a cluster, such as roles, use [ysql_dumpall](../ysql-dumpall/).

Dumps are output in plain-text, SQL script files. Script dumps are plain-text files containing the SQL statements required to reconstruct the database to the state it was in at the time it was saved. To restore from such a script, import it using the [`ysqlsh \i`](../ysqlsh-meta-commands/#-i-filename-include-filename) meta-command. Script files can be used to reconstruct the database even on other machines and other architectures; with some modifications, even on other SQL database products.
Dumps are output in plain-text, SQL script files. Script dumps are plain-text files containing the SQL statements required to reconstruct the database to the state it was in at the time it was saved. To restore from such a script, import it using the [`ysqlsh \i`](../ysqlsh-meta-commands/#i-filename-include-filename) meta-command. Script files can be used to reconstruct the database even on other machines and other architectures; with some modifications, even on other SQL database products.

While running ysql_dump, you should examine the output for any warnings (printed on standard error).

Expand Down Expand Up @@ -120,7 +120,7 @@ Dump only the object definitions (schema), not data.

This option is the inverse of [`-a|--data-only`](#a-data-only).

(Do not confuse this with the [`-n|--schema`](#n-schema-schema-schema) option, which uses the word schema in a different meaning.)
(Do not confuse this with the [`-n|--schema`](#n-schema-schema-schema) option, which uses the word "schema" in a different meaning.)

To exclude table data for only a subset of tables in the database, see [`--exclude-table-data`](#exclude-table-data).

Expand All @@ -142,9 +142,9 @@ When `-t|--table` is specified, ysql_dump makes no attempt to dump any other dat

#### -T *table*, --exclude-table=*table*

Do not dump any tables matching the table pattern. The pattern is interpreted according to the same rules as for [`-t`](#t-table). [`-T|--exclude-table`](#T-table-exclude-table-table) can be given more than once to exclude tables matching any of several patterns.
Do not dump any tables matching the table pattern. The pattern is interpreted according to the same rules as for [`-t`](#t-table-table-table). `-T|--exclude-table` can be given more than once to exclude tables matching any of several patterns.

When both [`-t|--table`](#t-table-table-table) and `-T|--exclude-table` are given, the behavior is to dump just the tables that match at least one [`-t|--table`](#t-table-table-table) option but no `-T|--exclude-table` options. If `-T|--exclude-table` appears without `-t|--table`, then tables matching `-T|--exclude-table` are excluded from what is otherwise a normal dump.
When both `-t|--table` and `-T|--exclude-table` are given, the behavior is to dump just the tables that match at least one `-t|--table` option but no `-T|--exclude-table` options. If `-T|--exclude-table` appears without `-t|--table`, then tables matching `-T|--exclude-table` are excluded from what is otherwise a normal dump.

#### -v, --verbose

Expand Down Expand Up @@ -288,7 +288,7 @@ This option is never essential, as ysql_dump automatically prompts for a passwor

#### --role=*rolename*

Specifies a role name to be used to create the dump. This option causes ysql_dump to issue a `SET ROLE <rolename>` statement after connecting to the database. It is useful when the authenticated user (specified by [`-U|--username`](#u-username)) lacks privileges needed by ysql_dump, but can switch to a role with the required rights. Some installations have a policy against logging in directly as a superuser, and use of this option allows dumps to be made without violating the policy.
Specifies a role name to be used to create the dump. This option causes ysql_dump to issue a `SET ROLE <rolename>` statement after connecting to the database. It is useful when the authenticated user (specified by [`-U|--username`](#u-username-username-username)) lacks privileges needed by ysql_dump, but can switch to a role with the required rights. Some installations have a policy against logging in directly as a superuser, and use of this option allows dumps to be made without violating the policy.

## Environment

Expand Down
10 changes: 5 additions & 5 deletions docs/content/preview/admin/ysql-dumpall.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ type: docs

## Overview

ysql_dumpall is a utility for writing out (dumping) all YugabyteDB databases of a cluster into one plain-text, SQL script file. The script file contains SQL statements that can be used as input to `ysqlsh` to restore the databases. It does this by calling [ysql_dump](../ysql-dump/) for each database in the YugabyteDB cluster. ysql_dumpall also dumps global objects that are common to all databases, such as database roles. (ysql_dump does not export roles.)
ysql_dumpall is a utility for writing out ("dumping") all YugabyteDB databases of a cluster into one plain-text, SQL script file. The script file contains SQL statements that can be used as input to `ysqlsh` to restore the databases. It does this by calling [ysql_dump](../ysql-dump/) for each database in the YugabyteDB cluster. ysql_dumpall also dumps global objects that are common to all databases, such as database roles. (ysql_dump does not export roles.)

Because ysql_dumpall reads tables from all databases, you will most likely have to connect as a database superuser in order to produce a complete dump. Also, you will need superuser privileges to execute the saved script in order to be allowed to add roles and create databases.

The SQL script will be written to the standard output. Use the [`-f|--file`](#f-file-filename) option or shell operators to redirect it into a file.
The SQL script will be written to the standard output. Use the [`-f|--file`](#f-filename-file-filename) option or shell operators to redirect it into a file.

ysql_dumpall needs to connect multiple times (once per database) to the YugabyteDB cluster. If you use password authentication, it will ask for a password each time. It is convenient to have a `~/.pgpass` file in such cases.

Expand Down Expand Up @@ -173,7 +173,7 @@ The following command line options control the database connection parameters.

Specifies parameters used to connect to the server, as a connection string.

The option is called `-d|--dbname` for consistency with other client applications, but because ysql_dumpall needs to connect to many databases, the database name in the connection string will be ignored. Use the [`-l|--database`](#l-database-database) option to specify the name of the database used for the initial connection, which will dump global objects and discover what other databases should be dumped.
The option is called `-d|--dbname` for consistency with other client applications, but because ysql_dumpall needs to connect to many databases, the database name in the connection string will be ignored. Use the [`-l|--database`](#l-dbname-database-database) option to specify the name of the database used for the initial connection, which will dump global objects and discover what other databases should be dumped.

#### -h *host*, --host *host*

Expand All @@ -193,7 +193,7 @@ The username to connect as.

#### -w, --no-password

Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a `~/.pgpass` file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.
Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a `~/.pgpass` file, the connection attempt will fail. This option can be helpful in batch jobs and scripts where no user is present to enter a password.

#### -W, --password

Expand All @@ -209,7 +209,7 @@ For each database to be dumped, a password prompt will occur. To avoid having to

#### --role=*rolename*

Specifies a role name to be used to create the dump. This option causes ysql_dumpall to issue a `SET ROLE <rolename>` statement after connecting to the database. It is helpful when the authenticated user (specified by [`-U|--username`](#u-username-username)) lacks privileges needed by ysql_dumpall, but can switch to a role with the required rights. Some installations have a policy against logging in directly as a superuser, and use of this option allows dumps to be made without violating the policy.
Specifies a role name to be used to create the dump. This option causes ysql_dumpall to issue a `SET ROLE <rolename>` statement after connecting to the database. It is helpful when the authenticated user (specified by [`-U|--username`](#u-username-username-username)) lacks privileges needed by ysql_dumpall, but can switch to a role with the required rights. Some installations have a policy against logging in directly as a superuser, and use of this option allows dumps to be made without violating the policy.

## Environment

Expand Down
4 changes: 2 additions & 2 deletions docs/content/preview/admin/ysqlsh-meta-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ Unlike most other meta-commands, the entire remainder of the line is always take

##### \f [ string ]

Sets the field separator for unaligned query output. The default is the vertical bar (`|`). It is equivalent to [\pset fieldsep](../ysqlsh-pset-options/#pset-option-value).
Sets the field separator for unaligned query output. The default is the vertical bar (`|`). It is equivalent to [\pset fieldsep](../ysqlsh-pset-options/#fieldsep).

##### \g [ filename ], \g [ |command ]

Expand Down Expand Up @@ -553,7 +553,7 @@ Sets options affecting the output of query result tables. *option* indicates whi

`\pset` without any arguments displays the current status of all printing options.

The *options* are defined in [pset options](../ysqlsh-pset-options/#pset-options).
The *options* are defined in [pset options](../ysqlsh-pset-options/).

For examples using `\pset`, see [ysqlsh meta-command examples](../ysqlsh-meta-examples/).

Expand Down
2 changes: 1 addition & 1 deletion docs/content/preview/admin/ysqlsh-meta-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ SELECT t1.first as "A", t2.first+100 AS "B", t1.first*(t2.first+100) as "AxB",

## pset

You can display tables in different ways by using the [`\pset`](../ysqlsh-pset-options/#pset-option-value) command:
You can display tables in different ways by using the [`\pset`](../ysqlsh-pset-options/) command:

```sql
\pset border 2
Expand Down
2 changes: 1 addition & 1 deletion docs/content/preview/admin/ysqlsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ Turn on HTML tabular output. This is equivalent to [\pset format html](../ysqlsh
##### -l, --list
List all available databases, then exit. Other non-connection options are ignored. This is similar to the meta-command [`\list`](../ysqlsh-meta-commands/#l-list-pattern).
List all available databases, then exit. Other non-connection options are ignored. This is similar to the meta-command [`\list`](../ysqlsh-meta-commands/#l-list-pattern-patterns).
When this option is used, ysqlsh connects to the database `yugabyte`, unless a different database is named on the command line (flag `-d` or non-option argument, possibly using a service entry, but not using an environment variable).
Expand Down
6 changes: 3 additions & 3 deletions docs/content/preview/architecture/core-functions/read-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ menu:
type: docs
---

The read I/O path can be illustrated by an example of a single key read that involves indentifying a tablet leader which then performs a read operation.
The read I/O path can be illustrated by an example of a single key read that involves identifying a tablet leader which then performs a read operation.

## Tablet leader identification

The user-issued read request interacts with the YQL query layer via a port with the appropriate API (either YSQL or YCQL). This user request is translated by the YQL layer into an internal key, allowing the YQL layer to find the tablet and the YB-TServers hosting it. The YQL layer performs this by making an RPC call to the YB-Master. The response is cached for future uses. Next, the YQL layer issues the read to the YB-TServer that hosts the leader tablet peer. The read is handled by the leader of the Raft group of the tablet owning the internal key. The leader of the tablet Raft group which handles the read request reads from its DocDB and returns the result to the user.

As described in [Write I/O path](../write-path/#step-1-identify-tablet-leader), the YugabyteDB smart client can route the application requests directly to the correct YB-TServer, avoiding any extra network hops or master lookups.
As described in [Write I/O path](../write-path/), the YugabyteDB smart client can route the application requests directly to the correct YB-TServer, avoiding any extra network hops or master lookups.

## Read operation performed by tablet leader

Suppose there is a requirement to read the value where the primary key column `K` has a value `k` from table `T1`. The table `T1` has a key column `K` and a value column `V`. The following diagram depicts the read flow:

![read_path_io](/images/architecture/read_path_io.png)
![Read path](/images/architecture/read_path_io.png)

The default is strongly-consistent read.

Expand Down
Loading

0 comments on commit 19c131f

Please sign in to comment.