Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/postgresql.rst @ 635:8c4b1154cc8b
mobile
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 19 Apr 2021 08:43:47 +0200 |
| parents | 5c0dfc863884 |
| children | 411e82bb3a9f |
| rev | line source |
|---|---|
| 24 | 1 .. _postgresql: |
| 2 | |
| 3 | |
| 4 PostgreSQL plugins | |
| 5 ================== | |
| 6 | |
| 27 | 7 .. contents:: |
| 8 | |
| 9 The Orthanc project provides two **official** plugins to replace the | |
| 10 default storage area (on the filesystem) and the default SQLite index | |
| 11 by a PostgreSQL database. | |
| 12 | |
| 13 For general information, check out the `official homepage of the | |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
336
diff
changeset
|
14 plugins <https://www.orthanc-server.com/static.php?page=postgresql>`__. |
| 27 | 15 |
| 16 | |
| 17 | |
| 18 Compilation | |
| 19 ----------- | |
| 20 | |
| 128 | 21 Static linking |
| 22 ^^^^^^^^^^^^^^ | |
| 23 | |
| 27 | 24 .. highlight:: text |
| 25 | |
| 154 | 26 The procedure to compile these plugins is similar to that for the |
| 27 | 27 :ref:`core of Orthanc <compiling>`. The following commands should work |
| 154 | 28 for most UNIX-like distribution (including GNU/Linux):: |
| 27 | 29 |
| 154 | 30 $ mkdir BuildPostgreSQL |
| 31 $ cd BuildPostgreSQL | |
| 32 $ cmake ../PostgreSQL -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release | |
| 27 | 33 $ make |
| 34 | |
| 35 The compilation will produce 2 shared libraries, each containing one plugin for Orthanc: | |
| 36 | |
| 37 * ``OrthancPostgreSQLIndex`` replaces the default SQLite index of Orthanc by PostgreSQL. | |
| 38 * ``OrthancPostgreSQLStorage`` makes Orthanc store the DICOM files it receives into PostgreSQL. | |
| 39 | |
| 128 | 40 |
| 41 Microsoft Windows and Apple OS X | |
| 42 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
| 43 | |
| 28 | 44 Pre-compiled binaries for Microsoft Windows `are also available |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
336
diff
changeset
|
45 <https://www.orthanc-server.com/browse.php?path=/plugin-postgresql>`__. |
| 30 | 46 A package for `Apple's Mac OS X |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
336
diff
changeset
|
47 <https://www.osimis.io/en/download.html>`__ |
|
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
336
diff
changeset
|
48 is available courtesy of `Osimis <https://www.osimis.io/>`__. |
| 27 | 49 |
| 50 | |
|
263
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
51 .. _postgresql-ubuntu1604: |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
52 |
| 128 | 53 Dynamic linking on Ubuntu 16.04 |
| 54 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
| 55 | |
| 56 .. highlight:: text | |
| 57 | |
| 58 If static linking is not desired, here are build instructions for | |
| 59 Ubuntu 16.04 (provided build dependencies for the :ref:`core of | |
| 60 Orthanc <compiling>` have already been installed):: | |
| 61 | |
| 62 $ sudo apt-get install libpq-dev postgresql-server-dev-all | |
| 154 | 63 $ mkdir BuildPostgreSQL |
| 64 $ cd BuildPostgreSQL | |
| 65 $ cmake ../PostgreSQL -DCMAKE_BUILD_TYPE=Release \ | |
| 66 -DALLOW_DOWNLOADS=ON \ | |
| 67 -DUSE_SYSTEM_GOOGLE_TEST=OFF \ | |
| 68 -DUSE_SYSTEM_ORTHANC_SDK=OFF | |
| 128 | 69 $ make |
| 70 | |
|
263
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
71 |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
72 .. _postgresql-cmake: |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
73 |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
74 Dynamic linking on other GNU/Linux distributions |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
75 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
76 |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
77 .. highlight:: text |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
78 |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
79 The build instructions should always be very similar to those for |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
80 :ref:`Ubuntu 16.04 <postgresql-ubuntu1604>`. One difficulty that could |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
81 however arise is that it is possible that the CMake environment that |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
82 is shipped with the GNU/Linux distribution cannot locate a recent |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
83 version of the development headers for PostgreSQL. This leads to an |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
84 error while invoking CMake that looks like:: |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
85 |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
86 -- Could NOT find PostgreSQL (missing: PostgreSQL_TYPE_INCLUDE_DIR) |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
87 |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
88 In such a situation, please add your version of PostgreSQL to the |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
89 macro ``PostgreSQL_ADDITIONAL_VERSIONS`` that is defined at the end of |
|
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
90 the `Resources/CMake/PostgreSQLConfiguration.cmake file |
| 449 | 91 <https://hg.orthanc-server.com/orthanc-databases/file/default/Resources/CMake/PostgreSQLConfiguration.cmake>`__ |
| 361 | 92 in the sources of the project. |
|
263
39609c9a2c41
note about includes for postgresql
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
181
diff
changeset
|
93 |
| 128 | 94 |
| 27 | 95 Usage |
| 96 ----- | |
| 97 | |
| 98 .. highlight:: json | |
| 99 | |
|
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
30
diff
changeset
|
100 You of course first have to :ref:`install Orthanc <binaries>`, with a |
| 154 | 101 version above 0.9.5. You then have to **create a database** dedicated |
| 28 | 102 to Orthanc on some PostgreSQL server. Please refer to the `PostgreSQL |
| 103 documentation | |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
336
diff
changeset
|
104 <https://www.postgresql.org/docs/current/tutorial-createdb.html>`__. |
| 27 | 105 |
| 106 Once Orthanc is installed and the database is created, you must add a | |
| 107 section in the :ref:`configuration file <configuration>` that | |
| 108 specifies the address of the **PostgreSQL server together with your | |
| 109 credentials**. You also have to tell Orthanc in which path it can find | |
| 110 the plugins: This is done by properly modifying the ``Plugins`` | |
| 111 option. You could for instance adapt the following configuration | |
| 112 file:: | |
| 113 | |
| 114 { | |
| 115 "Name" : "MyOrthanc", | |
| 116 "PostgreSQL" : { | |
| 117 "EnableIndex" : true, | |
| 118 "EnableStorage" : true, | |
| 119 "Host" : "localhost", | |
| 120 "Port" : 5432, | |
| 121 "Database" : "orthanc", | |
| 122 "Username" : "orthanc", | |
| 181 | 123 "Password" : "orthanc", |
| 124 "EnableSsl" : false // New in version 3.0 | |
| 27 | 125 }, |
| 126 "Plugins" : [ | |
| 154 | 127 "/home/user/orthanc-databases/BuildPostgreSQL/libOrthancPostgreSQLIndex.so", |
| 128 "/home/user/orthanc-databases/BuildPostgreSQL/libOrthancPostgreSQLStorage.so" | |
| 27 | 129 ] |
| 130 } | |
| 131 | |
| 154 | 132 **Important:** The ``EnableIndex`` and ``EnableStorage`` options must |
| 133 be explicitly set to ``true``, otherwise Orthanc will continue to use | |
| 134 its default SQLite back-end and the filesystem storage area. | |
| 27 | 135 |
| 181 | 136 **Remark 1:** When using the ``Storage`` PostgreSQL plugin, the DICOM |
| 154 | 137 files are stored as large objects in the database. This might |
| 138 actually consume more space than the DICOM file itself. We have | |
| 139 observed overhead up to 40%. However, it seems this overhead is | |
| 140 temporary and comes from Write-Ahead Logging. Check this `discussion | |
| 141 <https://groups.google.com/d/msg/orthanc-users/pPzHOpb--iw/QkKZ808gIgAJ>`__ | |
| 142 on the Orthanc Users group for more info). | |
| 118 | 143 |
| 181 | 144 **Remark 2:** A typical usage of the PostgreSQL plugin is to enable |
| 145 only the ``Index``, and to use the default filesystem storage for | |
| 146 DICOM files (on a NAS with proper disaster recovery strategies). This | |
| 147 setup provides best performance for large-scale databases. | |
| 148 | |
| 149 **Remark 3:** Setting the ``EnableSsl`` to ``true`` forces the use of | |
| 150 `SSL connections | |
| 151 <https://www.postgresql.org/docs/current/libpq-ssl.html>`__ between | |
| 152 Orthanc and the PostgreSQL server. It is a synonym for | |
| 153 ``sslmode=require`` in connections URI (see below). Setting | |
| 154 ``EnableSsl`` to ``false`` corresponds to ``sslmode=disable`` | |
| 155 (i.e. SSL is not used, even if it is both available in Orthanc and | |
| 156 PostgreSQL). To choose other values for the SSL mode (i.e. ``allow`` | |
| 157 and ``prefer``), please use connection URIs. | |
| 118 | 158 |
| 159 | |
|
94
b0a71b880ca0
fix link + remark about disk usage overhead
Alain Mazy <alain@mazy.be>
parents:
81
diff
changeset
|
160 |
| 27 | 161 .. highlight:: text |
| 162 | |
| 163 Orthanc must of course be **restarted** after the modification of its | |
| 164 configuration file. The log will contain an output similar to:: | |
| 165 | |
| 166 $ ./Orthanc Configuration.json | |
| 167 W0212 16:30:34.576972 11285 main.cpp:632] Orthanc version: 0.8.6 | |
| 168 W0212 16:30:34.577386 11285 OrthancInitialization.cpp:80] Using the configuration from: Configuration.json | |
| 169 [...] | |
| 154 | 170 W0212 16:30:34.598053 11285 main.cpp:379] Registering a plugin from: /home/jodogne/Subversion/orthanc-databases/BuildPostgreSQL/libOrthancPostgreSQLIndex.so |
| 27 | 171 W0212 16:30:34.598470 11285 PluginsManager.cpp:258] Registering plugin 'postgresql-index' (version 1.0) |
| 172 W0212 16:30:34.598491 11285 PluginsManager.cpp:148] Using PostgreSQL index | |
| 154 | 173 W0212 16:30:34.608289 11285 main.cpp:379] Registering a plugin from: /home/jodogne/Subversion/orthanc-databases/BuildPostgreSQL/libOrthancPostgreSQLStorage.so |
| 27 | 174 W0212 16:30:34.608916 11285 PluginsManager.cpp:258] Registering plugin 'postgresql-storage' (version 1.0) |
| 175 W0212 16:30:34.608947 11285 PluginsManager.cpp:148] Using PostgreSQL storage area | |
| 176 [...] | |
| 177 W0212 16:30:34.674648 11285 main.cpp:530] Orthanc has started | |
| 178 | |
| 179 | |
| 180 .. highlight:: json | |
| 181 | |
| 182 Instead of specifying explicit authentication parameters, you can also | |
| 183 use the `PostgreSQL connection URIs syntax | |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
336
diff
changeset
|
184 <https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING>`__. For |
| 27 | 185 instance:: |
| 186 | |
| 187 { | |
| 188 "Name" : "MyOrthanc", | |
| 189 "PostgreSQL" : { | |
| 190 "EnableIndex" : true, | |
| 191 "EnableStorage" : true, | |
| 181 | 192 "ConnectionUri" : "postgresql://username:password@localhost:5432/database?sslmode=prefer" |
| 27 | 193 }, |
| 194 "Plugins" : [ | |
| 154 | 195 "/home/user/orthanc-databases/BuildPostgreSQL/libOrthancPostgreSQLIndex.so", |
| 196 "/home/user/orthanc-databases/BuildPostgreSQL/libOrthancPostgreSQLStorage.so" | |
| 27 | 197 ] |
| 198 } | |
| 199 | |
| 200 | |
| 201 **Remark:** The Debian Med project maintains `another useful set of | |
| 202 instructions | |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
336
diff
changeset
|
203 <https://salsa.debian.org/med-team/orthanc-postgresql/-/blob/master/debian/README.Debian>`__. |
| 27 | 204 |
| 205 | |
| 206 Advanced options | |
| 207 ---------------- | |
| 208 | |
| 209 Several advanced options are available as well to fine-tune the | |
| 210 configuration of the PostgreSQL plugins. They are documented below. | |
| 211 | |
| 212 | |
|
270
f29d75bc5c25
more info about database locking
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
263
diff
changeset
|
213 .. _postgresql-lock: |
|
f29d75bc5c25
more info about database locking
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
263
diff
changeset
|
214 |
| 27 | 215 Locking |
| 216 ^^^^^^^ | |
| 217 | |
| 218 .. highlight:: json | |
| 219 | |
| 220 By default, the plugins lock the database (using `PostgreSQL advisory | |
| 221 locks | |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
336
diff
changeset
|
222 <https://www.postgresql.org/docs/current/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS>`__) |
| 27 | 223 to prevent other instances of Orthanc from using the same PostgreSQL |
| 224 database. If you want several instances of Orthanc to share the same | |
| 225 database, set the ``Lock`` option to ``false`` in the configuration | |
| 226 file:: | |
| 227 | |
| 228 { | |
| 229 "Name" : "MyOrthanc", | |
| 230 "PostgreSQL" : { | |
| 231 "EnableIndex" : true, | |
| 232 "EnableStorage" : true, | |
| 233 "Lock" : false, | |
| 234 "ConnectionUri" : "postgresql://username:password@localhost:5432/database" | |
| 235 }, | |
| 236 "Plugins" : [ | |
| 154 | 237 "/home/user/orthanc-databases/BuildPostgreSQL/libOrthancPostgreSQLIndex.so", |
| 238 "/home/user/orthanc-databases/BuildPostgreSQL/libOrthancPostgreSQLStorage.so" | |
| 27 | 239 ] |
| 240 } | |
| 241 | |
| 242 Obviously, one must be very cautious when sharing the same database | |
| 243 between instances of Orthanc. In particular, all these instances | |
| 244 should share the same configuration. | |
| 245 | |
| 246 | |
| 247 Keep-alive | |
| 248 ^^^^^^^^^^ | |
| 249 | |
| 250 .. highlight:: text | |
| 251 | |
| 252 After some period of inactivity (users have reported 10 hours), you | |
| 253 might `experience an error | |
|
445
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
438
diff
changeset
|
254 <https://bugs.orthanc-server.com/show_bug.cgi?id=15>`__ such as:: |
| 27 | 255 |
| 256 E0220 03:20:51.562601 PluginsManager.cpp:163] Exception in database back-end: Error in PostgreSQL: server closed the connection unexpectedly. | |
| 257 This probably means the server terminated abnormally before or while processing the request. | |
| 258 E0220 06:51:03.924868 PluginsManager.cpp:163] Exception in database back-end: Error in PostgreSQL: no connection to the server | |
| 259 | |
| 260 This is due to a timeout in the PostgreSQL server. Please make sure to | |
| 261 `enable keep-alive | |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
336
diff
changeset
|
262 <https://dba.stackexchange.com/questions/97534/is-there-a-timeout-option-for-remote-access-to-postgresql-database>`__ |
| 27 | 263 in the configuration of your PostgreSQL server |
| 438 | 264 |
| 265 | |
| 266 Scalability | |
| 267 ^^^^^^^^^^^ | |
| 268 | |
| 269 When configuring your PostgreSQL plugin, ensure you've read the :ref:`scalability section | |
| 270 <scalability>` | |
| 531 | 271 |
| 272 | |
| 273 Troubleshooting | |
| 274 --------------- | |
| 275 | |
| 276 SCRAM authentication | |
| 277 ^^^^^^^^^^^^^^^^^^^^ | |
| 278 | |
|
560
5c0dfc863884
note for postgresql 3.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
531
diff
changeset
|
279 .. note:: This section only applies to releases <= 3.2 of the |
|
5c0dfc863884
note for postgresql 3.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
531
diff
changeset
|
280 PostgreSQL plugins. Starting with release 3.3, the plugins |
|
5c0dfc863884
note for postgresql 3.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
531
diff
changeset
|
281 use a version of libpq that should support SCRAM |
|
5c0dfc863884
note for postgresql 3.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
531
diff
changeset
|
282 authentication. |
|
5c0dfc863884
note for postgresql 3.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
531
diff
changeset
|
283 |
|
5c0dfc863884
note for postgresql 3.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
531
diff
changeset
|
284 In the releases 3.2 of the PostgreSQL plugins, the precompiled |
|
5c0dfc863884
note for postgresql 3.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
531
diff
changeset
|
285 binaries use an old, but stable version of the PostgreSQL client |
|
5c0dfc863884
note for postgresql 3.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
531
diff
changeset
|
286 (libpq 9.6.1). This makes these binaries very portable, however they |
|
5c0dfc863884
note for postgresql 3.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
531
diff
changeset
|
287 might not be compatible with more recent features of PostgreSQL. |
| 531 | 288 |
| 289 In particular, the precompiled binaries are not compatible with `SCRAM | |
| 290 authentication | |
| 291 <https://en.wikipedia.org/wiki/Salted_Challenge_Response_Authentication_Mechanism>`__ | |
| 292 that is available since PostgreSQL 10. If you get the error ``psql: | |
| 293 authentication method 10 not supported``, this indicates that the | |
| 294 PostgreSQL plugins cannot connect to a PostgreSQL server because SCRAM | |
| 295 is enabled. | |
| 296 | |
| 297 `Ian Smith | |
| 298 <https://groups.google.com/g/orthanc-users/c/4EH7HpcEnSA/m/a4x6oiucAgAJ>`__ | |
| 299 has reported the following method to disable SCRAM: | |
| 300 | |
| 301 1. Drop/delete the ``orthanc`` database and user in PostgreSQL. | |
| 302 2. Edit the files ``postgresql.conf`` and ``pg_hba.conf`` and change | |
| 303 ``scram-sha-256`` to ``md5`` in all cases. | |
| 304 3. Add the ``orthanc`` user and database in PostgreSQL again. | |
| 305 4. Restart Orthanc. |