File: postgresoptions.html

package info (click to toggle)
libzdb 3.1-0.2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, stretch
  • size: 3,504 kB
  • ctags: 1,486
  • sloc: ansic: 6,072; sh: 3,600; makefile: 110; xml: 87; lex: 35
file content (95 lines) | stat: -rw-r--r-- 2,984 bytes parent folder | download | duplicates (2)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<html>
<head>
    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
    <title>libzdb | PostgreSQL Options</title>
    <link rel="stylesheet" href="libzdb.css">
</head>
<body>
    <h1>
        PostgreSQL URL properties
    </h1>
    <table>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Type</th>
        </tr>
        <tr>
            <td>
                user
            </td>
            <td>
                The PostgreSQL login ID. This property is required unless the auth-part of the URL was used.
                <p class="example">Example: user=root</p>
            </td>
            <td>
                String
            </td>
        </tr>
        <tr>
            <td>
                password
            </td>
            <td>
                The password for user. This property is required unless the auth-part of the URL was used.
                <p class="example">Example: password=swordfish</p>
            </td>
            <td>
                String
            </td>
        </tr>
        <tr>
            <td>
                connect-timeout
            </td>
            <td>
                Connect timeout in seconds. Default is 3 seconds. It is a checked runtime error to use a value equal to or less than 0.
                <p class="example">Example: connect-timeout=5</p>
            </td>
            <td>
                Integer (seconds)
            </td>
        </tr>
        <tr>
            <td>
                use-ssl
            </td>
            <td>
                Used for establishing secure connections using SSL. OpenSSL support must be enabled/linked in the client library. Default is false.
                <p class="example">Example: use-ssl=true</p>
                                
            </td>
            <td>
                Boolean (true/false)
            </td>
        </tr>
        <tr>
            <td>
                unix-socket
            </td>
            <td>
                Connect to the database server over a unix socket on localhost. The unix-socket value should be the name of the directory in which the
                unix socket file is stored. Note that this is different from the MySQL unix-socket parameter which specify the full path to the socket
                file.
                <p class="example">Example: unix-socket=/tmp</p>
                                        
            </td>
            <td>
                String (directory path)
            </td>
        </tr>
        <tr>
            <td>
                application-name
            </td>
            <td>
                Optionally specify the application name. The name will show up in PostgreSQL logs for connections and operations made through libzdb.
                <p class="example">Example: application-name=My Application</p>
            </td>
            <td>
                String
            </td>
        </tr>
    </table>
</body>
</html>