Speed up indexing with cursor_tuple_fraction pg option #11382

archesproject · Sep 6, 2024 · 907878f · 907878f
1 parent 4a89eb2
commit 907878f
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 3 deletions.
diff --git a/arches/install/arches-templates/project_name/settings.py-tpl b/arches/install/arches-templates/project_name/settings.py-tpl
@@ -106,7 +106,9 @@ DATABASES = {
         "ENGINE": "django.contrib.gis.db.backends.postgis",
         "HOST": "localhost",
         "NAME": "{{ project_name }}",
-        "OPTIONS": {},
+        "OPTIONS": {
+            "options": "-c cursor_tuple_fraction=1",
+        },
         "PASSWORD": "postgis",
         "PORT": "5432",
         "POSTGIS_TEMPLATE": "template_postgis",

diff --git a/arches/install/arches-templates/tests/test_settings.py-tpl b/arches/install/arches-templates/tests/test_settings.py-tpl
@@ -39,7 +39,9 @@ DATABASES = {
         "ENGINE": "django.contrib.gis.db.backends.postgis",
         "HOST": "localhost",
         "NAME": "{{ project_name }}",
-        "OPTIONS": {},
+        "OPTIONS": {
+            "options": "-c cursor_tuple_fraction=1",
+        },
         "PASSWORD": "postgis",
         "PORT": "5432",
         "POSTGIS_TEMPLATE": "template_postgis",

diff --git a/arches/settings.py b/arches/settings.py
@@ -48,6 +48,9 @@
         "HOST": "localhost",  # Set to empty string for localhost. Not used with sqlite3.
         "PORT": "5432",  # Set to empty string for default. Not used with sqlite3.
         "POSTGIS_TEMPLATE": "template_postgis",
+        "OPTIONS": {
+            "options": "-c cursor_tuple_fraction=1",
+        },
     }
 }
 

diff --git a/arches/settings_docker.py b/arches/settings_docker.py
@@ -33,6 +33,9 @@ def get_optional_env_variable(var_name):
         "HOST": get_env_variable("PGHOST"),
         "PORT": get_env_variable("PGPORT"),
         "POSTGIS_TEMPLATE": "template_postgis",
+        "OPTIONS": {
+            "options": "-c cursor_tuple_fraction=1",
+        },
     }
 }
 

diff --git a/docker/settings_local.py b/docker/settings_local.py
@@ -35,6 +35,9 @@ def get_optional_env_variable(var_name):
         "HOST": get_env_variable("PGHOST"),
         "PORT": get_env_variable("PGPORT"),
         "POSTGIS_TEMPLATE": "template_postgis",
+        "OPTIONS": {
+            "options": "-c cursor_tuple_fraction=1",
+        },
     }
 }
 

diff --git a/releases/8.0.0.md b/releases/8.0.0.md
@@ -52,6 +52,13 @@ JavaScript:
 
 1. Remove "3.10" from the `python-version` matrix in `.github/workflows/main.yml`.
 
+1. In settings.py, add the following key to `DATABASES` to [improve indexing performance](https://github.com/archesproject/arches/issues/11382):
+    ```
+        "OPTIONS": {
+            "options": "-c cursor_tuple_fraction=1",
+        },
+    ```
+
 1. Update your frontend dependencies:
     ```
     rm -rf node_modules package-lock.json

diff --git a/tests/fixtures/testing_prj/testing_prj/settings.py b/tests/fixtures/testing_prj/testing_prj/settings.py
@@ -53,7 +53,9 @@
         "ENGINE": "django.contrib.gis.db.backends.postgis",
         "HOST": "localhost",
         "NAME": "testing_prj",
-        "OPTIONS": {},
+        "OPTIONS": {
+            "options": "-c cursor_tuple_fraction=1",
+        },
         "PASSWORD": "postgis",
         "PORT": "5432",
         "POSTGIS_TEMPLATE": "template_postgis",