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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8">
<title>libzdb | PostgreSQL Options</title>
<link rel="stylesheet" href="libzdboptions.css">
</head>
<body>
<h1>
PostgreSQL <i>URL</i> 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>
Specifies the connect timeout in seconds. This is the duration to wait when establishing a connection to the database.
The default value is 3 seconds. It is a checked runtime error to use a value less than or equal to 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>
ssl-cert
</td>
<td>
The path to the SSL certificate file to use for establishing a secure connection.
<p class="example">Example: ssl-cert=/etc/ssl/certs/client-cert.pem</p>
</td>
<td>
String
</td>
</tr>
<tr>
<td>
ssl-key
</td>
<td>
The path to the SSL key file to use for establishing a secure connection.
<p class="example">Example: ssl-key=/etc/ssl/certs/client-key.pem</p>
</td>
<td>
String
</td>
</tr>
<tr>
<td>
ssl-ca
</td>
<td>
The path to the SSL CA certificate file to use for establishing a secure connection.
<p class="example">Example: ssl-ca=/etc/ssl/certs/ca-certificates.pem</p>
</td>
<td>
String
</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>
|
