Skip to content

Commit a7f7d15

Browse files
authored
Merge branch 'main' into v25.2.0-alpha.2-release-notes
2 parents da330d7 + 7d2d394 commit a7f7d15

File tree

69 files changed

+134
-159
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+134
-159
lines changed
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Option | Value | Description
22
----------------------------+-----------------------------------------+------------------------------
33
`first_run` | [`TIMESTAMPTZ`]({% link {{ page.version.version }}/timestamp.md %}) / `now` | Execute the schedule at the specified time in the future. If not specified, the default behavior is to execute the schedule based on its next `RECURRING` time.
4-
`on_execution_failure` | `retry` / `reschedule` / `pause` | If an error occurs during the backup execution, do the following: <ul><li>`retry`: Retry the backup right away.</li><li>`reschedule`: Retry the backup by rescheduling it based on the `RECURRING` expression.</li><li>`pause`: Pause the schedule. This requires manual intervention to [resume the schedule]({% link {{ page.version.version }}/resume-schedules.md %}).</li></ul><br>**Default**: `reschedule`
5-
<a name="on-previous-running-option"></a>`on_previous_running` | `start` / `skip` / `wait` | If the previous backup started by the schedule is still running, do the following: <ul><li>`start`: Start the new backup anyway, even if the previous one is still running.</li><li>`skip`: Skip the new backup and run the next backup based on the `RECURRING` expression.</li><li>`wait`: Wait for the previous backup to complete.</li></ul><br>**Default**: `wait`. The option affects backups started by the full backup schedule only. Incremental backups are always set to `wait`.
4+
`on_execution_failure` | `retry` / `reschedule` / `pause` | If an error occurs during the backup execution, do the following: <ul><li>`retry`: Retry the backup right away.</li><li>`reschedule`: Retry the backup by rescheduling it based on the `RECURRING` expression.</li><li>`pause`: Pause the schedule. This requires manual intervention to [resume the schedule]({% link {{ page.version.version }}/resume-schedules.md %}).</li></ul>**Default**: `reschedule`
5+
<a name="on-previous-running-option"></a>`on_previous_running` | `start` / `skip` / `wait` | If the previous backup started by the schedule is still running, do the following: <ul><li>`start`: Start the new backup anyway, even if the previous one is still running.</li><li>`skip`: Skip the new backup and run the next backup based on the `RECURRING` expression.</li><li>`wait`: Wait for the previous backup to complete.</li></ul>**Default**: `wait`. The option affects backups started by the full backup schedule only. Incremental backups are always set to `wait`.
66
`ignore_existing_backups` | N/A | If backups were already created in the [destination]({% link {{ page.version.version }}/use-cloud-storage.md %}) that the new schedule references, this option must be passed to acknowledge that the new schedule may be backing up different objects.
77
`updates_cluster_last_backup_time_metric` | N/A | ([`admin` privileges]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role) required) When set during backup schedule creation, this option updates the [`schedules_backup_last_completed_time`]({% link {{ page.version.version }}/backup-and-restore-monitoring.md %}#available-metrics) metric for the scheduled backup.

src/current/_includes/v23.1/sql/shell-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Client Options | Description
1313
<a name="sql-option-echo"></a> `echo` | Reveal the SQL statements sent implicitly by the SQL shell.<br><br>**Default:** `false`<br><br>To enable this option, run `\set echo`. [See an example]({% link {{ page.version.version }}/cockroach-sql.md %}#reveal-the-sql-statements-sent-implicitly-by-the-command-line-utility).
1414
<a name="sql-option-errexit"></a> `errexit` | Exit the SQL shell upon encountering an error.<br /><br />**Default:** `false` for [interactive sessions]({% link {{ page.version.version }}/cockroach-sql.md %}#session-and-output-types); `true` otherwise<br><br>To enable this option, run `\set errexit`.
1515
<a name="sql-option-prompt1"></a> `prompt1` | Customize the interactive prompt within the SQL shell. See [Customizing the prompt](#customizing-the-prompt) for information on the available prompt variables.
16-
<a name="sql-option-show-times"></a> `show_times` | Reveal the time a query takes to complete. Possible values:<br><ul><li>`execution` time refers to the time taken by the SQL execution engine to execute the query.</li><li>`network` time refers to the network latency between the server and the SQL client command.</li><li>`other` time refers to all other forms of latency affecting the total query completion time, including query planning.</li></ul><br>**Default:** `true`<br><br>To disable this option, run `\unset show_times`.
16+
<a name="sql-option-show-times"></a> `show_times` | Reveal the time a query takes to complete. Possible values:<br><ul><li>`execution` time refers to the time taken by the SQL execution engine to execute the query.</li><li>`network` time refers to the network latency between the server and the SQL client command.</li><li>`other` time refers to all other forms of latency affecting the total query completion time, including query planning.</li></ul>**Default:** `true`<br><br>To disable this option, run `\unset show_times`.
1717

1818
#### Customizing the prompt
1919

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Option | Value | Description
22
----------------------------+-----------------------------------------+------------------------------
33
`first_run` | [`TIMESTAMPTZ`]({% link {{ page.version.version }}/timestamp.md %}) / `now` | Execute the schedule at the specified time in the future. If not specified, the default behavior is to execute the schedule based on its next `RECURRING` time.
4-
`on_execution_failure` | `retry` / `reschedule` / `pause` | If an error occurs during the backup execution, do the following: <ul><li>`retry`: Retry the backup right away.</li><li>`reschedule`: Retry the backup by rescheduling it based on the `RECURRING` expression.</li><li>`pause`: Pause the schedule. This requires manual intervention to [resume the schedule]({% link {{ page.version.version }}/resume-schedules.md %}).</li></ul><br>**Default**: `reschedule`
5-
<a name="on-previous-running-option"></a>`on_previous_running` | `start` / `skip` / `wait` | If the previous backup started by the schedule is still running, do the following: <ul><li>`start`: Start the new backup anyway, even if the previous one is still running.</li><li>`skip`: Skip the new backup and run the next backup based on the `RECURRING` expression.</li><li>`wait`: Wait for the previous backup to complete.</li></ul><br>**Default**: `wait`. The option affects backups started by the full backup schedule only. Incremental backups are always set to `wait`.
4+
`on_execution_failure` | `retry` / `reschedule` / `pause` | If an error occurs during the backup execution, do the following: <ul><li>`retry`: Retry the backup right away.</li><li>`reschedule`: Retry the backup by rescheduling it based on the `RECURRING` expression.</li><li>`pause`: Pause the schedule. This requires manual intervention to [resume the schedule]({% link {{ page.version.version }}/resume-schedules.md %}).</li></ul>**Default**: `reschedule`
5+
<a name="on-previous-running-option"></a>`on_previous_running` | `start` / `skip` / `wait` | If the previous backup started by the schedule is still running, do the following: <ul><li>`start`: Start the new backup anyway, even if the previous one is still running.</li><li>`skip`: Skip the new backup and run the next backup based on the `RECURRING` expression.</li><li>`wait`: Wait for the previous backup to complete.</li></ul>**Default**: `wait`. The option affects backups started by the full backup schedule only. Incremental backups are always set to `wait`.
66
`ignore_existing_backups` | N/A | If backups were already created in the [destination]({% link {{ page.version.version }}/use-cloud-storage.md %}) that the new schedule references, this option must be passed to acknowledge that the new schedule may be backing up different objects.
77
`updates_cluster_last_backup_time_metric` | N/A | ([`admin` privileges]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role) required) When set during backup schedule creation, this option updates the [`schedules_backup_last_completed_time`]({% link {{ page.version.version }}/backup-and-restore-monitoring.md %}#available-metrics) metric for the scheduled backup.

src/current/_includes/v23.2/sql/shell-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Client Options | Description
1313
<a name="sql-option-echo"></a> `echo` | Reveal the SQL statements sent implicitly by the SQL shell.<br><br>**Default:** `false`<br><br>To enable this option, run `\set echo`. [See an example]({% link {{ page.version.version }}/cockroach-sql.md %}#reveal-the-sql-statements-sent-implicitly-by-the-command-line-utility).
1414
<a name="sql-option-errexit"></a> `errexit` | Exit the SQL shell upon encountering an error.<br /><br />**Default:** `false` for [interactive sessions]({% link {{ page.version.version }}/cockroach-sql.md %}#session-and-output-types); `true` otherwise<br><br>To enable this option, run `\set errexit`.
1515
<a name="sql-option-prompt1"></a> `prompt1` | Customize the interactive prompt within the SQL shell. See [Customizing the prompt](#customizing-the-prompt) for information on the available prompt variables.
16-
<a name="sql-option-show-times"></a> `show_times` | Reveal the time a query takes to complete. Possible values:<br><ul><li>`execution` time refers to the time taken by the SQL execution engine to execute the query.</li><li>`network` time refers to the network latency between the server and the SQL client command.</li><li>`other` time refers to all other forms of latency affecting the total query completion time, including query planning.</li></ul><br>**Default:** `true`<br><br>To disable this option, run `\unset show_times`.
16+
<a name="sql-option-show-times"></a> `show_times` | Reveal the time a query takes to complete. Possible values:<br><ul><li>`execution` time refers to the time taken by the SQL execution engine to execute the query.</li><li>`network` time refers to the network latency between the server and the SQL client command.</li><li>`other` time refers to all other forms of latency affecting the total query completion time, including query planning.</li></ul>**Default:** `true`<br><br>To disable this option, run `\unset show_times`.
1717

1818
#### Customizing the prompt
1919

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Option | Value | Description
22
----------------------------+-----------------------------------------+------------------------------
33
`first_run` | [`TIMESTAMPTZ`]({% link {{ page.version.version }}/timestamp.md %}) / `now` | Execute the schedule at the specified time in the future. If not specified, the default behavior is to execute the schedule based on its next `RECURRING` time.
4-
`on_execution_failure` | `retry` / `reschedule` / `pause` | If an error occurs during the backup execution, do the following: <ul><li>`retry`: Retry the backup right away.</li><li>`reschedule`: Retry the backup by rescheduling it based on the `RECURRING` expression.</li><li>`pause`: Pause the schedule. This requires manual intervention to [resume the schedule]({% link {{ page.version.version }}/resume-schedules.md %}).</li></ul><br>**Default**: `reschedule`
5-
<a name="on-previous-running-option"></a>`on_previous_running` | `start` / `skip` / `wait` | If the previous backup started by the schedule is still running, do the following: <ul><li>`start`: Start the new backup anyway, even if the previous one is still running.</li><li>`skip`: Skip the new backup and run the next backup based on the `RECURRING` expression.</li><li>`wait`: Wait for the previous backup to complete.</li></ul><br>**Default**: `wait`. The option affects backups started by the full backup schedule only. Incremental backups are always set to `wait`.
4+
`on_execution_failure` | `retry` / `reschedule` / `pause` | If an error occurs during the backup execution, do the following: <ul><li>`retry`: Retry the backup right away.</li><li>`reschedule`: Retry the backup by rescheduling it based on the `RECURRING` expression.</li><li>`pause`: Pause the schedule. This requires manual intervention to [resume the schedule]({% link {{ page.version.version }}/resume-schedules.md %}).</li></ul>**Default**: `reschedule`
5+
<a name="on-previous-running-option"></a>`on_previous_running` | `start` / `skip` / `wait` | If the previous backup started by the schedule is still running, do the following: <ul><li>`start`: Start the new backup anyway, even if the previous one is still running.</li><li>`skip`: Skip the new backup and run the next backup based on the `RECURRING` expression.</li><li>`wait`: Wait for the previous backup to complete.</li></ul>**Default**: `wait`. The option affects backups started by the full backup schedule only. Incremental backups are always set to `wait`.
66
`ignore_existing_backups` | N/A | If backups were already created in the [destination]({% link {{ page.version.version }}/use-cloud-storage.md %}) that the new schedule references, this option must be passed to acknowledge that the new schedule may be backing up different objects.
77
`updates_cluster_last_backup_time_metric` | N/A | ([`admin` privileges]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role) required) When set during backup schedule creation, this option updates the [`schedules_backup_last_completed_time`]({% link {{ page.version.version }}/backup-and-restore-monitoring.md %}#available-metrics) metric for the scheduled backup.

src/current/_includes/v24.1/sql/shell-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Client Options | Description
1313
<a name="sql-option-echo"></a> `echo` | Reveal the SQL statements sent implicitly by the SQL shell.<br><br>**Default:** `false`<br><br>To enable this option, run `\set echo`. [See an example]({% link {{ page.version.version }}/cockroach-sql.md %}#reveal-the-sql-statements-sent-implicitly-by-the-command-line-utility).
1414
<a name="sql-option-errexit"></a> `errexit` | Exit the SQL shell upon encountering an error.<br /><br />**Default:** `false` for [interactive sessions]({% link {{ page.version.version }}/cockroach-sql.md %}#session-and-output-types); `true` otherwise<br><br>To enable this option, run `\set errexit`.
1515
<a name="sql-option-prompt1"></a> `prompt1` | Customize the interactive prompt within the SQL shell. See [Customizing the prompt](#customizing-the-prompt) for information on the available prompt variables.
16-
<a name="sql-option-show-times"></a> `show_times` | Reveal the time a query takes to complete. Possible values:<br><ul><li>`execution` time refers to the time taken by the SQL execution engine to execute the query.</li><li>`network` time refers to the network latency between the server and the SQL client command.</li><li>`other` time refers to all other forms of latency affecting the total query completion time, including query planning.</li></ul><br>**Default:** `true`<br><br>To disable this option, run `\unset show_times`.
16+
<a name="sql-option-show-times"></a> `show_times` | Reveal the time a query takes to complete. Possible values:<br><ul><li>`execution` time refers to the time taken by the SQL execution engine to execute the query.</li><li>`network` time refers to the network latency between the server and the SQL client command.</li><li>`other` time refers to all other forms of latency affecting the total query completion time, including query planning.</li></ul>**Default:** `true`<br><br>To disable this option, run `\unset show_times`.
1717

1818
#### Customizing the prompt
1919

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Option | Value | Description
22
----------------------------+-----------------------------------------+------------------------------
33
`first_run` | [`TIMESTAMPTZ`]({% link {{ page.version.version }}/timestamp.md %}) / `now` | Execute the schedule at the specified time in the future. If not specified, the default behavior is to execute the schedule based on its next `RECURRING` time.
4-
`on_execution_failure` | `retry` / `reschedule` / `pause` | If an error occurs during the backup execution, do the following: <ul><li>`retry`: Retry the backup right away.</li><li>`reschedule`: Retry the backup by rescheduling it based on the `RECURRING` expression.</li><li>`pause`: Pause the schedule. This requires manual intervention to [resume the schedule]({% link {{ page.version.version }}/resume-schedules.md %}).</li></ul><br>**Default**: `reschedule`
5-
<a name="on-previous-running-option"></a>`on_previous_running` | `start` / `skip` / `wait` | If the previous backup started by the schedule is still running, do the following: <ul><li>`start`: Start the new backup anyway, even if the previous one is still running.</li><li>`skip`: Skip the new backup and run the next backup based on the `RECURRING` expression.</li><li>`wait`: Wait for the previous backup to complete.</li></ul><br>**Default**: `wait`. The option affects backups started by the full backup schedule only. Incremental backups are always set to `wait`.
4+
`on_execution_failure` | `retry` / `reschedule` / `pause` | If an error occurs during the backup execution, do the following: <ul><li>`retry`: Retry the backup right away.</li><li>`reschedule`: Retry the backup by rescheduling it based on the `RECURRING` expression.</li><li>`pause`: Pause the schedule. This requires manual intervention to [resume the schedule]({% link {{ page.version.version }}/resume-schedules.md %}).</li></ul>**Default**: `reschedule`
5+
<a name="on-previous-running-option"></a>`on_previous_running` | `start` / `skip` / `wait` | If the previous backup started by the schedule is still running, do the following: <ul><li>`start`: Start the new backup anyway, even if the previous one is still running.</li><li>`skip`: Skip the new backup and run the next backup based on the `RECURRING` expression.</li><li>`wait`: Wait for the previous backup to complete.</li></ul>**Default**: `wait`. The option affects backups started by the full backup schedule only. Incremental backups are always set to `wait`.
66
`ignore_existing_backups` | N/A | If backups were already created in the [destination]({% link {{ page.version.version }}/use-cloud-storage.md %}) that the new schedule references, this option must be passed to acknowledge that the new schedule may be backing up different objects.
77
`updates_cluster_last_backup_time_metric` | N/A | ([`admin` privileges]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role) required) When set during backup schedule creation, this option updates the [`schedules_backup_last_completed_time`]({% link {{ page.version.version }}/backup-and-restore-monitoring.md %}#available-metrics) metric for the scheduled backup.

0 commit comments

Comments
 (0)