Skip to content

[irods/irods#7975] Update documentation surrounding the database plugin (main) #361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alanking merged 1 commit into from
May 6, 2025
Merged

[irods/irods#7975] Update documentation surrounding the database plugin (main) #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions docs/getting_started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,14 +319,13 @@ Below you'll find examples showing what the input file might contain for a [Cata
"plugin_configuration": {
"authentication": {},
"database": {
"postgres": {
"db_host": "catalog",
"db_name": "ICAT",
"db_odbc_driver": "PostgreSQL ANSI",
"db_password": "testpassword",
"db_port": 5432,
"db_username": "irods"
}
"technology": "postgres",
"host": "catalog",
"name": "ICAT",
"odbc_driver": "PostgreSQL ANSI",
"password": "testpassword",
"port": 5432,
"username": "irods"
},
"network": {},
"resource": {},
Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/pluggable_database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

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

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

~~~
"catalog_database_type" : "postgres",
"technology" : "postgres",
~~~

This is populated by the `setup_irods.py` script on configuration.
Expand Down
30 changes: 15 additions & 15 deletions docs/system_overview/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,26 +301,26 @@ iRODS 5 servers only require a working `server_config.json` file. All server pro
"database": {
// The type of database iRODS is using for the catalog.
// The following property names are supported: postgres, mysql, and oracle
"catalog_database_type": {
// The hostname of the database server (can be localhost).
"db_host": "localhost",
"technology": ""

// The name of the database used as the catalog.
"db_name": "ICAT",
// The FQDN, Hostname, or IP of the database server (can be localhost).
"host": "localhost",

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

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

// The port number on which the database server is listening.
"db_port": 0,
// The password for the "username" to connect to the "name".
"password": "",

// The database user name.
"db_username": ""
}
// The port number on which the database server is listening.
"port": 0,

// The database user name.
"username": ""
},

// This property is currently unused.
Expand Down