From 4f20070e6d7059f6b7c151fb5caedadd2ac31307 Mon Sep 17 00:00:00 2001 From: Pere Miquel Brull Date: Wed, 13 Sep 2023 19:44:35 +0200 Subject: [PATCH] [Docs] - Add sort buffer size (#13181) --- .../upgrade/upgrade-prerequisites.md | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/openmetadata-docs/content/partials/v1.1/deployment/upgrade/upgrade-prerequisites.md b/openmetadata-docs/content/partials/v1.1/deployment/upgrade/upgrade-prerequisites.md index 00a9ee7d857..112b327e90a 100644 --- a/openmetadata-docs/content/partials/v1.1/deployment/upgrade/upgrade-prerequisites.md +++ b/openmetadata-docs/content/partials/v1.1/deployment/upgrade/upgrade-prerequisites.md @@ -167,6 +167,39 @@ The above command will update `global.*` with `openmetadata.config.*` yaml confi For more information, visit the official helm docs for [global chart values](https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#global-chart-values). +### Update `sort_buffer_size` (MySQL) or `work_mem` (Postgres) + +Before running the migrations, it is important to update these parameters to ensure there are no runtime errors. +A safe value would be setting them to 10MB. + +**If using MySQL** + +You can update it via SQL (note that it will reset after the server restarts): + +```sql +SET GLOBAL sort_buffer_size = 10485760 +``` + +To make the configuration persistent, you'd need to navigate to your MySQL Server install directory and update the +`my.ini` or `my.cnf` [files](https://dev.mysql.com/doc/refman/8.0/en/option-files.html) with `sort_buffer_size = 10485760`. + +If using RDS, you will need to update your instance's [Parameter Group](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) +to include the above change. + +**If using Postgres** + +You can update it via SQL (not that it will reset after the server restarts): + +```sql +SET work_mem = '10MB'; +``` + +To make the configuration persistent, you'll need to update the `postgresql.conf` [file](https://www.postgresql.org/docs/9.3/config-setting.html) +with `work_mem = 10MB`. + +If using RDS, you will need to update your instance's [Parameter Group](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) +to include the above change. + ### Elasticsearch and OpenSearch We now support ES version up to 7.16. However, this means that we need to handle the internals a bit differently