aboutsummaryrefslogtreecommitdiff
path: root/odb/mssql/details/options.cli
blob: e4b16f878508fc6475c160387222ecef369f469d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// file      : odb/mssql/details/options.cli
// copyright : Copyright (c) 2009-2019 Code Synthesis Tools CC
// license   : ODB NCUEL; see accompanying LICENSE file

include <string>;

namespace odb
{
  namespace mssql
  {
    namespace details
    {
      class options
      {
        std::string --user | -U
        {
          "<name>",
          "SQL Server database user. If not specified, then Windows
           authentication is used."
        };

        std::string --password | -P
        {
          "<str>",
          "SQL Server database password. Omit this option if the user
           password is blank or Windows authentication is used."
        };

        std::string --database | -d
        {
          "<name>",
          "SQL Server database name. If not specified, then the default
           database for this user is used."
        };

        std::string --server | -S
        {
          "<addr>",
          "SQL Server instance address in the
           \c{[\i{protocol}\b{:}]\i{host}[\b{\\}\i{instance}][\b{,}\i{port}]}
           format, where \ci{protocol} can be \cb{tcp} (TCP/IP),
           \cb{lpc} (shared memory), or \cb{np} (named pipe). If not specifid,
           then \cb{localhost} is used."
        };

        std::string --driver
        {
          "<name>",
          "SQL Server Native Client ODBC driver name. If not specified, then
           the latest available driver is used."
        };

        std::string --options-file
        {
          "<file>",
          "Read additional options from <file>. Each option appearing on a
           separate line optionally followed by space and an option value.
           Empty lines and lines starting with \cb{#} are ignored."
        };
      };
    }
  }
}