annotate README @ 384:e236be67e5f9 db-protobuf

fix
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 03 Apr 2023 10:46:01 +0200
parents 8f109cfbfc5d
children cd9521e04249 7d2ba3ece4ee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 Database plugins for Orthanc
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 ============================
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4
21
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
5 General information
0
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 -------------------
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 This repository contains the source code of various database plugins
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 for Orthanc, the lightweight, RESTful DICOM server. These plugins
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 enable Orthanc to store its index and its storage area within
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 well-known relational databases systems (RDBMS).
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 Content
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 -------
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * ./Framework/ : code shared by all the plugins
21
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
18 * ./MySQL/ : index and storage plugins for MySQL and MariaDB
0
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * ./PostgreSQL/ : index and storage plugins for PostgreSQL
337
8f109cfbfc5d updated README
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 336
diff changeset
20 * ./Odbc/ : index and storage plugins for Odbc
0
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * ./SQLite/ : index plugin for SQLite (for experimentation)
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 If you downloaded this project as a versioned release package
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 (.tar.gz) focused on one given RDBMS, you will only find the folders
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 that are related to this specific RDBMS. The full source code is
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 available at:
336
c0c12b3974b2 fix URLs to the old repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 21
diff changeset
27 https://hg.orthanc-server.com/orthanc-databases/
0
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
21
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
30 Compilation and usage
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
31 ---------------------
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
32
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
33 The compilation and usage of the plugins is available in the Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
34 Book:
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
35
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
36 * MySQL/MariaDB : http://book.orthanc-server.com/plugins/mysql.html
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
37 * PostgreSQL : http://book.orthanc-server.com/plugins/postgresql.html
337
8f109cfbfc5d updated README
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 336
diff changeset
38 * ODBC : http://book.orthanc-server.com/plugins/odbc.html
21
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
39
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
40
0
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 Older releases of PostgreSQL
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 ----------------------------
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 This repository supersedes the older "orthanc-postgresql" repository
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 that was only focused on PostgreSQL.
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
21
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
47 Releases <= 2.1 of the PostgreSQL plugins can still be found in the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
48 following legacy repository:
336
c0c12b3974b2 fix URLs to the old repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 21
diff changeset
49 https://hg.orthanc-server.com/orthanc-postgresql/
0
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 Licensing
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 ---------
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 The database plugins for Orthanc are licensed under the AGPL license.
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 We also kindly ask scientific works and clinical studies that make
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 use of Orthanc to cite Orthanc in their associated publications.
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 Similarly, we ask open-source and closed-source products that make
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 use of Orthanc to warn us about this use. You can cite our work
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 using the following BibTeX entry:
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 @Article{Jodogne2018,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 author="Jodogne, S{\'e}bastien",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 title="The {O}rthanc Ecosystem for Medical Imaging",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 journal="Journal of Digital Imaging",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 year="2018",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 month="Jun",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 day="01",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 volume="31",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 number="3",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 pages="341--352",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 issn="1618-727X",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 doi="10.1007/s10278-018-0082-y",
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 url="https://doi.org/10.1007/s10278-018-0082-y"
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 }