Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLParameters.h @ 522:c49136b34891 large-queries tip
use a prepared statement for InsertOrUpdateMetadata
| author | Alain Mazy <am@orthanc.team> |
|---|---|
| date | Fri, 05 Jul 2024 09:15:54 +0200 |
| parents | 54d518dcd74a |
| children |
| rev | line source |
|---|---|
| 0 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
|
507
54d518dcd74a
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
497
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
|
54d518dcd74a
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
497
diff
changeset
|
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
|
459
ecd0b719cff5
update year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 0 | 8 * |
| 9 * This program is free software: you can redistribute it and/or | |
| 10 * modify it under the terms of the GNU Affero General Public License | |
| 11 * as published by the Free Software Foundation, either version 3 of | |
| 12 * the License, or (at your option) any later version. | |
| 13 * | |
| 14 * This program is distributed in the hope that it will be useful, but | |
| 15 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 17 * Affero General Public License for more details. | |
| 18 * | |
| 19 * You should have received a copy of the GNU Affero General Public License | |
| 20 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 21 **/ | |
| 22 | |
| 23 | |
| 24 #pragma once | |
| 25 | |
| 26 #if ORTHANC_ENABLE_POSTGRESQL != 1 | |
| 27 # error PostgreSQL support must be enabled to use this file | |
| 28 #endif | |
| 29 | |
| 152 | 30 #include "../../Resources/Orthanc/Plugins/OrthancPluginCppWrapper.h" |
| 0 | 31 |
| 32 namespace OrthancDatabases | |
| 33 { | |
|
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
34 enum IsolationMode |
|
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
35 { |
| 470 | 36 IsolationMode_Serializable = 0, |
| 37 IsolationMode_ReadCommited = 1 | |
|
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
38 }; |
|
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
39 |
| 0 | 40 class PostgreSQLParameters |
| 41 { | |
| 42 private: | |
| 43 std::string host_; | |
| 44 uint16_t port_; | |
| 45 std::string username_; | |
| 46 std::string password_; | |
| 47 std::string database_; | |
| 48 std::string uri_; | |
|
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
49 bool ssl_; |
| 0 | 50 bool lock_; |
|
141
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
51 unsigned int maxConnectionRetries_; |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
52 unsigned int connectionRetryInterval_; |
|
429
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
53 bool isVerboseEnabled_; |
|
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
54 IsolationMode isolationMode_; |
| 0 | 55 void Reset(); |
| 56 | |
| 57 public: | |
| 58 PostgreSQLParameters(); | |
| 59 | |
| 186 | 60 explicit PostgreSQLParameters(const OrthancPlugins::OrthancConfiguration& configuration); |
| 0 | 61 |
| 62 void SetConnectionUri(const std::string& uri); | |
| 63 | |
| 64 std::string GetConnectionUri() const; | |
| 65 | |
| 66 void SetHost(const std::string& host); | |
| 67 | |
| 68 const std::string& GetHost() const | |
| 69 { | |
| 70 return host_; | |
| 71 } | |
| 72 | |
| 73 void SetPortNumber(unsigned int port); | |
| 74 | |
| 75 uint16_t GetPortNumber() const | |
| 76 { | |
| 77 return port_; | |
| 78 } | |
| 79 | |
| 80 void SetUsername(const std::string& username); | |
| 81 | |
| 82 const std::string& GetUsername() const | |
| 83 { | |
| 84 return username_; | |
| 85 } | |
| 86 | |
| 87 void SetPassword(const std::string& password); | |
| 88 | |
| 89 const std::string& GetPassword() const | |
| 90 { | |
| 91 return password_; | |
| 92 } | |
| 93 | |
| 94 void SetDatabase(const std::string& database); | |
| 95 | |
| 96 void ResetDatabase() | |
| 97 { | |
| 98 SetDatabase(""); | |
| 99 } | |
| 100 | |
| 101 const std::string& GetDatabase() const | |
| 102 { | |
| 103 return database_; | |
| 104 } | |
| 105 | |
|
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
106 void SetSsl(bool ssl) |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
107 { |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
108 ssl_ = ssl; |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
109 } |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
110 |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
111 bool IsSsl() const |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
112 { |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
113 return ssl_; |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
114 } |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
115 |
| 0 | 116 void SetLock(bool lock) |
| 117 { | |
| 118 lock_ = lock; | |
| 119 } | |
| 120 | |
| 121 bool HasLock() const | |
| 122 { | |
| 123 return lock_; | |
| 124 } | |
| 125 | |
|
141
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
126 unsigned int GetMaxConnectionRetries() const |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
127 { |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
128 return maxConnectionRetries_; |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
129 } |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
130 |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
131 unsigned int GetConnectionRetryInterval() const |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
132 { |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
133 return connectionRetryInterval_; |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
134 } |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
135 |
|
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
136 void SetIsolationMode(IsolationMode isolationMode) |
|
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
137 { |
|
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
138 isolationMode_ = isolationMode; |
|
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
139 } |
|
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
140 |
| 497 | 141 const std::string GetReadWriteTransactionStatement() const; |
|
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
142 |
| 497 | 143 const std::string GetReadOnlyTransactionStatement() const; |
|
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
144 |
|
429
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
145 void SetVerboseEnabled(bool enabled) |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
146 { |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
147 isVerboseEnabled_ = enabled; |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
148 } |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
149 |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
150 bool IsVerboseEnabled() const |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
151 { |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
152 return isVerboseEnabled_; |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
153 } |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
154 |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
155 |
| 0 | 156 void Format(std::string& target) const; |
| 157 }; | |
| 158 } |