Skip to content

Commit d9aa62b

Browse files
[irods/irods_7975] Update documentation on the database plugin
1 parent a52bd0e commit d9aa62b

File tree

3 files changed

+24
-25
lines changed

3 files changed

+24
-25
lines changed

docs/getting_started/installation.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -319,14 +319,13 @@ Below you'll find examples showing what the input file might contain for a [Cata
319319
"plugin_configuration": {
320320
"authentication": {},
321321
"database": {
322-
"postgres": {
323-
"db_host": "catalog",
324-
"db_name": "ICAT",
325-
"db_odbc_driver": "PostgreSQL ANSI",
326-
"db_password": "testpassword",
327-
"db_port": 5432,
328-
"db_username": "irods"
329-
}
322+
"technology": "postgres",
323+
"host": "catalog",
324+
"name": "ICAT",
325+
"odbc_driver": "PostgreSQL ANSI",
326+
"password": "testpassword",
327+
"port": 5432,
328+
"username": "irods"
330329
},
331330
"network": {},
332331
"resource": {},

docs/plugins/pluggable_database.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
The iRODS metadata catalog is installed and managed by separate plugins. iRODS has PostgreSQL, MySQL, and Oracle database plugins available and tested.
44

5-
The particular type of database is encoded in `/etc/irods/database_config.json` with the following directive:
5+
The particular type of database is encoded in `/etc/irods/server_config.json` with the following directive:
66

77
~~~
8-
"catalog_database_type" : "postgres",
8+
"technology" : "postgres",
99
~~~
1010

1111
This is populated by the `setup_irods.py` script on configuration.

docs/system_overview/configuration.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -301,26 +301,26 @@ iRODS 5 servers only require a working `server_config.json` file. All server pro
301301
"database": {
302302
// The type of database iRODS is using for the catalog.
303303
// The following property names are supported: postgres, mysql, and oracle
304-
"catalog_database_type": {
305-
// The hostname of the database server (can be localhost).
306-
"db_host": "localhost",
304+
"technology": ""
307305

308-
// The name of the database used as the catalog.
309-
"db_name": "ICAT",
306+
// The FQDN, Hostname, or IP of the database server (can be localhost).
307+
"host": "localhost",
310308

311-
// The name of the ODBC entry used by the server (normally defined in /etc/odbcinst.ini)
312-
// or the absolute path to a specific ODBC driver (shared library).
313-
"db_odbc_driver": "",
309+
// The name of the database used as the catalog.
310+
"name": "ICAT",
314311

315-
// The password for the "db_username" to connect to the "db_name".
316-
"db_password": "",
312+
// The name of the ODBC entry used by the server (normally defined in /etc/odbcinst.ini)
313+
// or the absolute path to a specific ODBC driver (shared library).
314+
"odbc_driver": "",
317315

318-
// The port number on which the database server is listening.
319-
"db_port": 0,
316+
// The password for the "username" to connect to the "name".
317+
"password": "",
320318

321-
// The database user name.
322-
"db_username": ""
323-
}
319+
// The port number on which the database server is listening.
320+
"port": 0,
321+
322+
// The database user name.
323+
"username": ""
324324
},
325325

326326
// This property is currently unused.

0 commit comments

Comments
 (0)