From 3a82b2b001e7ab9e8558c90a7d59b3dac9c4b3c2 Mon Sep 17 00:00:00 2001 From: Alex Ball Date: Wed, 2 Mar 2022 19:33:21 -0800 Subject: [PATCH] [docs] restructure releases section (#11621) (With a LOT of broken-link fixes, too) --- docs/config.yaml | 1 - docs/content/latest/_index.html | 10 +- docs/content/latest/admin/_index.md | 2 +- docs/content/latest/admin/yb-admin.md | 2 +- docs/content/latest/admin/yb-ctl.md | 6 +- docs/content/latest/admin/yb-ts-cli.md | 2 +- docs/content/latest/admin/ysql-dump.md | 8 +- docs/content/latest/admin/ysql-dumpall.md | 10 +- docs/content/latest/admin/ysqlsh.md | 28 +- docs/content/latest/api/ycql/_index.md | 26 +- .../latest/api/ycql/ddl_alter_table.md | 6 +- .../latest/api/ycql/ddl_create_table.md | 6 +- .../content/latest/api/ycql/ddl_drop_index.md | 2 +- .../content/latest/api/ycql/ddl_drop_table.md | 6 +- docs/content/latest/api/ycql/dml_delete.md | 20 +- docs/content/latest/api/ycql/dml_insert.md | 18 +- docs/content/latest/api/ycql/dml_select.md | 24 +- .../latest/api/ycql/dml_transaction.md | 8 +- docs/content/latest/api/ycql/dml_truncate.md | 6 +- docs/content/latest/api/ycql/dml_update.md | 20 +- docs/content/latest/api/ycql/explain.md | 8 +- docs/content/latest/api/ycql/expr_fcall.md | 28 +- .../content/latest/api/ycql/expr_subscript.md | 2 +- .../latest/api/ycql/function_datetime.md | 14 +- docs/content/latest/api/ycql/type_datetime.md | 6 +- docs/content/latest/api/ysql/_index.md | 10 +- .../latest/api/ysql/datatypes/_index.md | 18 +- .../type_datetime/conceptual-background.md | 18 +- .../type-interval/declaring-intervals.md | 4 +- .../interval-interval-addition.md | 6 +- .../interval-interval-comparison.md | 4 +- .../interval-number-multiplication.md | 16 +- ...nt-interval-overloads-of-plus-and-minus.md | 16 +- .../interval-representation/_index.md | 4 +- .../internal-representation-model.md | 2 +- .../type-interval/interval-utilities.md | 34 +- .../type-interval/justfy-and-extract-epoch.md | 2 +- .../type_datetime/functions/_index.md | 2 +- .../type_datetime/operators/_index.md | 8 +- .../test-date-time-addition-overloads.md | 10 +- .../test-date-time-comparison-overloads.md | 2 +- .../test-date-time-subtraction-overloads.md | 10 +- .../type_datetime/timezones/recommendation.md | 12 +- .../name-res-rules/rule-4.md | 18 +- .../function-syntax-semantics/_index.md | 2 +- .../invocation-syntax-semantics.md | 6 +- .../api/ysql/the-sql-language/_index.md | 2 +- .../the-sql-language/statements/_index.md | 20 +- .../statements/ddl_create_schema.md | 4 +- .../statements/ddl_create_trigger.md | 6 +- .../statements/ddl_create_view.md | 6 +- .../statements/ddl_drop_table.md | 2 +- .../statements/ddl_drop_trigger.md | 4 +- .../the-sql-language/statements/dml_delete.md | 6 +- .../the-sql-language/statements/dml_insert.md | 6 +- .../the-sql-language/statements/dml_update.md | 4 +- .../statements/perf_explain.md | 4 +- .../the-sql-language/statements/txn_abort.md | 4 +- .../the-sql-language/statements/txn_commit.md | 6 +- .../the-sql-language/statements/txn_end.md | 2 +- .../statements/txn_rollback.md | 2 +- .../latest/architecture/concepts/universe.md | 8 +- .../architecture/concepts/yb-tserver.md | 2 +- .../architecture/query-layer/overview.md | 2 +- .../resilience/jepsen-testing-ycql.md | 4 +- .../resilience/jepsen-testing-ysql.md | 4 +- .../scalability/scaling-queries-ycql.md | 14 +- .../scalability/scaling-queries-ysql.md | 6 +- docs/content/latest/contribute/_index.md | 2 +- docs/content/latest/deploy/checklist.md | 30 +- .../deploy/kubernetes/best-practices.md | 19 +- .../latest/deploy/kubernetes/clients.md | 11 +- .../multi-cluster/gke/helm-chart.md | 5 +- .../deploy/kubernetes/multi-zone/_index.md | 4 - .../kubernetes/multi-zone/eks/helm-chart.md | 4 +- .../kubernetes/multi-zone/gke/helm-chart.md | 4 +- .../kubernetes/single-zone/aks/helm-chart.md | 6 +- .../single-zone/aks/statefulset-yaml.md | 6 +- .../kubernetes/single-zone/eks/helm-chart.md | 2 +- .../kubernetes/single-zone/gke/helm-chart.md | 6 +- .../gke/statefulset-yaml-local-ssd.md | 12 +- .../single-zone/gke/statefulset-yaml.md | 6 +- .../single-zone/oss/operator-hub.md | 3 +- .../single-zone/oss/rook-operator.md | 6 +- .../latest/deploy/manual-deployment/_index.md | 8 +- .../manual-deployment/install-software.md | 2 - .../deploy/manual-deployment/start-masters.md | 10 +- .../manual-deployment/start-tservers.md | 12 +- .../deploy/manual-deployment/system-config.md | 2 - .../manual-deployment/verify-deployment.md | 2 - docs/content/latest/deploy/multi-dc/_index.md | 6 +- .../deploy/multi-dc/async-replication.md | 22 +- .../public-clouds/aws/cloudformation.md | 8 +- .../public-clouds/aws/manual-deployment.md | 6 +- .../deploy/public-clouds/aws/terraform.md | 8 +- .../latest/deploy/public-clouds/azure/aks.md | 6 +- .../deploy/public-clouds/azure/azure-arm.md | 8 +- .../deploy/public-clouds/azure/terraform.md | 12 +- .../gcp/gcp-deployment-manager.md | 6 +- .../latest/deploy/public-clouds/gcp/gke.md | 6 +- .../deploy/public-clouds/gcp/terraform.md | 6 +- .../develop/learn/acid-transactions-ycql.md | 10 +- .../develop/learn/acid-transactions-ysql.md | 4 +- .../latest/develop/learn/aggregations-ycql.md | 16 +- .../latest/develop/learn/aggregations-ysql.md | 4 +- .../develop/learn/batch-operations-ycql.md | 3 +- .../develop/learn/batch-operations-ysql.md | 2 +- .../develop/learn/data-modeling-ycql.md | 6 +- .../develop/learn/data-modeling-ysql.md | 4 +- .../latest/develop/learn/data-types-ycql.md | 10 +- .../latest/develop/learn/data-types-ysql.md | 4 +- .../develop/learn/date-and-time-ycql.md | 4 +- .../develop/learn/date-and-time-ysql.md | 4 +- .../content/latest/develop/learn/sql-nosql.md | 4 +- .../develop/learn/strings-and-text-ycql.md | 4 +- .../develop/learn/strings-and-text-ysql.md | 28 +- .../develop/learn/ttl-data-expiration-ycql.md | 21 +- .../develop/learn/ttl-data-expiration-ysql.md | 4 +- .../realworld-apps/iot-spark-kafka-ksql.md | 6 +- docs/content/latest/explore/_index.md | 4 +- .../point-in-time-recovery-ycql.md | 4 +- .../point-in-time-recovery-ysql.md | 92 +- .../latest/explore/fault-tolerance/docker.md | 10 +- .../explore/fault-tolerance/kubernetes.md | 10 +- .../latest/explore/fault-tolerance/linux.md | 16 +- .../latest/explore/fault-tolerance/macos.md | 16 +- .../latest/explore/indexes-constraints/gin.md | 2 +- .../indexes-constraints/primary-key-ysql.md | 4 +- .../latest/explore/json-support/jsonb-ycql.md | 12 +- .../latest/explore/json-support/jsonb-ysql.md | 47 +- .../explore/linear-scalability/_index.md | 2 +- .../scaling-transactions.md | 6 +- .../linear-scalability/sharding-data.md | 8 +- .../asynchronous-replication-ycql.md | 10 +- .../asynchronous-replication-ysql.md | 6 +- .../read-replicas-ycql.md | 76 +- .../row-level-geo-partitioning.md | 3 +- .../synchronous-replication-ycql.md | 4 +- .../synchronous-replication-ysql.md | 4 +- .../latest/explore/observability/_index.md | 6 +- .../observability/grafana-dashboard/macos.md | 24 +- .../prometheus-integration/docker.md | 10 +- .../prometheus-integration/kubernetes.md | 8 +- .../prometheus-integration/linux.md | 10 +- .../prometheus-integration/macos.md | 10 +- .../query-1-performance/query-tuning-intro.md | 16 +- .../latest/explore/security/security.md | 16 +- .../distributed-transactions-ycql.md | 6 +- .../distributed-transactions-ysql.md | 26 +- .../explore/transactions/explicit-locking.md | 8 +- .../explore/transactions/isolation-levels.md | 14 +- .../explore/ysql-language-features/_index.md | 4 +- .../advanced-features/savepoints.md | 14 +- .../advanced-features/views.md | 30 +- .../ysql-language-features/data-types.md | 4 +- .../going-beyond-sql/follower-reads-ycql.md | 2 +- docs/content/latest/faq/compatibility.md | 14 +- docs/content/latest/faq/general.md | 10 +- docs/content/latest/faq/yugabyte-platform.md | 4 +- .../latest/integrations/apache-kafka.md | 6 +- .../latest/integrations/apache-spark/scala.md | 2 +- .../latest/integrations/hasura/graphql.md | 8 +- .../latest/integrations/hasura/hasura-1.md | 22 +- docs/content/latest/integrations/liquibase.md | 27 +- .../latest/manage/backup-restore/_index.md | 4 +- .../backup-restore/back-up-data-ycql.md | 6 +- .../manage/backup-restore/back-up-data.md | 18 +- .../backup-restore/point-in-time-recovery.md | 2 +- .../backup-restore/restore-data-ycql.md | 6 +- .../manage/backup-restore/restore-data.md | 14 +- .../manage/backup-restore/snapshot-ysql.md | 10 +- .../manage/backup-restore/snapshots-ycql.md | 14 +- .../manage/data-migration/ycql/bulk-export.md | 8 +- .../manage/data-migration/ycql/bulk-import.md | 14 +- .../latest/manage/upgrade-deployment.md | 3 - .../migrate/migrate-from-postgresql/_index.md | 3 +- .../migrate-from-postgresql/export-data.md | 8 +- .../migrate-from-postgresql/migrate-schema.md | 4 +- .../migrate/migration-process-overview.md | 24 +- docs/content/latest/quick-start/_index.md | 2 +- .../latest/quick-start/build-apps/_index.html | 2 +- .../quick-start/build-apps/csharp/ysql.md | 18 +- .../build-apps/java/ysql-yb-jdbc.md | 15 +- .../quick-start/build-apps/nodejs/ycql.md | 2 +- .../quick-start/build-apps/nodejs/ysql-pg.md | 4 +- .../quick-start/build-apps/ruby/ysql-pg.md | 2 +- .../latest/quick-start/install/docker.md | 2 +- .../latest/quick-start/install/kubernetes.md | 2 +- .../latest/quick-start/install/linux.md | 4 +- .../latest/quick-start/install/macos.md | 2 +- .../reference/configuration/yb-master.md | 4 +- .../reference/configuration/yb-tserver.md | 8 +- .../reference/configuration/yugabyted.md | 8 +- .../reference/drivers/ysql-client-drivers.md | 4 +- docs/content/latest/releases/_index.md | 96 ++ .../releases/earlier-releases/_index.md | 68 -- .../releases/earlier-releases/v1.2.10.md | 82 -- .../releases/earlier-releases/v1.2.11.md | 109 --- .../releases/earlier-releases/v1.2.12.md | 74 -- .../releases/earlier-releases/v1.2.4.md | 71 -- .../releases/earlier-releases/v1.2.5.md | 72 -- .../releases/earlier-releases/v1.2.6.md | 60 -- .../releases/earlier-releases/v1.2.8.md | 105 --- .../releases/earlier-releases/v1.2.9.md | 98 -- .../releases/earlier-releases/v1.3.0.md | 101 --- .../releases/earlier-releases/v1.3.1.md | 92 -- .../releases/earlier-releases/v2.0.0.md | 106 --- .../releases/earlier-releases/v2.0.1.md | 129 --- .../releases/earlier-releases/v2.0.10.md | 77 -- .../releases/earlier-releases/v2.0.11.md | 97 -- .../releases/earlier-releases/v2.0.3.md | 107 --- .../releases/earlier-releases/v2.0.5.md | 101 --- .../releases/earlier-releases/v2.0.6.md | 87 -- .../releases/earlier-releases/v2.0.7.md | 70 -- .../releases/earlier-releases/v2.0.8.md | 79 -- .../releases/earlier-releases/v2.0.9.md | 92 -- .../releases/earlier-releases/v2.1.0.md | 127 --- .../releases/earlier-releases/v2.1.1.md | 59 -- .../releases/earlier-releases/v2.1.2.md | 84 -- .../releases/earlier-releases/v2.1.3.md | 114 --- .../releases/earlier-releases/v2.1.4.md | 95 -- .../releases/earlier-releases/v2.1.5.md | 98 -- .../releases/earlier-releases/v2.1.6.md | 73 -- .../releases/earlier-releases/v2.1.8.md | 132 --- .../releases/earlier-releases/v2.3.0.md | 186 ---- .../releases/earlier-releases/v2.3.1.md | 59 -- .../releases/earlier-releases/v2.3.2.md | 90 -- .../releases/earlier-releases/v2.3.3.md | 130 --- .../latest/releases/release-notes/v1.2.md | 605 +++++++++++++ .../latest/releases/release-notes/v1.3.md | 190 ++++ .../latest/releases/release-notes/v2.0.md | 847 ++++++++++++++++++ .../latest/releases/release-notes/v2.1.md | 663 ++++++++++++++ .../v2.11.md} | 26 +- .../v2.12.md} | 17 +- .../v2.2.0.md => release-notes/v2.2.md} | 99 +- .../latest/releases/release-notes/v2.3.md | 425 +++++++++ .../v2.4.md | 6 +- .../v2.5.md | 55 +- .../v2.6.md | 8 +- .../v2.7.md | 6 +- .../v2.8.md | 6 +- .../v2.9.md | 7 +- .../latest/releases/releases-overview.md | 88 -- docs/content/latest/releases/versioning.md | 2 +- .../latest/releases/whats-new/_index.md | 41 - .../audit-logging/audit-logging-ycql.md | 14 +- .../audit-logging/audit-logging-ysql.md | 20 +- .../object-audit-logging-ysql.md | 46 +- .../session-audit-logging-ysql.md | 37 +- .../latest/secure/authentication/_index.md | 1 - .../host-based-authentication.md | 12 +- .../ldap-authentication-ycql.md | 6 +- .../ldap-authentication-ysql.md | 12 +- .../authentication/password-authentication.md | 70 +- .../authentication/trust-authentication.md | 11 +- .../latest/secure/authorization/_index.md | 6 +- .../authorization/column-level-security.md | 150 ++-- .../secure/authorization/create-roles-ycql.md | 10 +- .../secure/authorization/create-roles.md | 10 +- .../secure/authorization/rbac-model-ycql.md | 4 +- .../latest/secure/authorization/rbac-model.md | 4 +- .../authorization/row-level-security.md | 263 +++--- .../authorization/ycql-grant-permissions.md | 12 +- .../authorization/ysql-grant-permissions.md | 6 +- .../secure/enable-authentication/ycql.md | 28 +- .../secure/enable-authentication/yedis.md | 6 +- .../secure/enable-authentication/ysql.md | 12 +- .../ysql_hba_conf-configuration.md | 4 +- .../latest/secure/security-checklist.md | 6 +- .../latest/secure/tls-encryption/_index.md | 6 +- .../secure/tls-encryption/client-to-server.md | 2 +- .../tls-encryption/connect-to-cluster.md | 8 +- .../secure/tls-encryption/server-to-server.md | 13 +- .../tls-encryption/tls-authentication.md | 2 +- docs/content/latest/tools/dbeaver-ycql.md | 12 +- docs/content/latest/tools/dbeaver-ysql.md | 12 +- docs/content/latest/troubleshoot/_index.md | 10 +- .../latest/troubleshoot/cluster/_index.md | 6 +- .../troubleshoot/cluster/connect-ycql.md | 1 - .../troubleshoot/cluster/recover_server.md | 20 +- .../troubleshoot/cluster/replace_tserver.md | 18 +- .../latest/troubleshoot/nodes/_index.md | 12 +- .../latest/troubleshoot/nodes/check-logs.md | 4 +- .../troubleshoot/nodes/check-processes.md | 2 - .../latest/troubleshoot/nodes/check-stats.md | 4 +- .../latest/troubleshoot/nodes/recover-disk.md | 2 +- .../troubleshoot/nodes/trouble-common.md | 18 +- docs/content/latest/troubleshoot/overview.md | 8 +- .../develop/client-drivers/yedis/csharp.md | 2 +- .../cloud-admin/cloud-billing-costs.md | 30 +- .../cloud-vpcs/cloud-vpc-intro.md | 2 +- .../cloud-vpcs/cloud-vpc-setup.md | 2 +- .../cloud-connect/connect-applications.md | 4 +- .../cloud-connect/connect-client-shell.md | 2 +- .../cloud-connect/connect-cloud-shell.md | 6 +- .../cloud-examples/hasura-cloud.md | 2 +- .../cloud-examples/hasura-sample-app.md | 4 +- .../spring-boot/spring-boot-mini.md | 8 +- .../latest/yugabyte-cloud/cloud-faq.md | 18 +- .../latest/yugabyte-cloud/cloud-overview.md | 20 +- .../cloud-build-apps/_index.md | 2 +- .../cloud-build-apps/cloud-ysql-c.md | 4 +- .../cloud-build-apps/cloud-ysql-cpp.md | 14 +- .../cloud-build-apps/cloud-ysql-csharp.md | 10 +- .../cloud-build-apps/cloud-ysql-go.md | 2 +- .../cloud-build-apps/cloud-ysql-node.md | 4 +- .../cloud-build-apps/cloud-ysql-php.md | 18 +- .../cloud-build-apps/cloud-ysql-python.md | 2 +- .../cloud-build-apps/cloud-ysql-ruby.md | 2 +- .../cloud-build-apps/cloud-ysql-rust.md | 6 +- .../cloud-build-apps/cloud-ysql-yb-jdbc.md | 2 +- .../cloud-quickstart/qs-connect.md | 4 +- .../cloud-quickstart/qs-data.md | 2 +- .../cloud-secure-clusters/cloud-users.md | 2 +- .../cloud-security/cloud-security-features.md | 2 +- .../yugabyte-cloud/cloud-troubleshoot.md | 2 +- .../latest/yugabyte-cloud/release-notes.md | 2 +- .../back-up-restore-k8s.md | 7 +- .../back-up-restore-yp.md | 7 +- .../ldap-authentication.md | 12 +- .../back-up-universe-data/ysql.md | 2 +- .../schedule-data-backups/ysql.md | 6 +- .../set-up-cloud-provider/aws.md | 21 +- .../set-up-cloud-provider/azure.md | 28 +- .../set-up-cloud-provider/gcp.md | 22 +- .../set-up-cloud-provider/kubernetes.md | 46 +- .../set-up-cloud-provider/on-premises.md | 57 +- .../set-up-cloud-provider/openshift.md | 34 +- .../set-up-cloud-provider/vmware-tanzu.md | 42 +- .../create-deployments/_index.md | 2 +- .../async-replication-platform.md | 10 +- .../create-universe-multi-cloud.md | 12 +- .../create-universe-multi-region.md | 40 +- .../create-universe-multi-zone-kubernetes.md | 18 +- .../create-universe-multi-zone.md | 30 +- .../create-deployments/read-replicas.md | 6 +- .../prepare-environment/aws.md | 30 +- .../prepare-environment/azure.md | 22 +- .../prepare-environment/gcp.md | 12 +- .../prepare-environment/kubernetes.md | 12 +- .../prepare-environment/on-premises.md | 20 +- .../prepare-environment/openshift.md | 20 +- .../manage-deployments/remove-nodes.md | 8 +- .../yugabyte-platform/overview/_index.md | 6 +- .../overview/configure/aws.md | 12 +- .../overview/configure/azure.md | 10 +- .../overview/configure/gcp.md | 16 +- .../overview/configure/kubernetes.md | 10 +- .../overview/configure/onprem.md | 10 +- .../overview/install/kubernetes.md | 6 +- .../overview/install/private-cloud.md | 6 +- .../overview/install/public-cloud.md | 8 +- .../security/ldap-authentication-platform.md | 10 +- .../security/security-checklist-yp.md | 2 +- .../stable/explore/indexes-constraints/gin.md | 2 +- .../advanced-features/savepoints.md | 14 +- .../ysql-language-features/data-types.md | 2 +- .../quick-start/build-apps/csharp/ysql.md | 18 +- .../quick-start/build-apps/nodejs/ycql.md | 2 +- .../quick-start/build-apps/nodejs/ysql-pg.md | 2 +- .../quick-start/build-apps/csharp/ysql.md | 6 +- .../quick-start/build-apps/csharp/ysql.md | 4 +- .../quick-start/build-apps/nodejs/ysql-pg.md | 2 +- .../ysql-language-features/data-types.md | 16 +- .../quick-start/build-apps/csharp/ysql.md | 4 +- .../quick-start/build-apps/nodejs/ysql-pg.md | 2 +- .../ysql-language-features/data-types.md | 2 +- .../quick-start/build-apps/csharp/ysql.md | 4 +- .../quick-start/build-apps/nodejs/ysql-pg.md | 2 +- .../ysql-language-features/data-types.md | 2 +- .../quick-start/build-apps/csharp/ysql.md | 18 +- .../quick-start/build-apps/nodejs/ysql-pg.md | 2 +- 372 files changed, 4695 insertions(+), 5271 deletions(-) create mode 100644 docs/content/latest/releases/_index.md delete mode 100644 docs/content/latest/releases/earlier-releases/_index.md delete mode 100644 docs/content/latest/releases/earlier-releases/v1.2.10.md delete mode 100644 docs/content/latest/releases/earlier-releases/v1.2.11.md delete mode 100644 docs/content/latest/releases/earlier-releases/v1.2.12.md delete mode 100644 docs/content/latest/releases/earlier-releases/v1.2.4.md delete mode 100644 docs/content/latest/releases/earlier-releases/v1.2.5.md delete mode 100644 docs/content/latest/releases/earlier-releases/v1.2.6.md delete mode 100644 docs/content/latest/releases/earlier-releases/v1.2.8.md delete mode 100644 docs/content/latest/releases/earlier-releases/v1.2.9.md delete mode 100644 docs/content/latest/releases/earlier-releases/v1.3.0.md delete mode 100644 docs/content/latest/releases/earlier-releases/v1.3.1.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.0.0.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.0.1.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.0.10.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.0.11.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.0.3.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.0.5.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.0.6.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.0.7.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.0.8.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.0.9.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.1.0.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.1.1.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.1.2.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.1.3.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.1.4.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.1.5.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.1.6.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.1.8.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.3.0.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.3.1.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.3.2.md delete mode 100644 docs/content/latest/releases/earlier-releases/v2.3.3.md create mode 100644 docs/content/latest/releases/release-notes/v1.2.md create mode 100644 docs/content/latest/releases/release-notes/v1.3.md create mode 100644 docs/content/latest/releases/release-notes/v2.0.md create mode 100644 docs/content/latest/releases/release-notes/v2.1.md rename docs/content/latest/releases/{whats-new/latest-release.md => release-notes/v2.11.md} (98%) rename docs/content/latest/releases/{whats-new/stable-release.md => release-notes/v2.12.md} (94%) rename docs/content/latest/releases/{earlier-releases/v2.2.0.md => release-notes/v2.2.md} (89%) create mode 100644 docs/content/latest/releases/release-notes/v2.3.md rename docs/content/latest/releases/{earlier-releases => release-notes}/v2.4.md (98%) rename docs/content/latest/releases/{earlier-releases => release-notes}/v2.5.md (97%) rename docs/content/latest/releases/{earlier-releases => release-notes}/v2.6.md (99%) rename docs/content/latest/releases/{earlier-releases => release-notes}/v2.7.md (99%) rename docs/content/latest/releases/{earlier-releases => release-notes}/v2.8.md (99%) rename docs/content/latest/releases/{earlier-releases => release-notes}/v2.9.md (98%) delete mode 100644 docs/content/latest/releases/releases-overview.md delete mode 100644 docs/content/latest/releases/whats-new/_index.md diff --git a/docs/config.yaml b/docs/config.yaml index b8f7a7359a12..c910d76f660c 100644 --- a/docs/config.yaml +++ b/docs/config.yaml @@ -3,7 +3,6 @@ baseurl: https://docs.yugabyte.com languageCode: en-us title: YugabyteDB Docs metadataformat: yaml -canonifyurls: false googleAnalytics: UA-104956980-3 pygmentsCodefences: true pygmentsStyle: "pygments" diff --git a/docs/content/latest/_index.html b/docs/content/latest/_index.html index c84573d02e35..57b07fe6c2f5 100644 --- a/docs/content/latest/_index.html +++ b/docs/content/latest/_index.html @@ -7,12 +7,6 @@ weight: 1 --- -{{< note title="New release versioning" >}} - -Starting with v2.2.0, Yugabyte release versions follow a [new release versioning convention](/latest/releases/versioning). The latest release series, denoted by `MAJOR.ODD`, incrementally introduces new features and changes and is intended for development and testing only. Patch releases, denoted by `MAJOR.ODD.PATCH` versioning, can include new features and changes that might break backwards compatibility. For more information, see [Releases overview](/latest/releases/releases-overview). - -{{< /note >}} -
@@ -136,7 +130,7 @@
- +
Integrations
@@ -308,7 +302,7 @@
-->
- +
Get involved
diff --git a/docs/content/latest/admin/_index.md b/docs/content/latest/admin/_index.md index af5532a1572b..bdc68008f47a 100644 --- a/docs/content/latest/admin/_index.md +++ b/docs/content/latest/admin/_index.md @@ -15,7 +15,7 @@ menu: {{< note title="Note" >}} -Information about configuring the [YB-Master](../reference/configuration/yb-master) and [YB-TServer](../reference/configuration/yb-tserver) services is in the [Configuration](../reference/configuration/) section. +Information about configuring the [YB-Master](../reference/configuration/yb-master/) and [YB-TServer](../reference/configuration/yb-tserver/) services is in the [Configuration](../reference/configuration/) section. {{< /note >}} diff --git a/docs/content/latest/admin/yb-admin.md b/docs/content/latest/admin/yb-admin.md index f58ebc509ed3..225007c5e1c6 100644 --- a/docs/content/latest/admin/yb-admin.md +++ b/docs/content/latest/admin/yb-admin.md @@ -1755,7 +1755,7 @@ The time needed to complete a data move depends on the following: {{< /note >}} -For an example of performing a data move and the use of this command, refer to [Change cluster configuration](../../manage/change-cluster-config). +For an example of performing a data move and the use of this command, refer to [Change cluster configuration](../../manage/change-cluster-config/). **Example** diff --git a/docs/content/latest/admin/yb-ctl.md b/docs/content/latest/admin/yb-ctl.md index 20392367bef3..9ee89652cb4c 100644 --- a/docs/content/latest/admin/yb-ctl.md +++ b/docs/content/latest/admin/yb-ctl.md @@ -146,7 +146,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" @@ -487,7 +487,7 @@ $ ./bin/yb-ctl restart - Restart with cloud, region and zone flags ```sh -$ ./bin/yb-ctl restart --placement_info "cloud1.region1.zone1" +$ ./bin/yb-ctl restart --placement_info "cloud1.region1.zone1" ``` ### Restart with custom flags @@ -536,7 +536,7 @@ $ ./bin/yb-ctl wipe_restart #### Wipe and restart with placement info flags ```sh -$ ./bin/yb-ctl wipe_restart --placement_info "cloud1.region1.zone1" +$ ./bin/yb-ctl wipe_restart --placement_info "cloud1.region1.zone1" ``` #### Wipe and restart with custom flags diff --git a/docs/content/latest/admin/yb-ts-cli.md b/docs/content/latest/admin/yb-ts-cli.md index bd0621996136..6fca00cf5fed 100644 --- a/docs/content/latest/admin/yb-ts-cli.md +++ b/docs/content/latest/admin/yb-ts-cli.md @@ -12,7 +12,7 @@ isTocNested: true showAsideToc: true --- -`yb-ts-cli` is a command line tool that can be used to perform an operation on a particular tablet server (`yb-tserver`). Some of the commands perform operations similar to [`yb-admin` commands](../yb-admin). The `yb-admin` commands focus on cluster administration, the `yb-ts-cli` commands apply to specific YB-TServer nodes. +`yb-ts-cli` is a command line tool that can be used to perform an operation on a particular tablet server (`yb-tserver`). Some of the commands perform operations similar to [`yb-admin` commands](../yb-admin/). The `yb-admin` commands focus on cluster administration, the `yb-ts-cli` commands apply to specific YB-TServer nodes. `yb-ts-cli` is a binary file installed with YugabyteDB and is located in the `bin` directory of the YugabyteDB home directory. diff --git a/docs/content/latest/admin/ysql-dump.md b/docs/content/latest/admin/ysql-dump.md index e735ed2d5619..cff27a44c750 100644 --- a/docs/content/latest/admin/ysql-dump.md +++ b/docs/content/latest/admin/ysql-dump.md @@ -15,7 +15,7 @@ showAsideToc: true `ysql_dump` is a utility for backing up a YugabyteDB database into a plain-text, SQL script file. `ysql_dump` makes consistent backups, even if the database is being used concurrently. `ysql_dump` does not block other users accessing the database (readers or writers). -`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). +`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/#-i-filename-include-filename) 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. @@ -295,7 +295,7 @@ This utility also uses the environment variables supported by `libpq`. ## Diagnostics -`ysql_dump` internally executes `SELECT` statements. If you have problems running `ysql_dump`, make sure you are able to select information from the database using, for example, [`ysqlsh`](../ysqlsh). Also, any default connection settings and environment variables used by the `libpq` front-end library will apply. +`ysql_dump` internally executes `SELECT` statements. If you have problems running `ysql_dump`, make sure you are able to select information from the database using, for example, [`ysqlsh`](../ysqlsh/). Also, any default connection settings and environment variables used by the `libpq` front-end library will apply. The database activity of `ysql_dump` is normally collected by the statistics collector. If this is undesirable, you can set parameter `track_counts` to `false` using `PGOPTIONS` or the [`ALTER USER`](../../api/ysql/the-sql-language/statements/dcl_alter_user) statement. @@ -351,5 +351,5 @@ $ ysql_dump -T 'ts_*' mydb > objects_mydb.sql ## See also -- [ysql_dumpall](../ysql-dumpall) -- [ysqlsh](../ysqlsh) +- [ysql_dumpall](../ysql-dumpall/) +- [ysqlsh](../ysqlsh/) diff --git a/docs/content/latest/admin/ysql-dumpall.md b/docs/content/latest/admin/ysql-dumpall.md index dabb220b9014..ece4a70249be 100644 --- a/docs/content/latest/admin/ysql-dumpall.md +++ b/docs/content/latest/admin/ysql-dumpall.md @@ -13,7 +13,7 @@ isTocNested: true showAsideToc: true --- -`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. @@ -76,7 +76,7 @@ Specify the superuser username to use when disabling triggers. This is relevant #### -v, --verbose -Specifies verbose mode. This will cause `ysql_dumpall` to output start and stop times to the dump file, and progress messages to standard error. It will also enable verbose output in [`ysql_dump`](../ysql-dump). +Specifies verbose mode. This will cause `ysql_dumpall` to output start and stop times to the dump file, and progress messages to standard error. It will also enable verbose output in [`ysql_dump`](../ysql-dump/). #### --version, -V @@ -216,7 +216,7 @@ This utility also uses the environment variables supported by `libpq`. ## Notes -- Since `ysql_dumpall` calls [`ysql_dump`](../ysql-dump) internally, some diagnostic messages will refer to `ysql_dump`. +- Since `ysql_dumpall` calls [`ysql_dump`](../ysql-dump/) internally, some diagnostic messages will refer to `ysql_dump`. - The [`-c|--clean`](#c-clean) option can be useful even when your intention is to restore the dump script into a fresh cluster. Use of `-c|--clean` authorizes the script to drop and recreate the built-in `yugabyte`, `postgres`, and `template1` databases, ensuring that those databases will retain the same properties (for instance, locale and encoding) that they had in the source cluster. Without the option, those databases will retain their existing database-level properties, as well as any pre-existing contents. - Once restored, it is wise to run `ANALYZE` on each database so the optimizer has useful statistics. You can also run `vacuumdb -a -z` to analyze all databases. - The dump script should not be expected to run completely without errors. In particular, because the script will issue `CREATE ROLE` statements for every role existing in the source cluster, it is certain to get a `role already exists` error for the bootstrap superuser, unless the destination cluster was initialized with a different bootstrap superuser name. This error is harmless and should be ignored. Use of the [`-c|--clean`](#c-clean) option is likely to produce additional harmless error messages about non-existent objects, although you can minimize those by adding [`--if-exists`](#if-exists). @@ -239,5 +239,5 @@ It is not important to which database you connect here since the script file cre ## See Also -- [ysql_dump](../ysql-dump) -- [ysqlsh](../ysqlsh) \ No newline at end of file +- [ysql_dump](../ysql-dump/) +- [ysqlsh](../ysqlsh/) \ No newline at end of file diff --git a/docs/content/latest/admin/ysqlsh.md b/docs/content/latest/admin/ysqlsh.md index b43238471aa9..5304ecee54c0 100644 --- a/docs/content/latest/admin/ysqlsh.md +++ b/docs/content/latest/admin/ysqlsh.md @@ -44,7 +44,7 @@ If you prefer, you can install a standalone version using any of the following m - Using a shell script: ```sh - wget -q -O - https://downloads.yugabyte.com/get_clients.sh | sh + wget -q -O - https://downloads.yugabyte.com/get_clients.sh | sh yugabyte*/bin/ysqlsh ``` @@ -264,9 +264,9 @@ Set the record separator for unaligned output to a zero byte. This is useful for ##### -1, --single-transaction -This option can only be used in combination with one or more `-c` and/or `-f` options. It causes `ysqlsh` to issue a [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin) statement before the first such option and a [`COMMIT`](../../api/ysql/the-sql-language/statements/txn_commit) statement after the last one, thereby wrapping all the commands into a single transaction. This ensures that either all the commands complete successfully, or no changes are applied. +This option can only be used in combination with one or more `-c` and/or `-f` options. It causes `ysqlsh` to issue a [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin/) statement before the first such option and a [`COMMIT`](../../api/ysql/the-sql-language/statements/txn_commit) statement after the last one, thereby wrapping all the commands into a single transaction. This ensures that either all the commands complete successfully, or no changes are applied. -If the statements themselves contain [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin), [`COMMIT`](../../api/ysql/the-sql-language/statements/txn_commit), or [`ROLLBACK`](../../api/ysql/the-sql-language/statements/txn_rollback), this option will not have the desired effects. Also, if an individual statement cannot be executed inside a transaction block, specifying this option will cause the whole transaction to fail. +If the statements themselves contain [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin/), [`COMMIT`](../../api/ysql/the-sql-language/statements/txn_commit), or [`ROLLBACK`](../../api/ysql/the-sql-language/statements/txn_rollback), this option will not have the desired effects. Also, if an individual statement cannot be executed inside a transaction block, specifying this option will cause the whole transaction to fail. ##### -?, --help[=*topic*] @@ -1150,7 +1150,7 @@ The specially treated variables are: ##### AUTOCOMMIT -When `on` (the default), each SQL statement is automatically committed upon successful completion. To postpone commit in this mode, you must enter a [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin) or [`START TRANSACTION`](../../api/ysql/the-sql-language/statements/) SQL statement. When `off` or unset, SQL statements are not committed until you explicitly issue `COMMIT` or `END` statements. The autocommit-off mode works by issuing an implicit `BEGIN` for you, just before any statement that is not already in a transaction block and is not itself a `BEGIN` or other transaction-control statement, nor a statement that cannot be executed inside a transaction block (such as `VACUUM`). +When `on` (the default), each SQL statement is automatically committed upon successful completion. To postpone commit in this mode, you must enter a [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin/) or [`START TRANSACTION`](../../api/ysql/the-sql-language/statements/) SQL statement. When `off` or unset, SQL statements are not committed until you explicitly issue `COMMIT` or `END` statements. The autocommit-off mode works by issuing an implicit `BEGIN` for you, just before any statement that is not already in a transaction block and is not itself a `BEGIN` or other transaction-control statement, nor a statement that cannot be executed inside a transaction block (such as `VACUUM`). {{< note title="Note" >}} @@ -1186,7 +1186,7 @@ The current client character set encoding. This is set every time you connect to ##### FETCH_COUNT -If this variable is set to an integer value greater than `0` (zero), the results of [`SELECT`](../../api/ysql/the-sql-language/statements/dml_select) queries are fetched and displayed in groups of that many rows, rather than the default behavior of collecting the entire result set before display. Therefore, only a limited amount of memory is used, regardless of the size of the result set. Settings of `100` to `1000` are commonly used when enabling this feature. Keep in mind that when using this feature, a query might fail after having already displayed some rows. +If this variable is set to an integer value greater than `0` (zero), the results of [`SELECT`](../../api/ysql/the-sql-language/statements/dml_select/) queries are fetched and displayed in groups of that many rows, rather than the default behavior of collecting the entire result set before display. Therefore, only a limited amount of memory is used, regardless of the size of the result set. Settings of `100` to `1000` are commonly used when enabling this feature. Keep in mind that when using this feature, a query might fail after having already displayed some rows. {{< note title="Tip" >}} @@ -1349,7 +1349,7 @@ The port number at which the database server is listening. ##### %n -The database session user name. (The expansion of this value might change during a database session as the result of the [`SET SESSION AUTHORIZATION`](../../api/ysql/the-sql-language/statements/dcl_set_session_authorization) statement.) +The database session user name. (The expansion of this value might change during a database session as the result of the [`SET SESSION AUTHORIZATION`](../../api/ysql/the-sql-language/statements/dcl_set_session_authorization/) statement.) ##### %/ @@ -1361,7 +1361,7 @@ Like `%/`, but the output is `~` (tilde) if the database is your default databas ##### %# -If the session user is a database superuser, then a `#`, otherwise a `>`. (The expansion of this value might change during a database session as the result of the [`SET SESSION AUTHORIZATION`](../../api/ysql/the-sql-language/statements/dcl_set_session_authorization) statement.) +If the session user is a database superuser, then a `#`, otherwise a `>`. (The expansion of this value might change during a database session as the result of the [`SET SESSION AUTHORIZATION`](../../api/ysql/the-sql-language/statements/dcl_set_session_authorization/) statement.) ##### %p @@ -1516,7 +1516,7 @@ testdb=> \d my_table Column | Type | Collation | Nullable | Default --------+---------+-----------+----------+--------- first | integer | | not null | 0 - second | text | | | + second | text | | | ``` Now you change the prompt to something more interesting: @@ -1611,7 +1611,7 @@ When suitable, query results can be shown in a crosstab representation with the ```plpgsql testdb=> SELECT first, second, first > 2 AS gt2 FROM my_table; - first | second | gt2 + first | second | gt2 -------+--------+----- 1 | one | f 2 | two | f @@ -1620,11 +1620,11 @@ testdb=> SELECT first, second, first > 2 AS gt2 FROM my_table; (4 rows) testdb=> \crosstabview first second - first | one | two | three | four + first | one | two | three | four -------+-----+-----+-------+------ - 1 | f | | | - 2 | | f | | - 3 | | | t | + 1 | f | | | + 2 | | f | | + 3 | | | t | 4 | | | | t (4 rows) ``` @@ -1636,7 +1636,7 @@ testdb=> SELECT t1.first as "A", t2.first+100 AS "B", t1.first*(t2.first+100) as testdb(> row_number() over(order by t2.first) AS ord testdb(> FROM my_table t1 CROSS JOIN my_table t2 ORDER BY 1 DESC testdb(> \crosstabview "A" "B" "AxB" ord - A | 101 | 102 | 103 | 104 + A | 101 | 102 | 103 | 104 ---+-----+-----+-----+----- 4 | 404 | 408 | 412 | 416 3 | 303 | 306 | 309 | 312 diff --git a/docs/content/latest/api/ycql/_index.md b/docs/content/latest/api/ycql/_index.md index 76cfa7a30d2d..cb8aaea0ca9a 100644 --- a/docs/content/latest/api/ycql/_index.md +++ b/docs/content/latest/api/ycql/_index.md @@ -20,7 +20,7 @@ showAsideToc: true ## Introduction -Yugabyte Cloud Query Language (YCQL) is a semi-relational SQL API that is best fit for internet-scale OLTP and HTAP applications needing massive data ingestion and blazing-fast queries. It supports strongly consistent secondary indexes, a native JSON column type, and distributed transactions. It has its roots in the [Cassandra Query Language (CQL)](http://cassandra.apache.org/doc/latest/cql/index.html). +Yugabyte Cloud Query Language (YCQL) is a semi-relational SQL API that is best fit for internet-scale OLTP and HTAP applications needing massive data ingestion and blazing-fast queries. It supports strongly consistent secondary indexes, a native JSON column type, and distributed transactions. It has its roots in the [Cassandra Query Language (CQL)](http://cassandra.apache.org/doc/latest/cql/index.html). This page covers the following YCQL features. @@ -44,7 +44,7 @@ Statement | Description | ----------|-------------| [`ALTER TABLE`](ddl_alter_table) | Alter a table | [`ALTER KEYSPACE`](ddl_alter_keyspace) | Alter a keyspace | -[`CREATE INDEX`](ddl_create_index) | Create a new index on a table | +[`CREATE INDEX`](ddl_create_index/) | Create a new index on a table | [`CREATE KEYSPACE`](ddl_create_keyspace) | Create a new keyspace | [`CREATE TABLE`](ddl_create_table) | Create a new table | [`CREATE TYPE`](ddl_create_type) | Create a user-defined data type | @@ -87,9 +87,9 @@ Data manipulation language (DML) statements are used to read from and write to t Statement | Description | ----------|-------------| [`INSERT`](dml_insert) | Insert rows into a table | -[`SELECT`](dml_select) | Select rows from a table | -[`UPDATE`](dml_update) | Update rows in a table | -[`DELETE`](dml_delete) | Delete specific rows from a table | +[`SELECT`](dml_select/) | Select rows from a table | +[`UPDATE`](dml_update/) | Update rows in a table | +[`DELETE`](dml_delete/) | Delete specific rows from a table | [`TRANSACTION`](dml_transaction) | Makes changes to multiple rows in one or more tables in a transaction | [`TRUNCATE`](dml_truncate) | Remove all rows from a table | @@ -97,11 +97,11 @@ Statement | Description | An expression is a finite combination of one or more values, operators, functions, and expressions that specifies a computation. Expressions can be used in the following components. -- The select list of [`SELECT`](dml_select) statement. For example, `SELECT id + 1 FROM sample_table;`. -- The WHERE clause in [`SELECT`](dml_select), [`DELETE`](dml_delete), [`INSERT`](dml_insert), or [`UPDATE`](dml_update). -- The IF clause in [`DELETE`](dml_delete), [`INSERT`](dml_insert), or [`UPDATE`](dml_update). +- The select list of [`SELECT`](dml_select/) statement. For example, `SELECT id + 1 FROM sample_table;`. +- The WHERE clause in [`SELECT`](dml_select/), [`DELETE`](dml_delete/), [`INSERT`](dml_insert), or [`UPDATE`](dml_update/). +- The IF clause in [`DELETE`](dml_delete/), [`INSERT`](dml_insert), or [`UPDATE`](dml_update/). - The VALUES clause in [`INSERT`](dml_insert). -- The SET clause in [`UPDATE`](dml_update). +- The SET clause in [`UPDATE`](dml_update/). Currently, the following expressions are supported. @@ -110,7 +110,7 @@ Expression | Description | [Simple Value](expr_simple) | Column, constant, or null. Column alias cannot be used in expression yet. | [Subscript `[]`](expr_subscript) | Subscripting columns of collection data types | [Operator Call](expr_ocall) | Builtin operators only | -[Function Call](expr_fcall) | Builtin function calls only | +[Function Call](expr_fcall/) | Builtin function calls only | ## Data types @@ -123,7 +123,7 @@ Primitive Type | Allowed in Key | Type Parameters | Description | [`BOOLEAN`](type_bool) | Yes | - | Boolean | [`COUNTER`](type_int) | No | - | 64-bit signed integer | [`DECIMAL`](type_number) | Yes | - | Exact, arbitrary-precision number, no upper-bound on decimal precision | -[`DATE`](type_datetime) | Yes | - | Date | +[`DATE`](type_datetime/) | Yes | - | Date | [`DOUBLE`](type_number) | Yes | - | 64-bit, inexact, floating-point number | [`FLOAT`](type_number) | Yes | - | 64-bit, inexact, floating-point number | [`FROZEN`](type_frozen) | Yes | 1 | Collection in binary format | @@ -134,8 +134,8 @@ Primitive Type | Allowed in Key | Type Parameters | Description | [`SET`](type_collection) | No | 1 | Collection of unique elements | [`SMALLINT`](type_int) | Yes | - | 16-bit signed integer | [`TEXT` | `VARCHAR`](type_text) | Yes | - | String of Unicode characters | -[`TIME`](type_datetime) | Yes | - | Time of day | -[`TIMESTAMP`](type_datetime) | Yes | - | Date-and-time | +[`TIME`](type_datetime/) | Yes | - | Time of day | +[`TIMESTAMP`](type_datetime/) | Yes | - | Date-and-time | [`TIMEUUID`](type_uuid) | Yes | - | Timed UUID | [`TINYINT`](type_int) | Yes | - | 8-bit signed integer | [`UUID`](type_uuid) | Yes | - | Standard UUID | diff --git a/docs/content/latest/api/ycql/ddl_alter_table.md b/docs/content/latest/api/ycql/ddl_alter_table.md index fd263ece7c74..d1f68824fc67 100644 --- a/docs/content/latest/api/ycql/ddl_alter_table.md +++ b/docs/content/latest/api/ycql/ddl_alter_table.md @@ -150,8 +150,8 @@ CREATE TABLE example.employees ( ## See also - [`CREATE TABLE`](../ddl_create_table) -- [`DELETE`](../dml_delete) +- [`DELETE`](../dml_delete/) - [`DROP TABLE`](../ddl_drop_table) - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) -- [`UPDATE`](../dml_update) +- [`SELECT`](../dml_select/) +- [`UPDATE`](../dml_update/) diff --git a/docs/content/latest/api/ycql/ddl_create_table.md b/docs/content/latest/api/ycql/ddl_create_table.md index a60d2629a4e5..8cc331a89835 100644 --- a/docs/content/latest/api/ycql/ddl_create_table.md +++ b/docs/content/latest/api/ycql/ddl_create_table.md @@ -268,8 +268,8 @@ ycqlsh:example> CREATE TABLE tracking (id int PRIMARY KEY) WITH tablets = 10 AND ## See also - [`ALTER TABLE`](../ddl_alter_table) -- [`DELETE`](../dml_delete) +- [`DELETE`](../dml_delete/) - [`DROP TABLE`](../ddl_drop_table) - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) -- [`UPDATE`](../dml_update) +- [`SELECT`](../dml_select/) +- [`UPDATE`](../dml_update/) diff --git a/docs/content/latest/api/ycql/ddl_drop_index.md b/docs/content/latest/api/ycql/ddl_drop_index.md index bfdddee5e23e..61b00436741b 100644 --- a/docs/content/latest/api/ycql/ddl_drop_index.md +++ b/docs/content/latest/api/ycql/ddl_drop_index.md @@ -56,4 +56,4 @@ ycqlsh:example> DROP INDEX users_by_name; ## See also - [`CREATE TABLE`](../ddl_create_table) -- [`CREATE INDEX`](../ddl_create_index) +- [`CREATE INDEX`](../ddl_create_index/) diff --git a/docs/content/latest/api/ycql/ddl_drop_table.md b/docs/content/latest/api/ycql/ddl_drop_table.md index c0eeb0f6e068..04de2044e5d2 100644 --- a/docs/content/latest/api/ycql/ddl_drop_table.md +++ b/docs/content/latest/api/ycql/ddl_drop_table.md @@ -53,7 +53,7 @@ ycqlsh:example> DROP TABLE users; - [`ALTER TABLE`](../ddl_alter_table) - [`CREATE TABLE`](../ddl_create_table) -- [`DELETE`](../dml_delete) +- [`DELETE`](../dml_delete/) - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) -- [`UPDATE`](../dml_update) +- [`SELECT`](../dml_select/) +- [`UPDATE`](../dml_update/) diff --git a/docs/content/latest/api/ycql/dml_delete.md b/docs/content/latest/api/ycql/dml_delete.md index bd6f7c4a0efa..232bb9a542d9 100644 --- a/docs/content/latest/api/ycql/dml_delete.md +++ b/docs/content/latest/api/ycql/dml_delete.md @@ -2,7 +2,7 @@ title: DELETE statement [YCQL] headerTitle: DELETE linkTitle: DELETE -description: Use the DELETE statement to remove rows from a specified table that meet a given condition. +description: Use the DELETE statement to remove rows from a specified table that meet a given condition. menu: latest: parent: api-cassandra @@ -27,9 +27,9 @@ Use the `DELETE` statement to remove rows from a specified table that meet a giv ### Grammar ``` -delete ::= DELETE FROM table_name - [ USING TIMESTAMP timestamp_expression ] WHERE - where_expression [ IF { [ NOT ] EXISTS | if_expression } ] +delete ::= DELETE FROM table_name + [ USING TIMESTAMP timestamp_expression ] WHERE + where_expression [ IF { [ NOT ] EXISTS | if_expression } ] [ RETURNS STATUS AS ROW ] ``` @@ -60,7 +60,7 @@ Where - The `if_expression` can only apply to non-key columns (regular columns). - The `if_expression` can contain any logical and boolean operators. - Deleting only some column values from a row is not yet supported. -- `IF EXISTS` and `IF NOT EXISTS` options are mostly for symmetry with the [`INSERT`](../dml_insert) and [`UPDATE`](../dml_update) commands. +- `IF EXISTS` and `IF NOT EXISTS` options are mostly for symmetry with the [`INSERT`](../dml_insert) and [`UPDATE`](../dml_update/) commands. - `IF EXISTS` works like a normal delete but additionally returns whether the delete was applied (a row was found with that primary key). - `IF NOT EXISTS` is effectively a no-op since rows that do not exist cannot be deleted (but returns whether no row was found with that primary key). @@ -73,9 +73,9 @@ The `timestamp_expression` must be an integer value (or a bind variable marker f ### Delete a row from a table ```sql -ycqlsh:example> CREATE TABLE employees(department_id INT, - employee_id INT, - name TEXT, +ycqlsh:example> CREATE TABLE employees(department_id INT, + employee_id INT, + name TEXT, PRIMARY KEY(department_id, employee_id)); ``` @@ -290,7 +290,7 @@ See examples in [batch docs](../batch#row-status). - [`CREATE TABLE`](../ddl_create_table) - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) -- [`UPDATE`](../dml_update) +- [`SELECT`](../dml_select/) +- [`UPDATE`](../dml_update/) - [`TRUNCATE`](../dml_truncate) - [`Expression`](..#expressions) diff --git a/docs/content/latest/api/ycql/dml_insert.md b/docs/content/latest/api/ycql/dml_insert.md index fcd675b24edb..1486cf899503 100644 --- a/docs/content/latest/api/ycql/dml_insert.md +++ b/docs/content/latest/api/ycql/dml_insert.md @@ -43,10 +43,10 @@ ttl_or_timestamp_expression = 'TTL' ttl_expression | 'TIMESTAMP' timestamp_expre ### Grammar ``` -insert ::= INSERT INTO table_name ( column_name [ , ... ] ) VALUES ( - expression [ , ... ] ) - [ IF { [ NOT ] EXISTS | if_expression } ] - [ USING using_expression ] +insert ::= INSERT INTO table_name ( column_name [ , ... ] ) VALUES ( + expression [ , ... ] ) + [ IF { [ NOT ] EXISTS | if_expression } ] + [ USING using_expression ] [ RETURNS STATUS AS ROW ] ``` @@ -59,7 +59,7 @@ Where ## Semantics -- An error is raised if the specified `table_name` does not exist. +- An error is raised if the specified `table_name` does not exist. - The columns list must include all primary key columns. - The `USING TIMESTAMP` clause indicates you would like to perform the INSERT as if it was done at the timestamp provided by the user. The timestamp is the number of microseconds since epoch. @@ -68,7 +68,7 @@ Where - **NOTE**: You should either use the `USING TIMESTAMP` clause in all of your statements or none of them. Using a mix of statements where some have `USING TIMESTAMP` and others do not will lead to very confusing results. -- Inserting rows with TTL is not supported on tables with [transactions enabled](./../ddl_create_table#table-properties-1). +- Inserting rows with TTL is not supported on tables with [transactions enabled](./../ddl_create_table#table-properties-1). ### `VALUES` clause @@ -271,7 +271,7 @@ See examples in [batch docs](../batch#row-status). ## See also - [`CREATE TABLE`](../ddl_create_table) -- [`DELETE`](../dml_delete) -- [`SELECT`](../dml_select) -- [`UPDATE`](../dml_update) +- [`DELETE`](../dml_delete/) +- [`SELECT`](../dml_select/) +- [`UPDATE`](../dml_update/) - [`Expression`](..#expressions) diff --git a/docs/content/latest/api/ycql/dml_select.md b/docs/content/latest/api/ycql/dml_select.md index 4b43553df1a0..d6b07fc4112d 100644 --- a/docs/content/latest/api/ycql/dml_select.md +++ b/docs/content/latest/api/ycql/dml_select.md @@ -33,7 +33,7 @@ Use the `SELECT` statement to retrieve (part of) rows of specified columns that ### Grammar ``` -select ::= SELECT [ DISTINCT ] { * | column_name [ , column_name ... ] } +select ::= SELECT [ DISTINCT ] { * | column_name [ , column_name ... ] } FROM table_name [ WHERE where_expression ] [ IF where_expression ] @@ -71,7 +71,7 @@ Where - The `where_expression` can specify conditions on any columns including partition, clustering, and regular columns. - The `where_expression` has a restricted list of operators. - - Only `=`, `!=`, `IN` and `NOT IN` operators can be used for conditions on partition columns. + - Only `=`, `!=`, `IN` and `NOT IN` operators can be used for conditions on partition columns. - Only operators `=`, `!=`, `<`, `<=`, `>`, `>=`, `IN` and `NOT IN` can be used for conditions on clustering and regular columns. ### `IF` clause @@ -92,7 +92,7 @@ Some best practices are: - Use equality conditions on all partition columns (to fix the value of the partition key). - Use comparison operators on the clustering columns (tighter restrictions are more valuable for left-most clustering columns). -- Generally, the closer a column is to the beginning of the primary key, the higher the performance gain for setting tighter restrictions on it. +- Generally, the closer a column is to the beginning of the primary key, the higher the performance gain for setting tighter restrictions on it. Ideally, these performance considerations should be taken into account when creating the table schema.{{< /note >}} @@ -101,30 +101,30 @@ Ideally, these performance considerations should be taken into account when crea ### Select all rows from a table ```sql -ycqlsh:example> CREATE TABLE employees(department_id INT, - employee_id INT, +ycqlsh:example> CREATE TABLE employees(department_id INT, + employee_id INT, dept_name TEXT STATIC, - employee_name TEXT, + employee_name TEXT, PRIMARY KEY(department_id, employee_id)); ``` ```sql -ycqlsh:example> INSERT INTO employees(department_id, employee_id, dept_name, employee_name) +ycqlsh:example> INSERT INTO employees(department_id, employee_id, dept_name, employee_name) VALUES (1, 1, 'Accounting', 'John'); ``` ```sql -ycqlsh:example> INSERT INTO employees(department_id, employee_id, dept_name, employee_name) +ycqlsh:example> INSERT INTO employees(department_id, employee_id, dept_name, employee_name) VALUES (1, 2, 'Accounting', 'Jane'); ``` ```sql -ycqlsh:example> INSERT INTO employees(department_id, employee_id, dept_name, employee_name) +ycqlsh:example> INSERT INTO employees(department_id, employee_id, dept_name, employee_name) VALUES (1, 3, 'Accounting', 'John'); ``` ```sql -ycqlsh:example> INSERT INTO employees(department_id, employee_id, dept_name, employee_name) +ycqlsh:example> INSERT INTO employees(department_id, employee_id, dept_name, employee_name) VALUES (2, 1, 'Marketing', 'Joe'); ``` @@ -306,6 +306,6 @@ SELECT * FROM sensor_data WHERE device_id = 1 ORDER BY sensor_id ASC, ts ASC; - [`CREATE TABLE`](../ddl_create_table) - [`INSERT`](../dml_insert) -- [`UPDATE`](../dml_update) -- [`DELETE`](../dml_delete) +- [`UPDATE`](../dml_update/) +- [`DELETE`](../dml_delete/) - [`Expression`](..#expressions) diff --git a/docs/content/latest/api/ycql/dml_transaction.md b/docs/content/latest/api/ycql/dml_transaction.md index b7bf32b0a063..8881429521f9 100644 --- a/docs/content/latest/api/ycql/dml_transaction.md +++ b/docs/content/latest/api/ycql/dml_transaction.md @@ -35,7 +35,7 @@ transaction_block ::= BEGIN TRANSACTION Where -- `insert`, `update`, and `delete` are [INSERT](../dml_insert), [UPDATE](../dml_update), and [DELETE](../dml_delete) statements. +- `insert`, `update`, and `delete` are [INSERT](../dml_insert), [UPDATE](../dml_update/), and [DELETE](../dml_delete/) statements. ### ANSI SQL syntax @@ -140,12 +140,12 @@ ycqlsh:example> SELECT account_name, account_type, balance, writetime(balance) F {{< note Type="Note" >}} -`BEGIN/END TRANSACTION` doesn't currently support `RETURNS STATUS AS ROW`. +`BEGIN/END TRANSACTION` doesn't currently support `RETURNS STATUS AS ROW`. {{< /note >}} ## See also - [`INSERT`](../dml_insert) -- [`UPDATE`](../dml_update) -- [`DELETE`](../dml_delete) +- [`UPDATE`](../dml_update/) +- [`DELETE`](../dml_delete/) diff --git a/docs/content/latest/api/ycql/dml_truncate.md b/docs/content/latest/api/ycql/dml_truncate.md index 1247443ea901..c4aa76f3bcf2 100644 --- a/docs/content/latest/api/ycql/dml_truncate.md +++ b/docs/content/latest/api/ycql/dml_truncate.md @@ -92,6 +92,6 @@ ycqlsh:example> SELECT * FROM employees; - [`CREATE TABLE`](../ddl_create_table) - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) -- [`UPDATE`](../dml_update) -- [`DELETE`](../dml_delete) +- [`SELECT`](../dml_select/) +- [`UPDATE`](../dml_update/) +- [`DELETE`](../dml_delete/) diff --git a/docs/content/latest/api/ycql/dml_update.md b/docs/content/latest/api/ycql/dml_update.md index bb992f5142a0..e57144c54032 100644 --- a/docs/content/latest/api/ycql/dml_update.md +++ b/docs/content/latest/api/ycql/dml_update.md @@ -46,9 +46,9 @@ ttl_or_timestamp_expression = 'TTL' ttl_expression | 'TIMESTAMP' timestamp_expre TTLttl_expressionTIMESTAMPtimestamp_expression ``` -update ::= UPDATE table_name [ USING using_expression ] SET assignment - [ , ... ] WHERE where_expression - [ IF { [ NOT ] EXISTS | if_expression } ] +update ::= UPDATE table_name [ USING using_expression ] SET assignment + [ , ... ] WHERE where_expression + [ IF { [ NOT ] EXISTS | if_expression } ] [ RETURNS STATUS AS ROW ] @@ -70,7 +70,7 @@ Where - **NOTE**: You should either use the `USING TIMESTAMP` clause in all of your statements or none of them. Using a mix of statements where some have `USING TIMESTAMP` and others do not will lead to very confusing results. -- Updating rows `USING TTL` is not supported on tables with [transactions enabled](./../ddl_create_table#table-properties-1). +- Updating rows `USING TTL` is not supported on tables with [transactions enabled](./../ddl_create_table#table-properties-1). ### `WHERE` clause @@ -94,10 +94,10 @@ Where ### Update a value in a table ```sql -ycqlsh:example> CREATE TABLE employees(department_id INT, - employee_id INT, - name TEXT, - age INT, +ycqlsh:example> CREATE TABLE employees(department_id INT, + employee_id INT, + name TEXT, + age INT, PRIMARY KEY(department_id, employee_id)); ``` @@ -272,7 +272,7 @@ See examples in [batch docs](../batch#row-status). ## See also - [`CREATE TABLE`](../ddl_create_table) -- [`DELETE`](../dml_delete) +- [`DELETE`](../dml_delete/) - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) +- [`SELECT`](../dml_select/) - [`Expression`](..#expressions) diff --git a/docs/content/latest/api/ycql/explain.md b/docs/content/latest/api/ycql/explain.md index 22af6f2a4c5a..87c6e81c787d 100644 --- a/docs/content/latest/api/ycql/explain.md +++ b/docs/content/latest/api/ycql/explain.md @@ -32,7 +32,7 @@ explain ::= EXPLAIN { select | update | insert | delete } ## Semantics -Where the target statement is one of the following: [SELECT](../dml_select), [UPDATE](../dml_update), [INSERT](../dml_insert), or [DELETE](../dml_delete). +Where the target statement is one of the following: [SELECT](../dml_select/), [UPDATE](../dml_update/), [INSERT](../dml_insert), or [DELETE](../dml_delete/). ## Examples Create the keyspace, tables and indexes. @@ -213,6 +213,6 @@ cqlsh:imdb> EXPLAIN UPDATE movie_stats SET user_rank = 1 WHERE movie_name = 'm1' ## See also - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) -- [`UPDATE`](../dml_update) -- [`DELETE`](../dml_delete) +- [`SELECT`](../dml_select/) +- [`UPDATE`](../dml_update/) +- [`DELETE`](../dml_delete/) diff --git a/docs/content/latest/api/ycql/expr_fcall.md b/docs/content/latest/api/ycql/expr_fcall.md index 90768c182576..a3573acd0fb0 100644 --- a/docs/content/latest/api/ycql/expr_fcall.md +++ b/docs/content/latest/api/ycql/expr_fcall.md @@ -30,22 +30,22 @@ function_call ::= function_name '(' [ arguments ... ] ')' |----------|-------------|---------------|-------------| | BlobAs\ | \ | ([`BLOB`](../type_blob)) | Converts a value from `BLOB` | | \AsBlob | [`BLOB`](../type_blob) | (\) | Converts a value to `BLOB` | -| [DateOf](../function_datetime/#dateof) | [`TIMESTAMP`](../type_datetime) | ([`TIMEUUID`](../type_uuid)) | Conversion | -| MaxTimeUuid | [`TIMEUUID`](../type_uuid) | ([`TIMESTAMP`](../type_datetime)) | Returns the associated max time uuid | -| MinTimeUuid | [`TIMEUUID`](../type_uuid) | ([`TIMESTAMP`](../type_datetime)) | Returns the associated min time uuid | -| [CurrentDate](../function_datetime/#currentdate-currenttime-and-currenttimestamp) | [`DATE`](../type_datetime) | () | Return the system current date | -| [CurrentTime](../function_datetime/#currentdate-currenttime-and-currenttimestamp) | [`TIME`](../type_datetime) | () | Return the system current time of day | -| [CurrentTimestamp](../function_datetime/#currentdate-currenttime-and-currenttimestamp) | [`TIMESTAMP`](../type_datetime) | () | Return the system current timestamp | +| [DateOf](../function_datetime/#dateof) | [`TIMESTAMP`](../type_datetime/) | ([`TIMEUUID`](../type_uuid)) | Conversion | +| MaxTimeUuid | [`TIMEUUID`](../type_uuid) | ([`TIMESTAMP`](../type_datetime/)) | Returns the associated max time uuid | +| MinTimeUuid | [`TIMEUUID`](../type_uuid) | ([`TIMESTAMP`](../type_datetime/)) | Returns the associated min time uuid | +| [CurrentDate](../function_datetime/#currentdate-currenttime-and-currenttimestamp) | [`DATE`](../type_datetime/) | () | Return the system current date | +| [CurrentTime](../function_datetime/#currentdate-currenttime-and-currenttimestamp) | [`TIME`](../type_datetime/) | () | Return the system current time of day | +| [CurrentTimestamp](../function_datetime/#currentdate-currenttime-and-currenttimestamp) | [`TIMESTAMP`](../type_datetime/) | () | Return the system current timestamp | | [Now](../function_datetime/#now) | [`TIMEUUID`](../type_uuid) | () | Returns the UUID of the current timestamp | | [TTL](#ttl-function) | [`BIGINT`](../type_int) | (\) | Get time-to-live of a column | -| [ToDate](../function_datetime/#todate) | [`DATE`](../type_datetime) | ([`TIMESTAMP`](../type_datetime)) | Conversion | -| [ToDate](../function_datetime/#todate) | [`DATE`](../type_datetime) | ([`TIMEUUID`](../type_uuid)) | Conversion | -| ToTime | [`TIME`](../type_datetime) | ([`TIMESTAMP`](../type_datetime)) | Conversion | -| ToTime | [`TIME`](../type_datetime) | ([`TIMEUUID`](../type_uuid) | Conversion | -| [ToTimestamp](../function_datetime/#totimestamp) | ([`TIMESTAMP`](../type_datetime)) | ([`DATE`](../type_datetime)) | Conversion | -| [ToTimestamp](../function_datetime/#totimestamp) | ([`TIMESTAMP`](../type_datetime)) | (`TIMEUUID`) | Conversion | -| [ToUnixTimestamp](../function_datetime/#tounixtimestamp) | [`BIGINT`](../type_int) | ([`DATE`](../type_datetime)) | Conversion | -| [ToUnixTimestamp](../function_datetime/#tounixtimestamp) | [`BIGINT`](../type_int) | ([`TIMESTAMP`](../type_datetime)) | Conversion | +| [ToDate](../function_datetime/#todate) | [`DATE`](../type_datetime/) | ([`TIMESTAMP`](../type_datetime/)) | Conversion | +| [ToDate](../function_datetime/#todate) | [`DATE`](../type_datetime/) | ([`TIMEUUID`](../type_uuid)) | Conversion | +| ToTime | [`TIME`](../type_datetime/) | ([`TIMESTAMP`](../type_datetime/)) | Conversion | +| ToTime | [`TIME`](../type_datetime/) | ([`TIMEUUID`](../type_uuid) | Conversion | +| [ToTimestamp](../function_datetime/#totimestamp) | ([`TIMESTAMP`](../type_datetime/)) | ([`DATE`](../type_datetime/)) | Conversion | +| [ToTimestamp](../function_datetime/#totimestamp) | ([`TIMESTAMP`](../type_datetime/)) | (`TIMEUUID`) | Conversion | +| [ToUnixTimestamp](../function_datetime/#tounixtimestamp) | [`BIGINT`](../type_int) | ([`DATE`](../type_datetime/)) | Conversion | +| [ToUnixTimestamp](../function_datetime/#tounixtimestamp) | [`BIGINT`](../type_int) | ([`TIMESTAMP`](../type_datetime/)) | Conversion | | [ToUnixTimestamp](../function_datetime/#tounixtimestamp) | [`BIGINT`](../type_int) | ([`TIMEUUID`](../type_uuid)) | Conversion | | [UnixTimestampOf](../function_datetime/#unixtimestampof) | [`BIGINT`](../type_int) | ([`TIMEUUID`](../type_uuid)) | Conversion | | [UUID](../function_datetime/#uuid) | [`UUID`](../type_uuid) | () | Returns a version 4 UUID | diff --git a/docs/content/latest/api/ycql/expr_subscript.md b/docs/content/latest/api/ycql/expr_subscript.md index f3eb6aa6d1db..64df1327de41 100644 --- a/docs/content/latest/api/ycql/expr_subscript.md +++ b/docs/content/latest/api/ycql/expr_subscript.md @@ -14,7 +14,7 @@ isTocNested: true showAsideToc: true --- -Use subscripted expressions to access elements in a multi-element value, such as a map collection by using operator `[]`. Subscripted column expressions can be used when writing the same way as a [column expression](../expr_simple##Column). For example, if `ids` refers to a column of type `LIST`, `ids[7]` refers to the third element of the list `ids`, which can be set in an [UPDATE](../dml_update) statement. +Use subscripted expressions to access elements in a multi-element value, such as a map collection by using operator `[]`. Subscripted column expressions can be used when writing the same way as a [column expression](../expr_simple##Column). For example, if `ids` refers to a column of type `LIST`, `ids[7]` refers to the third element of the list `ids`, which can be set in an [UPDATE](../dml_update/) statement.
  • Subscripted expression can only be applied to columns of type `LIST`, `MAP`, or user-defined data types.
  • Subscripting a `LIST` value with a non-positive index will yield NULL.
    • diff --git a/docs/content/latest/api/ycql/function_datetime.md b/docs/content/latest/api/ycql/function_datetime.md index 390ae93baf48..3aa8ad6d5cac 100644 --- a/docs/content/latest/api/ycql/function_datetime.md +++ b/docs/content/latest/api/ycql/function_datetime.md @@ -3,7 +3,7 @@ title: Date and time functions [YCQL] headerTitle: Date and time functions title: Date and time functions [YCQL] headerTitle: Date and time functions -linkTitle: Date and time +linkTitle: Date and time description: Use date and time functions to work on date and time data types. menu: latest: @@ -16,7 +16,7 @@ isTocNested: false showAsideToc: true --- -This section covers the set of YCQL built-in functions that work on the date and time data types: [`DATE`, `TIME`, `TIMESTAMP`](../type_datetime), or [`TIMEUUID`](../type_uuid). +This section covers the set of YCQL built-in functions that work on the date and time data types: [`DATE`, `TIME`, `TIMESTAMP`](../type_datetime/), or [`TIMEUUID`](../type_uuid). ## currentdate(), currenttime(), and currenttimestamp() @@ -96,7 +96,7 @@ ycqlsh:example> SELECT v FROM test_now WHERE v < now(); This function converts a timestamp or TIMEUUID to the corresponding date. -- It takes in an argument of type `TIMESTAMP` or `TIMEUUID`. +- It takes in an argument of type `TIMESTAMP` or `TIMEUUID`. - The return value is a `DATE`. ```sql @@ -121,7 +121,7 @@ ycqlsh:example> SELECT todate(ts) FROM test_todate; This function converts a date or TIMEUUID to the corresponding timestamp. -- It takes in an argument of type `DATE` or `TIMEUUID`. +- It takes in an argument of type `DATE` or `TIMEUUID`. - The return value is a `TIMESTAMP`. ### Examples @@ -164,7 +164,7 @@ ycqlsh:example> SELECT v FROM test_totimestamp WHERE v < totimestamp(now()); This function converts a TIMEUUID to the corresponding timestamp. -- It takes in an argument of type `TIMEUUID`. +- It takes in an argument of type `TIMEUUID`. - The return value is a `TIMESTAMP`. ### Examples @@ -252,7 +252,7 @@ ycqlsh:example> SELECT v from test_tounixtimestamp WHERE v < tounixtimestamp(now ## unixtimestampof() This function converts TIMEUUID or timestamp to a unix timestamp (which is -equal to the number of millisecond since epoch Thursday, 1 January 1970). +equal to the number of millisecond since epoch Thursday, 1 January 1970). - It takes in an argument of type `TIMEUUID` or type `TIMESTAMP`. - The return value is a `BIGINT`. @@ -338,6 +338,6 @@ ycqlsh:example> SELECT uuid() FROM test_uuid; ## See also -- [`DATE`, `TIME` and `TIMESTAMP`](../type_datetime) +- [`DATE`, `TIME` and `TIMESTAMP`](../type_datetime/) - [`TIMEUUID`](../type_uuid) - [`UUID`](../type_uuid) diff --git a/docs/content/latest/api/ycql/type_datetime.md b/docs/content/latest/api/ycql/type_datetime.md index f2f71aeae663..7f4c59524b24 100644 --- a/docs/content/latest/api/ycql/type_datetime.md +++ b/docs/content/latest/api/ycql/type_datetime.md @@ -38,7 +38,7 @@ type_specification ::= TIMESTAMP | DATE | TIME ### DATE A date is represented using a 32-bit unsigned integer representing the number of days since epoch (January 1, 1970) with no corresponding time value. -Use [INSERT](../dml_insert) or [UPDATE](../dml_update) to add values as an integer (days since epoch) or in the string format shown below. +Use [INSERT](../dml_insert) or [UPDATE](../dml_update/) to add values as an integer (days since epoch) or in the string format shown below. #### Syntax @@ -56,7 +56,7 @@ For example, `2020-07-29`. Values of the `time` data type are encoded as 64-bit signed integers representing the number of nanoseconds since midnight with no corresponding date value. -Use [INSERT](../dml_insert) or [UPDATE](../dml_update) to add values in the following string format, where subseconds (`f`) are optional and if provided, can be less than nanosecond: +Use [INSERT](../dml_insert) or [UPDATE](../dml_update/) to add values in the following string format, where subseconds (`f`) are optional and if provided, can be less than nanosecond: #### Syntax @@ -75,7 +75,7 @@ For example, `12:34:56` or `12:34:56.789` or `12:34:56.123456789`. Values of the `timestamp` data type combines date, time, and time zone, in ISO 8601 format. -Use [INSERT](../dml_insert) or [UPDATE](../dml_update) to add values in the string format shown below, where milliseconds (`f`) are optional. +Use [INSERT](../dml_insert) or [UPDATE](../dml_update/) to add values in the string format shown below, where milliseconds (`f`) are optional. #### Syntax diff --git a/docs/content/latest/api/ysql/_index.md b/docs/content/latest/api/ysql/_index.md index 67e7228a422e..63f2c27bf1c2 100644 --- a/docs/content/latest/api/ysql/_index.md +++ b/docs/content/latest/api/ysql/_index.md @@ -19,7 +19,7 @@ showAsideToc: true ## Introduction -Yugabyte Structured Query Language (YSQL) is an ANSI SQL, fully-relational API that is best fit for scale-out RDBMS applications that need ultra resilience, massive write scalability and geographic data distribution. The YugabyteDB SQL processing layer is built by using the PostgreSQL code (starting with version 11.2) directly. +Yugabyte Structured Query Language (YSQL) is an ANSI SQL, fully-relational API that is best fit for scale-out RDBMS applications that need ultra resilience, massive write scalability and geographic data distribution. The YugabyteDB SQL processing layer is built by using the PostgreSQL code (starting with version 11.2) directly. YSQL therefore supports all of the traditional relational modeling features, such as referential integrity (implemented using a foreign key constraint from a child table to a primary key to its parent table), joins, partial indexes, triggers and stored procedures. It extends the familiar transactional notions into the YugabyteDB Distributed SQL Database architecture. @@ -35,7 +35,7 @@ To find the version of the PostgreSQL processing layer used in YugabyteDB, you c select rpad(version(), 18)||'...' as v; ``` -For the “latest” release series of YugabyteDB, as reflected in this main documentation URL, +For the “latest” release series of YugabyteDB, as reflected in this main documentation URL, the query result shows that the PostgreSQL version is 11.2: ``` @@ -48,7 +48,7 @@ the query result shows that the PostgreSQL version is 11.2: ## Quick Start -You can explore the basics of the YSQL API using the [Quick Start](../../quick-start/explore/ysql) steps. +You can explore the basics of the YSQL API using the [Quick Start](../../quick-start/explore/ysql/) steps. ## The SQL language @@ -60,5 +60,5 @@ This section lists the main elements that support the YugabyteDB SQL language su - [Keywords](keywords). - Names and Qualifiers: Some names are reserved for the system. List of [reserved names](reserved_names). -- Data types: Most PostgreSQL-compatible data types are supported. List of [data types](datatypes). -- [Built-in SQL functions](exprs) +- Data types: Most PostgreSQL-compatible data types are supported. List of [data types](datatypes/). +- [Built-in SQL functions](exprs/) diff --git a/docs/content/latest/api/ysql/datatypes/_index.md b/docs/content/latest/api/ysql/datatypes/_index.md index 247dc44f0a74..5737bb8ed2c4 100644 --- a/docs/content/latest/api/ysql/datatypes/_index.md +++ b/docs/content/latest/api/ysql/datatypes/_index.md @@ -20,7 +20,7 @@ The following table lists the primitive and compound data types in YSQL. | Data type | Alias | Description | |-----------|-------|-------------| -| [`array`](type_array) | | One-dimensional or multidimensional rectilinear array of any data type payload | +| [`array`](type_array/) | | One-dimensional or multidimensional rectilinear array of any data type payload | | [`bigint`](type_numeric) | [`int8`](type_numeric) | Signed eight-byte integer | | [`bigserial`](type_serial) | [`serial8`](type_serial) | Autoincrementing eight-byte integer | | `bit [ (n) ]` 1 | | Fixed-length bit string | @@ -32,13 +32,13 @@ The following table lists the primitive and compound data types in YSQL. | [`character varying [ (n) ]`](type_character) | [`varchar [ (n) ]`](type_character) | Variable-length character string | | `cidr` 1 | | IPv4 or IPv6 network address | | `circle` 1 | | Circle on a plane | -| [`date`](type_datetime) | | Calendar date (year, month, day) | +| [`date`](type_datetime/) | | Calendar date (year, month, day) | | [`double precision`](type_numeric) | [`float8`](type_numeric) | Double precision floating-point number (8 bytes) | | `inet` 1 | | IPv4 or IPv6 host address | | [`integer`](type_numeric) | [`int`, `int4`](type_numeric) | Signed four-byte integer | -| [`interval [ fields ] [ (p) ]`](type_datetime) | | Time span | -| [`json`](type_json) 1 | | Textual JSON data | -| [`jsonb`](type_json) 1 | | Binary JSON data, decomposed | +| [`interval [ fields ] [ (p) ]`](type_datetime/) | | Time span | +| [`json`](type_json/) 1 | | Textual JSON data | +| [`jsonb`](type_json/) 1 | | Binary JSON data, decomposed | | `line` 1 | | Infinite line on a plane | | `lseg` 1 | | Line segment on a plane | | `macaddr` 1 | | Media Access Control (MAC) address | @@ -60,10 +60,10 @@ The following table lists the primitive and compound data types in YSQL. | [`smallserial`](type_serial) | [`serial2`](type_serial) | Autoincrementing two-byte integer | | [`serial`](type_serial) | [`serial4`](type_serial) | Autoincrementing four-byte integer | | [`text`](type_character) | | Variable-length character string | -| [`time [ (p) ] [ without time zone ]`](type_datetime) | | Time of day (no time zone) | -| [`time [ (p) ] with time zone`](type_datetime) | [`timetz`](type_datetime) | Time of day, including time zone | -| [`timestamp [ (p) ] [ without time zone ]`](type_datetime) | | Date and time (no time zone) | -| [`timestamp [ (p) ] with time zone`](type_datetime) | [`timestamptz`](type_datetime) | Date and time, including time zone | +| [`time [ (p) ] [ without time zone ]`](type_datetime/) | | Time of day (no time zone) | +| [`time [ (p) ] with time zone`](type_datetime/) | [`timetz`](type_datetime/) | Time of day, including time zone | +| [`timestamp [ (p) ] [ without time zone ]`](type_datetime/) | | Date and time (no time zone) | +| [`timestamp [ (p) ] with time zone`](type_datetime/) | [`timestamptz`](type_datetime/) | Date and time, including time zone | | `tsquery` 1 | | Text search query | | `tsvector` 1 | | Text search document | | `txid_snapshot` 1 | | Transaction ID snapshot | diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/conceptual-background.md b/docs/content/latest/api/ysql/datatypes/type_datetime/conceptual-background.md index 2c1fae73c5ba..e71f412e29b7 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/conceptual-background.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/conceptual-background.md @@ -12,7 +12,7 @@ isTocNested: true showAsideToc: true --- -The following subsections provide the conceptual background for the accounts of the _date-time_ data types that the table shown in the [Synopsis](../intro/#synopsis) lists and for the operations that the _date-time_ operators and built-in SQL functions perform. +The following subsections provide the conceptual background for the accounts of the _date-time_ data types that the table shown in the [Synopsis](../../type_datetime/) lists and for the operations that the _date-time_ operators and built-in SQL functions perform. - [Absolute time and the UTC Time Standard](#absolute-time-and-the-utc-time-standard) - [Wall-clock-time and local time](#wall-clock-time-and-local-time) @@ -68,12 +68,12 @@ select It quietly succeeds and produces the obvious result. (The _::text_ typecast of a _timestamp_ value uses only as much precision as the value requires.) ```output - min_ts | max_ts + min_ts | max_ts ------------------------+----------------------- 4713-01-01 00:00:00 BC | 294276-01-01 00:00:00 ``` -The values, _4713 BC_ and _294276_ AD, are given in the [table](../intro/#synopsis) in the _"Introduction"_ section to the present _date-time_ data types major section. +The values, _4713 BC_ and _294276_ AD, are given in the [table](../../type_datetime/) in the _"Introduction"_ section to the present _date-time_ data types major section. ## Wall-clock-time and local time @@ -231,7 +231,7 @@ This is the result. (The blank lines were added manually to improve the readabil You can see that, just as the Wikipedia article said, a conventional adjustment was edicted for clocks in the United States during the period from 16:00 _UTC_ through 20:00 _UTC_ on Sunday 18-Nov-1883. During that period (in fact, successively from region to region) everybody "gained" a little time—just as, now, people "gain" one hour on the "fall back" day when Daylight Savings Time ends. For example, people in the _America/Los_Angeles_ zone gained seven minutes and two seconds. Moreover, the offset between these regions and Greenwich UK was adjusted by a small compensating amount at the same transition moment to make it an integral multiple of one hour. -Notice that the time in London was always right—by definition! Meanwhile, other cities in Europe made their corresponding conventional adjustments at later dates. +Notice that the time in London was always right—by definition! Meanwhile, other cities in Europe made their corresponding conventional adjustments at later dates. By the year 2000, all the cities or regions that the query selects, whose timezones the function uses, have settled down to have timezone offsets that are integral multiples of one hour. Notably, some timezones have offsets that are integral multiples of fifteen minutes. Try this: @@ -276,7 +276,7 @@ It was eventually decided that an atomic clock should define the ultimate standa It is now understood that the observable phenomena like day, month, and year cannot be defined as constant integral numbers of seconds. -This realization is formalized in PostgreSQL (and therefore in YSQL) as the so-called _proleptic Gregorian calendar_. +This realization is formalized in PostgreSQL (and therefore in YSQL) as the so-called _proleptic Gregorian calendar_. {{< note title="The proleptic Gregorian calendar." >}}     The proleptic Gregorian calendar implements the notion of the Western calendar month with its idiosyncrasies: February has 29 days in a leap year and otherwise 28 days; and the other months have either 30 or 31 days. (Lunar months have vanished from the discourse.) So, while one year is usually 365 days, it is sometimes 366 days. The calendar is a mapping between the number of seconds before or after midnight 1970, on the Greenwich Meridian, and the year, calendar month, date, and time of day (in hours, minutes, and seconds) on that same meridian. The mapping cannot be a formula. Rather, it can only be an elaborate look-up table. @@ -305,7 +305,7 @@ Treating one day as exactly 24 hours, one month as 30 days, and one year as 12 m ### Clock-time -Briefly, _clock-time_ is caesium units—or, by convention, seconds, minutes, and hours. +Briefly, _clock-time_ is caesium units—or, by convention, seconds, minutes, and hours. **Note**: Some calendar implementations support [leap seconds](https://www.timeanddate.com/time/leapseconds.html). (When a leap second occurs, its containing minute is 61 seconds and not 60 seconds.) But the implementation that PostgreSQL and YSQL use does not support this notion. The implementation, therefore, can treat hours, minutes, and seconds with strict _clock-time-semantics_ and needs to treat only the larger units with _calendar-time-semantics_. @@ -331,7 +331,7 @@ with v as ( select ( -- The 'America/Los_Angeles' timezone adopted Standard Time at -- some moment between these two timestamptz values. - extract(epoch from '1883-11-19 08:00:00 America/Los_Angeles'::timestamptz) - + extract(epoch from '1883-11-19 08:00:00 America/Los_Angeles'::timestamptz) - extract(epoch from '1883-11-18 08:00:00 America/Los_Angeles'::timestamptz) ) as delta ) @@ -343,7 +343,7 @@ from v; This is the result: ```output - delta (hh:mi:ss) + delta (hh:mi:ss) ------------------ 24:07:02 ``` @@ -362,7 +362,7 @@ select This is the result: ```output - t0 + 24 hours | t0 + 1 day + t0 + 24 hours | t0 + 1 day ------------------------+------------------------ 1883-11-19 07:52:58-08 | 1883-11-19 08:00:00-08 ``` diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/declaring-intervals.md b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/declaring-intervals.md index bed0da36db61..69cc5b3e33a8 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/declaring-intervals.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/declaring-intervals.md @@ -13,7 +13,7 @@ showAsideToc: true --- {{< tip title="Download and [re]install the date-time utilities code." >}} -The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../interval-utilities/) and on the [function interval_mm_dd_ss (interval_parameterization_t)](../interval-representation/internal-representation-model/#function-interval-mm-dd-ss-interval-parameterization-t-returns-interval-mm-dd-ss-t), explained in the section [Modeling the internal representation and comparing the model with the actual implementation](../interval-representation/internal-representation-model/). This is all included in the larger [code kit](../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../type_datetime)_ section describes and uses. +The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../interval-utilities/) and on the [function interval_mm_dd_ss (interval_parameterization_t)](../interval-representation/internal-representation-model/#function-interval-mm-dd-ss-interval-parameterization-t-returns-interval-mm-dd-ss-t), explained in the section [Modeling the internal representation and comparing the model with the actual implementation](../interval-representation/internal-representation-model/). This is all included in the larger [code kit](../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../type_datetime/)_ section describes and uses. Even if you have already installed the code kit, install it again now. Do this because a code example in the section [How does YSQL represent an _interval_ value?](../interval-representation/) redefines one of the _interval_ utility functions. {{< /tip >}} @@ -303,7 +303,7 @@ declare i_hour constant interval hour not null := i_bare; i_minute constant interval minute not null := i_bare; i_second constant interval second not null := i_bare; -begin +begin return case mode when 'bare' then i_bare diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-interval-addition.md b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-interval-addition.md index 759c0d926c2d..9b52283bfddd 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-interval-addition.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-interval-addition.md @@ -13,7 +13,7 @@ showAsideToc: true --- {{< tip title="Download and install the date-time utilities code." >}} -The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../../interval-utilities/). This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime)_ section describes and uses. +The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../../interval-utilities/). This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime/)_ section describes and uses. {{< /tip >}} This section presents a PL/pgSQL implementation of the model that explains how adding two _interval_ values or subtracting one _interval_ value from another works. @@ -88,7 +88,7 @@ This is the result: intermediate model mm_dd_ss: 6.0000 months 2.0000 days 0.0000 seconds ultimate model mm_dd_ss: 6.0000 months 2.0000 days 0.0000 seconds actual mm_dd_ss: 6.0000 months 2.0000 days 0.0000 seconds - + ultimate model result: 6 mons 2 days ``` @@ -108,7 +108,7 @@ This is the result: intermediate model mm_dd_ss: 8.0000 months 56.0000 days 141840.0000 seconds ultimate model mm_dd_ss: 8.0000 months 56.0000 days 141840.0000 seconds actual mm_dd_ss: 8.0000 months 56.0000 days 141840.0000 seconds - + ultimate model result: 8 mons 56 days 39:24:00 ``` diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-interval-comparison.md b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-interval-comparison.md index 03fc57256872..481c2d03a52b 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-interval-comparison.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-interval-comparison.md @@ -13,7 +13,7 @@ showAsideToc: true --- {{< tip title="Download and install the date-time utilities code." >}} -The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../../interval-utilities/). This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime)_ section describes and uses. +The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../../interval-utilities/). This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime/)_ section describes and uses. {{< /tip >}} The semantics of the _interval-interval_ overloads of these comparison operators can be understood in terms of the semantics of the _[justify_interval()](../../justfy-and-extract-epoch/#the-justify-hours-justify-days-and-justify-interval-built-in-functions)_ built-in function: @@ -93,7 +93,7 @@ select It finishes silently, showing that the _assert_ holds, and produces this result: ```output - e1 | e2 + e1 | e2 ---------+--------- i1 = i2 | i1 = i2 ``` diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-number-multiplication.md b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-number-multiplication.md index fe449f34caf4..7b039d8a783c 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-number-multiplication.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/interval-number-multiplication.md @@ -13,7 +13,7 @@ showAsideToc: true --- {{< tip title="Download and install the date-time utilities code." >}} -The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../../interval-utilities/). This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime)_ section describes and uses. +The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../../interval-utilities/). This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime/)_ section describes and uses. {{< /tip >}} This section presents a PL/pgSQL implementation of the model that explains how multiplying or dividing an _interval_ value by a number works. Make sure that you have read the section [Adding or subtracting a pair of _interval_ values](../interval-interval-addition/) before reading this section. @@ -83,7 +83,7 @@ This is the multiplication result: intermediate model mm_dd_ss: 2.4691 months 0.0000 days 0.0000 seconds ultimate model mm_dd_ss: 2.0000 months 14.0000 days 6399.4752 seconds actual mm_dd_ss: 2.0000 months 14.0000 days 6399.4752 seconds - + ultimate model result: 2 mons 14 days 01:46:39.4752 ``` @@ -94,7 +94,7 @@ And this is the division result: intermediate model mm_dd_ss: 1.9753 months 0.0000 days 0.0000 seconds ultimate model mm_dd_ss: 1.0000 months 29.0000 days 22399.8912 seconds actual mm_dd_ss: 1.0000 months 29.0000 days 22399.8912 seconds - + ultimate model result: 1 mon 29 days 06:13:19.8912 ``` @@ -192,7 +192,7 @@ This is the result: intermediate model mm_dd_ss: 1.9200 months 1.9200 days 6912.0000 seconds ultimate model mm_dd_ss: 1.0000 months 28.0000 days 138240.0000 seconds actual mm_dd_ss: 1.0000 months 29.0000 days 51840.0000 seconds - + ultimate model result: 1 mon 28 days 38:24:00 ``` @@ -251,7 +251,7 @@ select This is the result: ```output - actual | model + actual | model ------------------------+------------------------ 1 mon 28 days 21:36:00 | 1 mon 28 days 21:36:00 ``` @@ -267,7 +267,7 @@ select This is the result: ```output - actual | model + actual | model ------------------------+------------------------ 1 mon 29 days 12:28:48 | 1 mon 28 days 36:28:48 ``` @@ -289,7 +289,7 @@ select This is the result: ```output - add then multiply | multiply then add + add then multiply | multiply then add ------------------------+------------------------ 1 mon 29 days 12:28:48 | 1 mon 28 days 36:28:48 ``` @@ -305,7 +305,7 @@ select This is the result: ```output - add then multiply | multiply then add + add then multiply | multiply then add ------------------------+------------------------ 1 mon 28 days 36:28:48 | 1 mon 28 days 36:28:48 ``` diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/moment-interval-overloads-of-plus-and-minus.md b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/moment-interval-overloads-of-plus-and-minus.md index d1a081230548..d081f9ed355b 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/moment-interval-overloads-of-plus-and-minus.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-arithmetic/moment-interval-overloads-of-plus-and-minus.md @@ -13,7 +13,7 @@ showAsideToc: true --- {{< tip title="Download and install the date-time utilities code." >}} -The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../../interval-utilities/). This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime)_ section describes and uses. +The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../../interval-utilities/). This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime/)_ section describes and uses. {{< /tip >}} This section presents PL/pgSQL implementations that model the semantics of the _interval_-moment-overload of the `+` operator for three distinct kinds of _interval_ value: _pure seconds_, _pure days_, and _pure months_. The semantics of the _interval_-moment-overloads of the `-` operator is implied by the semantics of the overload of the `+` operator. @@ -52,7 +52,7 @@ update t set "t0 + 720 hours" = t0 + '720 hours'::interval, "t0 + 30 days" = t0 + '30 days'::interval, "t0 + 1 month" = t0 + '1 month'::interval; - + prepare inspect_result as select t0, @@ -73,12 +73,12 @@ execute inspect_result; This is the result: ```output - t0 | t0 + 720 hours | t0 + 30 days | t0 + 1 month + t0 | t0 + 720 hours | t0 + 30 days | t0 + 1 month ------------------------+------------------------+------------------------+------------------------ 2021-02-19 12:00:00-08 | 2021-03-21 13:00:00-07 | 2021-03-21 12:00:00-07 | 2021-03-19 12:00:00-07 ``` -All the three results are displayed with a negative seven hours _UTC offset_ reflecting the fact that they occur during the Daylight Savings Time period in the United States. The time of day for _"t0 + 720 hours"_ differs by one hour from that for _"t0 + 30 days"_, but the date component is the same for each. The time of day for _"t0 + 30 days"_ is the same as that for _"t0 + 1 month"_, but the date component differs by two days. +All the three results are displayed with a negative seven hours _UTC offset_ reflecting the fact that they occur during the Daylight Savings Time period in the United States. The time of day for _"t0 + 720 hours"_ differs by one hour from that for _"t0 + 30 days"_, but the date component is the same for each. The time of day for _"t0 + 30 days"_ is the same as that for _"t0 + 1 month"_, but the date component differs by two days. You have to think quite hard to understand displayed _timestamptz_ values when you inspect them using a session whose _TimeZone_ setting is _not_ _UTC_ because that setting affects the values that you see. This is very much intended and reflects the _raison d’être_ of the data type. See the section [The plain _timestamp_ and _timestamptz_ data types](../../../type-timestamp/). In particular, this is why the moment before "spring forward" is displayed with an offset of negative _eight_ hours while the moments after "spring forward" are displayed with an offset of negative _seven_ hours. @@ -100,12 +100,12 @@ execute inspect_result; This is the result: ```output - t0 | t0 + 720 hours | t0 + 30 days | t0 + 1 month + t0 | t0 + 720 hours | t0 + 30 days | t0 + 1 month ------------------------+------------------------+------------------------+------------------------ 2021-02-19 20:00:00+00 | 2021-03-21 20:00:00+00 | 2021-03-21 19:00:00+00 | 2021-03-19 19:00:00+00 ``` -The three _interval_ arithmetic results all differ from each other. in other words, the semantic effect of adding the "same" _interval_ value to the same _timestamptz_ value is different for each of the three nominally interchangeable spellings, _'720 hours'_, _'30 days'_, or _'1 month'_, of the _interval_ value. +The three _interval_ arithmetic results all differ from each other. in other words, the semantic effect of adding the "same" _interval_ value to the same _timestamptz_ value is different for each of the three nominally interchangeable spellings, _'720 hours'_, _'30 days'_, or _'1 month'_, of the _interval_ value. Now re-execute the prepared statement after setting the session's timezone to one that does _not_ respect Daylight savings Time. @@ -124,7 +124,7 @@ execute inspect_result; This is the new result: ```output - t0 | t0 + 720 hours | t0 + 30 days | t0 + 1 month + t0 | t0 + 720 hours | t0 + 30 days | t0 + 1 month ------------------------+------------------------+------------------------+------------------------ 2021-02-19 20:00:00+00 | 2021-03-21 20:00:00+00 | 2021-03-21 20:00:00+00 | 2021-03-19 20:00:00+00 ``` @@ -153,7 +153,7 @@ select This is the result: ```output - '720 hours' | '30 days' | '1 month' + '720 hours' | '30 days' | '1 month' ---------------+-----------+----------- (0,0,2592000) | (0,30,0) | (1,0,0) ``` diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-representation/_index.md b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-representation/_index.md index 2b58958e067c..1b78e1f253ac 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-representation/_index.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-representation/_index.md @@ -14,7 +14,7 @@ showAsideToc: true --- {{< tip title="Download and install the date-time utilities code." >}} -The code on this page and on its child, [Modeling the internal representation and comparing the model with the actual implementation](./internal-representation-model/), depends on the code presented in the section [User-defined _interval_ utility functions](../interval-utilities/). This is included in the larger [code kit](../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../type_datetime)_ section describes and uses. +The code on this page and on its child, [Modeling the internal representation and comparing the model with the actual implementation](./internal-representation-model/), depends on the code presented in the section [User-defined _interval_ utility functions](../interval-utilities/). This is included in the larger [code kit](../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../type_datetime/)_ section describes and uses. {{< /tip >}} The PostgreSQL documentation, under the table [Interval Input](https://www.postgresql.org/docs/11/datatype-datetime.html#DATATYPE-INTERVAL-INPUT-EXAMPLES), says this: @@ -108,5 +108,5 @@ The section [Interval arithmetic](../interval-arithmetic/) explains that the sem {{< tip title="Heads up." >}} There has been some discussion on the [pgsql-general](mailto:pgsql-general@lists.postgresql.org) and [pgsql-hackers](mailto:pgsql-hackers@lists.postgresql.org) mail lists about the algorithm whose implementation that the function _interval()_ documents. As a result, a patch has been developed for a future version of the PostgreSQL system that makes some subtle changes to the "spill-down" behavior in response to real number input values for _years_, _months_, _days_, _hours_, and _minutes_ when you use the _::interval_ typecast approach to construct an _interval_ value. When YugabyteDB adopts this patch, the implementation of the function [interval_mm_dd_ss (interval_parameterization_t)](./internal-representation-model/#function-interval-mm-dd-ss-interval-parameterization-t-returns-interval-mm-dd-ss-t) will be changed accordingly. -If you follow Yugabyte's recommendation to construct _interval_ values using only integral values for _years_, _months_, _days_, _hours_, and _minutes_ (or, equivalently, always to use the _make_interval()_ SQL built-in function rather than the _::interval_ typecast approach), then your application code will not see a behavior change when you move to a version of YugabyteDB that implements this patch. As mentioned above, the section [Custom domain types for specializing the native _interval_ functionality](../custom-interval-domains/) shows how to impose this discipline programmatically. +If you follow Yugabyte's recommendation to construct _interval_ values using only integral values for _years_, _months_, _days_, _hours_, and _minutes_ (or, equivalently, always to use the _make_interval()_ SQL built-in function rather than the _::interval_ typecast approach), then your application code will not see a behavior change when you move to a version of YugabyteDB that implements this patch. As mentioned above, the section [Custom domain types for specializing the native _interval_ functionality](../custom-interval-domains/) shows how to impose this discipline programmatically. {{< /tip >}} diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-representation/internal-representation-model.md b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-representation/internal-representation-model.md index c0cdddb33cca..5fe899ef9abd 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-representation/internal-representation-model.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-representation/internal-representation-model.md @@ -13,7 +13,7 @@ showAsideToc: true --- {{< tip title="Download and install the date-time utilities code." >}} -The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../../interval-utilities/). This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime)_ section describes and uses. +The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../../interval-utilities/). This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime/)_ section describes and uses. {{< /tip >}} Each of the [ad hoc examples](../ad-hoc-examples/) creates an _interval_ value by specifying any subset of its parameterization using _years_, _months_, _days_, _hours_, _minutes_, and _seconds_ from at least one of these through at most all six of them. (Omitting any of these six has the same effect as specifying _zero_ for that parameter.) diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-utilities.md b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-utilities.md index 412df5f23e24..5f22534201b1 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-utilities.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/interval-utilities.md @@ -48,7 +48,7 @@ The code presented on this page defines two user-defined types, _interval_parame The code that the remainder of this section presents defines the _interval_parameterization_t_ and _interval_mm_dd_ss_t_ types, and all but one of the six mutual transformation functions. The design of the five functions that are shown here is straightforward—but it does depend on knowing that the internal representation of an _interval_ value is a _[\[mm, dd, ss\]](../interval-representation/)_ tuple that uses four-byte integers to record the _months_ and _days_ fields and an eight-byte integer to record the _seconds_ field as a microseconds value. -The section [Modeling the internal representation and comparing the model with the actual implementation](../interval-representation/internal-representation-model/) defines and tests the function that the present page doesn't show: _function interval_mm_dd_ss(interval_parameterization_t)_. It implements, using PL/pgSQL, the rather complex algorithm that PostgreSQL, and therefore YSQL, use in their C code to transform a value, presented as a _text_ literal, to the internal _interval_ representation. +The section [Modeling the internal representation and comparing the model with the actual implementation](../interval-representation/internal-representation-model/) defines and tests the function that the present page doesn't show: _function interval_mm_dd_ss(interval_parameterization_t)_. It implements, using PL/pgSQL, the rather complex algorithm that PostgreSQL, and therefore YSQL, use in their C code to transform a value, presented as a _text_ literal, to the internal _interval_ representation. Here's an example of such a _text_ literal: @@ -67,7 +67,7 @@ Here's an example of such a _text_ literal: PostgreSQL defines two fundamentally different data type families for representing real numbers and for supporting arithmetic using their values. Of course, YSQL inherits this regime. -The PostgreSQL documentation uses the terms [Arbitrary Precision Numbers](https://www.postgresql.org/docs/11/datatype-numeric.html#DATATYPE-NUMERIC-DECIMAL) and [Floating-Point Numbers](https://www.postgresql.org/docs/11/datatype-numeric.html#DATATYPE-FLOAT) for these two kinds of data type. The first kind is exemplified by the data type _numeric_. And the second kind is exemplified by _double precision_. There are other variants in each class. But the entire _[date_time](../../../type_datetime/)_ section uses only these two (and uses only the unconstraint _numeric_ variant). Moreover, it uses _numeric_ only under duress. For example, you can easily round a _numeric_ value to some desired number of decimal places like this: +The PostgreSQL documentation uses the terms [Arbitrary Precision Numbers](https://www.postgresql.org/docs/11/datatype-numeric.html#DATATYPE-NUMERIC-DECIMAL) and [Floating-Point Numbers](https://www.postgresql.org/docs/11/datatype-numeric.html#DATATYPE-FLOAT) for these two kinds of data type. The first kind is exemplified by the data type _numeric_. And the second kind is exemplified by _double precision_. There are other variants in each class. But the entire _[date_time](../../../../type_datetime/)_ section uses only these two (and uses only the unconstraint _numeric_ variant). Moreover, it uses _numeric_ only under duress. For example, you can easily round a _numeric_ value to some desired number of decimal places like this: ```plpgsql select round(12.3456789::numeric, 3::int); @@ -125,7 +125,7 @@ In the context of the _date-time_ data types, _double precision_ values always r ```plpgsql drop function if exists approx_equals(double precision, double precision) cascade; -create function approx_equals(v1 in double precision, v2 in double precision) +create function approx_equals(v1 in double precision, v2 in double precision) returns boolean language plpgsql as $body$ @@ -173,7 +173,7 @@ from c3; This is the result: ```output - orig | recovered | native_equals | approx_equals + orig | recovered | native_equals | approx_equals --------------------+--------------------+---------------+--------------- 234.567000000000 | 234.567000000000 | false | true ``` @@ -188,15 +188,15 @@ When you define an _interval_ value using either the _::interval_ typecast of a ```plpgsql select - '5 years 4 months' ::interval as i1, - '40 days' ::interval as i2, + '5 years 4 months' ::interval as i1, + '40 days' ::interval as i2, '9 hours 30 minutes 45 seconds' ::interval as i3; ``` This is the result: ```output - i1 | i2 | i3 + i1 | i2 | i3 ----------------+---------+---------- 5 years 4 mons | 40 days | 09:30:45 ``` @@ -205,8 +205,8 @@ And try this, using the _make_interval()_ approach: ```plpgsql select - make_interval(years=>5, months=>4) as i1, - make_interval(days=>40) as i2, + make_interval(years=>5, months=>4) as i1, + make_interval(days=>40) as i2, make_interval(hours=>9, mins=>30, secs=>45) as i3; ``` @@ -274,7 +274,7 @@ select interval_parameterization(yy=>5, mm=>6)::text; This is the result: ```output - interval_parameterization + interval_parameterization --------------------------- (5,6,0,0,0,0) ``` @@ -297,7 +297,7 @@ declare hh constant interval not null := p.hh::text ||' hours'; mi constant interval not null := p.mi::text ||' minutes'; ss constant interval not null := p.ss::text ||' seconds'; -begin +begin return yy + mm + dd + hh + mi + ss; end; $body$; @@ -314,7 +314,7 @@ select interval_value(interval_parameterization(mm=>2.345, dd=>3.456))::text; This is the result: ```output - interval_value + interval_value --------------------------- 2 mons 13 days 19:20:38.4 ``` @@ -353,7 +353,7 @@ select parameterization('2 months 13 days 19:20:38.4'::interval)::text; This is the result: ```output - parameterization + parameterization -------------------------------------- (0,2,13,19,20,38.4) ``` @@ -505,7 +505,7 @@ create function interval_value(i in interval_mm_dd_ss_t) returns interval language plpgsql as $body$ -begin +begin return make_interval(months=>i.mm, days=>i.dd, secs=>i.ss); end; $body$; @@ -536,7 +536,7 @@ select extract(hours from '123 months 234 days 34567.123456 seconds'::interval) This is the result: ```output - extracted hours + extracted hours ----------------- 9 ``` @@ -650,7 +650,7 @@ Yugabyte staff members have carefully considered the practical value of the nati They believe that the use-cases where the functionality will be useful are rare—and that, rather, a "strict equals" notion, that requires pairwise equality of the individual fields of the [_\[mm, dd, ss\]_ internal representations](../interval-representation/) of the _interval_ values that are compared, will generally be more valuable. {{< /tip >}} -See the section [Comparing two _interval_ values](../interval-arithmetic/interval-interval-comparison/) for the larger discussion on this topic. +See the section [Comparing two _interval_ values](../interval-arithmetic/interval-interval-comparison/) for the larger discussion on this topic. Create the _strict_equals()_ function thus: @@ -900,7 +900,7 @@ select This is the result: ```output - all the same + all the same -------------- true ``` diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/justfy-and-extract-epoch.md b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/justfy-and-extract-epoch.md index 5cd5f0e9cd1a..8992107f4223 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/justfy-and-extract-epoch.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/date-time-data-types-semantics/type-interval/justfy-and-extract-epoch.md @@ -13,7 +13,7 @@ showAsideToc: true --- {{< tip title="Download and install the date-time utilities code." >}} -The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../interval-utilities/). This is included in the larger [code kit](../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../type_datetime)_ section describes and uses. +The code on this page depends on the code presented in the section [User-defined _interval_ utility functions](../interval-utilities/). This is included in the larger [code kit](../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../type_datetime/)_ section describes and uses. {{< /tip >}} ## The justify_hours(), justify_days(), and justify_interval() built-in functions diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/functions/_index.md b/docs/content/latest/api/ysql/datatypes/type_datetime/functions/_index.md index ecaee28bab3e..3f931fbc1ca5 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/functions/_index.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/functions/_index.md @@ -136,7 +136,7 @@ For this reason, this section won't say any more about the _timeofday()_ builtin | [pg_sleep_for()](./delaying-execution#function-pg-sleep-for-returns-void) | void | | [pg_sleep_until()](./delaying-execution#function-pg-sleep-until-returns-void) | void | -## [Miscellaneous functions](./miscellaneous) +## [Miscellaneous functions](./miscellaneous/) | | **return data type** | | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/operators/_index.md b/docs/content/latest/api/ysql/datatypes/type_datetime/operators/_index.md index b6e49e1fac60..2fe334387c8d 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/operators/_index.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/operators/_index.md @@ -13,7 +13,7 @@ isTocNested: true showAsideToc: true --- -Each of the comparison operators, `<`, `<=`, `=`, `>=`, `>`, and `<>`, each of the arithmetic operators, `+`, `-`, `*`, and `/`, and, of course, the `::` typecast operator has one or several overloads whose two operands are among the _date_, _time_, plain _timestamp_, _timestamptz_, and _interval_ data types. The [parent section](../../type_datetime) explains why _timetz_ is not covered in this overall _date-time_ section. This is why there are _five_ interesting _date-time_ data types. +Each of the comparison operators, `<`, `<=`, `=`, `>=`, `>`, and `<>`, each of the arithmetic operators, `+`, `-`, `*`, and `/`, and, of course, the `::` typecast operator has one or several overloads whose two operands are among the _date_, _time_, plain _timestamp_, _timestamptz_, and _interval_ data types. The [parent section](../../type_datetime/) explains why _timetz_ is not covered in this overall _date-time_ section. This is why there are _five_ interesting _date-time_ data types. The section [Typecasting between values of different date-time datatypes](../typecasting-between-date-time-values/) shows which of the twenty potential typecasts between pairs of _different_ interesting date-time data types are legal. (It's meaningless to think about typecasting between a pair of values of the _same_ data type.) And for each of those _ten_ that is legal, the section describes its semantics. Further, the typecast operator, `::`, has an overload from/to each of the five listed interesting _date-time_ data types to/from _text_. In other words, there are _ten_ typecasts from/to the interesting _date-time_ data types to/from _text_. The section [Typecasting between date-time values and text values](../typecasting-between-date-time-and-text/) describes these. @@ -73,7 +73,7 @@ from c; It runs without error and produces these two values: ```output - ts > t | tstz > t + ts > t | tstz > t --------+---------- false | true ``` @@ -125,7 +125,7 @@ select This is the result: ```output - data type | result + data type | result -----------+-------- integer | 5 ``` @@ -141,7 +141,7 @@ select This is the result: ```output - data type | result + data type | result -----------+------------ date | 2020-01-06 ``` diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-addition-overloads.md b/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-addition-overloads.md index 2554d682f82f..1961c5b7c7f9 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-addition-overloads.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-addition-overloads.md @@ -12,7 +12,7 @@ isTocNested: true showAsideToc: true --- -The [start page](../../../type_datetime) of the overall _date-time_ section explains why _timetz_ is not covered. So there are five _date-time_ data types to consider here and therefore twenty-five overloads to test. The following code implements all of the tests. The design of the code (it tests the legal additions and the illegal additions separately) was informed by _ad hoc_ tests during its development. +The [start page](../../../type_datetime/) of the overall _date-time_ section explains why _timetz_ is not covered. So there are five _date-time_ data types to consider here and therefore twenty-five overloads to test. The following code implements all of the tests. The design of the code (it tests the legal additions and the illegal additions separately) was informed by _ad hoc_ tests during its development. Try this: @@ -194,18 +194,18 @@ This is the result: ```output date-time: timestamp without time zone date-interval: timestamp without time zone - + time-date: timestamp without time zone time-ts: timestamp without time zone time-tstz: timestamp with time zone time-interval: time without time zone - + ts-time: timestamp without time zone ts-interval: timestamp without time zone - + tstz-time: timestamp with time zone tstz-interval: timestamp with time zone - + interval-date: timestamp without time zone interval-time: time without time zone interval-ts: timestamp without time zone diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-comparison-overloads.md b/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-comparison-overloads.md index 873a79520f6b..d59b72b12466 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-comparison-overloads.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-comparison-overloads.md @@ -26,7 +26,7 @@ data_type_2_value A data_type_1_value The fact that one is legal does not imply that the other is. The legality of each is informed by its own mental model; and each requires its own test. -The [start page](../../../type_datetime) of the overall _date-time_ section explains why _timetz_ is not covered. So there are five _date-time_ data types to consider here and therefore twenty-five overloads to test. (You can't assume that you can always compare values of the same data type. For example, if the data type represents the latitude and longitude of a location, then you can't ask which location is greater than the other.) +The [start page](../../../type_datetime/) of the overall _date-time_ section explains why _timetz_ is not covered. So there are five _date-time_ data types to consider here and therefore twenty-five overloads to test. (You can't assume that you can always compare values of the same data type. For example, if the data type represents the latitude and longitude of a location, then you can't ask which location is greater than the other.) The following code implements all of the tests. The design of the code (it tests the legal comparisons and the illegal comparisons separately) was informed by _ad hoc_ tests during its development. diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-subtraction-overloads.md b/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-subtraction-overloads.md index f6671438d335..c5a1faaf83a4 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-subtraction-overloads.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/operators/test-date-time-subtraction-overloads.md @@ -12,7 +12,7 @@ isTocNested: true showAsideToc: true --- -The [start page](../../../type_datetime) of the overall _date-time_ section explains why _timetz_ is not covered. So there are five _date-time_ data types to consider here and therefore twenty-five overloads to test. The following code implements all of the tests. The design of the code (it tests the legal subtractions and the illegal subtractions separately) was informed by _ad hoc_ tests during its development. +The [start page](../../../type_datetime/) of the overall _date-time_ section explains why _timetz_ is not covered. So there are five _date-time_ data types to consider here and therefore twenty-five overloads to test. The following code implements all of the tests. The design of the code (it tests the legal subtractions and the illegal subtractions separately) was informed by _ad hoc_ tests during its development. Try this: @@ -195,22 +195,22 @@ This is the result: date-ts: interval date-tstz: interval date-interval: timestamp without time zone - + time-time: interval time-interval: time without time zone - + ts-date: interval ts-time: timestamp without time zone ts-ts: interval ts-tstz: interval ts-interval: timestamp without time zone - + tstz-date: interval tstz-time: timestamp with time zone tstz-ts: interval tstz-tstz: interval tstz-interval: timestamp with time zone - + interval-time: interval interval-interval: interval ``` diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/timezones/recommendation.md b/docs/content/latest/api/ysql/datatypes/type_datetime/timezones/recommendation.md index 802ada4a3fa4..d8371debbdc6 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/timezones/recommendation.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/timezones/recommendation.md @@ -30,7 +30,7 @@ Following these recommendations protects you from the many opportunities to go w {{< tip title="Download and install the date-time utilities code." >}} The code on this page depends on the [_extended_timezone_names_ view](../extended-timezone-names/). It also depends on the [custom _interval_ domains](../../date-time-data-types-semantics/type-interval/custom-interval-domains/) code. And this, in turn, depends on the [user-defined _interval_ utilities](../../date-time-data-types-semantics/type-interval/interval-utilities/). -These components are all included in the larger [code kit](../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../type_datetime)_ section describes and uses. +These components are all included in the larger [code kit](../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../type_datetime/)_ section describes and uses. The code on that this page defines is intended for reuse. It, too, is therefore included in the _date-time utilities_ downloadable code kit. {{< /tip >}} @@ -307,13 +307,13 @@ begin declare msg constant text not null := tz_in||' assert failed'; begin - assert tz_out = tz_in, msg; + assert tz_out = tz_in, msg; end; end loop; begin call set_timezone('Bad'); - assert false, 'Logic error'; + assert false, 'Logic error'; exception when invalid_parameter_value then declare msg text not null := ''; @@ -359,7 +359,7 @@ begin begin call set_timezone(make_interval(hours=>19)); - assert false, 'Logic error'; + assert false, 'Logic error'; exception when invalid_parameter_value then declare msg text not null := ''; @@ -411,7 +411,7 @@ begin declare msg constant text not null := tz||' assert failed'; begin - assert tz_result = tz_expected, msg; + assert tz_result = tz_expected, msg; end; end loop; end; @@ -449,7 +449,7 @@ begin declare msg constant text not null := i::text||' assert failed'; begin - assert tz_result = tz_expected, msg; + assert tz_result = tz_expected, msg; end; end loop; end; diff --git a/docs/content/latest/api/ysql/datatypes/type_datetime/timezones/ways-to-spec-offset/name-res-rules/rule-4.md b/docs/content/latest/api/ysql/datatypes/type_datetime/timezones/ways-to-spec-offset/name-res-rules/rule-4.md index 55754f128bf6..6eec0854b603 100644 --- a/docs/content/latest/api/ysql/datatypes/type_datetime/timezones/ways-to-spec-offset/name-res-rules/rule-4.md +++ b/docs/content/latest/api/ysql/datatypes/type_datetime/timezones/ways-to-spec-offset/name-res-rules/rule-4.md @@ -19,7 +19,7 @@ This applies only in those syntax contexts where _pg_timezone_abbrevs.abbrev_ is {{< /tip >}}
    {{< tip title="Download and install the date-time utilities code." >}} -The code on this page depends on the code presented in the [_extended_timezone_names_ view](../../../extended-timezone-names/) section. This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime)_ section describes and uses. +The code on this page depends on the code presented in the [_extended_timezone_names_ view](../../../extended-timezone-names/) section. This is included in the larger [code kit](../../../../download-date-time-utilities/) that includes all of the reusable code that the overall _[date-time](../../../../../type_datetime/)_ section describes and uses. {{< /tip >}} The page for [Rule 3](../rule-3) tested with a string that's found uniquely in _pg_timezone_abbrevs.abbrev_. It established that for the second two syntax contexts (the _at time zone_ operator and the _text_ literal for a _timestamptz_ value), the string _is_ looked up in this column; and that for the first syntax context (the _set timezone_ statement) this column is _not_ searched. @@ -40,7 +40,7 @@ from c; This is the result: ```output - ~names.name | ~names.abbrev | ~abbrevs.abbrev + ~names.name | ~names.abbrev | ~abbrevs.abbrev -------------+---------------+----------------- true | false | false ``` @@ -81,7 +81,7 @@ from c; This is the result: ```output - ~names.name | ~names.abbrev | ~abbrevs.abbrev + ~names.name | ~names.abbrev | ~abbrevs.abbrev -------------+---------------+----------------- true | false | true ``` @@ -107,7 +107,7 @@ Predictably, this is the result: The [PostgresSQL documentation](https://www.postgresql.org/docs/11/) does not provide the answer. But the question can be answered empirically if _MET_ (or another such string that occurs in both columns) maps to different _UTC_offset_ values in the two different columns. Try this: ```plpgsql -with +with met_names_offsets(string, names_offset, is_dst) as ( select name, utc_offset, is_dst from pg_timezone_names @@ -125,7 +125,7 @@ possibly_disagreeing_offsets(string, names_offset, is_dst, abbrevs_offset) as ( inner join met_abbrevs_offset as a using(string)) - + select string, names_offset, is_dst::text, abbrevs_offset from possibly_disagreeing_offsets; ``` @@ -133,12 +133,12 @@ from possibly_disagreeing_offsets; This is the result: ```output - string | names_offset | is_dst | abbrevs_offset + string | names_offset | is_dst | abbrevs_offset --------+--------------+--------+---------------- MET | 02:00:00 | true | 01:00:00 ``` -Of course, there is just one row because both _pg_timezone_names.name_ and _pg_timezone_abbrevs.abbrev_ have unique values. You can see that the query happens to have been executed during the Day Light Savings Time period for the timezone _MET_. This is fortunate for the usefulness of the test that follows. Look up _MET_ in the [_extended_timezone_names_](../../../extended-timezone-names/) view. +Of course, there is just one row because both _pg_timezone_names.name_ and _pg_timezone_abbrevs.abbrev_ have unique values. You can see that the query happens to have been executed during the Day Light Savings Time period for the timezone _MET_. This is fortunate for the usefulness of the test that follows. Look up _MET_ in the [_extended_timezone_names_](../../../extended-timezone-names/) view. ```plpgsql select name, std_abbrev, dst_abbrev, std_offset, dst_offset @@ -149,7 +149,7 @@ where name = 'MET'; This is the result: ```output - name | std_abbrev | dst_abbrev | std_offset | dst_offset + name | std_abbrev | dst_abbrev | std_offset | dst_offset ------+------------+------------+------------+------------ MET | MET | MEST | 01:00:00 | 02:00:00 ``` @@ -209,7 +209,7 @@ order by string; This is the result: ```outout - string | std_abbrev | dst_abbrev | std offset from ~names | dst offset from ~names | offset from ~abbrevs + string | std_abbrev | dst_abbrev | std offset from ~names | dst offset from ~names | offset from ~abbrevs --------+------------+------------+------------------------+------------------------+---------------------- CET | CET | CEST | 01:00:00 | 02:00:00 | 01:00:00 EET | EET | EEST | 02:00:00 | 03:00:00 | 02:00:00 diff --git a/docs/content/latest/api/ysql/exprs/window_functions/function-syntax-semantics/_index.md b/docs/content/latest/api/ysql/exprs/window_functions/function-syntax-semantics/_index.md index db9545deb46f..98342ea0ba25 100644 --- a/docs/content/latest/api/ysql/exprs/window_functions/function-syntax-semantics/_index.md +++ b/docs/content/latest/api/ysql/exprs/window_functions/function-syntax-semantics/_index.md @@ -38,7 +38,7 @@ This property is marked by _"Y"_ in the column _"agg?"_ in the following tables; {{< note title="Functions with both a 'window' and an 'aggregate' variant" >}} -The definitive description of the use, as an aggregate function, of a window function that has such a variant, is described within the [Aggregate functions](../../aggregate_functions) major section in the section [Within-group hypothetical-set aggregate functions +The definitive description of the use, as an aggregate function, of a window function that has such a variant, is described within the [Aggregate functions](../../aggregate_functions/) major section in the section [Within-group hypothetical-set aggregate functions ](../../aggregate_functions/function-syntax-semantics/rank-dense-rank-percent-rank-cume-dist/). {{< /note >}} diff --git a/docs/content/latest/api/ysql/exprs/window_functions/invocation-syntax-semantics.md b/docs/content/latest/api/ysql/exprs/window_functions/invocation-syntax-semantics.md index 02218591670e..85d6df0f7dbb 100644 --- a/docs/content/latest/api/ysql/exprs/window_functions/invocation-syntax-semantics.md +++ b/docs/content/latest/api/ysql/exprs/window_functions/invocation-syntax-semantics.md @@ -23,7 +23,7 @@ Notice these three different orthography styles: - `OVER` is a keyword that names a clause. You write such a keyword in a SQL statement. -- [`window_definition`](../../../syntax_resources/grammar_diagrams/#window-definition) is the name of a rule within the overall SQL grammar. You never type such a name in a SQL statement. It is written in bold lower case with underscores, as appropriate, between the English words. Because such a rule is always shown as a link, you can jump directly to the rule in the [Grammar Diagrams](../../../syntax_resources/grammar_diagrams/#abort) page. This page shows every single one of the SQL rules. It so happens that the [`window_definition`](../../../syntax_resources/grammar_diagrams/#window-definition) rule starts with the keyword `WINDOW` and might therefore, according to the context of use, be referred to alternatively as the `WINDOW` clause. +- [`window_definition`](../../../syntax_resources/grammar_diagrams/#window-definition) is the name of a rule within the overall SQL grammar. You never type such a name in a SQL statement. It is written in bold lower case with underscores, as appropriate, between the English words. Because such a rule is always shown as a link, you can jump directly to the rule in the [Grammar Diagrams](../../../syntax_resources/grammar_diagrams/#abort) page. This page shows every single one of the SQL rules. It so happens that the [`window_definition`](../../../syntax_resources/grammar_diagrams/#window-definition) rule starts with the keyword `WINDOW` and might therefore, according to the context of use, be referred to alternatively as the `WINDOW` clause. - [_window frame_](./#frame-clause-semantics-for-window-functions) is a pure term of art. It is written in italic lower case with spaces, as appropriate, between the English words. You neither write it in a SQL statement nor use it to look up anything in the [Grammar Diagrams](../../../syntax_resources/grammar_diagrams/#abort) page. Because such a term of art is always shown as a link, you can jump directly to its definition within this _"Window function invocation—SQL syntax and semantics"_ page. @@ -182,12 +182,12 @@ The [`frame_clause`](../../../syntax_resources/grammar_diagrams/#frame-clause) s - The functions in the first group, [Window functions that return an "int" or "double precision" value as a "classifier" of the rank of the row within its window](../function-syntax-semantics/#window-functions-that-return-an-int-or-double-precision-value-as-a-classifier-of-the-rank-of-the-row-within-its-window), are not sensitive to what the [`frame_clause`](../../../syntax_resources/grammar_diagrams/#frame-clause) specifies and always use all of the rows in the current [_window_](./#the-window-definition-rule). Yugabyte recommends that you therefore omit the [`frame_clause`](../../../syntax_resources/grammar_diagrams/#frame-clause) in the `OVER` clause that you use to invoke these functions. - The functions in the second group, [Window functions that return columns of another row within the window](../function-syntax-semantics/#window-functions-that-return-column-s-of-another-row-within-the-window), make obvious sense when the scope within which the specified row is found is the entire [_window_](./#the-window-definition-rule). If you have one of the very rare use cases where the output that you want is produced by a different [`frame_clause`](../../../syntax_resources/grammar_diagrams/#frame-clause), then specify what you want explicitly. Otherwise, because it isn't the default, you must specify that the [_window frame_](./#frame-clause-semantics-for-window-functions) includes the entire current [_window_](./#the-window-definition-rule) like this: - + ``` range between unbounded preceding and unbounded following ``` -Use cases where the [`frame_clause`](../../../syntax_resources/grammar_diagrams/#frame-clause)'s many other variants are useful arise when an aggregate function is invoked using the `OVER` clause. One example is given in the section [Using the aggregate function `avg()` to compute a moving average](../#using-the-aggregate-function-avg-to-compute-a-moving-average). Another example, that uses `count(*)`, is given in the code that explains the meaning of the [`percent_rank()`](../function-syntax-semantics/percent-rank-cume-dist-ntile/#percent-rank) function. Otherwise, see the main [Aggregate functions](../../aggregate_functions) section. +Use cases where the [`frame_clause`](../../../syntax_resources/grammar_diagrams/#frame-clause)'s many other variants are useful arise when an aggregate function is invoked using the `OVER` clause. One example is given in the section [Using the aggregate function `avg()` to compute a moving average](../#using-the-aggregate-function-avg-to-compute-a-moving-average). Another example, that uses `count(*)`, is given in the code that explains the meaning of the [`percent_rank()`](../function-syntax-semantics/percent-rank-cume-dist-ntile/#percent-rank) function. Otherwise, see the main [Aggregate functions](../../aggregate_functions/) section. #### frame_clause semantics for aggregate functions diff --git a/docs/content/latest/api/ysql/the-sql-language/_index.md b/docs/content/latest/api/ysql/the-sql-language/_index.md index 1b34a07a4266..bcac3e19f653 100644 --- a/docs/content/latest/api/ysql/the-sql-language/_index.md +++ b/docs/content/latest/api/ysql/the-sql-language/_index.md @@ -51,6 +51,6 @@ Statements in this class support the preparation of SQL statements, and their su In the performance control class, the [`EXPLAIN`](./statements/perf_explain/) statement shows what access methods a DML statement will use and (for statements with joins) the join order and method. -## The WITH clause: [here](./with-clause) +## The WITH clause: [here](./with-clause/) The `WITH` clause (sometimes known as the _common table expression_) can be used as part of a `SELECT` statement, an `INSERT` statement, an `UPDATE` statement, or a `DELETE` statement. For this reason, the functionality is described in a dedicated section. \ No newline at end of file diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/_index.md b/docs/content/latest/api/ysql/the-sql-language/statements/_index.md index 628d168d3a42..68aa9450e953 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/_index.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/_index.md @@ -2,7 +2,7 @@ title: SQL statements [YSQL] headerTitle: Categorized list of SQL statements linkTitle: SQL statements -description: List of PostgreSQL-compatible SQL statements supported by Yugabyte SQL (YSQL) +description: List of PostgreSQL-compatible SQL statements supported by Yugabyte SQL (YSQL) image: /images/section_icons/api/ysql.png menu: latest: @@ -17,7 +17,7 @@ showAsideToc: true The YSQL statements are compatible with the SQL dialect that PostgreSQL supports. The sidebar lists all of the YSQL statements in alphabetical order. The following tables list them by catagory. -## Data definition language (DDL) +## Data definition language (DDL) | Statement | Description | | :-------- | :---------- | @@ -32,7 +32,7 @@ The YSQL statements are compatible with the SQL dialect that PostgreSQL supports | [`CREATE DOMAIN`](ddl_create_domain) | Create a user-defined data type with optional constraints | | [`CREATE EXTENSION`](ddl_create_extension) | Load an extension | | [`CREATE FUNCTION`](ddl_create_function) | Create a function | -| [`CREATE INDEX`](ddl_create_index) | Create an index | +| [`CREATE INDEX`](ddl_create_index/) | Create an index | | [`CREATE MATERIALIZED VIEW`](ddl_create_matview) | Create a materialized view | | [`CREATE OPERATOR`](ddl_create_operator) | Create an operator | | [`CREATE OPERATOR CLASS`](ddl_create_operator_class) | Create an operator class | @@ -63,16 +63,16 @@ The YSQL statements are compatible with the SQL dialect that PostgreSQL supports | [`REFRESH MATERIALIZED VIEW`](ddl_refresh_matview) | Refresh a materialized view | | [`TRUNCATE`](ddl_truncate) | Clear all rows from a table | -## Data manipulation language (DML) +## Data manipulation language (DML) | Statement | Description | | :-------- | :---------- | -| [`DELETE`](dml_delete) | Delete rows from a table | +| [`DELETE`](dml_delete/) | Delete rows from a table | | [`INSERT`](dml_insert) | Insert rows into a table | -| [`SELECT`](dml_select) | Select rows from a table | -| [`UPDATE`](dml_update) | Update rows in a table | +| [`SELECT`](dml_select/) | Select rows from a table | +| [`UPDATE`](dml_update/) | Update rows in a table | -## Data control language (DCL) +## Data control language (DCL) | Statement | Description | | :-------- | :---------- | @@ -96,12 +96,12 @@ The YSQL statements are compatible with the SQL dialect that PostgreSQL supports | [`SET ROLE`](dcl_set_role) | Set a role | | [`SET SESSION AUTHORIZATION`](dcl_set_session_authorization) | Set session authorization | -## Transaction control language (TCL) +## Transaction control language (TCL) | Statement | Description | | :-------- | :---------- | | [`ABORT`](txn_abort) | Roll back a transaction | -| [`BEGIN`](txn_begin) | Start a transaction | +| [`BEGIN`](txn_begin/) | Start a transaction | | [`COMMIT`](txn_commit) | Commit a transaction | | [`END`](txn_end) | Commit a transaction | | [`LOCK`](txn_lock) | Lock a table | diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_schema.md b/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_schema.md index 8c6b312f60be..cc13b1f900be 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_schema.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_schema.md @@ -52,7 +52,7 @@ Where - `role_name` is the role who will own the new schema. If omitted, it defaults to the user executing the command. To create a schema owned by another role, you must be a direct or indirect member of that role, or be a superuser. - `schema_element` is a YSQL statement defining an object to be created within the schema. -Currently, only [`CREATE TABLE`](../ddl_create_table), [`CREATE VIEW`](../ddl_create_view), [`CREATE INDEX`](../ddl_create_index), [`CREATE SEQUENCE`](../ddl_create_sequence), [`CREATE TRIGGER`](../ddl_create_trigger) and [`GRANT`](../dcl_grant) are supported as clauses within `CREATE SCHEMA`. +Currently, only [`CREATE TABLE`](../ddl_create_table), [`CREATE VIEW`](../ddl_create_view), [`CREATE INDEX`](../ddl_create_index/), [`CREATE SEQUENCE`](../ddl_create_sequence), [`CREATE TRIGGER`](../ddl_create_trigger) and [`GRANT`](../dcl_grant) are supported as clauses within `CREATE SCHEMA`. Other kinds of objects may be created in separate commands after the schema is created. ## Examples @@ -91,6 +91,6 @@ yugabyte=# CREATE SCHEMA branch - [`CREATE TABLE`](../ddl_create_table) - [`CREATE VIEW`](../ddl_create_view) -- [`CREATE INDEX`](../ddl_create_index) +- [`CREATE INDEX`](../ddl_create_index/) - [`CREATE SEQUENCE`](../ddl_create_sequence) - [`GRANT`](../dcl_grant) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_trigger.md b/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_trigger.md index f031b8aebda8..8ee395831fe4 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_trigger.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_trigger.md @@ -45,7 +45,7 @@ Use the `CREATE TRIGGER` statement to create a trigger. ## Semantics -- the `WHEN` condition can be used to specify whether the trigger should be fired. For low-level triggers it can reference the old and/or new values of the row's columns. +- the `WHEN` condition can be used to specify whether the trigger should be fired. For low-level triggers it can reference the old and/or new values of the row's columns. - multiple triggers can be defined for the same event. In that case, they will be fired in alphabetical order by name. ## Examples @@ -131,5 +131,5 @@ Use the `CREATE TRIGGER` statement to create a trigger. - [`DROP TRIGGER`](../ddl_drop_trigger) - [`INSERT`](../dml_insert) -- [`UPDATE`](../dml_update) -- [`DELETE`](../dml_delete) +- [`UPDATE`](../dml_update/) +- [`DELETE`](../dml_delete/) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_view.md b/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_view.md index 7e0cb571723b..2e5518a2b979 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_view.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/ddl_create_view.md @@ -2,7 +2,7 @@ title: CREATE VIEW statement [YSQL] headerTitle: CREATE VIEW linkTitle: CREATE VIEW -description: Use the CREATE VIEW statement to create a view in a database. +description: Use the CREATE VIEW statement to create a view in a database. menu: latest: identifier: ddl_create_view @@ -15,7 +15,7 @@ showAsideToc: true ## Synopsis -Use the `CREATE VIEW` statement to create a view in a database. It defines the view name and the (select) statement defining it. +Use the `CREATE VIEW` statement to create a view in a database. It defines the view name and the (select) statement defining it. ## Syntax @@ -99,4 +99,4 @@ yugabyte=# SELECT * FROM sample_view; ## See also -- [`SELECT`](../dml_select) +- [`SELECT`](../dml_select/) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/ddl_drop_table.md b/docs/content/latest/api/ysql/the-sql-language/statements/ddl_drop_table.md index 3eb3a219ca8f..4589edbc4561 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/ddl_drop_table.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/ddl_drop_table.md @@ -115,7 +115,7 @@ The 'DROP' now succeeds and the `\d` metacommand shows that the table _"children - [`CREATE TABLE`](../ddl_create_table) - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) +- [`SELECT`](../dml_select/) ``` diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/ddl_drop_trigger.md b/docs/content/latest/api/ysql/the-sql-language/statements/ddl_drop_trigger.md index f8fb71b79d6c..5747680e1d12 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/ddl_drop_trigger.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/ddl_drop_trigger.md @@ -59,5 +59,5 @@ DROP TRIGGER update_moddatetime ON posts; - [`CREATE TRIGGER`](../ddl_create_trigger) - [`INSERT`](../dml_insert) -- [`UPDATE`](../dml_update) -- [`DELETE`](../dml_delete) +- [`UPDATE`](../dml_update/) +- [`DELETE`](../dml_delete/) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/dml_delete.md b/docs/content/latest/api/ysql/the-sql-language/statements/dml_delete.md index 2b645fdf9b4d..1a71e896d637 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/dml_delete.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/dml_delete.md @@ -55,7 +55,7 @@ See the section [The WITH clause and common table expressions](../../with-clause - While the `WHERE` clause allows a wide range of operators, the exact conditions used in the `WHERE` clause have significant performance considerations (especially for large datasets). For the best performance, use a `WHERE` clause that provides values for all columns in `PRIMARY KEY` or `INDEX KEY`. -### *delete* +### *delete* #### WITH [ RECURSIVE ] *with_query* [ , ... ] DELETE FROM [ ONLY ] *table_name* [ * ] [ [ AS ] *alias* ] [ WHERE *condition* | WHERE CURRENT OF *cursor_name* ] [ [*returning_clause*] (#returning-clause) ] @@ -127,5 +127,5 @@ DELETE 1 ## See also - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) -- [`UPDATE`](../dml_update) +- [`SELECT`](../dml_select/) +- [`UPDATE`](../dml_update/) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/dml_insert.md b/docs/content/latest/api/ysql/the-sql-language/statements/dml_insert.md index bbea70d0fcac..27304a3701ee 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/dml_insert.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/dml_insert.md @@ -47,7 +47,7 @@ See the section [The WITH clause and common table expressions](../../with-clause ## Semantics -Constraints must be satisfied. +Constraints must be satisfied. ### *insert* @@ -238,7 +238,7 @@ yugabyte=# SELECT id, c1, c2 FROM sample ORDER BY id; ``` ``` - id | c1 | c2 + id | c1 | c2 ----+--------+----------- 1 | cat | sparrow 2 | dog | blackbird @@ -334,4 +334,4 @@ yugabyte=# SELECT id, c1, c2 FROM sample ORDER BY c1; - [`COPY`](../cmd_copy) - [`CREATE TABLE`](../ddl_create_table) -- [`SELECT`](../dml_select) +- [`SELECT`](../dml_select/) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/dml_update.md b/docs/content/latest/api/ysql/the-sql-language/statements/dml_update.md index f9efd9dd4397..3649e7b5babd 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/dml_update.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/dml_update.md @@ -131,6 +131,6 @@ yugabyte=# SELECT * FROM sample ORDER BY k1; ## See also -- [`DELETE`](../dml_delete) +- [`DELETE`](../dml_delete/) - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) +- [`SELECT`](../dml_select/) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/perf_explain.md b/docs/content/latest/api/ysql/the-sql-language/statements/perf_explain.md index 8ba622e87333..d923d6732350 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/perf_explain.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/perf_explain.md @@ -45,7 +45,7 @@ Use the `EXPLAIN` statement to show the execution plan for an statement. If the ## Semantics -Where statement is the target statement (see more [here](../dml_select)). +Where statement is the target statement (see more [here](../dml_select/)). ### ANALYZE @@ -110,4 +110,4 @@ yugabyte=# EXPLAIN ANALYZE SELECT * FROM sample WHERE k1 = 2 and floor(k2 + 1.5) ## See also - [`INSERT`](../dml_insert) -- [`SELECT`](../dml_select) +- [`SELECT`](../dml_select/) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/txn_abort.md b/docs/content/latest/api/ysql/the-sql-language/statements/txn_abort.md index b232114ad030..87bf104b3db7 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/txn_abort.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/txn_abort.md @@ -68,7 +68,7 @@ yugabyte=# CREATE TABLE sample(k1 int, k2 int, v1 int, v2 text, PRIMARY KEY (k1, Begin a transaction and insert some rows. ```plpgsql -yugabyte=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ; +yugabyte=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ; ``` ```plpgsql @@ -155,6 +155,6 @@ yugabyte=# SELECT * FROM sample; -- run in second shell. ## See also -- [`BEGIN`](../txn_begin) +- [`BEGIN`](../txn_begin/) - [`COMMIT`](../txn_commit) - [`ROLLBACK`](../txn_rollback) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/txn_commit.md b/docs/content/latest/api/ysql/the-sql-language/statements/txn_commit.md index c15f1974095a..c8aa35870760 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/txn_commit.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/txn_commit.md @@ -70,7 +70,7 @@ CREATE TABLE sample(k1 int, k2 int, v1 int, v2 text, PRIMARY KEY (k1, k2)); Begin a transaction and insert some rows. ```plpgsql -BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ; +BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ; ``` ```plpgsql @@ -80,7 +80,7 @@ INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b'); Start a new shell with `ysqlsh` and begin another transaction to insert some more rows. ```plpgsql -yugabyte=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ; +yugabyte=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ; ``` ```plpgsql @@ -156,5 +156,5 @@ yugabyte=# SELECT * FROM sample; -- run in second shell. ## See also -- [`BEGIN`](../txn_begin) +- [`BEGIN`](../txn_begin/) - [`ROLLBACK`](../txn_rollback) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/txn_end.md b/docs/content/latest/api/ysql/the-sql-language/statements/txn_end.md index e9ad1d29eb1b..5df60a0fe176 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/txn_end.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/txn_end.md @@ -61,6 +61,6 @@ Add optional keyword — has no effect. ## See also - [`ABORT`](../txn_abort) -- [`BEGIN`](../txn_begin) +- [`BEGIN`](../txn_begin/) - [`COMMIT`](../txn_commit) - [`ROLLBACK`](../txn_rollback) diff --git a/docs/content/latest/api/ysql/the-sql-language/statements/txn_rollback.md b/docs/content/latest/api/ysql/the-sql-language/statements/txn_rollback.md index a81dd8727988..6c47d6cfd608 100644 --- a/docs/content/latest/api/ysql/the-sql-language/statements/txn_rollback.md +++ b/docs/content/latest/api/ysql/the-sql-language/statements/txn_rollback.md @@ -61,5 +61,5 @@ Add optional keyword — has no effect. ## See also -- [`BEGIN`](../txn_begin) +- [`BEGIN`](../txn_begin/) - [`COMMIT`](../txn_commit) diff --git a/docs/content/latest/architecture/concepts/universe.md b/docs/content/latest/architecture/concepts/universe.md index 7cb9e3834150..6973f594dd8c 100644 --- a/docs/content/latest/architecture/concepts/universe.md +++ b/docs/content/latest/architecture/concepts/universe.md @@ -1,5 +1,5 @@ --- -title: Universe +title: Universe headerTitle: Universe linkTitle: Universe description: Learn about the YugabyteDB universe (or cluster). @@ -59,13 +59,13 @@ These serve different purposes as described below. The **YB-TServer** (aka the *YugabyteDB Tablet Server*) service is responsible for hosting/serving user data (for example, tables). They deal with all the user queries. -For details, see [YB-TServer](../yb-tserver). +For details, see [YB-TServer](../yb-tserver/). ### YB-Master The **YB-Master** (aka the *YugabyteDB Master Server*) service is responsible for keeping system metadata, coordinating system-wide operations, such as create/alter/drop tables, and initiating maintenance operations such as load balancing. -For details, see [YB-Master](../yb-master). +For details, see [YB-Master](../yb-master/). Below is an illustration of a simple 4-node YugabyteDB universe: @@ -73,7 +73,7 @@ Below is an illustration of a simple 4-node YugabyteDB universe: ## Universe vs cluster -A YugabyteDB universe comprises of exactly one primary cluster and zero or more read replica clusters. +A YugabyteDB universe comprises of exactly one primary cluster and zero or more read replica clusters. - A primary cluster can perform both writes and reads. Replication between nodes in a primary cluster is performed synchronously. diff --git a/docs/content/latest/architecture/concepts/yb-tserver.md b/docs/content/latest/architecture/concepts/yb-tserver.md index 45cde0b8c2cc..2fca4074a52a 100644 --- a/docs/content/latest/architecture/concepts/yb-tserver.md +++ b/docs/content/latest/architecture/concepts/yb-tserver.md @@ -48,7 +48,7 @@ In addition to throttling controls for compactions, YugabyteDB does a variety of ### Manual compactions -YugabyteDB allows compactions to be externally triggered on a table using the [`compact_table`](../../../admin/yb-admin/#compact-table) command in the [`yb-admin` utility](../../../admin/yb-admin). This can be useful for cases when new data is not coming into the system for a table anymore, users want to reclaim disk space due to overwrites/deletes that have already happened or due to TTL expiry. +YugabyteDB allows compactions to be externally triggered on a table using the [`compact_table`](../../../admin/yb-admin/#compact-table) command in the [`yb-admin` utility](../../../admin/yb-admin/). This can be useful for cases when new data is not coming into the system for a table anymore, users want to reclaim disk space due to overwrites/deletes that have already happened or due to TTL expiry. ### Server-global memstore limit diff --git a/docs/content/latest/architecture/query-layer/overview.md b/docs/content/latest/architecture/query-layer/overview.md index 0fe7f66b69fb..ed4ebd21a59e 100644 --- a/docs/content/latest/architecture/query-layer/overview.md +++ b/docs/content/latest/architecture/query-layer/overview.md @@ -12,7 +12,7 @@ menu: weight: 1172 --- -The Yugabyte Query Layer (YQL) is the upper layer of YugabyteDB. Applications interact directly with YQL using client drivers. This layer deals with the API specific aspects such as query/command compilation and the run-time (data type representations, built-in operations and more). YQL is built with extensibility in mind, and allows for new APIs to be added. Currently, YQL supports two flavors of distributed SQL APIs, namely [YSQL](../../../api/ysql) and [YCQL](../../../api/ycql). +The Yugabyte Query Layer (YQL) is the upper layer of YugabyteDB. Applications interact directly with YQL using client drivers. This layer deals with the API specific aspects such as query/command compilation and the run-time (data type representations, built-in operations and more). YQL is built with extensibility in mind, and allows for new APIs to be added. Currently, YQL supports two flavors of distributed SQL APIs, namely [YSQL](../../../api/ysql/) and [YCQL](../../../api/ycql/). ![cluster_overview](/images/architecture/cluster_overview.png) diff --git a/docs/content/latest/benchmark/resilience/jepsen-testing-ycql.md b/docs/content/latest/benchmark/resilience/jepsen-testing-ycql.md index fd309becbb7b..700e1c033770 100644 --- a/docs/content/latest/benchmark/resilience/jepsen-testing-ycql.md +++ b/docs/content/latest/benchmark/resilience/jepsen-testing-ycql.md @@ -16,14 +16,14 @@ isTocNested: true
    • - + YSQL
    • - + YCQL diff --git a/docs/content/latest/benchmark/resilience/jepsen-testing-ysql.md b/docs/content/latest/benchmark/resilience/jepsen-testing-ysql.md index 9532a3252efb..bead4c902645 100644 --- a/docs/content/latest/benchmark/resilience/jepsen-testing-ysql.md +++ b/docs/content/latest/benchmark/resilience/jepsen-testing-ysql.md @@ -16,14 +16,14 @@ isTocNested: true
      • - + YSQL
      • - + YCQL diff --git a/docs/content/latest/benchmark/scalability/scaling-queries-ycql.md b/docs/content/latest/benchmark/scalability/scaling-queries-ycql.md index 3eae49a77280..161f4e8994e9 100644 --- a/docs/content/latest/benchmark/scalability/scaling-queries-ycql.md +++ b/docs/content/latest/benchmark/scalability/scaling-queries-ycql.md @@ -16,14 +16,14 @@ isTocNested: true
        • - + YSQL
        • - + YCQL @@ -59,17 +59,17 @@ The workload was generated using a multi-threaded Cassandra key-value sample app YugabyteDB performs strongly consistent reads by default. For details, see [Read IO path (single shard)](../../../architecture/core-functions/read-path/). Below is the summary of the performance metrics observed during a 100% read workload: -- **2.6& million read operations per second**, sum across the YugaByte nodes. +- **2.6& million read operations per second**, sum across the YugabyteDB nodes. - **0.2 millisecond average latency** per read on the server side. -- **65% CPU usage**, averaged across the YugaByte nodes. +- **65% CPU usage**, averaged across the YugabyteDB nodes. -#### 50-node cluster  read IOPS and latency across the nodes. +#### 50-node cluster - read IOPS and latency across the nodes The graphs below were captured for one hour of the run. The operations per second is the sum across all the nodes while the latency is the average. Note that the throughput and latency metrics are very steady over the entire time window. ![Total YCQL operations per second and YCQL operations latency](/images/benchmark/scalability/total-cql-ops-per-sec-reads.png) -#### 50-node cluster   CPU and memory during the read benchmark +#### 50-node cluster - CPU and memory during the read benchmark The two graphs below show the corresponding CPU and memory (RAM) usage during that time interval. @@ -87,7 +87,7 @@ The graphs below are for twelve hours of the run. Note that this is a much longe #### 50-node cluster — write IOPS and latency across the nodes -The two graphs below are the corresponding CPU and RAM usage for those twelve hours, and are the average across all the YugaByte nodes. +The two graphs below are the corresponding CPU and RAM usage for those twelve hours, and are the average across all the YugabyteDB nodes. ![Total YCQL operations per second and YCQL operation latency](/images/benchmark/scalability/total-cql-ops-per-sec-writes-ycql.png) diff --git a/docs/content/latest/benchmark/scalability/scaling-queries-ysql.md b/docs/content/latest/benchmark/scalability/scaling-queries-ysql.md index 5ee732ee48c0..a9cad5f8e9f7 100644 --- a/docs/content/latest/benchmark/scalability/scaling-queries-ysql.md +++ b/docs/content/latest/benchmark/scalability/scaling-queries-ysql.md @@ -3,8 +3,6 @@ title: Benchmark scaling YSQL queries headerTitle: Scaling YSQL queries linkTitle: Scaling queries description: Benchmark scaling YSQL queries in YugabyteDB -aliases: - - /latest/benchmark/scalability/scaling-queries/ menu: latest: identifier: scaling-queries-1-ysql @@ -18,14 +16,14 @@ isTocNested: true
          • - + YSQL
          • - + YCQL diff --git a/docs/content/latest/contribute/_index.md b/docs/content/latest/contribute/_index.md index 2b824751f62c..a5cd21bf714f 100644 --- a/docs/content/latest/contribute/_index.md +++ b/docs/content/latest/contribute/_index.md @@ -31,7 +31,7 @@ There are a few areas you can get involved in depending on your interests. ### Core database -This is the C++ code and the unit tests that comprise the core of YugabyteDB. You can [follow the steps outlined here](core-database/checklist) to get going with steps such as building the codebase and running the unit tests. +This is the C++ code and the unit tests that comprise the core of YugabyteDB. You can [follow the steps outlined here](core-database/checklist/) to get going with steps such as building the codebase and running the unit tests. ### Docs diff --git a/docs/content/latest/deploy/checklist.md b/docs/content/latest/deploy/checklist.md index 15a8451e2dd6..528387a2093d 100644 --- a/docs/content/latest/deploy/checklist.md +++ b/docs/content/latest/deploy/checklist.md @@ -40,7 +40,7 @@ You would first need to choose a Replication Factor (RF). You would need at leas Note that YugabyteDB works with both hostnames or IP addresses. IP addresses are preferred at this point as they are more extensively tested. -See the [yb-master command reference](../manual-deployment/start-masters) for more information. +See the [yb-master command reference](../manual-deployment/start-masters/) for more information. ## Hardware requirements @@ -52,12 +52,12 @@ You should allocate adequate CPU and RAM. YugabyteDB has good defaults for runni **Minimum requirement** -- 2 cores +- 2 cores - 2GB RAM **Production requirement** -- 16+ cores +- 16+ cores - 32GB+ RAM - Add more CPU (compared to adding more RAM) to improve performance. @@ -81,18 +81,18 @@ $ cat /proc/cpuinfo | grep sse2 ### Disks -- SSDs (solid state disks) are required. +- SSDs (solid state disks) are required. - Both local or remote attached storage work with YugabyteDB. Since YugabyteDB internally replicates data for fault tolerance, remote attached storage which does its own additional replication is not a requirement. Local disks often offer better performance at a lower cost. -- Multi-disk nodes - - Do not use RAID across multiple disks. YugabyteDB can natively handle multi-disk nodes (JBOD). +- Multi-disk nodes + - Do not use RAID across multiple disks. YugabyteDB can natively handle multi-disk nodes (JBOD). - Create a data directory on each of the data disks and specify a comma separated list of those directories to the yb-master and yb-tserver servers via the `--fs_data_dirs` flag. -- Mount settings - - XFS is the recommended filesystem. - - Use the `noatime` setting when mounting the data drives. - - ZFS isn't currently supported and [is in the roadmap](https://github.com/yugabyte/yugabyte-db/issues/4157). - - NFS isn't currently supported and [is in the roadmap](https://github.com/yugabyte/yugabyte-db/issues/4388). +- Mount settings + - XFS is the recommended filesystem. + - Use the `noatime` setting when mounting the data drives. + - ZFS isn't currently supported and [is in the roadmap](https://github.com/yugabyte/yugabyte-db/issues/4157). + - NFS isn't currently supported and [is in the roadmap](https://github.com/yugabyte/yugabyte-db/issues/4388). -YugabyteDB does not require any form of RAID, but runs optimally on a JBOD (just a bunch of disks) setup. +YugabyteDB does not require any form of RAID, but runs optimally on a JBOD (just a bunch of disks) setup. It can also leverage multiple disks per node and has been tested beyond 10 TB of storage per node. Write-heavy applications usually require more disk IOPS (especially if the size of each record is larger), therefore in this case the total IOPS that a disk can support matters. On the read side, if the data does not fit into the cache and data needs to be read from the disk in order to satisfy queries, the disk performance (latency and IOPS) will start to matter. @@ -105,9 +105,9 @@ Below is a minimal list of default ports (along with the network access required - Each of the nodes in the YugabyteDB cluster must be able to communicate with each other using TCP/IP on the following ports. - 7100 for YB-Master RPC communication + 7100 for YB-Master RPC communication - 9100 for YB-TServer RPC communication + 9100 for YB-TServer RPC communication - In order to view the cluster dashboard, you need to be able to navigate to the following ports on the nodes. @@ -151,7 +151,7 @@ In practice, the clock drift would have to be orders of magnitude higher in orde ## Security checklist -For a list of best practices, see [security checklist](../../secure/security-checklist). +For a list of best practices, see [security checklist](../../secure/security-checklist/). ## Running on public clouds diff --git a/docs/content/latest/deploy/kubernetes/best-practices.md b/docs/content/latest/deploy/kubernetes/best-practices.md index 42d11904da60..39848278d61c 100644 --- a/docs/content/latest/deploy/kubernetes/best-practices.md +++ b/docs/content/latest/deploy/kubernetes/best-practices.md @@ -2,8 +2,6 @@ title: Best practices linkTitle: Best practices description: Best practices -aliases: - - /latest/deploy/kubernetes/local-ssd/ menu: latest: identifier: best-practices @@ -14,7 +12,7 @@ isTocNested: true showAsideToc: true --- -## Local vs remote SSDs +## Local vs remote SSDs Kubernetes gives users the option of using remote disks using dynamic provisioning or local storage which has to be pre-provisioned. @@ -27,12 +25,12 @@ Below is a table that summarizes the features and when to use local or remote st - + - + @@ -42,30 +40,29 @@ Below is a table that summarizes the features and when to use local or remote st - + - + - + - + - +
            Local SSD storageLocal SSD storage Remote SSD storage
            Provision large disk capacity per nodeDepends on cloud-providerDepends on cloud-provider Yes
            Disk storage resilient to failuresNoNo Yes
            Performance - latencyLowerLower Higher
            Performance - throughputHigherHigher Lower
            Typical cost characteristicsLowerLower Higher
            Kubernetes provisioning schemePre-provisionedPre-provisioned Dynamic provisioning
            Thus, it is generally preferable to use local storage where possible for higher performance and lower costs. The [GKE section](../gke/statefulset-yaml/) shows how to deploy YugabyteDB on Kubernetes using local SSDs. - diff --git a/docs/content/latest/deploy/kubernetes/clients.md b/docs/content/latest/deploy/kubernetes/clients.md index 94a315b8ff92..143bfad10056 100644 --- a/docs/content/latest/deploy/kubernetes/clients.md +++ b/docs/content/latest/deploy/kubernetes/clients.md @@ -19,7 +19,7 @@ This document describes options available for connecting to a Yugabyte cluster d ## Prerequisites -You must have a Yugabyte cluster set up according to the [Kubernetes deployment instructions.](../../kubernetes) +You must have a Yugabyte cluster set up according to the [Kubernetes deployment instructions.](../../kubernetes/) ## Connecting from Within the Kubernetes Cluster @@ -31,7 +31,7 @@ NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) yb-tservers ClusterIP None 7100/TCP,9000/TCP,6379/TCP,9042/TCP,5433/TCP 56m ``` -The following example shows a client that uses the YSQL shell ([`ysqlsh`](../../../admin/ysqlsh)) to connect: +The following example shows a client that uses the YSQL shell ([`ysqlsh`](../../../admin/ysqlsh/)) to connect: ```sh $ kubectl run ysqlsh-client -it --rm --image yugabytedb/yugabyte-client --command -- ysqlsh -h yb-tservers.yb-demo.svc.cluster.local @@ -63,7 +63,7 @@ yb-tserver-service LoadBalancer 10.99.76.181 98.138.219.232 6379:3014 yb-tservers ClusterIP None 7100/TCP,9000/TCP,6379/TCP,9042/TCP,5433/TCP 43h ``` -The following example shows a client that uses the YSQL shell ([`ysqlsh`](../../../admin/ysqlsh)) to connect: +The following example shows a client that uses the YSQL shell ([`ysqlsh`](../../../admin/ysqlsh/)) to connect: ```sh $ docker run yugabytedb/yugabyte-client ysqlsh -h 98.138.219.232 @@ -145,7 +145,7 @@ spec: defaultMode: 256 ``` -When a client uses the `YSQL shell` ([`ysqlsh`](../../../admin/ysqlsh)) to connect, you can execute the following command to verify the connection: +When a client uses the `YSQL shell` ([`ysqlsh`](../../../admin/ysqlsh/)) to connect, you can execute the following command to verify the connection: ```sh $ kubectl exec -n yb-demo -it yb-client -- ysqlsh -h yb-tservers.yb-demo.svc.cluster.local "sslmode=require" @@ -185,7 +185,7 @@ $ mkdir $(pwd)/certs $ kubectl get secret yugabyte-tls-client-cert -n yb-demo -o jsonpath='{.data.root\.crt}' | base64 --decode > $(pwd)/certs/root.crt ``` -When a client that uses the `YSQL shell` ([`ysqlsh`](../../../admin/ysqlsh)) to connect, the command to execute specifies the external LoadBalancer IP of the `yb-tserver-service`, as described in [Connect using external clients](../single-zone/oss/helm-chart/#connect-using-external-clients). You can verify the connection via the following command: +When a client that uses the `YSQL shell` ([`ysqlsh`](../../../admin/ysqlsh/)) to connect, the command to execute specifies the external LoadBalancer IP of the `yb-tserver-service`, as described in [Connect using external clients](../single-zone/oss/helm-chart/#connect-using-external-clients). You can verify the connection via the following command: ```sh $ docker run -it --rm -v $(pwd)/certs/:/root/.yugabytedb/:ro yugabytedb/yugabyte-client:latest ysqlsh -h "sslmode=require" @@ -210,4 +210,3 @@ Use HELP for help. cqlsh> SHOW HOST Connected to local cluster at 35.200.205.208:9042. ``` - diff --git a/docs/content/latest/deploy/kubernetes/multi-cluster/gke/helm-chart.md b/docs/content/latest/deploy/kubernetes/multi-cluster/gke/helm-chart.md index 31a576f40f70..2f6eb4487e22 100644 --- a/docs/content/latest/deploy/kubernetes/multi-cluster/gke/helm-chart.md +++ b/docs/content/latest/deploy/kubernetes/multi-cluster/gke/helm-chart.md @@ -11,7 +11,6 @@ menu: weight: 628 aliases: - /latest/deploy/kubernetes/multi-cluster/gke - - /latest/deploy/kubernetes/multi-cluster/gke/helm-chart type: page isTocNested: true showAsideToc: true @@ -19,7 +18,7 @@ showAsideToc: true
            • - + Helm chart @@ -498,7 +497,7 @@ $ kubectl exec -n yb-demo-us-west1-b --context gke_yugabyte_us-west1-b_yugabyted -it yb-tserver-0 -- ycqlsh yb-tserver-0.yb-tservers.yb-demo-us-west1-b ``` -You can follow the [Explore YSQL](../../../../../quick-start/explore/ysql) tutorial and then go to the `http://:7000/tablet-servers` page of the yb-master Admin UI to confirm that tablet peers and their leaders are placed evenly across all three zones for both user data and system data. +You can follow the [Explore YSQL](../../../../../quick-start/explore/ysql/) tutorial and then go to the `http://:7000/tablet-servers` page of the yb-master Admin UI to confirm that tablet peers and their leaders are placed evenly across all three zones for both user data and system data. ![mz-ybtserver](/images/deploy/kubernetes/gke-multicluster-ybtserver.png) diff --git a/docs/content/latest/deploy/kubernetes/multi-zone/_index.md b/docs/content/latest/deploy/kubernetes/multi-zone/_index.md index 0ee2010df659..860ecdf26df9 100644 --- a/docs/content/latest/deploy/kubernetes/multi-zone/_index.md +++ b/docs/content/latest/deploy/kubernetes/multi-zone/_index.md @@ -16,12 +16,8 @@ menu: As highlighted in Kubernetes multi-zone documentation, Kubernetes is by default a single-zone technology. This means workloads will be distributed across multiple nodes of a single Kubernetes cluster running in a single zone. Running a single Kubernetes cluster with nodes present in multiple zones of a single region is possible with additional configuration. Multi-zone Kubernetes clusters have a list of known limitations that users should be aware of. -

              - Amazon Elastic Kubernetes Service and Google Kubernetes Engine supports multi-zone Kubernetes clusters automatically. The following instructions highlight how to deploy a 3-zone YugabyteDB cluster on a 3-zone Kubernetes cluster. Both these deployments use the standard single-zone YugabyteDB Helm Chart to deploy one third of the nodes in the database cluster in each of the 3 zones. -

              -

              diff --git a/docs/content/latest/deploy/kubernetes/multi-zone/eks/helm-chart.md b/docs/content/latest/deploy/kubernetes/multi-zone/eks/helm-chart.md index 91f1c4c293fe..0599b3c83e05 100644 --- a/docs/content/latest/deploy/kubernetes/multi-zone/eks/helm-chart.md +++ b/docs/content/latest/deploy/kubernetes/multi-zone/eks/helm-chart.md @@ -18,7 +18,7 @@ showAsideToc: true
              • - + Helm chart @@ -363,7 +363,7 @@ $ kubectl exec -n yb-demo-us-east-1a -it yb-tserver-0 -- ycqlsh \ yb-tserver-0.yb-tservers.yb-demo-us-east-1a ``` -You can follow the [Explore YSQL](../../../../../quick-start/explore/ysql) tutorial and then go to the `http://:7000/tablet-servers` page of the yb-master Admin UI to confirm that tablet peers and their leaders are placed evenly across all three zones for both user data and system data. +You can follow the [Explore YSQL](../../../../../quick-start/explore/ysql/) tutorial and then go to the `http://:7000/tablet-servers` page of the yb-master Admin UI to confirm that tablet peers and their leaders are placed evenly across all three zones for both user data and system data. ![mz-ybtserver](/images/deploy/kubernetes/aws-multizone-ybtserver.png) diff --git a/docs/content/latest/deploy/kubernetes/multi-zone/gke/helm-chart.md b/docs/content/latest/deploy/kubernetes/multi-zone/gke/helm-chart.md index cd9aad319675..41a6ea19caaa 100644 --- a/docs/content/latest/deploy/kubernetes/multi-zone/gke/helm-chart.md +++ b/docs/content/latest/deploy/kubernetes/multi-zone/gke/helm-chart.md @@ -18,7 +18,7 @@ showAsideToc: true
                • - + Helm chart @@ -374,7 +374,7 @@ $ kubectl exec -n yb-demo-us-central1-a -it yb-tserver-0 -- ycqlsh \ yb-tserver-0.yb-tservers.yb-demo-us-central1-a ``` -You can follow the [Explore YSQL](../../../../../quick-start/explore/ysql) tutorial and then go to the `http://:7000/tablet-servers` page of the yb-master Admin UI to confirm that tablet peers and their leaders are placed evenly across all three zones for both user data and system data. +You can follow the [Explore YSQL](../../../../../quick-start/explore/ysql/) tutorial and then go to the `http://:7000/tablet-servers` page of the yb-master Admin UI to confirm that tablet peers and their leaders are placed evenly across all three zones for both user data and system data. ![mz-ybtserver](/images/deploy/kubernetes/gke-multizone-ybtserver.png) diff --git a/docs/content/latest/deploy/kubernetes/single-zone/aks/helm-chart.md b/docs/content/latest/deploy/kubernetes/single-zone/aks/helm-chart.md index 2470994caaf0..797f6c2b479d 100644 --- a/docs/content/latest/deploy/kubernetes/single-zone/aks/helm-chart.md +++ b/docs/content/latest/deploy/kubernetes/single-zone/aks/helm-chart.md @@ -21,13 +21,13 @@ showAsideToc: true
                  • - + Helm chart
                  • - + StatefulSet YAML @@ -44,7 +44,7 @@ Before you can deploy YugabyteDB on AKS, you need to verify that the following a - `kubectl` - For more information, see [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/). - - [Kubernetes API v1.18.0](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/) + - [Kubernetes API](https://kubernetes.io/docs/reference/kubernetes-api/) - Helm 3.4 or later - For more information, see [Installing Helm](https://helm.sh/docs/intro/install/). diff --git a/docs/content/latest/deploy/kubernetes/single-zone/aks/statefulset-yaml.md b/docs/content/latest/deploy/kubernetes/single-zone/aks/statefulset-yaml.md index e476bfe60f7c..377e5bbee443 100644 --- a/docs/content/latest/deploy/kubernetes/single-zone/aks/statefulset-yaml.md +++ b/docs/content/latest/deploy/kubernetes/single-zone/aks/statefulset-yaml.md @@ -10,7 +10,7 @@ menu: identifier: k8s-aks-2 weight: 624 aliases: - - /latest/deploy/kubernetes/aks/statefulset-yaml + - /latest/deploy/kubernetes/aks/statefulset-yaml/ type: page isTocNested: true showAsideToc: true @@ -19,13 +19,13 @@ showAsideToc: true
                    • - + Helm chart
                    • - + StatefulSet YAML diff --git a/docs/content/latest/deploy/kubernetes/single-zone/eks/helm-chart.md b/docs/content/latest/deploy/kubernetes/single-zone/eks/helm-chart.md index de1a57458e37..a73bff588e31 100644 --- a/docs/content/latest/deploy/kubernetes/single-zone/eks/helm-chart.md +++ b/docs/content/latest/deploy/kubernetes/single-zone/eks/helm-chart.md @@ -20,7 +20,7 @@ showAsideToc: true
                      • - + Helm chart diff --git a/docs/content/latest/deploy/kubernetes/single-zone/gke/helm-chart.md b/docs/content/latest/deploy/kubernetes/single-zone/gke/helm-chart.md index 2c1f5b05562b..03f414c491a2 100644 --- a/docs/content/latest/deploy/kubernetes/single-zone/gke/helm-chart.md +++ b/docs/content/latest/deploy/kubernetes/single-zone/gke/helm-chart.md @@ -20,19 +20,19 @@ showAsideToc: true
                        • - + Helm chart
                        • - + YAML (remote disk)
                        • - + YAML (local disk) diff --git a/docs/content/latest/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md b/docs/content/latest/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md index 674e01430028..09cf82f5fdaa 100644 --- a/docs/content/latest/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md +++ b/docs/content/latest/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md @@ -18,19 +18,19 @@ showAsideToc: true
                          • - + Helm Chart
                          • - + YAML (remote disk)
                          • - + YAML (local disk) @@ -185,14 +185,14 @@ You can see the [YAML file to launch a YugabyteDB kubernetes universe on nodes w Note the following `nodeSelector` snippet in the YAML file which instructs the Kubernetes scheduler to place the YugabyteDB pods on nodes that have local disks: -``` +```yaml nodeSelector: cloud.google.com/gke-local-ssd: "true" ``` Also, note that you instruct the scheduler to place the various pods in the `yb-master` or `yb-tserver` services on different physical nodes with the `antiAffinity` hint: -``` +```yaml spec: affinity: # Set the anti-affinity selector scope to YB masters. @@ -270,7 +270,7 @@ You can connect to the `ycqlsh` shell on this universe by running the following $ kubectl exec -it yb-tserver-0 -- ycqlsh yb-tserver-0 ``` -```sh +```output.cql Connected to local cluster at 127.0.0.1:9042. [ycqlsh 5.0.1 | Cassandra 3.9-SNAPSHOT | CQL spec 3.4.2 | Native protocol v4] Use HELP for help. diff --git a/docs/content/latest/deploy/kubernetes/single-zone/gke/statefulset-yaml.md b/docs/content/latest/deploy/kubernetes/single-zone/gke/statefulset-yaml.md index 880dc2288872..d95d2182b6f9 100644 --- a/docs/content/latest/deploy/kubernetes/single-zone/gke/statefulset-yaml.md +++ b/docs/content/latest/deploy/kubernetes/single-zone/gke/statefulset-yaml.md @@ -18,19 +18,19 @@ showAsideToc: true - - [Rook](https://rook.io) is an open source, cloud-native storage orchestrator for Kubernetes, providing the platform, framework, and support that can turn YugabyteDB clusters into self-managing, self-scaling, and self-healing storage services. Rook automates storage-layer tasks, including deployment, bootstrapping, configuration, provisioning, scaling, upgrading, migration, disaster recovery, monitoring, and resource management. The [Rook YugabyteDB operator](https://rook.io/docs/rook/v1.1/yugabytedb.html) is a custom controller that uses Custom Resource Definition (CRD) to extend the Kubernetes API and automate deploying, scaling, and managing YugabyteDB clusters. Based on the _desired state_ that you specified in the CRD, the Rook operator observes (watching for changes in state and health), analyzes (comparing current to desired state), and acts (applying changes to the cluster) to maintain the desired state. For details, see [YugabyteDB Cluster CRD](https://rook.io/docs/rook/v1.1/yugabytedb-cluster-crd.html). @@ -85,7 +83,7 @@ To deploy the YugabyteDB operator: ## Create the YugabyteDB Cluster CRD -When using the Rook YugabyteDB operator, your YugabyteDB clusters are controlled using the custom resource object (`ybclusters.yugabytedb.rook.io`). The Custom Resource Definition (CRD), used to create this object, is specified in the `cluster.yaml` file. +When using the Rook YugabyteDB operator, your YugabyteDB clusters are controlled using the custom resource object (`ybclusters.yugabytedb.rook.io`). The Custom Resource Definition (CRD), used to create this object, is specified in the `cluster.yaml` file. A sample Custom Resource Definition (CRD) file, called `cluster.yaml`, is located in the following Rook directory: @@ -126,7 +124,7 @@ kubectl exec -it yb-tserver-rook-yugabytedb-0 -- ysqlsh -h yb-tserver-rook-yuga For details on the YSQL API, see: - [Explore YSQL](../../../../../quick-start/explore/ysql/) -- [YSQL Reference](../../../../../api/ysql/) +- [YSQL Reference](../../../../../api/ysql/) ## Cleanup diff --git a/docs/content/latest/deploy/manual-deployment/_index.md b/docs/content/latest/deploy/manual-deployment/_index.md index a5b6520697d5..f35ced5bf4bc 100644 --- a/docs/content/latest/deploy/manual-deployment/_index.md +++ b/docs/content/latest/deploy/manual-deployment/_index.md @@ -5,10 +5,6 @@ linkTitle: Manual deployment description: Deploy a YugabyteDB cluster in a single region or data center with a multi-zone/multi-rack configuration. headcontent: Instructions for manually deploying YugabyteDB. image: /images/section_icons/deploy/manual-deployment.png -aliases: - - /deploy/multi-node-cluster/ - - /latest/deploy/multi-node-cluster/ - - /deploy/manual-deployment/ menu: latest: identifier: deploy-manual-deployment @@ -16,11 +12,11 @@ menu: weight: 610 --- -This section covers the generic manual deployment of a YugabyteDB cluster in a single region or data center with a multi-zone/multi-rack configuration. Note that single zone configuration is a special case of multi-zone where all placement related flags are set to the same value across every node. +This section covers the generic manual deployment of a YugabyteDB cluster in a single region or data center with a multi-zone/multi-rack configuration. Note that single zone configuration is a special case of multi-zone where all placement related flags are set to the same value across every node.

                            -For AWS deployments specifically, a step-by-step guide to deploying a YugabyteDB cluster is also available. These steps can be easily adopted for on-premises deployments or deployments in other clouds. +For AWS deployments specifically, a step-by-step guide to deploying a YugabyteDB cluster is also available. These steps can be easily adopted for on-premises deployments or deployments in other clouds.

                            diff --git a/docs/content/latest/deploy/manual-deployment/install-software.md b/docs/content/latest/deploy/manual-deployment/install-software.md index 18cb6e54f33c..b3c259c48d22 100644 --- a/docs/content/latest/deploy/manual-deployment/install-software.md +++ b/docs/content/latest/deploy/manual-deployment/install-software.md @@ -3,8 +3,6 @@ title: Install YugabyteDB software headerTitle: Install software linkTitle: 2. Install software description: Download and install YugabyteDB software to each node -aliases: - - /deploy/manual-deployment/install-software menu: latest: identifier: deploy-manual-deployment-install-software diff --git a/docs/content/latest/deploy/manual-deployment/start-masters.md b/docs/content/latest/deploy/manual-deployment/start-masters.md index 1a15178a80ab..784f9e8ce231 100644 --- a/docs/content/latest/deploy/manual-deployment/start-masters.md +++ b/docs/content/latest/deploy/manual-deployment/start-masters.md @@ -3,8 +3,6 @@ title: Start YB-Master nodes of YugabyteDB cluster headerTitle: Start YB-Masters linkTitle: 3. Start YB-Masters description: Start YB-Master servers of your YugabyteDB cluster -aliases: - - /deploy/manual-deployment/start-masters menu: latest: identifier: deploy-manual-deployment-start-masters @@ -29,7 +27,7 @@ This section covers deployment for a single region or data center in a multi-zon - Create a six-node cluster with replication factor of `3`. - YB-Master server should run on only three nodes, but as noted in the next section, the YB-TServer server should run on all six nodes. - Assume the three YB-Master private IP addresses are `172.151.17.130`, `172.151.17.220` and `172.151.17.140`. - - Cloud will be `aws`, region will be `us-west`, and the three AZs will be `us-west-2a`, `us-west-2b`, and `us-west-2c`. Two nodes will be placed in each AZ in such a way that one replica for each tablet (aka shard) gets placed in any one node for each AZ. + - Cloud will be `aws`, region will be `us-west`, and the three AZs will be `us-west-2a`, `us-west-2b`, and `us-west-2c`. Two nodes will be placed in each AZ in such a way that one replica for each tablet (aka shard) gets placed in any one node for each AZ. - Multiple data drives mounted on `/home/centos/disk1`, `/home/centos/disk2`. ## Run YB-Master servers with command line flags @@ -57,9 +55,9 @@ Alternatively, you can also create a `master.conf` file with the following flags --master_addresses=172.151.17.130:7100,172.151.17.220:7100,172.151.17.140:7100 --rpc_bind_addresses=172.151.17.130:7100 --fs_data_dirs=/home/centos/disk1,/home/centos/disk2 ---placement_cloud=aws ---placement_region=us-west ---placement_zone=us-west-2a +--placement_cloud=aws +--placement_region=us-west +--placement_zone=us-west-2a ``` ```sh diff --git a/docs/content/latest/deploy/manual-deployment/start-tservers.md b/docs/content/latest/deploy/manual-deployment/start-tservers.md index 555cbd8b5e7f..a76977e3b03b 100644 --- a/docs/content/latest/deploy/manual-deployment/start-tservers.md +++ b/docs/content/latest/deploy/manual-deployment/start-tservers.md @@ -3,8 +3,6 @@ title: Start YB-TServer servers headerTitle: Start YB-TServers linkTitle: 4. Start YB-TServers description: Steps to start YB-TServers when deploying for a single region or data center in a multi-zone/multi-rack configuration. -aliases: - - /deploy/manual-deployment/start-tservers menu: latest: identifier: deploy-manual-deployment-start-tservers @@ -21,14 +19,14 @@ showAsideToc: true {{< /note >}} -This section covers deployment for a single region or data center in a multi-zone/multi-rack configuration. Note that single zone configuration is a special case of multi-zone where all placement related flags are set to the same value across every node. +This section covers deployment for a single region or data center in a multi-zone/multi-rack configuration. Note that single zone configuration is a special case of multi-zone where all placement related flags are set to the same value across every node. ## Example scenario - Create a 6-node cluster with replication factor of 3. - YB-TServer server should on all the six nodes, but as noted in the previous section, the YB-Master server should run on only three of these nodes. - Assume the three YB-Master private IP addresses are `172.151.17.130`, `172.151.17.220` and `172.151.17.140`. - - Cloud will be `aws`, region will be `us-west` and the 3 AZs will be `us-west-2a`, `us-west-2b`, and `us-west-2c`. Two nodes will be placed in each AZ in such a way that 1 replica for each tablet (aka shard) gets placed in any 1 node for each AZ. + - Cloud will be `aws`, region will be `us-west` and the 3 AZs will be `us-west-2a`, `us-west-2b`, and `us-west-2c`. Two nodes will be placed in each AZ in such a way that 1 replica for each tablet (aka shard) gets placed in any 1 node for each AZ. - Multiple data drives mounted on `/home/centos/disk1`, `/home/centos/disk2` ## Run YB-TServer with command line flags @@ -68,9 +66,9 @@ Alternatively, you can also create a `tserver.conf` file with the following flag --pgsql_proxy_bind_address=172.151.17.130:5433 --cql_proxy_bind_address=172.151.17.130:9042 --fs_data_dirs=/home/centos/disk1,/home/centos/disk2 ---placement_cloud=aws ---placement_region=us-west ---placement_zone=us-west-2a +--placement_cloud=aws +--placement_region=us-west +--placement_zone=us-west-2a ``` ```sh diff --git a/docs/content/latest/deploy/manual-deployment/system-config.md b/docs/content/latest/deploy/manual-deployment/system-config.md index 5419efa7fffb..beda405c698d 100644 --- a/docs/content/latest/deploy/manual-deployment/system-config.md +++ b/docs/content/latest/deploy/manual-deployment/system-config.md @@ -3,8 +3,6 @@ title: System configuration headerTitle: System configuration linkTitle: 1. System configuration description: Configure NTP and ulimits on your YugabyteDB cluster -aliases: - - /deploy/manual-deployment/system-config menu: latest: identifier: deploy-manual-deployment-system-config diff --git a/docs/content/latest/deploy/manual-deployment/verify-deployment.md b/docs/content/latest/deploy/manual-deployment/verify-deployment.md index 42dce86f62af..0e8189b91956 100644 --- a/docs/content/latest/deploy/manual-deployment/verify-deployment.md +++ b/docs/content/latest/deploy/manual-deployment/verify-deployment.md @@ -3,8 +3,6 @@ title: Verify deployment headerTitle: Verify deployment linkTitle: 5. Verify deployment description: Verify deployment of your YugabyteDB cluster -aliases: - - /deploy/manual-deployment/verify-deployment menu: latest: identifier: deploy-manual-deployment-verify-deployment diff --git a/docs/content/latest/deploy/multi-dc/_index.md b/docs/content/latest/deploy/multi-dc/_index.md index 7b80d09632d3..be023782349f 100644 --- a/docs/content/latest/deploy/multi-dc/_index.md +++ b/docs/content/latest/deploy/multi-dc/_index.md @@ -12,11 +12,11 @@ menu: weight: 631 --- -YugabyteDB is a geo-distributed SQL database that can be easily deployed across multiple data centers (DCs) or cloud regions. There are two primary configurations for such multi-DC deployments. +YugabyteDB is a geo-distributed SQL database that can be easily deployed across multiple data centers (DCs) or cloud regions. There are two primary configurations for such multi-DC deployments. -The first configuration uses a single cluster stretched across 3 or more data centers with data getting automatically sharded across all data centers. This configuration is default for [Spanner-inspired databases](../../architecture/docdb/) like YugabyteDB. Data replication across data centers is synchronous and is based on the Raft consensus protocol. This means writes are globally consistent and reads are either globally consistent or timeline consistent (when application clients use follower reads). Additionally, resilience against data center failures is fully automatic. This configuration has the potential to incur Wide Area Network (WAN) latency in the write path if the data centers are geographically located far apart from each other and are connected through the shared/unreliable Internet. +The first configuration uses a single cluster stretched across 3 or more data centers with data getting automatically sharded across all data centers. This configuration is default for [Spanner-inspired databases](../../architecture/docdb/) like YugabyteDB. Data replication across data centers is synchronous and is based on the Raft consensus protocol. This means writes are globally consistent and reads are either globally consistent or timeline consistent (when application clients use follower reads). Additionally, resilience against data center failures is fully automatic. This configuration has the potential to incur Wide Area Network (WAN) latency in the write path if the data centers are geographically located far apart from each other and are connected through the shared/unreliable Internet. -For users not requiring global consistency and automatic resilience to data center failures, the WAN latency can be eliminated altogether through the second configuration where two independent, single-DC clusters are connected through asynchronous replication based on Change Data Capture. +For users not requiring global consistency and automatic resilience to data center failures, the WAN latency can be eliminated altogether through the second configuration where two independent, single-DC clusters are connected through asynchronous replication based on Change Data Capture. 9 Techniques to Build Cloud-Native, Geo-Distributed SQL Apps with Low Latency highlights the various multi-DC deployment strategies for a distributed SQL database like YugabyteDB. Note that YugabyteDB is the only Spanner-inspired distributed SQL database to support a 2DC deployment. diff --git a/docs/content/latest/deploy/multi-dc/async-replication.md b/docs/content/latest/deploy/multi-dc/async-replication.md index 8f87d2edd47e..18094d434a9f 100644 --- a/docs/content/latest/deploy/multi-dc/async-replication.md +++ b/docs/content/latest/deploy/multi-dc/async-replication.md @@ -23,9 +23,9 @@ For information on two data center (2DC) deployment architecture and supported r You can create source and target universes as follows: -1. Create the yugabyte-source universe by following the procedure from [Manual deployment](../../manual-deployment). +1. Create the yugabyte-source universe by following the procedure from [Manual deployment](../../manual-deployment/). 1. Create tables for the APIs being used by the source universe. -1. Create the yugabyte-target universe by following the procedure from [Manual deployment](../../manual-deployment). +1. Create the yugabyte-target universe by following the procedure from [Manual deployment](../../manual-deployment/). 1. Create tables for the APIs being used by the target universe. These should be the same tables as you created for the source universe. 1. Proceed to setting up [unidirectional](#seting-up-unidirectional-replication) or [bidirectional](#setting-up-bidirectional-replication) replication. @@ -35,9 +35,9 @@ After you created the required tables, you can set up asynchronous replication a - Look up the source universe UUID and the table IDs for the two tables and the index table: - - To find a universe's UUID, check `/varz` for `--cluster_uuid`. If it is not available in this location, check the same field in the cluster configuration. + - To find a universe's UUID, check `/varz` for `--cluster_uuid`. If it is not available in this location, check the same field in the cluster configuration. - - To find a table ID, execute the following command as an admin user: + - To find a table ID, execute the following command as an admin user: ```shell yb-admin list_tables include_table_id @@ -63,7 +63,6 @@ After you created the required tables, you can set up asynchronous replication a 000030a5000030008000000000004000,000030a5000030008000000000004005,dfef757c415c4b2cacc9315b8acb539a ``` - The preceding command contains three table IDs: the first two are YSQL for the base table and index, and the third is the YCQL table. Also, be sure to specify all master addresses for source and target universes in the command. @@ -86,16 +85,17 @@ Once you have set up replication, load data into the source universe as follows: - YSQL: - ```sh - java -jar yb-sample-apps.jar --workload SqlSecondaryIndex --nodes 127.0.0.1:5433 - ``` + ```sh + java -jar yb-sample-apps.jar --workload SqlSecondaryIndex --nodes 127.0.0.1:5433 + ``` - YCQL: - ```sh - java -jar yb-sample-apps.jar --workload CassandraBatchKeyValue --nodes 127.0.0.1:9042 - ``` + ```sh + java -jar yb-sample-apps.jar --workload CassandraBatchKeyValue --nodes 127.0.0.1:9042 + ``` + \ Note that the IP address needs to correspond to the IP of any T-Servers in the cluster. - For bidirectional replication, repeat the preceding step in the yugabyte-target universe. diff --git a/docs/content/latest/deploy/public-clouds/aws/cloudformation.md b/docs/content/latest/deploy/public-clouds/aws/cloudformation.md index de1a0d25cc49..9a5893975c7e 100644 --- a/docs/content/latest/deploy/public-clouds/aws/cloudformation.md +++ b/docs/content/latest/deploy/public-clouds/aws/cloudformation.md @@ -16,19 +16,19 @@ showAsideToc: true
                            • - + CloudFormation
                            • - + Terraform
                            • - + Manual deployment @@ -40,7 +40,7 @@ showAsideToc: true 1. You need to have an IAM user who has `AWSCloudFormationFullAccess`, `AmazonEC2FullAccess` and `ssm:GetParameters` privilege. 2. If you are going to create the stack via AWS Console then make sure the user also has `s3:CreateBucket`, `s3:PutObject` and `s3:GetObject` policies. 3. Create an SSH key pair that you want to attach to the nodes. -4. In the region you want to bring up the stack, make sure you can launch new VPCs. +4. In the region you want to bring up the stack, make sure you can launch new VPCs. 5. Download the template file. ```sh diff --git a/docs/content/latest/deploy/public-clouds/aws/manual-deployment.md b/docs/content/latest/deploy/public-clouds/aws/manual-deployment.md index 6f02477ee72c..b32cdaa81760 100644 --- a/docs/content/latest/deploy/public-clouds/aws/manual-deployment.md +++ b/docs/content/latest/deploy/public-clouds/aws/manual-deployment.md @@ -14,19 +14,19 @@ showAsideToc: true
                              • - + CloudFormation
                              • - + Terraform
                              • - + Manual deployment diff --git a/docs/content/latest/deploy/public-clouds/aws/terraform.md b/docs/content/latest/deploy/public-clouds/aws/terraform.md index b95c51a0f466..c08c96a45fb0 100644 --- a/docs/content/latest/deploy/public-clouds/aws/terraform.md +++ b/docs/content/latest/deploy/public-clouds/aws/terraform.md @@ -14,19 +14,19 @@ showAsideToc: true
                                • - + CloudFormation
                                • - + Terraform
                                • - + Manual deployment @@ -35,7 +35,7 @@ showAsideToc: true ## Prerequisites -1. Download and install [terraform](https://www.terraform.io/downloads.html). +1. Download and install [terraform](https://www.terraform.io/downloads.html). 2. Verify by the `terraform` command, it should print a help message that looks similar to that shown below. diff --git a/docs/content/latest/deploy/public-clouds/azure/aks.md b/docs/content/latest/deploy/public-clouds/azure/aks.md index f9714c96d2a4..141d4b7c4cda 100644 --- a/docs/content/latest/deploy/public-clouds/azure/aks.md +++ b/docs/content/latest/deploy/public-clouds/azure/aks.md @@ -16,19 +16,19 @@ showAsideToc: true
                                  • - + Azure ARM template
                                  • - + Azure Kubernetes Service (AKS)
                                  • - + Terraform diff --git a/docs/content/latest/deploy/public-clouds/azure/azure-arm.md b/docs/content/latest/deploy/public-clouds/azure/azure-arm.md index 893f39313f42..f8cd29b5e85e 100644 --- a/docs/content/latest/deploy/public-clouds/azure/azure-arm.md +++ b/docs/content/latest/deploy/public-clouds/azure/azure-arm.md @@ -17,19 +17,19 @@ showAsideToc: true
                                    • - + Azure ARM template
                                    • - + Azure Kubernetes Service (AKS)
                                    • - + Terraform @@ -130,7 +130,7 @@ showAsideToc: true ``` $ az group deployment show -g -n --query properties.outputs ``` - + In the output, you will get the YugabyteDB admin URL, JDBC URL, YSQL, YCQL and YEDIS connection string. You can use YugabyteDB admin URL to access admin portal. ## Deploy using Azure Portal diff --git a/docs/content/latest/deploy/public-clouds/azure/terraform.md b/docs/content/latest/deploy/public-clouds/azure/terraform.md index 1d6a85b9f2f7..2eb69ca65f5c 100644 --- a/docs/content/latest/deploy/public-clouds/azure/terraform.md +++ b/docs/content/latest/deploy/public-clouds/azure/terraform.md @@ -14,19 +14,19 @@ showAsideToc: true
                                      • - + Azure ARM template
                                      • - + Azure Kubernetes Service (AKS)
                                      • - + Terraform @@ -42,7 +42,7 @@ showAsideToc: true ```sh $ terraform ``` - + ``` Usage: terraform [--version] [--help] [args] ... @@ -93,7 +93,7 @@ module "yugabyte-db-cluster" { # The region name where the nodes should be spawned. region_name = "YOUR VPC REGION" - # The name of resource group in which all Azure resource will be created. + # The name of resource group in which all Azure resource will be created. resource_group = "test-yugabyte" # Replication factor. @@ -150,7 +150,7 @@ For a cluster named `test-cluster`, this security group will be named `yugabyte- - `module.azure-yugabyte.null_resource.create_yugabyte_universe` A local script that configures the newly created instances to form a new YugabyteDB universe. - `module.azure-yugabyte.azurerm_network_interface.Yugabyte-NIC` The Azure network interface for VM instance. - + For cluster named `test-cluster`, the network interface will be named `yugabyte-test-cluster-NIC-1`, `yugabyte-test-cluster-NIC-2`, `yugabyte-test-cluster-NIC-3`. ## 5. Destroy the cluster [optional] diff --git a/docs/content/latest/deploy/public-clouds/gcp/gcp-deployment-manager.md b/docs/content/latest/deploy/public-clouds/gcp/gcp-deployment-manager.md index 7c3621973294..d68bb143236e 100644 --- a/docs/content/latest/deploy/public-clouds/gcp/gcp-deployment-manager.md +++ b/docs/content/latest/deploy/public-clouds/gcp/gcp-deployment-manager.md @@ -13,21 +13,21 @@ menu:
                                        • - + Google Cloud Deployment Manager
                                        • - + Google Kubernetes Engine (GKE)
                                        • - + Terraform diff --git a/docs/content/latest/deploy/public-clouds/gcp/gke.md b/docs/content/latest/deploy/public-clouds/gcp/gke.md index 92ce5e50c656..c60953e68342 100644 --- a/docs/content/latest/deploy/public-clouds/gcp/gke.md +++ b/docs/content/latest/deploy/public-clouds/gcp/gke.md @@ -13,21 +13,21 @@ menu:
                                          • - + Google Cloud Deployment Manager
                                          • - + Google Kubernetes Engine (GKE)
                                          • - + Terraform diff --git a/docs/content/latest/deploy/public-clouds/gcp/terraform.md b/docs/content/latest/deploy/public-clouds/gcp/terraform.md index 4b4149a3bc31..d9724f75ffee 100644 --- a/docs/content/latest/deploy/public-clouds/gcp/terraform.md +++ b/docs/content/latest/deploy/public-clouds/gcp/terraform.md @@ -15,21 +15,21 @@ menu:
                                            • - + Google Cloud Deployment Manager
                                            • - + Google Kubernetes Engine (GKE)
                                            • - + Terraform diff --git a/docs/content/latest/develop/learn/acid-transactions-ycql.md b/docs/content/latest/develop/learn/acid-transactions-ycql.md index 6b06298ffa62..a1968467b306 100644 --- a/docs/content/latest/develop/learn/acid-transactions-ycql.md +++ b/docs/content/latest/develop/learn/acid-transactions-ycql.md @@ -15,14 +15,14 @@ showAsideToc: true
                                              • - + YSQL
                                              • - + YCQL @@ -76,7 +76,7 @@ Here is a code snippet of how you would insert data into this table. ```java // Insert two key values, (key1, value1) and (key2, value2) as a transaction. -String create_stmt = +String create_stmt = String.format("BEGIN TRANSACTION" + " INSERT INTO %s (k, v) VALUES (%s, %s);" + " INSERT INTO %s (k, v) VALUES (%s, %s);" + @@ -92,7 +92,7 @@ You can prepare statements with transactions and bind variables to the prepared ### Java example ```java -String create_stmt = +String create_stmt = String.format("BEGIN TRANSACTION" + " INSERT INTO %s (k, v) VALUES (:k1, :v1);" + " INSERT INTO %s (k, v) VALUES (:k1, :v2);" + @@ -262,7 +262,7 @@ ycqlsh> SELECT SUM(balance) as Johns_balance FROM banking.accounts WHERE account Further, the checking and savings account balances for John should have been written at the same write timestamp. ```sql -ycqlsh> select account_name, account_type, balance, writetime(balance) +ycqlsh> select account_name, account_type, balance, writetime(balance) from banking.accounts where account_name='John'; ``` diff --git a/docs/content/latest/develop/learn/acid-transactions-ysql.md b/docs/content/latest/develop/learn/acid-transactions-ysql.md index d88a9bf01a2c..668f733232f0 100644 --- a/docs/content/latest/develop/learn/acid-transactions-ysql.md +++ b/docs/content/latest/develop/learn/acid-transactions-ysql.md @@ -18,14 +18,14 @@ showAsideToc: true
                                                • - + YSQL
                                                • - + YCQL diff --git a/docs/content/latest/develop/learn/aggregations-ycql.md b/docs/content/latest/develop/learn/aggregations-ycql.md index bcc63417a27a..c90c6221a56e 100644 --- a/docs/content/latest/develop/learn/aggregations-ycql.md +++ b/docs/content/latest/develop/learn/aggregations-ycql.md @@ -15,14 +15,14 @@ showAsideToc: true
                                                  • - + YSQL
                                                  • - + YCQL @@ -68,7 +68,7 @@ INSERT INTO store.products (ProductID, ProductName, SupplierID, CategoryID, Unit ycqlsh> SELECT COUNT(ProductID) FROM store.products; ``` -``` +```output count(productid) ------------------ 5 @@ -82,7 +82,7 @@ ycqlsh> SELECT COUNT(ProductID) FROM store.products; ycqlsh> SELECT COUNT(ProductID) as num_products FROM store.products; ``` -``` +```output num_products -------------- 5 @@ -98,7 +98,7 @@ You can do this as shown below. ycqlsh> SELECT COUNT(ProductID) as supplier1_num_products FROM store.products WHERE SupplierID=1; ``` -``` +```output supplier1_num_products ------------------------ 3 @@ -116,7 +116,7 @@ The standard aggregate functions of `min`, `max`, `sum`, `avg` and `count` are b ycqlsh> SELECT SUM(Quantity) FROM store.products; ``` -``` +```output sum(quantity) --------------- 96 @@ -130,7 +130,7 @@ ycqlsh> SELECT SUM(Quantity) FROM store.products; ycqlsh> SELECT MIN(Price), MAX(Price) FROM store.products; ``` -``` +```output min(price) | max(price) ------------+------------ 10 | 22 @@ -144,7 +144,7 @@ ycqlsh> SELECT MIN(Price), MAX(Price) FROM store.products; ycqlsh> SELECT AVG(price) FROM store.products; ``` -``` +```output system.avg(price) ------------------- 18.07 diff --git a/docs/content/latest/develop/learn/aggregations-ysql.md b/docs/content/latest/develop/learn/aggregations-ysql.md index ee3fa71ae91b..69ced352d025 100644 --- a/docs/content/latest/develop/learn/aggregations-ysql.md +++ b/docs/content/latest/develop/learn/aggregations-ysql.md @@ -18,14 +18,14 @@ showAsideToc: true
                                                    • - + YSQL
                                                    • - + YCQL diff --git a/docs/content/latest/develop/learn/batch-operations-ycql.md b/docs/content/latest/develop/learn/batch-operations-ycql.md index a774afe0f3b0..248156679ce8 100644 --- a/docs/content/latest/develop/learn/batch-operations-ycql.md +++ b/docs/content/latest/develop/learn/batch-operations-ycql.md @@ -21,12 +21,13 @@ showAsideToc: true
                                                    • - + }}" class="nav-link active"> YCQL
                                                    + Batch operations let you send multiple operations in a single RPC call to the database. The larger the batch size, the higher the latency for the entire batch. Although the latency for the entire batch of operations is higher than the latency of any single operation, the throughput of the batch of operations is much higher. ## Inserting data diff --git a/docs/content/latest/develop/learn/batch-operations-ysql.md b/docs/content/latest/develop/learn/batch-operations-ysql.md index ed0e8450150e..e748ff41f869 100644 --- a/docs/content/latest/develop/learn/batch-operations-ysql.md +++ b/docs/content/latest/develop/learn/batch-operations-ysql.md @@ -17,7 +17,7 @@ showAsideToc: true
                                                    • - + }}" class="nav-link active"> YSQL diff --git a/docs/content/latest/develop/learn/data-modeling-ycql.md b/docs/content/latest/develop/learn/data-modeling-ycql.md index f61914bb38db..b70efa359825 100644 --- a/docs/content/latest/develop/learn/data-modeling-ycql.md +++ b/docs/content/latest/develop/learn/data-modeling-ycql.md @@ -19,14 +19,14 @@ showAsideToc: true
                                                      • - + YSQL
                                                      • - + YCQL @@ -36,7 +36,7 @@ showAsideToc: true Data modeling is a process that involves identifying the entities (items to be stored) and the relationships between entities. To create your data model, identify the patterns used to access data and the types of queries to be performed. These two ideas inform the organization and structure of the data, and the design and creation of the database's tables. -This topic documents data modeling with [Yugabyte Cloud Query Language (YCQL)](../../../api/ycql), YugabyteDB's Cassandra-compatible API. +This topic documents data modeling with [Yugabyte Cloud Query Language (YCQL)](../../../api/ycql/), YugabyteDB's Cassandra-compatible API. ## Keyspaces, tables, rows, and columns diff --git a/docs/content/latest/develop/learn/data-modeling-ysql.md b/docs/content/latest/develop/learn/data-modeling-ysql.md index 292076d13421..5dbf66298961 100644 --- a/docs/content/latest/develop/learn/data-modeling-ysql.md +++ b/docs/content/latest/develop/learn/data-modeling-ysql.md @@ -15,14 +15,14 @@ showAsideToc: true
                                                        • - + YSQL
                                                        • - + YCQL diff --git a/docs/content/latest/develop/learn/data-types-ycql.md b/docs/content/latest/develop/learn/data-types-ycql.md index f2da36dd5288..79132144ebda 100644 --- a/docs/content/latest/develop/learn/data-types-ycql.md +++ b/docs/content/latest/develop/learn/data-types-ycql.md @@ -15,14 +15,14 @@ showAsideToc: true -This topic lists the various data types available in YugabyteDB’s [Cassandra-compatible YCQL API](../../../api/ycql). +This topic lists the various data types available in YugabyteDB's [Cassandra-compatible YCQL API](../../../api/ycql/). ## JSONB @@ -73,8 +73,8 @@ ycqlsh> CREATE TABLE store.books ( id int PRIMARY KEY, details jsonb ); Next we insert some sample data for a few books into this store. You can copy and paste the following commands into the YCQL shell (`ycqlsh`) for YugabyteDB to insert the data. ```sql -INSERT INTO store.books (id, details) VALUES (1, - '{ "name" : "Macbeth", +INSERT INTO store.books (id, details) VALUES (1, + '{ "name" : "Macbeth", "author" : {"first_name": "William", "last_name": "Shakespeare"}, "year" : 1623, "editors": ["John", "Elizabeth", "Jeff"] }' diff --git a/docs/content/latest/develop/learn/data-types-ysql.md b/docs/content/latest/develop/learn/data-types-ysql.md index 53e96b7da79e..b11a91e3bb07 100644 --- a/docs/content/latest/develop/learn/data-types-ysql.md +++ b/docs/content/latest/develop/learn/data-types-ysql.md @@ -18,14 +18,14 @@ showAsideToc: true
                                                          • - + YSQL
                                                          • - + YCQL diff --git a/docs/content/latest/develop/learn/date-and-time-ycql.md b/docs/content/latest/develop/learn/date-and-time-ycql.md index e7261934c982..8643f4bc7424 100644 --- a/docs/content/latest/develop/learn/date-and-time-ycql.md +++ b/docs/content/latest/develop/learn/date-and-time-ycql.md @@ -19,14 +19,14 @@ showAsideToc: true
                                                            • - + }}" class="nav-link"> YSQL
                                                            • - + }}" class="nav-link active"> YCQL diff --git a/docs/content/latest/develop/learn/date-and-time-ysql.md b/docs/content/latest/develop/learn/date-and-time-ysql.md index 1b8ac22bd027..813de57efd0a 100644 --- a/docs/content/latest/develop/learn/date-and-time-ysql.md +++ b/docs/content/latest/develop/learn/date-and-time-ysql.md @@ -20,14 +20,14 @@ showAsideToc: true
                                                              • - + }}" class="nav-link active"> YSQL
                                                              • - + }}" class="nav-link"> YCQL diff --git a/docs/content/latest/develop/learn/sql-nosql.md b/docs/content/latest/develop/learn/sql-nosql.md index e2dec71bb5f1..1c681d2d5000 100644 --- a/docs/content/latest/develop/learn/sql-nosql.md +++ b/docs/content/latest/develop/learn/sql-nosql.md @@ -3,8 +3,6 @@ title: SQL vs NoSQL in YugabyteDB headerTitle: SQL vs NoSQL linkTitle: 1. SQL vs NoSQL description: Learn how YugabyteDB brings the best of SQL and NoSQL together into one unified platform to simplify development of scalable cloud services. -aliases: - - /develop/learn/sql-nosql/ menu: latest: identifier: sql-nosql @@ -58,7 +56,7 @@ Applications and cloud services depend on databases for a variety of built-in fe Here is a table that lists some of the important features that YugabyteDB supports, and which of YugabyteDB's APIs to use in order to achieve these features. Note that typically, multiple databases are deployed in order to achieve these features. -| Database features | [Yugabyte SQL API](../../../api/ysql) | [Yugabyte Cloud QL API](../../../api/ycql) | +| Database features | [Yugabyte SQL API](../../../api/ysql/) | [Yugabyte Cloud QL API](../../../api/ycql/) | | --------------- | ---------------- | ------------------ | | Multi-row transactions | Yes | Yes | | Consistent secondary indexes | Yes | Yes | diff --git a/docs/content/latest/develop/learn/strings-and-text-ycql.md b/docs/content/latest/develop/learn/strings-and-text-ycql.md index 88d4e04dd3ad..41926e534a27 100644 --- a/docs/content/latest/develop/learn/strings-and-text-ycql.md +++ b/docs/content/latest/develop/learn/strings-and-text-ycql.md @@ -15,14 +15,14 @@ showAsideToc: true
                                                                • - + }}" class="nav-link"> YSQL
                                                                • - + }}" class="nav-link active"> YCQL diff --git a/docs/content/latest/develop/learn/strings-and-text-ysql.md b/docs/content/latest/develop/learn/strings-and-text-ysql.md index 746bbed5a3bd..a47a618c1253 100644 --- a/docs/content/latest/develop/learn/strings-and-text-ysql.md +++ b/docs/content/latest/develop/learn/strings-and-text-ysql.md @@ -18,14 +18,14 @@ showAsideToc: true
                                                                  • - + }}" class="nav-link active"> YSQL
                                                                  • - + }}" class="nav-link"> YCQL @@ -115,7 +115,7 @@ yugabyte=# select cast(123 AS TEXT), cast('123' AS TEXT), 123::text, '123'::text yugabyte=# select tablename, hasindexes AS nocast, hasindexes::text AS casted from pg_catalog.pg_tables where tablename in('pg_default_acl', 'sql_features'); - + tablename | nocast | casted ----------------+--------+-------- pg_default_acl | t | true @@ -133,7 +133,7 @@ The focus here was to quickly show how each of the functions could be used, alon ### Altering the appearance of text ```sh -yugabyte=# \c yb_demo +yugabyte=# \c yb_demo You are now connected to database "yb_demo" as user "yugabyte". yb_demo =# select lower('hELLO world') AS LOWER, @@ -242,11 +242,11 @@ yb_demo=# select repeat(' ', ((x.maxlen-length(u.name))/2)::int) || rpad(u.name, Rahul Kreiger Wilhelmine Erdman Elwin Okuneva - Maximillian Dickinson + Maximillian Dickinson Lucie Cormier - Alexandrine Rosenbaum + Alexandrine Rosenbaum Jayne Breitenberg - Alexandria Schowalter + Alexandria Schowalter Augustine Runolfsdottir Mathilde Weissnat Theresa Grant @@ -257,7 +257,7 @@ yb_demo=# select x.RawDay, length(x.RawDay) AS RawLen, x.TrimDay, length(x.TrimD from (select to_char(generate_series, 'Day') AS RawDay, trim(to_char(generate_series, 'Day')) AS TrimDay, ltrim(to_char(generate_series, 'Day')) AS LTrimDay, - rtrim(to_char(generate_series, 'Day')) AS RTrimDay + rtrim(to_char(generate_series, 'Day')) AS RTrimDay from generate_series(current_date, current_date+6, '1 day')) AS x; rawday | rawlen | trimday | trimlen | ltrimday | ltrimlen | rtrimday | rtrimlen @@ -347,7 +347,7 @@ yb_demo=# select concat_ws(':', 1,2,3) AS "123 WS"; yb_demo =# select left(vendor,1) AS V, string_agg(distinct(category), ', ' ORDER BY category) AS CATEGORIES from products group by left(vendor,1) order by 1; - + v | categories ---+---------------------------------- A | Doohickey, Gadget, Gizmo @@ -420,7 +420,7 @@ The treatment of nulls in mathematical operations is often problematic, as is st ``` yb_demo=# select trunc(avg(coalesce(discount,0))::numeric,3) AS "COALESCED", trunc(avg(discount)::numeric,3) AS "RAW" from orders; - COALESCED | RAW + COALESCED | RAW -----------+------- 0.530 | 5.195 @@ -605,7 +605,7 @@ Rather than format or change the contents of text, you often might want to under yb_demo=# select x.c AS CHAR, ascii(x.c) AS ASCII from (select regexp_split_to_table(i.input, '') AS "c" from (select 'hello' AS input) AS i) AS x; - + char | ascii ------+------- h | 104 @@ -623,7 +623,7 @@ yb_demo=# select bit_length('hello'), char_length('hello'), octet_length('hello' yb_demo=# select array_agg(chr(ascii(x.c))) AS "CHAR" from (select regexp_split_to_table(i.input, '') AS "c" from (select 'hello' AS input) AS i) AS x; - + CHAR ------------- {h,e,l,l,o} @@ -683,9 +683,9 @@ yb_demo=# select m.name name ----------- - January + January June - July + July ``` ## Something a bit more advanced diff --git a/docs/content/latest/develop/learn/ttl-data-expiration-ycql.md b/docs/content/latest/develop/learn/ttl-data-expiration-ycql.md index 8d62332ff7d9..5b61980676e9 100644 --- a/docs/content/latest/develop/learn/ttl-data-expiration-ycql.md +++ b/docs/content/latest/develop/learn/ttl-data-expiration-ycql.md @@ -15,14 +15,14 @@ isTocNested: true
                                                                    • - + YSQL
                                                                    • - + YCQL @@ -42,16 +42,16 @@ non-primary key columns are deleted only in the case of inserts. ## Table level TTL -YCQL allows the TTL property to be specified at the table level. -In this case, you do not store the TTL on a per KV basis in DocDB; but the TTL is implicitly enforced +YCQL allows the TTL property to be specified at the table level. +In this case, you do not store the TTL on a per KV basis in DocDB; but the TTL is implicitly enforced on reads as well as during compactions (to reclaim space). -Table level TTL can be defined with `default_time_to_live` [property](../../../api/ycql/ddl_create_table#table-properties-1). +Table level TTL can be defined with `default_time_to_live` [property](../../../api/ycql/ddl_create_table/#table-properties-1). Below, you will look at how the row-level TTL is achieved in detail. ## Row level TTL -YCQL allows the TTL property to be specified at the level of each INSERT/UPDATE operation. +YCQL allows the TTL property to be specified at the level of each INSERT/UPDATE operation. Row level TTL expires the whole row. The value is specified at insert/update time with `USING TTL` clause. In such cases, the TTL is stored as part of the DocDB value. A simple query would be: @@ -65,6 +65,7 @@ SELECT * FROM pageviews; (1 rows) ``` + After 10 seconds, the row is expired: ```sql @@ -78,7 +79,7 @@ SELECT * FROM pageviews; ## Column level TTL -YCQL also allows to set column level TTL. In such cases, the TTL is stored as part of the DocDB column value. +YCQL also allows to set column level TTL. In such cases, the TTL is stored as part of the DocDB column value. But you can set it only when updating the column: ```sql @@ -111,8 +112,8 @@ SELECT * FROM pageviews; There are several ways to work with TTL: -1. Table level TTL with [`default_time_to_live`](../../../api/ycql/ddl_create_table#table-properties-1) property. -2. [Expiring rows with TTL](../../../api/ycql/dml_insert#insert-a-row-with-expiration-time-using-the-using-ttl-clause) +1. Table level TTL with [`default_time_to_live`](../../../api/ycql/ddl_create_table/#table-properties-1) property. +2. [Expiring rows with TTL](../../../api/ycql/dml_insert/#insert-a-row-with-expiration-time-using-the-using-ttl-clause) 3. [`TTL` function](../../../api/ycql/expr_fcall/#ttl-function) to return number of seconds until expiration -4. [`WriteTime` function](../../../api/ycql/expr_fcall#writetime-function) returns timestamp when row/column was inserted +4. [`WriteTime` function](../../../api/ycql/expr_fcall/#writetime-function) returns timestamp when row/column was inserted 5. [Update row/column TTL](../../../api/ycql/dml_update/#using-clause) to update the TTL of a row or column diff --git a/docs/content/latest/develop/learn/ttl-data-expiration-ysql.md b/docs/content/latest/develop/learn/ttl-data-expiration-ysql.md index 86d865435aa1..5b38e6aafcd2 100644 --- a/docs/content/latest/develop/learn/ttl-data-expiration-ysql.md +++ b/docs/content/latest/develop/learn/ttl-data-expiration-ysql.md @@ -19,14 +19,14 @@ isTocNested: true
                                                                      • - + YSQL
                                                                      • - + YCQL diff --git a/docs/content/latest/develop/realworld-apps/iot-spark-kafka-ksql.md b/docs/content/latest/develop/realworld-apps/iot-spark-kafka-ksql.md index 23ff86900ef9..a9197ea416ec 100644 --- a/docs/content/latest/develop/realworld-apps/iot-spark-kafka-ksql.md +++ b/docs/content/latest/develop/realworld-apps/iot-spark-kafka-ksql.md @@ -55,7 +55,7 @@ App architecture with the SKY stack is shown below. The Kafka Connect Sink Conne ## Data store -Stores all the user-facing data. YugabyteDB is used here, with the Cassandra-compatible [YCQL](../../../api/ycql) as the programming language. +Stores all the user-facing data. YugabyteDB is used here, with the Cassandra-compatible [YCQL](../../../api/ycql/) as the programming language. All the data is stored in the keyspace `TrafficKeySpace`: @@ -240,7 +240,7 @@ Create non-filtered and filtered streams, to be used later in actual processing: JavaDStream nonFilteredIotDataStream = directKafkaStream.map(tuple -> tuple._2()); // Filtered stream for total and traffic data calculation -JavaPairDStream iotDataPairStream = +JavaPairDStream iotDataPairStream = nonFilteredIotDataStream.mapToPair(iot -> new Tuple2(iot.getVehicleId(),iot)).reduceByKey((a, b) -> a ); // Check vehicle ID is already processed @@ -280,7 +280,7 @@ JavaPairDStream countDStreamPair = filteredIotDataStream .mapToPair(iot -> new Tuple2<>(new AggregateKey(iot.getRouteId(), iot.getVehicleType()), 1L)) .reduceByKey((a, b) -> a + b); - + // Keep state for total count JavaMapWithStateDStream> countDStreamWithStatePair = countDStreamPair.mapWithState( diff --git a/docs/content/latest/explore/_index.md b/docs/content/latest/explore/_index.md index 3431c6e310c4..72118a8b703d 100644 --- a/docs/content/latest/explore/_index.md +++ b/docs/content/latest/explore/_index.md @@ -20,7 +20,7 @@ menu: {{< tip title="Tip" >}} -Use [yb-ctl](../admin/yb-ctl) local cluster management utility to explore the core features of YugabyteDB. +Use [yb-ctl](../admin/yb-ctl/) local cluster management utility to explore the core features of YugabyteDB. {{< /tip >}} @@ -38,7 +38,7 @@ Use [yb-ctl](../admin/yb-ctl) local cluster management utility to explore the co
                            - +
                            Fault tolerance
                            diff --git a/docs/content/latest/explore/cluster-management/point-in-time-recovery-ycql.md b/docs/content/latest/explore/cluster-management/point-in-time-recovery-ycql.md index b928a763d707..2f41883a6c64 100644 --- a/docs/content/latest/explore/cluster-management/point-in-time-recovery-ycql.md +++ b/docs/content/latest/explore/cluster-management/point-in-time-recovery-ycql.md @@ -18,13 +18,13 @@ showAsideToc: true
                            • - + YSQL
                            • - + YCQL diff --git a/docs/content/latest/explore/cluster-management/point-in-time-recovery-ysql.md b/docs/content/latest/explore/cluster-management/point-in-time-recovery-ysql.md index d39b02a29324..4cf8c2266172 100644 --- a/docs/content/latest/explore/cluster-management/point-in-time-recovery-ysql.md +++ b/docs/content/latest/explore/cluster-management/point-in-time-recovery-ysql.md @@ -18,13 +18,13 @@ showAsideToc: true
                              • - + YSQL
                              • - + YCQL @@ -65,18 +65,18 @@ Create and populate a table, look at a timestamp to which you'll restore, and th salary integer ); - INSERT INTO employees (employee_no, name, department, salary) - VALUES + INSERT INTO employees (employee_no, name, department, salary) + VALUES (1221, 'John Smith', 'Marketing', 50000), (1222, 'Bette Davis', 'Sales', 55000), (1223, 'Lucille Ball', 'Operations', 70000), (1224, 'John Zimmerman', 'Sales', 60000); - + SELECT * from employees; ``` ```output - employee_no | name | department | salary + employee_no | name | department | salary -------------+----------------+------------+-------- 1223 | Lucille Ball | Operations | 70000 1224 | John Zimmerman | Sales | 60000 @@ -138,15 +138,15 @@ Create and populate a table, look at a timestamp to which you'll restore, and th 1. Add a row for employee 9999 to the table: ```sql - INSERT INTO employees (employee_no, name, department, salary) - VALUES + INSERT INTO employees (employee_no, name, department, salary) + VALUES (9999, 'Wrong Name', 'Marketing', 10000); SELECT * FROM employees; ``` ```output - employee_no | name | department | salary + employee_no | name | department | salary -------------+----------------+------------+-------- 1223 | Lucille Ball | Operations | 70000 9999 | Wrong Name | Marketing | 10000 @@ -195,7 +195,7 @@ Create and populate a table, look at a timestamp to which you'll restore, and th ``` ```output - employee_no | name | department | salary + employee_no | name | department | salary -------------+----------------+------------+-------- 1223 | Lucille Ball | Operations | 70000 1224 | John Zimmerman | Sales | 60000 @@ -297,18 +297,18 @@ In addition to data changes, you can also use PITR to recover from metadata chan salary integer ); - INSERT INTO employees (employee_no, name, department, salary) - VALUES + INSERT INTO employees (employee_no, name, department, salary) + VALUES (1221, 'John Smith', 'Marketing', 50000), (1222, 'Bette Davis', 'Sales', 55000), (1223, 'Lucille Ball', 'Operations', 70000), (1224, 'John Zimmerman', 'Sales', 60000); - + SELECT * from employees; ``` ```output - employee_no | name | department | salary + employee_no | name | department | salary -------------+----------------+------------+-------- 1223 | Lucille Ball | Operations | 70000 1224 | John Zimmerman | Sales | 60000 @@ -391,18 +391,18 @@ In addition to data changes, you can also use PITR to recover from metadata chan salary integer ); - INSERT INTO employees (employee_no, name, department, salary) - VALUES + INSERT INTO employees (employee_no, name, department, salary) + VALUES (1221, 'John Smith', 'Marketing', 50000), (1222, 'Bette Davis', 'Sales', 55000), (1223, 'Lucille Ball', 'Operations', 70000), (1224, 'John Zimmerman', 'Sales', 60000); - + SELECT * from employees; ``` ```output - employee_no | name | department | salary + employee_no | name | department | salary -------------+----------------+------------+-------- 1223 | Lucille Ball | Operations | 70000 1224 | John Zimmerman | Sales | 60000 @@ -507,7 +507,7 @@ In addition to data changes, you can also use PITR to recover from metadata chan ``` ```output - employee_no | name | department | salary + employee_no | name | department | salary -------------+----------------+------------+-------- 1223 | Lucille Ball | Operations | 70000 1224 | John Zimmerman | Sales | 60000 @@ -548,18 +548,18 @@ In addition to data changes, you can also use PITR to recover from metadata chan salary integer ); - INSERT INTO employees (employee_no, name, department, salary) - VALUES + INSERT INTO employees (employee_no, name, department, salary) + VALUES (1221, 'John Smith', 'Marketing', 50000), (1222, 'Bette Davis', 'Sales', 55000), (1223, 'Lucille Ball', 'Operations', 70000), (1224, 'John Zimmerman', 'Sales', 60000); - + SELECT * from employees; ``` ```output - employee_no | name | department | salary + employee_no | name | department | salary -------------+----------------+------------+-------- 1223 | Lucille Ball | Operations | 70000 1224 | John Zimmerman | Sales | 60000 @@ -628,12 +628,12 @@ In addition to data changes, you can also use PITR to recover from metadata chan ``` ```output - employee_no | name | department | salary | v2 + employee_no | name | department | salary | v2 -------------+----------------+------------+--------+---- - 1223 | Lucille Ball | Operations | 70000 | - 1224 | John Zimmerman | Sales | 60000 | - 1221 | John Smith | Marketing | 50000 | - 1222 | Bette Davis | Sales | 55000 | + 1223 | Lucille Ball | Operations | 70000 | + 1224 | John Zimmerman | Sales | 60000 | + 1221 | John Smith | Marketing | 50000 | + 1222 | Bette Davis | Sales | 55000 | (4 rows) ``` @@ -718,18 +718,18 @@ In addition to data changes, you can also use PITR to recover from metadata chan salary integer ); - INSERT INTO employees (employee_no, name, department, salary) - VALUES + INSERT INTO employees (employee_no, name, department, salary) + VALUES (1221, 'John Smith', 'Marketing', 50000), (1222, 'Bette Davis', 'Sales', 55000), (1223, 'Lucille Ball', 'Operations', 70000), (1224, 'John Zimmerman', 'Sales', 60000); - + SELECT * from employees; ``` ```output - employee_no | name | department | salary + employee_no | name | department | salary -------------+----------------+------------+-------- 1223 | Lucille Ball | Operations | 70000 1224 | John Zimmerman | Sales | 60000 @@ -881,18 +881,18 @@ In addition to data changes, you can also use PITR to recover from metadata chan salary integer ); - INSERT INTO employees (employee_no, name, department, salary) - VALUES + INSERT INTO employees (employee_no, name, department, salary) + VALUES (1221, 'John Smith', 'Marketing', 50000), (1222, 'Bette Davis', 'Sales', 55000), (1223, 'Lucille Ball', 'Operations', 70000), (1224, 'John Zimmerman', 'Sales', 60000); - + SELECT * from employees; ``` ```output - employee_no | name | department | salary + employee_no | name | department | salary -------------+----------------+------------+-------- 1223 | Lucille Ball | Operations | 70000 1224 | John Zimmerman | Sales | 60000 @@ -957,12 +957,12 @@ In addition to data changes, you can also use PITR to recover from metadata chan ```output Table "public.employees" - Column | Type | Collation | Nullable | Default + Column | Type | Collation | Nullable | Default -------------+---------+-----------+----------+--------- - employee_no | integer | | not null | - name | text | | | - department | text | | | - salary | integer | | | + employee_no | integer | | not null | + name | text | | | + department | text | | | + salary | integer | | | Indexes: "employees_pkey" PRIMARY KEY, lsm (employee_no HASH) "t1_index" lsm (employee_no HASH) @@ -1009,12 +1009,12 @@ In addition to data changes, you can also use PITR to recover from metadata chan ```output Table "public.employees" - Column | Type | Collation | Nullable | Default + Column | Type | Collation | Nullable | Default -------------+---------+-----------+----------+--------- - employee_no | integer | | not null | - name | text | | | - department | text | | | - salary | integer | | | + employee_no | integer | | not null | + name | text | | | + department | text | | | + salary | integer | | | Indexes: "employees_pkey" PRIMARY KEY, lsm (employee_no HASH) ``` diff --git a/docs/content/latest/explore/fault-tolerance/docker.md b/docs/content/latest/explore/fault-tolerance/docker.md index 24e6563d504c..ac14449f182c 100644 --- a/docs/content/latest/explore/fault-tolerance/docker.md +++ b/docs/content/latest/explore/fault-tolerance/docker.md @@ -17,28 +17,28 @@ showAsideToc: true
                                • - + macOS
                                • - + Linux
                                • - + Docker
                                • - + Kubernetes @@ -185,7 +185,7 @@ $ docker exec -it yb-tserver-n4 /home/yugabyte/bin/ycqlsh $YB_TSERVER_N4_ADDR Let us insert some data. ```sql -ycqlsh> INSERT INTO users.profile (id, email, password, profile) VALUES +ycqlsh> INSERT INTO users.profile (id, email, password, profile) VALUES (3000, 'austin.powers@yugabyte.com', 'imGroovy', {'firstname': 'Austin', 'lastname': 'Powers'}); ``` diff --git a/docs/content/latest/explore/fault-tolerance/kubernetes.md b/docs/content/latest/explore/fault-tolerance/kubernetes.md index 6d84702d3392..18de4161106c 100644 --- a/docs/content/latest/explore/fault-tolerance/kubernetes.md +++ b/docs/content/latest/explore/fault-tolerance/kubernetes.md @@ -17,28 +17,28 @@ showAsideToc: true
                                  • - + macOS
                                  • - + Linux
                                  • - + Docker
                                  • - + Kubernetes @@ -204,7 +204,7 @@ $ kubectl -n yb-demo exec -it yb-tserver-1 -- ycqlsh yb-tserver-1 Let us insert some data to ensure that the loss of a node hasn't impacted the ability of the universe to take writes. ```sql -ycqlsh> INSERT INTO users.profile (id, email, password, profile) VALUES +ycqlsh> INSERT INTO users.profile (id, email, password, profile) VALUES (3000, 'austin.powers@yugabyte.com', 'imGroovy', {'firstname': 'Austin', 'lastname': 'Powers'}); ``` diff --git a/docs/content/latest/explore/fault-tolerance/linux.md b/docs/content/latest/explore/fault-tolerance/linux.md index bdb71927c270..cc4c64c18a26 100644 --- a/docs/content/latest/explore/fault-tolerance/linux.md +++ b/docs/content/latest/explore/fault-tolerance/linux.md @@ -17,28 +17,28 @@ showAsideToc: true
                                    • - + macOS
                                    • - + Linux
                                    • - + Docker
                                    • - + Kubernetes @@ -48,7 +48,7 @@ showAsideToc: true YugabyteDB can automatically handle failures and therefore provides [high availability](../../../architecture/core-functions/high-availability/). In this section, you'll see how YugabyteDB can continue to do reads and writes even in case of node failures. You will create YSQL tables with a replication factor (RF) of `3` that allows a [fault tolerance](../../../architecture/docdb-replication/replication/) of 1. This means the cluster will remain available for both reads and writes even if one node fails. However, if another node fails bringing the number of failures to two, then writes will become unavailable on the cluster in order to preserve data consistency. -This tutorial uses the [yugabyted](../../../reference/configuration/yugabyted) cluster management utility. +This tutorial uses the [yugabyted](../../../reference/configuration/yugabyted/) cluster management utility. ## 1. Create a universe @@ -60,7 +60,7 @@ Start a new local three-node cluster with a replication factor of `3`. First cre --base_dir=/tmp/ybd1 ``` -Next, create a 3 node cluster by joining two more nodes with the previous node. By default, [yugabyted](../../../reference/configuration/yugabyted) creates a cluster with a replication factor of `3` on starting a 3 node cluster. +Next, create a 3 node cluster by joining two more nodes with the previous node. By default, [yugabyted](../../../reference/configuration/yugabyted/) creates a cluster with a replication factor of `3` on starting a 3 node cluster. ```sh ./bin/yugabyted start \ @@ -81,7 +81,7 @@ Next, create a 3 node cluster by joining two more nodes with the previous node. Download the YugabyteDB workload generator JAR file (`yb-sample-apps.jar`). ```sh -$ wget https://github.com/yugabyte/yb-sample-apps/releases/download/1.3.9/yb-sample-apps.jar?raw=true -O yb-sample-apps.jar +$ wget https://github.com/yugabyte/yb-sample-apps/releases/download/1.3.9/yb-sample-apps.jar?raw=true -O yb-sample-apps.jar ``` Run the `SqlInserts` workload against the local universe using the following command. @@ -119,7 +119,7 @@ Refresh the table ![Read and write IOPS with 3rd node dead](/images/ce/fault_tolerance_dead_node.png) -## 6. [Optional] Clean up +## 6. [Optional] Clean up Optionally, you can shut down the local cluster you created earlier. diff --git a/docs/content/latest/explore/fault-tolerance/macos.md b/docs/content/latest/explore/fault-tolerance/macos.md index ca11ae6a3372..29ee6106d9ca 100644 --- a/docs/content/latest/explore/fault-tolerance/macos.md +++ b/docs/content/latest/explore/fault-tolerance/macos.md @@ -21,28 +21,28 @@ showAsideToc: true
                                      • - + macOS
                                      • - + Linux
                                      • - + Docker
                                      • - + Kubernetes @@ -52,7 +52,7 @@ showAsideToc: true YugabyteDB can automatically handle failures and therefore provides [high availability](../../../architecture/core-functions/high-availability/). In this section, you'll see how YugabyteDB can continue to do reads and writes even in case of node failures. You will create YSQL tables with a replication factor (RF) of `3` that allows a [fault tolerance](../../../architecture/docdb-replication/replication/) of 1. This means the cluster will remain available for both reads and writes even if one node fails. However, if another node fails bringing the number of failures to two, then writes will become unavailable on the cluster in order to preserve data consistency. -This tutorial uses the [yugabyted](../../../reference/configuration/yugabyted) cluster management utility. +This tutorial uses the [yugabyted](../../../reference/configuration/yugabyted/) cluster management utility. ## 1. Create a universe @@ -64,7 +64,7 @@ Start a new local three-node cluster with a replication factor of `3`. First cre --base_dir=/tmp/ybd1 ``` -Next, create a 3 node cluster by joining two more nodes with the previous node. By default, [yugabyted](../../../reference/configuration/yugabyted) creates a cluster with a replication factor of `3` on starting a 3 node cluster. +Next, create a 3 node cluster by joining two more nodes with the previous node. By default, [yugabyted](../../../reference/configuration/yugabyted/) creates a cluster with a replication factor of `3` on starting a 3 node cluster. ```sh ./bin/yugabyted start \ @@ -85,7 +85,7 @@ Next, create a 3 node cluster by joining two more nodes with the previous node. Download the YugabyteDB workload generator JAR file (`yb-sample-apps.jar`). ```sh -$ wget https://github.com/yugabyte/yb-sample-apps/releases/download/1.3.9/yb-sample-apps.jar?raw=true -O yb-sample-apps.jar +$ wget https://github.com/yugabyte/yb-sample-apps/releases/download/1.3.9/yb-sample-apps.jar?raw=true -O yb-sample-apps.jar ``` Run the `SqlInserts` workload against the local universe using the following command. @@ -123,7 +123,7 @@ Refresh the table ![Read and write IOPS with 3rd node dead](/images/ce/fault_tolerance_dead_node.png) -## 6. [Optional] Clean up +## 6. [Optional] Clean up Optionally, you can shut down the local cluster you created earlier. diff --git a/docs/content/latest/explore/indexes-constraints/gin.md b/docs/content/latest/explore/indexes-constraints/gin.md index 33fcd1fa68eb..a2fc7fb1d0ec 100644 --- a/docs/content/latest/explore/indexes-constraints/gin.md +++ b/docs/content/latest/explore/indexes-constraints/gin.md @@ -16,7 +16,7 @@ showAsideToc: true
                                        • - + YSQL diff --git a/docs/content/latest/explore/indexes-constraints/primary-key-ysql.md b/docs/content/latest/explore/indexes-constraints/primary-key-ysql.md index 0fe30d4eec77..0bdd010c7e0e 100644 --- a/docs/content/latest/explore/indexes-constraints/primary-key-ysql.md +++ b/docs/content/latest/explore/indexes-constraints/primary-key-ysql.md @@ -36,9 +36,9 @@ The Primary Key constraint is a means to identify a specific row in a table uniq ## Syntax and examples -- To run the examples below, follow these steps to create a local [cluster](/latest/quick-start/) or in [Yugabyte Cloud](/latest/yugabyte-cloud/cloud-connect/). +- To run the examples below, follow these steps to create a local [cluster](../../../quick-start/) or in [Yugabyte Cloud](../../../yugabyte-cloud/cloud-connect/). -- Use the [YSQL shell](/latest/admin/ysqlsh/) for local clusters, or [Connect using Cloud shell](/latest/yugabyte-cloud/cloud-connect/connect-cloud-shell/) for Yugabyte Cloud, and create the yb_demo [database](latest/yugabyte-cloud/cloud-quickstart/qs-data/#create-a-database). +- Use the [YSQL shell](../../../admin/ysqlsh/) for local clusters, or [Connect using Cloud shell](../../../yugabyte-cloud/cloud-connect/connect-cloud-shell/) for Yugabyte Cloud, and create the yb_demo [database](../../../yugabyte-cloud/cloud-quickstart/qs-data/#create-a-database). ### Primary key for a single column diff --git a/docs/content/latest/explore/json-support/jsonb-ycql.md b/docs/content/latest/explore/json-support/jsonb-ycql.md index ecc2000b5a34..64bc6244edc2 100644 --- a/docs/content/latest/explore/json-support/jsonb-ycql.md +++ b/docs/content/latest/explore/json-support/jsonb-ycql.md @@ -20,14 +20,14 @@ JSON data types are for storing JSON (JavaScript Object Notation) data, as speci
                                          • - + YSQL
                                          • - + YCQL @@ -67,13 +67,13 @@ Insert JSONB documents ```sql INSERT INTO store.books (id, details) VALUES (1, '{ "name": "Macbeth", "author": { "first_name": "William", "last_name": "Shakespeare" }, "year": 1623, "editors": ["John", "Elizabeth", "Jeff"] }'); -INSERT INTO store.books (id, details) VALUES +INSERT INTO store.books (id, details) VALUES (2, '{ "name": "Hamlet", "author": { "first_name": "William", "last_name": "Shakespeare" }, "year": 1603, "editors": ["Lysa", "Mark", "Robert"] }'); -INSERT INTO store.books (id, details) VALUES +INSERT INTO store.books (id, details) VALUES (3, '{ "name": "Oliver Twist", "author": { "first_name": "Charles", "last_name": "Dickens" }, "year": 1838, "genre": "novel", "editors": ["Mark", "Tony", "Britney"] }'); -INSERT INTO store.books (id, details) VALUES +INSERT INTO store.books (id, details) VALUES (4, '{ "name": "Great Expectations", "author": { "first_name": "Charles", "last_name": "Dickens" }, "year": 1950, "genre": "novel", "editors": ["Robert", "John", "Melisa"] }'); -INSERT INTO store.books (id, details) VALUES +INSERT INTO store.books (id, details) VALUES (5, '{ "name": "A Brief History of Time", "author": { "first_name": "Stephen", "last_name": "Hawking" }, "year": 1988, "genre": "science", "editors": ["Melisa", "Mark", "John"] }'); ``` diff --git a/docs/content/latest/explore/json-support/jsonb-ysql.md b/docs/content/latest/explore/json-support/jsonb-ysql.md index d3570cbc9113..2e82c5a53726 100644 --- a/docs/content/latest/explore/json-support/jsonb-ysql.md +++ b/docs/content/latest/explore/json-support/jsonb-ysql.md @@ -20,14 +20,14 @@ JSON data types are for storing JSON (JavaScript Object Notation) data, as speci
                                            • - + YSQL
                                            • - + YCQL @@ -35,11 +35,10 @@ JSON data types are for storing JSON (JavaScript Object Notation) data, as speci
                                            - -See the section [JSON data types and functionality](../../../api/ysql/datatypes/type_json/) for the YSQL reference documentation on the topic. +See the section [JSON data types and functionality](../../../api/ysql/datatypes/type_json/) for the YSQL reference documentation on the topic. {{< note title="Note" >}} -The JSON functionality in YSQL is nearly identical to the [JSON functionality in PostgreSQL](https://www.postgresql.org/docs/11/datatype-json.html). +The JSON functionality in YSQL is nearly identical to the [JSON functionality in PostgreSQL](https://www.postgresql.org/docs/11/datatype-json.html). {{< /note >}} There are two JSON data types supported in YSQL: `json` and `jsonb`. @@ -85,7 +84,7 @@ Next, insert some rows which contain details about various books. These details insert into books(k, doc) values (1, '{ "ISBN" : 4582546494267, - "title" : "Macbeth", + "title" : "Macbeth", "author" : {"given_name": "William", "family_name": "Shakespeare"}, "year" : 1623}'), @@ -130,7 +129,7 @@ insert into books(k, doc) values ``` {{< note title="Note" >}} -Some of the rows in the example have some of the keys missing (intentional). But the row with "k=6" has every key. +Some of the rows in the example have some of the keys missing (intentional). But the row with "k=6" has every key. {{< /note >}} ## 2. Query JSON documents @@ -164,8 +163,8 @@ YSQL has two native operators, the `->` opertator (see [this section)](../../../ The example below shows how to select a few attributes from each document. ```plpgsql -SELECT doc->'title' AS book_title, - CONCAT(doc->'author'->'family_name', +SELECT doc->'title' AS book_title, + CONCAT(doc->'author'->'family_name', ', ', doc->'author'->'given_name') AS author FROM books; ``` @@ -189,7 +188,7 @@ yugabyte-# FROM books; Because the -> operator returns an object, you can chain it to inspect deep into a JSON document, as shown below. ```plpgsql -select '{"title": "Macbeth", "author": {"given_name": "William"}}'::jsonb +select '{"title": "Macbeth", "author": {"given_name": "William"}}'::jsonb -> 'author' -> 'given_name' as first_name; ``` @@ -209,8 +208,8 @@ yugabyte=# select '{"title": "Macbeth", "author": {"given_name": "William"}}'::j The `?` operator (see [this section](../../../api/ysql/datatypes/type_json/functions-operators/key-or-value-existence-operators/#the-160-160-160-160-operator)) can be used to check if a JSON document contains a certain attribute. For example, if you want to find a count of the records where the `doc` column contains a property named *genre*, run the following statement. ```plpgsql -SELECT doc->'title' AS book_title, - doc->'genre' as genre +SELECT doc->'title' AS book_title, + doc->'genre' as genre FROM books WHERE doc ? 'genre'; ``` @@ -234,10 +233,10 @@ yugabyte-# FROM books WHERE doc ? 'genre'; The containment operator `@>` (see [this section](../../../api/ysql/datatypes/type_json/functions-operators/containment-operators/)) tests whether one document contains another. If you want to find all books that contain the JSON value `{"author": {"given_name": "William"}}` (in other words, the author of the book has the given name *William*), do this: ```plpgsql -SELECT doc->'title' AS book_title, - CONCAT(doc->'author'->'family_name', +SELECT doc->'title' AS book_title, + CONCAT(doc->'author'->'family_name', ', ', doc->'author'->'given_name') AS author - FROM books + FROM books WHERE doc @> '{"author": {"given_name": "William"}}'::jsonb; ``` @@ -312,8 +311,8 @@ yugabyte=# SELECT doc->'title' AS title, doc->'stock' as stock FROM books; To replace an entire document, run the following SQL statement. ```plpgsql -UPDATE books - SET doc = '{"ISBN": 4582546494267, "year": 1623, "title": "Macbeth", "author": {"given_name": "William", "family_name": "Shakespeare"}}' +UPDATE books + SET doc = '{"ISBN": 4582546494267, "year": 1623, "title": "Macbeth", "author": {"given_name": "William", "family_name": "Shakespeare"}}' WHERE k=1; ``` @@ -408,7 +407,7 @@ You can create constraint on `jsonb` data types. Here are a couple of examples. Here's how to insist that each JSON document is an object: ```plpgsql -alter table books +alter table books add constraint books_doc_is_object check (jsonb_typeof(doc) = 'object'); ``` @@ -418,8 +417,8 @@ check (jsonb_typeof(doc) = 'object'); Here's how to insist that the ISBN is always defined and is a positive 13-digit number: ```plpgsql -alter table books -add constraint books_isbn_is_positive_13_digit_number +alter table books +add constraint books_isbn_is_positive_13_digit_number check ( (doc->'ISBN') is not null and @@ -442,7 +441,7 @@ Indexes are essential to perform efficient lookups by document attributes. Witho If you want to support range queries that reference the value for the *year* attribute, do this: ```plpgsql -CREATE INDEX books_year +CREATE INDEX books_year ON books (((doc->>'year')::int) ASC) WHERE doc->>'year' is not null; ``` @@ -467,7 +466,7 @@ You might want to index only those documents that contain the attribute (as oppo In the previous section where you created a secondary index, not all the books may have the `year` attribute defined. Suppose that you want to index only those documents that have a `NOT NULL` `year` attribute create the following partial index: ```plpgsql -CREATE INDEX books_year +CREATE INDEX books_year ON books ((doc->>'year') ASC) WHERE doc->>'year' IS NOT NULL; ``` @@ -483,8 +482,8 @@ create unique index books_isbn_unq on books((doc->>'ISBN')); Inserting a row with a duplicate value would fail as shown below. The book has a new primary key `k` but an existing ISBN, `4582546494267`. ```plpgsql -yugabyte=# insert into books values - (7, '{ "ISBN" : 4582546494267, +yugabyte=# insert into books values + (7, '{ "ISBN" : 4582546494267, "title" : "Fake Book with duplicate ISBN" }'); ERROR: 23505: duplicate key value violates unique constraint "books_isbn_unq" ``` diff --git a/docs/content/latest/explore/linear-scalability/_index.md b/docs/content/latest/explore/linear-scalability/_index.md index fcaea5619a6c..de785e2e88c3 100644 --- a/docs/content/latest/explore/linear-scalability/_index.md +++ b/docs/content/latest/explore/linear-scalability/_index.md @@ -56,7 +56,7 @@ The various features are explained in these sections:
                                            - +
                                            Scaling transactions per second
                                            diff --git a/docs/content/latest/explore/linear-scalability/scaling-transactions.md b/docs/content/latest/explore/linear-scalability/scaling-transactions.md index adcb72493520..5cfb7b922f10 100644 --- a/docs/content/latest/explore/linear-scalability/scaling-transactions.md +++ b/docs/content/latest/explore/linear-scalability/scaling-transactions.md @@ -17,14 +17,14 @@ showAsideToc: true
                                            • - + YSQL
                                              • +By default, new standard clusters are provisioned with a **stable** release, from the YugabyteDB [stable release](../../releases/stable-release/) series. Once a cluster is created, it is upgraded with releases from the release track that was assigned at creation (that is, either edge or stable). @@ -104,7 +104,7 @@ To view the database version running on a particular cluster, navigate to the ** ### Can I test YugabyteDB locally? -To test locally, [download](https://download.yugabyte.com) and install YugabyteDB on a local machine. Refer to [Quick Start](../../quick-start). For accurate comparison with cloud, be sure to download the version that is running on Yugabyte Cloud. +To test locally, [download](https://download.yugabyte.com) and install YugabyteDB on a local machine. Refer to [Quick Start](../../quick-start/). For accurate comparison with cloud, be sure to download the version that is running on Yugabyte Cloud. ## Support @@ -157,10 +157,10 @@ For multi-region deployments, including [synchronous replication](../../explore/ You can connect to clusters in the following ways: Cloud Shell -: Run the [ysqlsh](../../admin/ysqlsh) or [ycqlsh](../../admin/ycqlsh) shell from your browser to connect to and interact with your YugabyteDB database. Cloud Shell does not require a CA certificate or any special network access configured. +: Run the [ysqlsh](../../admin/ysqlsh/) or [ycqlsh](../../admin/ycqlsh) shell from your browser to connect to and interact with your YugabyteDB database. Cloud Shell does not require a CA certificate or any special network access configured. Client Shell -: Connect to your YugabyteDB cluster using the YugabyteDB [ysqlsh](../../admin/ysqlsh) and [ycqlsh](../../admin/ycqlsh) client shells installed on your computer. +: Connect to your YugabyteDB cluster using the YugabyteDB [ysqlsh](../../admin/ysqlsh/) and [ycqlsh](../../admin/ycqlsh) client shells installed on your computer. : Before you can connect using a client shell, you need to add your computer to the cluster IP allow list. Refer to [Assign IP Allow Lists](../cloud-secure-clusters/add-connections/). @@ -189,7 +189,7 @@ psql : For detailed steps for configuring other popular third party tools, see [Third party tools](../../tools/). Applications -: Applications connect to and interact with YugabyteDB using API client libraries (also known as client drivers). Before you can connect an application, you need to install the correct driver. Clusters have SSL (encryption in-transit) enabled so make sure your driver details include SSL parameters. For information on available drivers, refer to [Build an application](../../quick-start/build-apps). +: Applications connect to and interact with YugabyteDB using API client libraries (also known as client drivers). Before you can connect an application, you need to install the correct driver. Clusters have SSL (encryption in-transit) enabled so make sure your driver details include SSL parameters. For information on available drivers, refer to [Build an application](../../quick-start/build-apps/). : Before you can connect, your application has to be able to reach your Yugabyte Cloud. To add inbound network access from your application environment to Yugabyte Cloud, add the public IP addresses to the [cluster IP access list](../cloud-secure-clusters/add-connections/), or use [VPC peering](../cloud-basics/cloud-vpcs/) to add private IP addresses. diff --git a/docs/content/latest/yugabyte-cloud/cloud-overview.md b/docs/content/latest/yugabyte-cloud/cloud-overview.md index 753650be60c1..4d4faa7dc078 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-overview.md +++ b/docs/content/latest/yugabyte-cloud/cloud-overview.md @@ -28,17 +28,17 @@ Learn the basics of using YugabyteDB clusters in Yugabyte Cloud. : Create single region clusters that can be deployed across multiple and single availability zones. (To deploy multi-region clusters, contact [Yugabyte Support](https://support.yugabyte.com/hc/en-us/requests/new?ticket_form_id=360003113431).) : Create virtual private cloud (VPC) networks to peer clusters with application VPCs. -[Secure](../cloud-secure-clusters) +[Secure](../cloud-secure-clusters/) : Manage the security features of your clusters, including network authorization, database authorization, encryption, and auditing. : Use IP allow lists to manage access to clusters. -[Connect](../cloud-connect) +[Connect](../cloud-connect/) : Connect to clusters from a browser using Cloud Shell, from your desktop using a shell, and from applications. -[Alerts and monitoring](../cloud-monitor) +[Alerts and monitoring](../cloud-monitor/) : Monitor cluster performance and get notified of potential problems. -[Manage](../cloud-clusters) +[Manage](../cloud-clusters/) : Scale vertically and horizontally to match your performance requirements. : Back up and restore clusters. @@ -46,22 +46,22 @@ Learn the basics of using YugabyteDB clusters in Yugabyte Cloud. Learn about managing your Yugabyte Cloud account. -[Add cloud users](../cloud-admin/manage-access) +[Add cloud users](../cloud-admin/manage-access/) : Invite team members to your cloud. -[Manage billing](../cloud-admin/cloud-billing-profile) +[Manage billing](../cloud-admin/cloud-billing-profile/) : Create your billing profile, manage your payment methods, and review invoices. ## Reference -[What's new](../release-notes) +[What's new](../release-notes/) : See what's new in Yugabyte Cloud, what regions are supported, and known issues. -[Troubleshooting](../cloud-troubleshoot) +[Troubleshooting](../cloud-troubleshoot/) : Get solutions to common problems. -[FAQ](../cloud-faq) +[FAQ](../cloud-faq/) : Get answers to frequently asked questions. -[Security architecture](../cloud-security) +[Security architecture](../cloud-security/) : Review Yugabyte Cloud's security architecture and shared responsibility model. diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/_index.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/_index.md index 25a891bc5583..dc06d999e370 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/_index.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/_index.md @@ -16,7 +16,7 @@ menu: Applications connect to and interact with YugabyteDB using API client libraries (also known as client drivers). The tutorials in this section show how to connect applications to Yugabyte Cloud clusters using available drivers and ORMs. -Because the YugabyteDB YSQL API is PostgreSQL-compatible, and the YCQL API has roots in the Apache Cassandra CQL, YugabyteDB supports many third-party drivers. For details about supported client drivers (by programming language), see Drivers. +Because the YugabyteDB YSQL API is PostgreSQL-compatible, and the YCQL API has roots in the Apache Cassandra CQL, YugabyteDB supports many third-party drivers. For details about supported client drivers (by programming language), see Drivers. For more advanced applications, including Spring and GraphQL examples, refer to [Example applications](../../cloud-examples/). diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-c.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-c.md index ce4b96420eed..b0ebe8c2f98e 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-c.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-c.md @@ -150,7 +150,7 @@ if (PQresultStatus(res) != PGRES_TUPLES_OK) { } for (i = 0; i < PQntuples(res); i++) { - printf("name = %s, age = %s, country = %s, balance = %s\n", + printf("name = %s, age = %s, country = %s, balance = %s\n", PQgetvalue(res, i, 0), PQgetvalue(res, i, 1), PQgetvalue(res, i, 2), PQgetvalue(res, i, 3)); } ``` @@ -185,7 +185,7 @@ if (PQresultStatus(res) != PGRES_COMMAND_OK) { [libpq driver](../../../../reference/drivers/ysql-client-drivers/#libpq) -[Explore more applications](../../../cloud-examples) +[Explore more applications](../../../cloud-examples/) [Deploy clusters in Yugabyte Cloud](../../../cloud-basics) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-cpp.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-cpp.md index 1e6dfbfc27d9..9309356cb12c 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-cpp.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-cpp.md @@ -61,7 +61,7 @@ Build the application with gcc or clang. ```sh g++ -std=c++17 sample-app.cpp -o sample-app -lpqxx -lpq \ -I/libpq/include -I/libpqxx/include \ --L/libpq/lib -L/libpqxx/lib +-L/libpq/lib -L/libpqxx/lib ``` Replace `` with the path to the libpq installation, and `` with the path to the libpqxx installation; for example, `/usr/local/opt`. @@ -146,7 +146,7 @@ The `selectAccounts` method queries your distributed data using the SQL `SELECT` res = txn.exec("SELECT name, age, country, balance FROM DemoAccount"); for (auto row: res) { - std::cout + std::cout << "name=" << row["name"].c_str() << ", " << "age=" << row["age"].as() << ", " << "country=" << row["country"].c_str() << ", " @@ -162,10 +162,10 @@ The `transferMoneyBetweenAccounts` method updates your data consistently with di try { pqxx::work txn(*conn); - txn.exec("UPDATE DemoAccount SET balance = balance -" + std::to_string(amount) + txn.exec("UPDATE DemoAccount SET balance = balance -" + std::to_string(amount) + " WHERE name = \'Jessica\'"); - txn.exec("UPDATE DemoAccount SET balance = balance +" + std::to_string(amount) + txn.exec("UPDATE DemoAccount SET balance = balance +" + std::to_string(amount) + " WHERE name = \'John\'"); txn.commit(); @@ -173,10 +173,10 @@ try { std::cout << ">>>> Transferred " << amount << " between accounts." << std::endl; } catch (pqxx::sql_error const &e) { if (e.sqlstate().compare("40001") == 0) { - std::cerr << "The operation is aborted due to a concurrent transaction that is modifying the same set of rows." + std::cerr << "The operation is aborted due to a concurrent transaction that is modifying the same set of rows." << "Consider adding retry logic for production-grade applications." << std::endl; } - throw e; + throw e; } ``` @@ -186,7 +186,7 @@ try { [libpqxx driver](../../../../reference/drivers/ysql-client-drivers/#libpqxx) -[Explore more applications](../../../cloud-examples) +[Explore more applications](../../../cloud-examples/) [Deploy clusters in Yugabyte Cloud](../../../cloud-basics) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-csharp.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-csharp.md index db4672ff1073..7b194aec78fb 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-csharp.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-csharp.md @@ -152,11 +152,11 @@ try { NpgsqlTransaction tx = conn.BeginTransaction(); - NpgsqlCommand query = new NpgsqlCommand("UPDATE DemoAccount SET balance = balance - " + + NpgsqlCommand query = new NpgsqlCommand("UPDATE DemoAccount SET balance = balance - " + amount + " WHERE name = \'Jessica\'", conn, tx); query.ExecuteNonQuery(); - query = new NpgsqlCommand("UPDATE DemoAccount SET balance = balance + " + + query = new NpgsqlCommand("UPDATE DemoAccount SET balance = balance + " + amount + " WHERE name = \'John\'", conn, tx); query.ExecuteNonQuery(); @@ -164,9 +164,9 @@ try Console.WriteLine(">>>> Transferred " + amount + " between accounts"); -} catch (NpgsqlException ex) +} catch (NpgsqlException ex) { - if (ex.SqlState != null && ex.SqlState.Equals("40001")) + if (ex.SqlState != null && ex.SqlState.Equals("40001")) { Console.WriteLine("The operation is aborted due to a concurrent transaction that is modifying the same set of rows." + "Consider adding retry logic for production-grade applications."); @@ -180,7 +180,7 @@ try [Npgsql driver](../../../../reference/drivers/ysql-client-drivers/#npgsql) -[Explore more applications](../../../cloud-examples) +[Explore more applications](../../../cloud-examples/) [Deploy clusters in Yugabyte Cloud](../../../cloud-basics) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-go.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-go.md index c1361cb3d1b8..0aa412e5f610 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-go.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-go.md @@ -188,7 +188,7 @@ if checkIfTxAborted(err) { [Go PostgreSQL driver](../../../../reference/drivers/ysql-client-drivers/#go-postgresql-driver-pq) -[Explore more applications](../../../cloud-examples) +[Explore more applications](../../../cloud-examples/) [Deploy clusters in Yugabyte Cloud](../../../cloud-basics) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-node.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-node.md index 0c46e732e0c4..5c53594482e2 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-node.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-node.md @@ -129,7 +129,7 @@ try { stmt = `INSERT INTO DemoAccount VALUES (1, 'Jessica', 28, 'USA', 10000), (2, 'John', 28, 'Canada', 9000)`; - + await client.query(stmt); console.log('>>>> Successfully created table DemoAccount.'); @@ -186,7 +186,7 @@ try { [node-postgres module](../../../../reference/drivers/ysql-client-drivers/#node-postgres) -[Explore more applications](../../../cloud-examples) +[Explore more applications](../../../cloud-examples/) [Deploy clusters in Yugabyte Cloud](../../../cloud-basics) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-php.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-php.md index 25eefd9cde93..cbc282444425 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-php.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-php.md @@ -102,15 +102,15 @@ The `create_database` method uses PostgreSQL-compliant DDL commands to create a ```php $conn->exec('DROP TABLE IF EXISTS DemoAccount'); -$conn->exec('CREATE TABLE DemoAccount ( - id int PRIMARY KEY, - name varchar, - age int, - country varchar, +$conn->exec('CREATE TABLE DemoAccount ( + id int PRIMARY KEY, + name varchar, + age int, + country varchar, balance int)'); -$conn->exec("INSERT INTO DemoAccount VALUES - (1, 'Jessica', 28, 'USA', 10000), +$conn->exec("INSERT INTO DemoAccount VALUES + (1, 'Jessica', 28, 'USA', 10000), (2, 'John', 28, 'Canada', 9000)"); ``` @@ -142,7 +142,7 @@ try { print "The operation is aborted due to a concurrent transaction that is modifying the same set of rows. Consider adding retry logic for production-grade applications.\n"; } - + throw $e; } ``` @@ -151,7 +151,7 @@ try { [php-pgsql driver](../../../../reference/drivers/ysql-client-drivers/#php-pgsql) -[Explore more applications](../../../cloud-examples) +[Explore more applications](../../../cloud-examples/) [Deploy clusters in Yugabyte Cloud](../../../cloud-basics) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-python.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-python.md index 8d6b78eb58f8..8b32f9b31326 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-python.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-python.md @@ -182,7 +182,7 @@ except (Exception, psycopg2.DatabaseError) as e: [Python psycopg2 PostgreSQL database adapter](../../../../reference/drivers/ysql-client-drivers/#psycopg2) -[Explore more applications](../../../cloud-examples) +[Explore more applications](../../../cloud-examples/) [Deploy clusters in Yugabyte Cloud](../../../cloud-basics) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-ruby.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-ruby.md index fbedd35c04cb..dda36810a3d2 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-ruby.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-ruby.md @@ -173,7 +173,7 @@ end [libpq driver](../../../../reference/drivers/ysql-client-drivers/#libpq) -[Explore more applications](../../../cloud-examples) +[Explore more applications](../../../cloud-examples/) [Deploy clusters in Yugabyte Cloud](../../../cloud-basics) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-rust.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-rust.md index ca01be65da43..304dc7ad83a6 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-rust.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-rust.md @@ -111,7 +111,7 @@ client.execute("CREATE TABLE DemoAccount ( country varchar, balance int)", &[])?; -client.execute("INSERT INTO DemoAccount VALUES +client.execute("INSERT INTO DemoAccount VALUES (1, 'Jessica', 28, 'USA', 10000), (2, 'John', 28, 'Canada', 9000)", &[])?; ``` @@ -127,7 +127,7 @@ for row in client.query("SELECT name, age, country, balance FROM DemoAccount", & let country: &str = row.get("country"); let balance: i32 = row.get("balance"); - println!("name = {}, age = {}, country = {}, balance = {}", + println!("name = {}, age = {}, country = {}, balance = {}", name, age, country, balance); } ``` @@ -152,7 +152,7 @@ let exec_txn = || -> Result<(), DBError> { [Rust-Postgres driver](../../../../reference/drivers/ysql-client-drivers/#rust-postgres) -[Explore more applications](../../../cloud-examples) +[Explore more applications](../../../cloud-examples/) [Deploy clusters in Yugabyte Cloud](../../../cloud-basics) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-yb-jdbc.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-yb-jdbc.md index 5054b48ca7e6..74f6655a1d4a 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-yb-jdbc.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/cloud-build-apps/cloud-ysql-yb-jdbc.md @@ -175,7 +175,7 @@ try { [Yugabyte JDBC driver](../../../../integrations/jdbc-driver/) -[Explore more applications](../../../cloud-examples) +[Explore more applications](../../../cloud-examples/) [Sample Java application demonstrating load balancing](../../../../quick-start/build-apps/java/ysql-yb-jdbc/) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/qs-connect.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/qs-connect.md index c6de29901754..6208a4a2e4e3 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/qs-connect.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/qs-connect.md @@ -34,7 +34,7 @@ To connect to your cluster, do the following: Cloud Shell opens in a separate browser window. Cloud Shell can take up to 30 seconds to be ready. ```output - Password for user admin: + Password for user admin: ``` 1. Enter the password for the admin user credentials that you saved when you created the cluster.\ @@ -63,4 +63,4 @@ For information on other ways to connect to your cluster, refer to [Connect to c ## Next step -[Create a database and load data](../qs-data) +[Create a database and load data](../qs-data/) diff --git a/docs/content/latest/yugabyte-cloud/cloud-quickstart/qs-data.md b/docs/content/latest/yugabyte-cloud/cloud-quickstart/qs-data.md index 4a4620b5100f..b6ede163fa62 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-quickstart/qs-data.md +++ b/docs/content/latest/yugabyte-cloud/cloud-quickstart/qs-data.md @@ -186,4 +186,4 @@ To add additional users to your database, refer to [Add database users](../../cl ## Next step -[Explore distributed SQL](../qs-explore) +[Explore distributed SQL](../qs-explore/) diff --git a/docs/content/latest/yugabyte-cloud/cloud-secure-clusters/cloud-users.md b/docs/content/latest/yugabyte-cloud/cloud-secure-clusters/cloud-users.md index 393b3836bf2b..65606767737e 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-secure-clusters/cloud-users.md +++ b/docs/content/latest/yugabyte-cloud/cloud-secure-clusters/cloud-users.md @@ -13,7 +13,7 @@ isTocNested: true showAsideToc: true --- -To manage database access and authorization, YugabyteDB uses [role-based access control](../../../secure/authorization) (RBAC), consisting of a collection of privileges on resources given to roles. +To manage database access and authorization, YugabyteDB uses [role-based access control](../../../secure/authorization/) (RBAC), consisting of a collection of privileges on resources given to roles. Clusters in Yugabyte Cloud include a set of default users and roles in YSQL and YCQL. diff --git a/docs/content/latest/yugabyte-cloud/cloud-security/cloud-security-features.md b/docs/content/latest/yugabyte-cloud/cloud-security/cloud-security-features.md index 95c9ac0e65e5..542597e9f41f 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-security/cloud-security-features.md +++ b/docs/content/latest/yugabyte-cloud/cloud-security/cloud-security-features.md @@ -24,7 +24,7 @@ Yugabyte Cloud uses both encryption in transit and encryption at rest to protect All communication between Yugabyte Cloud architecture domains is encrypted in transit using TLS. Likewise, all communication between clients or applications and clusters is encrypted in transit. Every cluster has its own certificates, generated when the cluster is created and signed by the Yugabyte internal PKI. Root and intermediate certificates are not extractable from the hardware security appliances. -Data at rest, including clusters and backups, is AES-256 encrypted using native cloud provider technologies - S3 and EBS volume encryption for AWS, and server-side and persistent disk encryption for GCP. Encryption keys are managed by the cloud provider and anchored by hardware security appliances. Customers can enable [column-level encryption](../../../secure/column-level-encryption) as an additional security control. +Data at rest, including clusters and backups, is AES-256 encrypted using native cloud provider technologies - S3 and EBS volume encryption for AWS, and server-side and persistent disk encryption for GCP. Encryption keys are managed by the cloud provider and anchored by hardware security appliances. Customers can enable [column-level encryption](../../../secure/column-level-encryption/) as an additional security control. Yugabyte Cloud provides DDoS and application layer protection, and automatically blocks network protocol and volumetric DDoS attacks. diff --git a/docs/content/latest/yugabyte-cloud/cloud-troubleshoot.md b/docs/content/latest/yugabyte-cloud/cloud-troubleshoot.md index 17e9e06b42eb..2784f6a9971a 100644 --- a/docs/content/latest/yugabyte-cloud/cloud-troubleshoot.md +++ b/docs/content/latest/yugabyte-cloud/cloud-troubleshoot.md @@ -81,7 +81,7 @@ If you are unable to successfully create the VPC, contact {{}}. #### Peering connection status is Pending -A peering connection status of _Pending_ indicates that you need to configure your cloud provider to accept the connection. Refer to [Create a peering connection](../cloud-basics/cloud-vpcs/cloud-add-peering). +A peering connection status of _Pending_ indicates that you need to configure your cloud provider to accept the connection. Refer to [Create a peering connection](../cloud-basics/cloud-vpcs/cloud-add-peering/). #### Peering connection status is Expired (AWS only) diff --git a/docs/content/latest/yugabyte-cloud/release-notes.md b/docs/content/latest/yugabyte-cloud/release-notes.md index d46966109029..155db99b38b7 100644 --- a/docs/content/latest/yugabyte-cloud/release-notes.md +++ b/docs/content/latest/yugabyte-cloud/release-notes.md @@ -86,7 +86,7 @@ showAsideToc: true #### New features -- Ability to [create clusters](../cloud-basics/create-clusters) suitable for production workloads. Yugabyte Cloud clusters support horizontal and vertical scaling, VPC peering, and scheduled and manual backups. +- Ability to [create clusters](../cloud-basics/create-clusters/) suitable for production workloads. Yugabyte Cloud clusters support horizontal and vertical scaling, VPC peering, and scheduled and manual backups. - Billing support. Set up a billing profile, manage payment methods, and review invoices on the [Billing](../cloud-admin/cloud-billing-profile) tab. (You must create a billing profile and add a payment method before you can create any clusters apart from your free cluster.) ### September 8, 2021 diff --git a/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/back-up-restore-k8s.md b/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/back-up-restore-k8s.md index 25a01ce2d9cc..c7dad4f6220d 100644 --- a/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/back-up-restore-k8s.md +++ b/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/back-up-restore-k8s.md @@ -3,7 +3,6 @@ title: Back Up and Restore Yugabyte Platform on Kubernetes headerTitle: Back Up and Restore Yugabyte Platform on Kubernetes description: Use a script file to back up and restore Yugabyte Platform on Kubernetes. linkTitle: Back Up Yugabyte Platform -aliases: menu: latest: identifier: back-up-restore-k8s @@ -16,14 +15,14 @@ showAsideToc: true
                                              • - + Default
                                              • - + Kubernetes @@ -119,4 +118,4 @@ To restore the Yugabyte Platform content from your saved backup, perform the fol *verbose* prints debug output.
                                                -Upon completion of the preceding steps, the restored Yugabyte Platform is ready to continue orchestrating and managing your universes and clusters. \ No newline at end of file +Upon completion of the preceding steps, the restored Yugabyte Platform is ready to continue orchestrating and managing your universes and clusters. diff --git a/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/back-up-restore-yp.md b/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/back-up-restore-yp.md index 8809a40c43ae..82bb4d4b22be 100644 --- a/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/back-up-restore-yp.md +++ b/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/back-up-restore-yp.md @@ -3,8 +3,6 @@ title: Back Up and Restore Yugabyte Platform headerTitle: Back Up and Restore Yugabyte Platform linkTitle: Back Up Yugabyte Platform description: Use a script file to back up and restore Yugabyte Platform. -aliases: - - /latest/manage/enterprise-edition/back-up-restore-yp menu: latest: identifier: back-up-restore-yp @@ -16,14 +14,14 @@ showAsideToc: true
                                                • - + Default
                                                • - + Kubernetes @@ -88,4 +86,3 @@ To restore the Yugabyte Platform content from your saved backup, perform the fol *destination* is optional. It specifies the output location for data. Default is `/opt/yugabyte`. Upon completion of the preceding steps, the restored Yugabyte Platform is ready to continue orchestrating and managing your universes and clusters. - diff --git a/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/ldap-authentication.md b/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/ldap-authentication.md index fb7535dce64a..d4e0a65ca3fd 100644 --- a/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/ldap-authentication.md +++ b/docs/content/latest/yugabyte-platform/administer-yugabyte-platform/ldap-authentication.md @@ -3,7 +3,6 @@ title: Enable Yugabyte Platform authentication via LDAP headerTitle: Enable Yugabyte Platform authentication via LDAP description: Use LDAP to enable login to Yugabyte Platform. linkTitle: Authenticate with LDAP -aliases: menu: latest: identifier: ldap-authentication @@ -15,7 +14,7 @@ showAsideToc: true LDAP provides means for querying directory services. A directory typically stores credentials and permissions assigned to a user, therefore allowing to maintain a single repository of user information for all applications across the organization. In addition, having a hierarchical structure, LDAP allows creation of user groups requiring the same credentials. -LDAP authentication is similar to a direct password authentication, except that it employs the LDAP protocol to verify the password. This means that only users who already exist in the database and have appropriate permissions can be authenticated via LDAP. +LDAP authentication is similar to a direct password authentication, except that it employs the LDAP protocol to verify the password. This means that only users who already exist in the database and have appropriate permissions can be authenticated via LDAP. Yugabyte Platform's integration with LDAP enables you to use your LDAP server for authentication purposes instead of having to create user accounts on Yugabyte Platform. @@ -27,7 +26,7 @@ If configured by the LDAP server, Yugabyte Platform can prevent the user from be You can use the Yugabyte Platform UI console to enable LDAP authentication for Yugabyte Platform login, as follows: -- Navigate to **Admin > User Management > User Authentication**. +- Navigate to **Admin > User Management > User Authentication**. - Complete the fields in the **LDAP Configuration** page shown in the following illustration:

                                                  @@ -50,7 +49,6 @@ To enable LDAP authentication for Yugabyte Platform login, you can perform a num --data-raw 'true' ``` - - Your LDAP server endpoint `yb.security.ldap.ldap_url`, set using the *0.0.0.0* format, as follows: ```shell @@ -124,7 +122,7 @@ To enable LDAP authentication for Yugabyte Platform login, you can perform a num --data-raw 'true' ``` -
                                                  If the port is configured for an SSL connection, then you can enable SSL when you configure the LDAP server on Yugabyte Platform. +
                                                  If the port is configured for an SSL connection, then you can enable SSL when you configure the LDAP server on Yugabyte Platform. - TLS usage with LDAP `yb.security.ldap.enable_ldap_start_tls`, set to `true` or `false` (default), as follows: @@ -136,7 +134,7 @@ To enable LDAP authentication for Yugabyte Platform login, you can perform a num --data-raw 'true' ``` -
                                                  If the port is configured for a TLS connection, then you can enable StartTLS when you configure the LDAP server on Yugabyte Platform. +
                                                  If the port is configured for a TLS connection, then you can enable StartTLS when you configure the LDAP server on Yugabyte Platform. By default, if neither `ldap.enable_ldaps` or `ldap.enable_ldap_start_tls` is enabled, the connection will be unsecured. @@ -178,4 +176,4 @@ You need to define a Yugabyte Platform-specific role for each user on your LDAP If the role is not specified, users are created with ReadOnly privileges by default, which can be modified by the local super admin. -When LDAP is set up on a Windows Active Directory (AD) server, the user is expected to have permissions to query the user's properties from that server. If the permissions have not been granted, Yugabyte Platform defaults its role to ReadOnly, which can later be modified by the local super admin. \ No newline at end of file +When LDAP is set up on a Windows Active Directory (AD) server, the user is expected to have permissions to query the user's properties from that server. If the permissions have not been granted, Yugabyte Platform defaults its role to ReadOnly, which can later be modified by the local super admin. diff --git a/docs/content/latest/yugabyte-platform/back-up-restore-universes/back-up-universe-data/ysql.md b/docs/content/latest/yugabyte-platform/back-up-restore-universes/back-up-universe-data/ysql.md index f09110590917..a987e12cbe06 100644 --- a/docs/content/latest/yugabyte-platform/back-up-restore-universes/back-up-universe-data/ysql.md +++ b/docs/content/latest/yugabyte-platform/back-up-restore-universes/back-up-universe-data/ysql.md @@ -37,7 +37,7 @@ showAsideToc: true Use Yugabyte Platform to back up your YugabyteDB universe YSQL data. -To schedule backups for a later time, or as a recurring task, see [Schedule universe YSQL data backups](../../schedule-data-backups/ysql). +To schedule backups for a later time, or as a recurring task, see [Schedule universe YSQL data backups](../../schedule-data-backups/ysql/). To immediately back up your YugabyteDB universe YSQL data, perform the following: diff --git a/docs/content/latest/yugabyte-platform/back-up-restore-universes/schedule-data-backups/ysql.md b/docs/content/latest/yugabyte-platform/back-up-restore-universes/schedule-data-backups/ysql.md index 2bc4be269457..2c752194678a 100644 --- a/docs/content/latest/yugabyte-platform/back-up-restore-universes/schedule-data-backups/ysql.md +++ b/docs/content/latest/yugabyte-platform/back-up-restore-universes/schedule-data-backups/ysql.md @@ -34,9 +34,9 @@ showAsideToc: true
                                                -Use Yugabyte Platform to perform regularly scheduled backups of YugabyteDB universe data for all YSQL tables in a namespace. +Use Yugabyte Platform to perform regularly scheduled backups of YugabyteDB universe data for all YSQL tables in a namespace. -To back up your universe YSQL data immediately, see [Back up universe YSQL data](../../back-up-universe-data/ysql). +To back up your universe YSQL data immediately, see [Back up universe YSQL data](../../back-up-universe-data/ysql/). ## Schedule a backup @@ -74,6 +74,6 @@ To temporarily disable all scheduled backups: To permanently remove a scheduled backup: -1. Go to the **Backups** tab for the universe. +1. Go to the **Backups** tab for the universe. 2. Find the scheduled backup and click **Options**. 3. Click **Delete schedule**. The scheduled backup is deleted. diff --git a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/aws.md b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/aws.md index 703c4cf517d3..c1c0b3318a05 100644 --- a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/aws.md +++ b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/aws.md @@ -19,47 +19,47 @@ showAsideToc: true
                                                • - + AWS
                                                • - + GCP
                                                • - +    Azure
                                                • - + Kubernetes
                                                • - + VMware Tanzu
                                                • - + OpenShift
                                                • - + On-premises @@ -88,7 +88,7 @@ Provider name is an internal tag used for organizing your providers, so you know In order to deploy YugabyteDB nodes in your AWS account, Yugabyte Platform requires access to a set of cloud credentials which can be provided in one of the following ways: - Directly provide your [AWS Access Key ID and Secret Key](http://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html). -- Attach an [IAM role](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) to the Yugabyte Platform VM in the **EC2** tab. For more information, see [Deploy the YugabyteDB universe using an IAM role](../../../install-yugabyte-platform/prepare-environment/aws/#deploy-the-yugabytedb-universe-using-an-iam-role). +- Attach an [IAM role](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) to the Yugabyte Platform VM in the **EC2** tab. For more information, see [Deploy the YugabyteDB universe using an IAM role](../../../install-yugabyte-platform/prepare-environment/aws/#deploy-the-yugabytedb-universe-using-an-iam-role). ### SSH Key Pairs @@ -109,7 +109,7 @@ For deployment, Yugabyte Platform aims to provide you with easy access to the ma ### Yugabyte Platform-managed configuration -If you choose to use Yugabyte Platform to configure, own, and manage a full cross-region deployment of Virtual Private Cloud (VPC), Yugabyte Platform will generate a YugabyteDB-specific VPC in each selected region, then interconnect them, as well as the VPC in which Yugabyte Platform was deployed, using [VPC Peering](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-peering.html). This mode also sets up all other relevant subcomponents in all regions, such as Subnets, Security Groups, and Routing Table entries. +If you choose to use Yugabyte Platform to configure, own, and manage a full cross-region deployment of Virtual Private Cloud (VPC), Yugabyte Platform will generate a YugabyteDB-specific VPC in each selected region, then interconnect them, as well as the VPC in which Yugabyte Platform was deployed, using [VPC Peering](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-peering.html). This mode also sets up all other relevant subcomponents in all regions, such as Subnets, Security Groups, and Routing Table entries. You have an option to provide the following: @@ -119,7 +119,6 @@ You have an option to provide the following: ![New Region Modal](/images/ee/aws-setup/aws_new_region.png) - ### Self-managed configuration You can use your own custom VPCs. This allows you the highest level of customization for your VPC setup. You can provide the following: @@ -141,7 +140,7 @@ If you choose to provide your own VPC information, you will be responsible for h ### Ubuntu 18 and Oracle 8 support -In addition to CentOS, Yugabyte Platform allows you to bring up universes on the following host nodes: +In addition to CentOS, Yugabyte Platform allows you to bring up universes on the following host nodes: - Ubuntu 18.04, which requires Python 2 or later installed on the host, as well as the provider created with a custom AMI and custom SSH user. - Oracle 8, which requires the provider created with a custom AMI and custom SSH user, assumes that gtar or gunzip is present on the host AMI, and uses the firewall-cmd client to set default target `ACCEPT`. Yugabyte Platform support for Oracle 8 has the following limitations: diff --git a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/azure.md b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/azure.md index 325efa29778e..81ce575f9b89 100644 --- a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/azure.md +++ b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/azure.md @@ -17,47 +17,47 @@ showAsideToc: true
                                                  • - + AWS
                                                  • - + GCP
                                                  • - +    Azure
                                                  • - + Kubernetes
                                                  • - + VMware Tanzu
                                                  • - + OpenShift
                                                  • - + On-premises @@ -150,19 +150,19 @@ You can specify a region as follows: 1. Click **Add Region**. -2. Use the **Specify Region Info** dialog to select a region and provide a virtual network name from your Azure portal. +1. Use the **Specify Region Info** dialog to select a region and provide a virtual network name from your Azure portal. -3. Optionally, specify the security group, if the database VM is in a different network than the platform. +1. Optionally, specify the security group, if the database VM is in a different network than the platform. -4. Provide a URN to a marketplace image or a shared gallery image by following instructions provided in [How to use a shared image gallery](#how-to-use-a-shared-image-gallery). If you are using custom images, you need to specify the SSH port and user, as described in [Configure Azure](#configure-azure). +1. Provide a URN to a marketplace image or a shared gallery image by following instructions provided in [How to use a shared image gallery](#how-to-use-a-shared-image-gallery). If you are using custom images, you need to specify the SSH port and user, as described in [Configure Azure](#configure-azure). -5. Provide a mapping of subnet IDs to use for each availability zone you wish to deploy. This is required for ensuring that Yugabyte Platform can deploy nodes in the correct network isolation that you need in your environment. +1. Provide a mapping of subnet IDs to use for each availability zone you wish to deploy. This is required for ensuring that Yugabyte Platform can deploy nodes in the correct network isolation that you need in your environment. ![Prepare Azure cloud to install Yugabyte Platform](/images/yb-platform/install/azure/platform-azure-prepare-cloud-env-5.png) -6. Click **Add Region** on the **Specify Region Info** dialog. +1. Click **Add Region** on the **Specify Region Info** dialog. -7. Click **Save** on the **Cloud Provider Configuration** page. +1. Click **Save** on the **Cloud Provider Configuration** page. Typically, it takes a few minutes for the cloud provider to be configured. When the configuration completes, you will be ready to create a YugabyteDB universe on Azure. @@ -178,7 +178,7 @@ You set up a shared gallery image on Azure as follows: 1. Create a VM of which you want to take a snapshot. -1. Navigate to the VM and click **Capture** on the top menu. +1. Navigate to the VM and click **Capture** on the top menu. 1. Fill in the information and then choose the gallery and image definition you created in the previous steps, as per the following illustration:

                                                    diff --git a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/gcp.md b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/gcp.md index c9a397d02671..879079cabba8 100644 --- a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/gcp.md +++ b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/gcp.md @@ -17,47 +17,47 @@ showAsideToc: true
                                                    • - + AWS
                                                    • - + GCP
                                                    • - +    Azure
                                                    • - + Kubernetes
                                                    • - + VMware Tanzu
                                                    • - + OpenShift
                                                    • - + On-premises @@ -73,7 +73,7 @@ To run YugabyteDB nodes on GCP, all you need to provide on the Yugabyte Platform ## Configure GCP -You can configure GCP as follows: +You can configure GCP as follows: - Navigate to **Configs > Google Cloud Platform**. @@ -86,9 +86,9 @@ You can configure GCP as follows: - Upload the JSON file that you obtained when you created your service account, as described in [Prepare the Google Cloud Platform (GCP) environment](../../../install-yugabyte-platform/prepare-environment/gcp). - - If this is a new deployment, it is recommended that you use the **VPC Setup** field to create a new VPC specifically for YugabyteDB nodes. You have to ensure that the Yugabyte Platform host machine can connect to your Google Cloud account where this new VPC will be created. + - If this is a new deployment, it is recommended that you use the **VPC Setup** field to create a new VPC specifically for YugabyteDB nodes. You have to ensure that the Yugabyte Platform host machine can connect to your Google Cloud account where this new VPC will be created. -
                                                      Alternatively, you may choose to specify an existing VPC for YugabyteDB nodes, in which case you would need to map regions by providing the following: +
                                                      Alternatively, you may choose to specify an existing VPC for YugabyteDB nodes, in which case you would need to map regions by providing the following: - A region name. - A subnet ID. @@ -96,7 +96,7 @@ You can configure GCP as follows: The third option that is available only when your Yugabyte Platform host machine is also running on Google Cloud, is to use the same VPC on which the Yugabyte Platform host machine runs. Note that choosing to use the same VPC as Yugabyte Platform is an advanced option, which assumes that you are in complete control over this VPC and will be responsible for setting up the networking, SSH access, and firewall rules for it. -- Click **Save** and wait for the configuration to complete. +- Click **Save** and wait for the configuration to 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 Yugabyte Platform-to-YugabyteDB connectivity. diff --git a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/kubernetes.md b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/kubernetes.md index 633a5696cdd4..3cd0b39911cd 100644 --- a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/kubernetes.md +++ b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/kubernetes.md @@ -17,47 +17,47 @@ showAsideToc: true
                                                      • - + AWS
                                                      • - + GCP
                                                      • - +    Azure
                                                      • - + Kubernetes
                                                      • - + VMware Tanzu
                                                      • - + OpenShift
                                                      • - + On-premises @@ -192,7 +192,7 @@ You can create a `kubeconfig` file for previously created `yugabyte-platform-uni ## Select the Kubernetes service -You can use the Pivotal Container Service or Managed Kubernetes Service. +You can use the Pivotal Container Service or Managed Kubernetes Service. Select the tab for the service you are using, as per the following illustration:

                                                        K8s Configuration -- Tabs @@ -242,7 +242,7 @@ Continue configuring your Kubernetes provider by clicking **Add Region** and com app: "yb-master" ports: ui: "7000" - + - name: "yb-tserver-service" type: "LoadBalancer" annotations: @@ -255,17 +255,17 @@ Continue configuring your Kubernetes provider by clicking **Add Region** and com ``` - Overrides to disable LoadBalancer: - + ```yml enableLoadBalancer: False ``` - + - Overrides to change the cluster domain name: - + ```yml domainName: my.cluster ``` - + - Overrides to add annotations at StatefulSet-level: ```yml @@ -275,7 +275,7 @@ Continue configuring your Kubernetes provider by clicking **Add Region** and com ``` - Overrides to add custom resource allocation for YB master and TServer pods and it overrides the instance types selected in the Yugabyte universe creation flow: - + ```yml resource: master: @@ -299,11 +299,11 @@ Continue configuring your Kubernetes provider by clicking **Add Region** and com ```yml istioCompatibility: enabled: true ``` - + - Overrides to publish Node-IP as the server broadcast address. - + By default, Master and T-Server pod fully-qualified domain names (FQDNs) are used within the cluster as the server broadcast address. To publish the IPs of the nodes on which YugabyteDB TServer pods are deployed, add the following YAML to each zone override configuration: - + ```yml tserver: extraEnv: @@ -322,24 +322,24 @@ Continue configuring your Kubernetes provider by clicking **Add Region** and com values: - "yb-tserver" topologyKey: kubernetes.io/hostname - + # Required to esure that the Kubernetes FQDNs are used for # internal communication between the nodes and node-to-node # TLS certificates are validated correctly. - + gflags: master: use_private_ip: cloud tserver: use_private_ip: cloud - + serviceEndpoints: - name: "yb-master-ui" type: LoadBalancer app: "yb-master" ports: http-ui: "7000" - + - name: "yb-tserver-service" type: NodePort externalTrafficPolicy: "Local" @@ -349,10 +349,10 @@ Continue configuring your Kubernetes provider by clicking **Add Region** and com tcp-yedis-port: "6379" tcp-ysql-port: "5433" ``` - + Continue configuring your Kubernetes provider by clicking **Add Zone** and notice that there are might be multiple zones, as per the following illustration: K8s Configuration -- region -Finally, click **Add Region**, and then click **Save** to save the configuration. If successful, you will be redirected to the table view of all configurations. \ No newline at end of file +Finally, click **Add Region**, and then click **Save** to save the configuration. If successful, you will be redirected to the table view of all configurations. diff --git a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/on-premises.md b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/on-premises.md index 5b5b0d205752..b0b73bf0f31a 100644 --- a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/on-premises.md +++ b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/on-premises.md @@ -17,47 +17,47 @@ showAsideToc: true
                                                        • - + AWS
                                                        • - + GCP
                                                        • - + Azure
                                                        • - + Kubernetes
                                                        • - + VMware Tanzu
                                                        • - + OpenShift
                                                        • - + On-premises @@ -89,7 +89,7 @@ If the SSH user requires a password for sudo access or the SSH user does not hav #### SSH Port -Provide the port number of SSH client connections. +Provide the port number of SSH client connections. #### Manually Provision Nodes @@ -105,7 +105,7 @@ If any of the following statements are applicable to your use case, you need to Ensure that the SSH key is pasted correctly (the supported format is RSA). -#### Air Gap Install +#### Air Gap Install Enable this option if you want the installation to run in an air-gapped mode without expecting any internet access. @@ -119,11 +119,11 @@ Specify the port number for the Node Exporter. The default value is 9300. #### Install Node Exporter -Enable this option if you want the Node Exporter installed. You can skip this step if you have Node Exporter already installed on the nodes. Ensure you have provided the correct port number for skipping the installation. +Enable this option if you want the Node Exporter installed. You can skip this step if you have Node Exporter already installed on the nodes. Ensure you have provided the correct port number for skipping the installation. #### Node Exporter User -Override the default Prometheus user. This is useful when the user is pre-provisioned on nodes (in case user creation is disabled). If overridden, the installer checks whether or not the user exists and creates the user if it does not exist. +Override the default Prometheus user. This is useful when the user is pre-provisioned on nodes (in case user creation is disabled). If overridden, the installer checks whether or not the user exists and creates the user if it does not exist. ### Configure hardware for YugabyteDB nodes @@ -189,20 +189,20 @@ You can manually provision each node using the pre-provisioning Python script, a sudo docker exec -it yugaware bash ``` -1. Copy and paste the Python script prompted via the UI and substitute for a node IP address and mount points. +1. Copy and paste the Python script prompted via the UI and substitute for a node IP address and mount points. Optionally, use the `--ask_password` flag if the sudo user requires password authentication, as follows: - + ```bash bash-4.4# /opt/yugabyte/yugaware/data/provision/9cf26f3b-4c7c-451a-880d-593f2f76efce/provision_instance.py --ip 10.9.116.65 --mount_points /data --ask_password ``` - + Expect the following output and prompt: - + ```output Executing provision now for instance with IP 10.9.116.65... SUDO password: ``` - + 1. Wait for the script to finish successfully. 1. Repeat step 3 for every node that will participate in the universe. @@ -265,7 +265,6 @@ Physical nodes (or cloud instances) are installed with a standard Centos 7 serve server prefer iburst ``` -
                                                          Then, run the following command: ```sh @@ -283,7 +282,7 @@ Physical nodes (or cloud instances) are installed with a standard Centos 7 serve
                                                          Ensure that the `yugabyte` user has permissions to SSH into the YugabyteDB nodes (as defined in `/etc/ssh/sshd_config`). 1. Copy the SSH public key to each DB node. - + \ This public key should correspond to the private key entered into the Yugabyte Platform provider. @@ -349,7 +348,7 @@ Physical nodes (or cloud instances) are installed with a standard Centos 7 serve $ lsblk ``` - * Perform the following steps for each available volume (all listed volumes other than the root volume): + * Perform the following steps for each available volume (all listed volumes other than the root volume): ```sh $ sudo mkdir /data # (or /data1, /data2 etc) @@ -432,23 +431,23 @@ On each node, perform the following as a user with sudo access: Description=node_exporter - Exporter for machine metrics. Documentation=https://github.com/William-Yeh/ansible-prometheus After=network.target - + [Install] WantedBy=multi-user.target - + [Service] Type=simple - + #ExecStartPre=/bin/sh -c " mkdir -p '/var/run/prometheus' '/var/log/prometheus' " #ExecStartPre=/bin/sh -c " chown -R prometheus '/var/run/prometheus' '/var/log/prometheus' " #PIDFile=/var/run/prometheus/node_exporter.pid - + User=prometheus Group=prometheus - + ExecStart=/opt/prometheus/node_exporter-0.13.0.linux-amd64/node_exporter --web.listen-address=:9300 --collector.textfile.directory=/tmp/yugabyte/metrics ``` - + 1. Exit from vi, and continue (sudo required): ```sh @@ -482,7 +481,7 @@ Yugabyte Platform supports backing up YugabyteDB to AWS S3, Azure Storage, Googl ```sh $ cd /usr/local $ sudo tar xvfz path-to-s3cmd-2.0.1.tar.gz - $ sudo ln -s /usr/local/s3cmd-2.0.1/s3cmd /usr/local/bin/s3cmd + $ sudo ln -s /usr/local/s3cmd-2.0.1/s3cmd /usr/local/bin/s3cmd ``` **Azure Storage** - Install azcopy using one of the following options: @@ -513,7 +512,7 @@ Yugabyte Platform supports backing up YugabyteDB to AWS S3, Azure Storage, Googl ```sh $ cd /usr/local $ sudo tar xvfz gsutil_4.60.tar.gz - $ sudo ln -s /usr/local/gsutil/gsutil /usr/local/bin/gsutil + $ sudo ln -s /usr/local/gsutil/gsutil /usr/local/bin/gsutil ``` ##### Set crontab permissions @@ -532,11 +531,11 @@ If you are not using either file, no changes are required. diff --git a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/openshift.md b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/openshift.md index 77364e6b1da6..50231d3c012b 100644 --- a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/openshift.md +++ b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/openshift.md @@ -16,47 +16,47 @@ showAsideToc: true
                                                          • - + AWS
                                                          • - + GCP
                                                          • - +    Azure
                                                          • - + Kubernetes
                                                          • - + VMware Tanzu
                                                          • - + OpenShift
                                                          • - + On-premises @@ -144,11 +144,11 @@ You can create a provider as follows: - Click **Add Region** and complete the **Add new region** dialog shown in the following illustration by first selecting the region you found previously (US East), and then entering the following information: - In the **Zone** field, enter the exact zone label (us-east4-a). - In the **Namespace** field, enter yb-platform.

                                                            - + ![Add Region](/images/ee/openshift-add-region.png) - + - Click **Add Region**. -- Click **Save**. +- Click **Save**. You should see the newly-added provider under **Red Hat OpenShift configs**. @@ -156,7 +156,7 @@ You should see the newly-added provider under **Red Hat OpenShift configs**. You can create a universe using the provider as follows: -- Use the Yugabyte Platform web UI to navigate to **Universes** and then click **Create Universe**. +- Use the Yugabyte Platform web UI to navigate to **Universes** and then click **Create Universe**. - Complete the **Create Universe** page shown in the following illustration by entering the following information: @@ -164,10 +164,10 @@ You can create a universe using the provider as follows: - In the **Provider** field, enter ocp-test. - In the **Regions** field, enter US East. - In the **Instance Type** field, enter xsmall (2 cores, 4GB RAM).

                                                            - + ![Create Universe](/images/ee/openshift-create-uni.png) - -- Click **Create**. + +- Click **Create**. The following illustration shows the universe creation progress: @@ -206,10 +206,10 @@ yb-tserver-1 2/2 Running 0 5m58s yb-tserver-2 2/2 Running 0 5m58s ``` -If any of the pods are in pending state, perform the following: +If any of the pods are in pending state, perform the following: - Login with an admin account and navigate to **Compute > Machine Sets**. -- Open the Machine Set corresponding to your zone label (us-east4-a). +- Open the Machine Set corresponding to your zone label (us-east4-a). - Click **Desired Count** and increase the count by 1 or 2, as shown in the following illustration. - Click **Save**. @@ -228,4 +228,4 @@ Expect the following output: machineset.machine.openshift.io/ocp-dev4-l5ffp-worker-a scaled ``` -As soon as the new machine is added, the pending pods become ready. \ No newline at end of file +As soon as the new machine is added, the pending pods become ready. diff --git a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/vmware-tanzu.md b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/vmware-tanzu.md index 2a123b2c5d2d..60ea36fb68cf 100644 --- a/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/vmware-tanzu.md +++ b/docs/content/latest/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/vmware-tanzu.md @@ -18,47 +18,47 @@ showAsideToc: true -This document explains how to configure VMware Tanzu Kubernetes Grid (TKG) for a YugabyteDB universe using Yugabyte Platform. +This document explains how to configure VMware Tanzu Kubernetes Grid (TKG) for a YugabyteDB universe using Yugabyte Platform. ## Configuring the VMware Tanzu Provider @@ -89,13 +89,12 @@ To start configuring any TKG edition (that is, either TKG-Integrated, TKG-Servic - Use the **Image Registry** field to specify the location of the YugabyteDB image. You should accept the default setting, unless you are hosting your own registry. - The **Pull Secret** field indicates that the Enterprise YugabyteDB image is in a private repository. Use this field to upload the pull secret for downloading the images. The secret should be supplied by your organization's sales team. -![Tanzu Configuratioin](/images/deploy/pivotal-cloud-foundry/tanzu-config-1.png) + ![Tanzu Configuration](/images/deploy/pivotal-cloud-foundry/tanzu-config-1.png) ### How to Configure Region and Zones - On the **Create VMware Tanzu Configuration** page, click **Add Region** to open the **Add new region** dialog shown in the following illustration:

                                                            - ![Add Region](/images/deploy/pivotal-cloud-foundry/add-region-1.png) - Use the **Region** field to select the region. @@ -116,7 +115,7 @@ To start configuring any TKG edition (that is, either TKG-Integrated, TKG-Servic app: "yb-master" ports: ui: "7000" - + - name: "yb-tserver-service" type: "LoadBalancer" annotations: @@ -150,24 +149,22 @@ To start configuring any TKG edition (that is, either TKG-Integrated, TKG-Servic - Add a new zone by clicking **Add Zone**. Your configuration may have multiple zones, as shown in the following illustration: - -![Add Region](/images/deploy/pivotal-cloud-foundry/add-region-2.png) + ![Add Region](/images/deploy/pivotal-cloud-foundry/add-region-2.png) - Click **Add Region**. - Click **Save**. If your configuration is successful, you are redirected to **VMware Tanzu configs**, as shown in the following illustration:

                                                            - ![Finish Tanzu Configuration](/images/deploy/pivotal-cloud-foundry/tanzu-config-finish.png) ## Appendix Using VMware Tanzu Application Service VMware Tanzu Application Service is no longer actively supported and the following information is considered legacy. -If you choose to use VMware Tanzu Application Service, before creating the service instance, ensure that the following is available: +If you choose to use VMware Tanzu Application Service, before creating the service instance, ensure that the following is available: - The YugabyteDB tile is installed in your PCF marketplace. -- The cloud provider is configured in the Yugabyte Platform instance in your PCF environment . +- The cloud provider is configured in the Yugabyte Platform instance in your PCF environment . ### Creating a YugabyteDB Service Instance @@ -175,15 +172,15 @@ You can create a YugabyteDB service instance via the App Manager UI or Cloud Fou #### How to Use the PCF App Manager -- In your PCF App manager, navigate to the marketplace and select **YugabyteDB**. +- In your PCF App manager, navigate to the marketplace and select **YugabyteDB**. - Read descriptions of the available service plans to identify the resource requirements and intended environment, as shown in the following illustration. -![Yugabyte Service Plans](/images/deploy/pivotal-cloud-foundry/service-plan-choices.png) + ![Yugabyte Service Plans](/images/deploy/pivotal-cloud-foundry/service-plan-choices.png) -- Select the service plan. +- Select the service plan. - Complete the service instance configuration, as shown in the following illustration: -![App Manager Config](/images/deploy/pivotal-cloud-foundry/apps-manager-config.png) + ![App Manager Config](/images/deploy/pivotal-cloud-foundry/apps-manager-config.png) #### How to Use the Cloud Foundry CLI @@ -193,9 +190,9 @@ You can view the marketplace and plan description in the cf CLI by executing the $ cf marketplace -s yugabyte-db ``` -The ouput should be simiar to the following: +The output should be similar to the following: -``` +```output service plan description free or paid x-small Cores: 2, Memory (GB): 4 paid small Cores: 4, Memory (GB): 7 paid @@ -285,4 +282,3 @@ To override the YugabyteDB software version to be used, include `yb_version` wit "yb_version": "1.1.6.0-b4" } ``` - diff --git a/docs/content/latest/yugabyte-platform/create-deployments/_index.md b/docs/content/latest/yugabyte-platform/create-deployments/_index.md index 3731c633b70b..09f1573da6f9 100644 --- a/docs/content/latest/yugabyte-platform/create-deployments/_index.md +++ b/docs/content/latest/yugabyte-platform/create-deployments/_index.md @@ -77,7 +77,7 @@ showAsideToc: true
                                            - +
                                            diff --git a/docs/content/latest/yugabyte-platform/create-deployments/async-replication-platform.md b/docs/content/latest/yugabyte-platform/create-deployments/async-replication-platform.md index f350bd12d051..ae5e1e85ee44 100644 --- a/docs/content/latest/yugabyte-platform/create-deployments/async-replication-platform.md +++ b/docs/content/latest/yugabyte-platform/create-deployments/async-replication-platform.md @@ -23,9 +23,9 @@ Within the concept of replication, universes are divided into the following cate Note that in the current release, replicating a source universe that has already been populated with data can be done only by contacting Yugabyte Support. -- A target universe is the recepient of the replicated data. One source universe can replicate to one or more target universes. +- A target universe is the recipient of the replicated data. One source universe can replicate to one or more target universes. -For additional information on asynchronous replication in YugabyteDB, see the following: +For additional information on asynchronous replication in YugabyteDB, see the following: - [Asynchronous Replication: Overview and Architecture](https://docs.yugabyte.com/latest/architecture/docdb-replication/async-replication/) - [Asynchronous Replication Between Universes in YugabyteDB](https://docs.yugabyte.com/latest/deploy/multi-dc/async-replication/) @@ -86,7 +86,7 @@ This page allows you to do the following: ![Tables](/images/yp/asynch-replication-7.png)

                                            - - Click **Modify Tables**. + - Click **Modify Tables**. - Use the **Add tables to the replication** dialog to change the table selection, as per the following illustration:

                                            @@ -120,15 +120,13 @@ This page allows you to do the following: You can set up bidirectional replication using either the Yugabyte Platform UI or API by creating two separate replication configurations. Under this scenario, a source universe of the first replication becomes the target universe of the second replication, and vice versa. - -