comparison doc/mysql.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 b21ebabeb2ef
children 3d7292d222d1
comparison
equal deleted inserted replaced
7718:3da452f4a3ac 7719:3071db43bfb6
18 if you have no other choice). If you're running < 4.0.18 (but not <4.0) 18 if you have no other choice). If you're running < 4.0.18 (but not <4.0)
19 then you'll need to use BDB to pass all unit tests. Edit the 19 then you'll need to use BDB to pass all unit tests. Edit the
20 ``roundup/backends/back_mysql.py`` file to enable DBD instead of InnoDB. 20 ``roundup/backends/back_mysql.py`` file to enable DBD instead of InnoDB.
21 2. Python MySQL interface - https://pypi.org/project/mysqlclient/ 21 2. Python MySQL interface - https://pypi.org/project/mysqlclient/
22 22
23
24 Preparing the Database
25 ======================
26
27 The Roundup user expects to be able to create and drop its database
28 when using ``roundup_admin init``.
29
30 In the examples below, replace ``roundupuser``, ``rounduppw`` and
31 ``roundupdb`` with suitable values.
32
33 This assumes you are running MySQL on the same host as you are
34 running Roundup. If this is not the case, setting up remote
35 credentials, SSL/TLS etc. is beyond the scope of this documentation.
36 However examples are welcome on the wiki or mailing list.
37
38 These references may be helpful:
39 https://dev.mysql.com/doc/refman/8.0/en/create-user.html and
40 https://dev.mysql.com/doc/refman/8.0/en/grant.html.
41
42 Creating a Role/User
43 --------------------
44
45 The following command will create a ``roundupuser`` with the ability
46 to create the database::
47
48 mysql -u root -e 'CREATE USER "roundupuser"@"localhost" IDENTIFIED WITH mysql_native_password BY "rounduppw"; GRANT ALL on roundupuser.* TO "roundupuser"@"localhost";'
23 49
24 Other Configuration 50 Other Configuration
25 =================== 51 ===================
26 52
27 If you are indexing large documents (e.g attached file contents) 53 If you are indexing large documents (e.g attached file contents)

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