orthanc-book: Sphinx/source/plugins/odbc.rst comparison

comparison Sphinx/source/plugins/odbc.rst @ 751:37512473ffe9

improved odbc

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Fri, 13 Aug 2021 15:49:42 +0200
parents	8b8df1be0cf9
children	2f70f622059b

comparison

equal deleted inserted replaced

-:8b8df1be0cf9
+:37512473ffe9
 genericity: Some specific optimisations can only be done if focusing
 on one single database.
 That being said, there are multiple use cases for the ODBC plugins:
-* Connection to Microsoft SQL Server (MSSQL) is only possible with
+* Connection to Microsoft SQL Server (MSSQL), including Microsoft
-ODBC. Note that the ODBC plugins were only validated against MSSQL
+Azure SQL, is only possible with ODBC. Note that the ODBC plugins
-2017 and MSSQL 2019, under GNU/Linux.
+were only validated against MSSQL 2017 and MSSQL 2019, under
+GNU/Linux.
 * Contrarily to the built-in SQLite engine and to the MySQL/MariaDB
 index plugin, the ODBC index plugin supports the :ref:`revision
 mechanism <revisions>` to protect metadata and attachments from
 concurrent modifications.
 +------------------------------+--------------------------------------------------------+
 | Database management system   | Recommended index plugin                               |
 +==============================+========================================================+
 | Microsoft SQL server (MSSQL) | ODBC plugin                                            |
+| or Microsoft Azure SQL       |                                                        |
 +------------------------------+--------------------------------------------------------+
 | MySQL (with revisions)       | ODBC plugin                                            |
 +------------------------------+--------------------------------------------------------+
 | MySQL (without revisions)    | :ref:`MySQL plugin <mysql>`                            |
 +------------------------------+--------------------------------------------------------+
 | Type of storage area         | Recommended storage plugin                             |
 +==============================+========================================================+
 | Filesystem                   | No plugin needed                                       |
 +------------------------------+--------------------------------------------------------+
 | Microsoft SQL server (MSSQL) | ODBC plugin                                            |
+| or Microsoft Azure SQL       |                                                        |
 +------------------------------+--------------------------------------------------------+
 | MySQL                        | :ref:`MySQL plugin <mysql>`                            |
 +------------------------------+--------------------------------------------------------+
 | PostgreSQL                   | :ref:`PostgreSQL plugin <postgresql>`                  |
 +------------------------------+--------------------------------------------------------+
 Usage
 -----
-.. highlight:: json
 You of course first have to :ref:`install Orthanc <binaries>`, with a
 version above 0.9.5. You then have to **configure an ODBC data
 source** dedicated to Orthanc. The procedure depends upon your
 operating system:
 * If you are interested in interfacing Orthanc with Microsoft SQL
 Server, the corresponding ODBC drivers can be `downloaded from
 Microsoft
 <https://docs.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server>`__.
+.. highlight:: json
 Once Orthanc is installed and the data sources have been defined, you
 must add a section in the :ref:`configuration file <configuration>`
 that specifies the **data source(s) to be used**. You also have to
 tell Orthanc in which path it can find the plugins: This is done by
 properly modifying the ``Plugins`` option. You could for instance
 "Odbc" : {
 "EnableIndex" : true,
 "EnableStorage" : true,
 "IndexConnectionString" : "DSN=index",
 "StorageConnectionString" : "DSN=storage",
-"MaximumConnectionRetries" : 10,  // Optional
+"MaximumConnectionRetries" : 10,
-"ConnectionRetryInterval" : 5,    // Optional
+"ConnectionRetryInterval" : 5,
-"IndexConnectionsCount" : 1       // Optional
+"IndexConnectionsCount" : 1
 },
 "Plugins" : [
 "/home/user/orthanc-databases/BuildOdbc/libOrthancOdbcIndex.so",
 "/home/user/orthanc-databases/BuildOdbc/libOrthancOdbcStorage.so"
 ]
 Server = tcp:localhost,1433
 Database = orthanctest
 Note that there exist `many more configuration options
 <https://docs.microsoft.com/en-us/sql/relational-databases/native-client/applications/using-connection-string-keywords-with-sql-server-native-client>`__
-for Microsoft SQL Server.
+for Microsoft SQL Server. In particular, ``Encrypt`` and
+``TrustServerCertificate`` and ``Connect Timeout`` can be
+interesting in the case of a connection to Microsoft Azure SQL.
 .. highlight:: json
 5. Start Orthanc using the following :ref:`configuration file
 <configuration>` for ODBC::
 In the connection strings:
 * ``DSN`` corresponds to the name of the entry in ``~/.odbc.ini``.
 * ``Uid`` is the user name in MSSQL (by default, the Docker image uses ``sa``).
-* ``Pwd`` is the password that has been used when starting Docker.
+* ``Pwd`` is the password that has been provided in the ``SA_PASSWORD``
+environment variable when starting Docker.
 * For security reasons, the ``Uid`` and ``Pwd`` parameters cannot
 be set in ``~/.odbc.ini``.
+**Remark:** It is actually not necessary to create an entry in
+``~/.odbc.ini``.  All the parameters can indeed be provided directly
+in the connection strings, for instance::
+{
+"Odbc" : {
+"EnableIndex" : true,
+"EnableStorage" : true,
+"IndexConnectionString" : "Driver={ODBC Driver 17 for SQL Server};Server=tcp:localhost,1433;Database=orthanctest;Uid=sa;Pwd=MyStrOngPa55word!",
+"StorageConnectionString" : "Driver={ODBC Driver 17 for SQL Server};Server=tcp:localhost,1433;Database=orthanctest;Uid=sa;Pwd=MyStrOngPa55word!"
+}
+}
 PostgreSQL
 ^^^^^^^^^^
 1. Install the ``odbc-postgresql`` package.
+.. highlight:: text
 2. Create the following sample `unixODBC
 <https://en.wikipedia.org/wiki/UnixODBC>`__ configuration file::
 $ cat ~/.odbc.ini
 Database    = orthanctest
 UserName    = postgres
 Password    = postgres
 Port        = 5432
+.. highlight:: json
 3. Start Orthanc using the following :ref:`configuration file
 <configuration>` for ODBC::
 {
 "Odbc" : {
 ^^^^^
 1. Install the official `Connect/ODBC package
 <https://dev.mysql.com/downloads/connector/odbc/>`__ (it is not
 packaged for Ubuntu 18.04).
+.. highlight:: text
 2. Create the following sample `unixODBC
 <https://en.wikipedia.org/wiki/UnixODBC>`__ configuration file::
 $ cat ~/.odbc.ini
 Database    = orthanctest
 UID         = root
 PWD         = root
 Port        = 3306
+.. highlight:: json
 3. Start Orthanc using the following :ref:`configuration file
 <configuration>` for ODBC::
 {
 "Odbc" : {
 SQLite
 ^^^^^^
 1. Install the ``libsqliteodbc`` package.
+.. highlight:: text
 2. Create the following sample `unixODBC
 <https://en.wikipedia.org/wiki/UnixODBC>`__ configuration file::
 $ cat ~/.odbc.ini
 [index]
 Note that we define two different data sources, one for the index
 and another for the storage area, because a SQLite database can
 only be opened by one client at once.
+.. highlight:: json
 3. Start Orthanc using the following :ref:`configuration file
 <configuration>` for ODBC::
 {
 "Odbc" : {

Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/odbc.rst @ 751:37512473ffe9