Skip to content

Commit

Permalink
Merge branch 'master' into pg-logical-repl-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ddhodge authored Jul 30, 2024
2 parents 564b94f + e166cee commit 0ab5c65
Show file tree
Hide file tree
Showing 59 changed files with 570 additions and 276 deletions.
11 changes: 6 additions & 5 deletions docs/content/preview/api/ycql/dml_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ menu:
parent: api-cassandra
weight: 1320
aliases:
- /preview/api/cassandra/dml_update
- /preview/api/ycql/dml_update
- /preview/api/cassandra/dml_update/
- /preview/api/ycql/dml_update/
- /preview/api/ysql/dml_update/
type: docs
---

Expand Down Expand Up @@ -46,11 +47,11 @@ ttl_or_timestamp_expression = 'TTL' ttl_expression | 'TIMESTAMP' timestamp_expre
<svg class="rrdiagram" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" width="305" height="65" viewbox="0 0 305 65"><path class="connector" d="M0 22h25m41 0h10m104 0h120m-290 0q5 0 5 5v20q0 5 5 5h5m90 0h10m155 0h5q5 0 5-5v-20q0-5 5-5m5 0h5"/><rect class="literal" x="25" y="5" width="41" height="25" rx="7"/><text class="text" x="35" y="22">TTL</text><a xlink:href="../grammar_diagrams#ttl-expression"><rect class="rule" x="76" y="5" width="104" height="25"/><text class="text" x="86" y="22">ttl_expression</text></a><rect class="literal" x="25" y="35" width="90" height="25" rx="7"/><text class="text" x="35" y="52">TIMESTAMP</text><a xlink:href="../grammar_diagrams#timestamp-expression"><rect class="rule" x="125" y="35" width="155" height="25"/><text class="text" x="135" y="52">timestamp_expression</text></a></svg>

```ebnf
update ::= UPDATE table_name [ USING using_expression ] SET assignment
[ , ... ] WHERE where_expression
update ::= UPDATE table_name [ USING using_expression ] SET assignment
[ , ... ] WHERE where_expression
[ IF { if_expression
| [ NOT ] EXISTS
| if_expression OR [ NOT ] EXISTS } ]
| if_expression OR [ NOT ] EXISTS } ]
[ RETURNS STATUS AS ROW ]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ linkTitle: CDC using Logical Replication
description: Learn how YugabyteDB supports asynchronous replication of data changes (inserts, updates, and deletes) to external databases or applications.
headContent: Asynchronous replication of data changes (inserts, updates, and deletes) to external databases or applications
badges: ea
aliases:
- /preview/explore/logical-replication/
menu:
preview:
parent: architecture-docdb-replication
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ headContent: Mix & match common design patterns to achieve advanced patterns
image: /images/section_icons/architecture/distributed_acid.png
aliases:
- /preview/develop/realworld-apps/iot-spark-kafka-ksql/
- /develop/realworld-apps/iot-spark-kafka/
menu:
preview:
identifier: global-apps-real-world-scenarios
Expand Down
1 change: 1 addition & 0 deletions docs/content/preview/drivers-orms/java/yugabyte-jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ aliases:
- /preview/develop/client-drivers/java/
- /preview/develop/build-apps/java/
- /preview/quick-start/build-apps/java/
- /preview/integrations/jdbc-drivers/
menu:
preview:
identifier: yugabyte-jdbc-driver
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ linkTitle: PostgreSQL compatibility
description: Summary of YugabyteDB's PostgreSQL compatibility
aliases:
- /preview/ysql/postgresql-compatibility/
- /preview/explore/ysql-language-features/postgresql-compatibility/
menu:
preview:
identifier: explore-ysql-postgresql-compatibility
Expand Down
2 changes: 2 additions & 0 deletions docs/content/preview/integrations/apache-beam.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ menu:
identifier: apache-beam
parent: data-integration
weight: 571
alises:
- /preview/integrations/apache-spark/
type: docs
---

Expand Down
2 changes: 2 additions & 0 deletions docs/content/preview/integrations/prisma.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ menu:
identifier: prisma-integration
parent: schema-migration
weight: 571
aliases:
- /preview/develop/graphql/prisma/
type: docs
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ headerTitle: YB-Master metrics
linkTitle: YB-Master metrics
headcontent: Monitor table and tablet operations
description: Learn about YugabyteDB's YB-Master metrics, and how to select and use the metrics.
aliases:
- /launch-and-manage/monitor-and-alert/metrics/ybmaster/
menu:
preview:
identifier: yb-master-metrics
Expand Down
107 changes: 39 additions & 68 deletions docs/content/preview/yugabyte-platform/alerts-monitoring/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,77 +17,48 @@ YugabyteDB Anywhere provides preconfigured alerts to notify you of potential pro

Use the Live Queries and Slow Queries dashboards to monitor and display current running queries and analyze statistics of past queries on your YugabyteDB universes.

<div class="row">
{{<index/block>}}

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="alert/">
<div class="head">
<div class="icon"><i class="fa-regular fa-bell"></i></div>
<div class="title">Alerts</div>
</div>
<div class="body">
View and manage alerts generated by YugabyteDB Anywhere.
</div>
</a>
</div>
{{<index/item
title="Alerts"
body="View and manage alerts generated by YugabyteDB Anywhere.."
href="alert/"
icon="fa-regular fa-bell">}}

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="anywhere-metrics/">
<div class="head">
<img class="icon" src="/images/section_icons/explore/high_performance.png" aria-hidden="true" />
<div class="title">Performance metrics</div>
</div>
<div class="body">
View universe performance metrics.
</div>
</a>
</div>
{{<index/item
title="Performance metrics"
body="View universe performance metrics."
href="anywhere-metrics/"
icon="/images/section_icons/explore/high_performance.png">}}

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="live-queries-dashboard/">
<div class="head">
<img class="icon" src="/images/section_icons/explore/monitoring.png" aria-hidden="true" />
<div class="title">Live queries dashboard</div>
</div>
<div class="body">
Use the Live Queries dashboard to monitor and display current running queries on your YugabyteDB universes.
</div>
</a>
</div>
{{<index/item
title="Live queries dashboard"
body="Use the Live Queries dashboard to monitor and display current running queries on your YugabyteDB universes."
href="live-queries-dashboard/"
icon="/images/section_icons/explore/monitoring.png">}}

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="slow-queries-dashboard/">
<div class="head">
<img class="icon" src="/images/section_icons/explore/monitoring.png" aria-hidden="true" />
<div class="title">Slow queries dashboard</div>
</div>
<div class="body">
Use the Slow Queries dashboard to analyze statistics and execution times of past queries on your YugabyteDB universes.
</div>
</a>
</div>
{{<index/item
title="Slow queries dashboard"
body="Use the Slow Queries dashboard to analyze statistics and execution times of past queries on your YugabyteDB universes."
href="slow-queries-dashboard/"
icon="/images/section_icons/explore/monitoring.png">}}

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="performance-advisor/">
<div class="head">
<img class="icon" src="/images/section_icons/manage/diagnostics.png" aria-hidden="true" />
<div class="title">Performance advisor</div>
</div>
<div class="body">
Scan your database for potential optimizations.
</div>
</a>
</div>
{{<index/item
title="Performance advisor"
body="Scan your database for potential optimizations."
href="performance-advisor/"
icon="/images/section_icons/manage/diagnostics.png">}}

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="latency-histogram/">
<div class="head">
<img class="icon" src="/images/section_icons/introduction/benefits.png" aria-hidden="true" />
<div class="title">Latency histogram and P99 latencies</div>
</div>
<div class="body">
Use the Slow Queries dashboard to view latency histogram and P99 latency metrics.
</div>
</a>
</div>
</div>
{{<index/item
title="Latency histogram and P99 latencies"
body="Use the Slow Queries dashboard to view latency histogram and P99 latency metrics."
href="latency-histogram/"
icon="/images/section_icons/introduction/benefits.png">}}

{{<index/item
title="CDC Observability"
body="Use CDC to capture and emit database change events."
href="cdc-observability/"
icon="fa-regular fa-arrows-spin">}}

{{</index/block>}}
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,11 @@ To create an AWS provider:

1. Enter the provider details. Refer to [Provider settings](#provider-settings).

1. Click **Create Provider Configuration** when you are done and wait for the configuration to complete.
1. Click **Validate and Save Configuration** when you are done and wait for the configuration to validate and complete.

This process includes configuring a network, subnetworks in all available regions, firewall rules, VPC peering for network connectivity, and a custom SSH key pair for YBA-to-YugabyteDB connectivity.
If you want to save your progress, you can skip validation by choosing the **Ignore and save provider configuration anyway** option, which saves the provider configuration without validating. Note that you may not be able to create universes using an incomplete or unvalidated provider.

The create provider process includes configuring a network, subnetworks in all available regions, firewall rules, VPC peering for network connectivity, and a custom SSH key pair for YBA-to-YugabyteDB connectivity.

### View and edit providers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,11 @@ To create an Azure provider:

1. Enter the provider details. Refer to [Provider settings](#provider-settings).

1. Click **Create Provider Configuration** when you are done and wait for the configuration to complete.
1. Click **Validate and Save Configuration** when you are done and wait for the configuration to validate and complete.

This process includes configuring a network, subnetworks in all available regions, firewall rules, VPC peering for network connectivity, and a custom SSH key pair for YBA-to-YugabyteDB connectivity.
If you want to save your progress, you can skip validation by choosing the **Ignore and save provider configuration anyway** option, which saves the provider configuration without validating. Note that you may not be able to create universes using an incomplete or unvalidated provider.

The create provider process includes configuring a network, subnetworks in all available regions, firewall rules, VPC peering for network connectivity, and a custom SSH key pair for YugabyteDB Anywhere-to-YugabyteDB connectivity.

When the configuration is completed, you can see all the resources managed by YBA in your resource group, including virtual machines, network interface, network security groups, public IP addresses, and disks.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,11 @@ To create a GCP provider:

1. Enter the provider details. Refer to [Provider settings](#provider-settings).

1. Click **Create Provider Configuration** when you are done and wait for the configuration to complete.
1. Click **Validate and Save Configuration** when you are done and wait for the configuration to validate and complete.

This process includes generating a new VPC, a network, subnetworks in all available regions, as well as a new firewall rule, VPC peering for network connectivity, and a custom SSH key pair for YBA-to-YugabyteDB connectivity.
If you want to save your progress, you can skip validation by choosing the **Ignore and save provider configuration anyway** option, which saves the provider configuration without validating. Note that you may not be able to create universes using an incomplete or unvalidated provider.

The create provider process includes generating a new VPC, a network, subnetworks in all available regions, as well as a new firewall rule, VPC peering for network connectivity, and a custom SSH key pair for YugabyteDB Anywhere-to-YugabyteDB connectivity.

Now you are ready to create a YugabyteDB universe on GCP.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,9 @@ To create a Kubernetes provider:

![Auto-fill Kubernetes provider](/images/yb-platform/kubernetes-config-autofill.png)

1. Click **Create Provider Configuration** when you are done and wait for the configuration to complete.
1. Click **Validate and Save Configuration** when you are done and wait for the configuration to validate and complete.

If you want to save your progress, you can skip validation by choosing the **Ignore and save provider configuration anyway** option, which saves the provider configuration without validating. Note that you may not be able to create universes using an incomplete or unvalidated provider.

## Provider settings

Expand Down
3 changes: 3 additions & 0 deletions docs/content/preview/yugabyte-voyager/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ cascade:
unversioned: true
description: YugabyteDB Voyager is a powerful open-source data migration engine that helps you migrate your database to YugabyteDB quickly and securely.
type: indexpage
aliases:
- /preview/voyager/
- /preview/tools/voyager/
menu:
preview_yugabyte-voyager:
identifier: yugabyte-voyager
Expand Down
38 changes: 38 additions & 0 deletions docs/content/preview/yugabyte-voyager/migrate/assess-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,44 @@ For the most accurate migration assessment, the source database must be actively
- [Live migration with fall-forward](../../migrate/live-fall-forward/)
- [Live migration with fall-back](../../migrate/live-fall-back/)
## Visualize the Migration Assessment report
[yugabyted](/preview/reference/configuration/yugabyted/) UI allows you to visualize the database migrations performed by YugabyteDB Voyager. The UI provides details of migration complexity, SQL objects details from the source database, YugabyteDB sharding strategy, conversion issues (if any), and also allows you to track the percentage completion of data export from the source database and data import to the target YugabyteDB cluster.
### Prerequisites
Before you begin the Voyager migration, do the following:
1. Start a local YugabyteDB cluster using the steps described in [Use a local cluster](/preview/quick-start/) section.
1. [Install Voyager](../../install-yb-voyager/).
### Send Voyager details to a local YugabyteDB cluster
Set the following environment variables before starting the migration:
```sh
export CONTROL_PLANE_TYPE=yugabyted
export YUGABYTED_DB_CONN_STRING=<ysql-connection-string-to-yugabyted-instance>
```
For example, `postgresql://yugabyte:yugabyte@127.0.0.1:5433`
### Assess Migration
Voyager Migration Assessment conducts a detailed analysis of the source database by capturing essential metadata and metrics. Yugabyted UI allows you to go over the assessment report which includes recommendations of effective migration strategies, migration complexity, and provides an overview on effort involved in migrating from the source database.
After [generating a Migration Assessment Report](#generate-a-migration-assessment-report), from yugabyted UI, navigate to **Migrations** tab, available at [http://127.0.0.1:15433](http://127.0.0.1:15433) to see a list of the available migrations.
#### Migrations
![Migration Landing Page](/images/migrate/ybd-landing-page.png)
#### Migration Assessment UI
![Migration Assessment Page](/images/migrate/ybd-assessment-page.png)
## Learn more
- [Assess migration CLI](../../reference/assess-migration/)
Loading

0 comments on commit 0ab5c65

Please sign in to comment.