diff doc/upgrading.txt @ 7719:3071db43bfb6

feat: issue2550852 - support using a specified PostgreSQL db schema Finally after 7 years this is closed. roundup/backends/back_postgresql.py: Support use of schema when specified in RDBMS_NAME. Stuart McGraws code is finally merged 8-). test/test_postgresql.py, test/conftest.py: Run all postgresql tests in the schema db as well. Also make sure that db_nuke raises an error when trying to delete the schema test database. Conftest defines pg_schema mark that can be used to exclude schema tests with pytest -m "not pg_schema". roundup/configuration.py: change doc on RDBMS_NAME to include db.schema form. .travis.yml, .github/workflows/ci-test.yml: create schema test db; add user for testing with schema; grant new user create privs for schema. doc/installation.txt: Reference to roundup-admin init deleting schema added. doc/mysql.txt doc/postgresql.txt: New documentation on psql/mysql commands to set up a production db. doc/upgrading.txt: mention schema support, also document service setting for selecting connection from pg_service.conf. doc/reference.txt: update config.ini documentation for RDBMS_NAME.
author John Rouillard <rouilj@ieee.org>
date Wed, 27 Dec 2023 22:52:14 -0500
parents 0c855080794e
children 8147f6deac9f
line wrap: on
line diff
--- a/doc/upgrading.txt	Sat Dec 23 21:59:08 2023 -0500
+++ b/doc/upgrading.txt	Wed Dec 27 22:52:14 2023 -0500
@@ -153,6 +153,39 @@
 It is also missing the ``solves`` field which is added to match the
 schema.
 
+New PostgreSQL Settings (optional)
+----------------------------------
+
+With this release, you can specify a Postgresql database
+schema to use. By default Roundup creates a database when
+using ``roundup-admin init``. Setting the rdbms ``name``
+keyword to ``roundup_database.roundup_schema`` will create
+and use the ``roundup_schema`` in the pre-created
+``roundup_database``.
+
+Also there is a new configuration keyword in the rdbms section of
+``config.ini``. The ``service`` keyword allows you to define the
+service name for Postgres that will be looked up in the Postgres
+`Connection Service File`_. Setting service to `roundup` with the
+following in the service file::
+
+   [roundup_roundup]
+   host=127.0.0.1
+   port=5432
+   user=roundup
+   password=roundup
+   dbname=roundup
+
+would use the roundup database with the specified credentials.
+
+It is possible to define a service that connects to a specific
+schema. However this will require a little fiddling to get things
+working. A future enhancement may make using a schema via this
+mechanism easier. See https://issues.roundup-tracker.org/issue2551299
+for details.
+
+.. _`Connection Service File`: https://www.postgresql.org/docs/current/libpq-pgservice.html
+
 Bad Login Rate Limiting and Locking (info)
 ------------------------------------------
 

Roundup Issue Tracker: http://roundup-tracker.org/