forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNpgsqlError.cs
More file actions
312 lines (288 loc) · 8 KB
/
NpgsqlError.cs
File metadata and controls
312 lines (288 loc) · 8 KB
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
// created on 12/7/2003 at 18:36
// Npgsql.NpgsqlError.cs
//
// Author:
// Francisco Jr. (fxjrlists@yahoo.com.br)
//
// Copyright (C) 2002 The Npgsql Development Team
// npgsql-general@gborg.postgresql.org
// http://gborg.postgresql.org/project/npgsql/projdisplay.php
//
// Permission to use, copy, modify, and distribute this software and its
// documentation for any purpose, without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph and the following two paragraphs appear in all copies.
//
// IN NO EVENT SHALL THE NPGSQL DEVELOPMENT TEAM BE LIABLE TO ANY PARTY
// FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
// INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
// DOCUMENTATION, EVEN IF THE NPGSQL DEVELOPMENT TEAM HAS BEEN ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
// THE NPGSQL DEVELOPMENT TEAM SPECIFICALLY DISCLAIMS ANY WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
// ON AN "AS IS" BASIS, AND THE NPGSQL DEVELOPMENT TEAM HAS NO OBLIGATIONS
// TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
using System;
using System.IO;
using System.Text;
namespace Npgsql
{
/// <summary>
/// EventArgs class to send Notice parameters, which are just NpgsqlError's in a lighter context.
/// </summary>
public class NpgsqlNoticeEventArgs : EventArgs
{
/// <summary>
/// Notice information.
/// </summary>
public NpgsqlError Notice = null;
internal NpgsqlNoticeEventArgs(NpgsqlError eNotice)
{
Notice = eNotice;
}
}
/// <summary>
/// This class represents the ErrorResponse and NoticeResponse
/// message sent from PostgreSQL server.
/// </summary>
[Serializable]
public sealed class NpgsqlError
{
private readonly ProtocolVersion protocol_version;
private readonly String _severity = String.Empty;
private readonly String _code = String.Empty;
private readonly String _message = String.Empty;
private readonly String _detail = String.Empty;
private readonly String _hint = String.Empty;
private readonly String _position = String.Empty;
private readonly String _internalPosition = String.Empty;
private readonly String _internalQuery = String.Empty;
private readonly String _where = String.Empty;
private readonly String _file = String.Empty;
private readonly String _line = String.Empty;
private readonly String _routine = String.Empty;
private String _errorSql = String.Empty;
/// <summary>
/// Severity code. All versions.
/// </summary>
public String Severity
{
get { return _severity; }
}
/// <summary>
/// Error code. PostgreSQL 7.4 and up.
/// </summary>
public String Code
{
get { return _code; }
}
/// <summary>
/// Terse error message. All versions.
/// </summary>
public String Message
{
get { return _message; }
}
/// <summary>
/// Detailed error message. PostgreSQL 7.4 and up.
/// </summary>
public String Detail
{
get { return _detail; }
}
/// <summary>
/// Suggestion to help resolve the error. PostgreSQL 7.4 and up.
/// </summary>
public String Hint
{
get { return _hint; }
}
/// <summary>
/// Position (one based) within the query string where the error was encounterd. PostgreSQL 7.4 and up.
/// </summary>
public String Position
{
get { return _position; }
}
/// <summary>
/// Position (one based) within the query string where the error was encounterd. This position refers to an internal command executed for example inside a PL/pgSQL function. PostgreSQL 7.4 and up.
/// </summary>
public String InternalPosition
{
get { return _internalPosition; }
}
/// <summary>
/// Internal query string where the error was encounterd. This position refers to an internal command executed for example inside a PL/pgSQL function. PostgreSQL 7.4 and up.
/// </summary>
public String InternalQuery
{
get { return _internalQuery; }
}
/// <summary>
/// Trace back information. PostgreSQL 7.4 and up.
/// </summary>
public String Where
{
get { return _where; }
}
/// <summary>
/// Source file (in backend) reporting the error. PostgreSQL 7.4 and up.
/// </summary>
public String File
{
get { return _file; }
}
/// <summary>
/// Source file line number (in backend) reporting the error. PostgreSQL 7.4 and up.
/// </summary>
public String Line
{
get { return _line; }
}
/// <summary>
/// Source routine (in backend) reporting the error. PostgreSQL 7.4 and up.
/// </summary>
public String Routine
{
get { return _routine; }
}
/// <summary>
/// String containing the sql sent which produced this error.
/// </summary>
public String ErrorSql
{
set { _errorSql = value; }
get { return _errorSql; }
}
/// <summary>
/// Return a string representation of this error object.
/// </summary>
public override String ToString()
{
StringBuilder B = new StringBuilder();
if (Severity.Length > 0)
{
B.AppendFormat("{0}: ", Severity);
}
if (Code.Length > 0)
{
B.AppendFormat("{0}: ", Code);
}
B.AppendFormat("{0}", Message);
// CHECKME - possibly multi-line, that is yucky
// if (Hint.Length > 0) {
// B.AppendFormat(" ({0})", Hint);
// }
return B.ToString();
}
internal NpgsqlError(ProtocolVersion protocolVersion, Stream stream)
{
switch (protocol_version = protocolVersion)
{
case ProtocolVersion.Version2:
string[] parts = PGUtil.ReadString(stream).Split(new char[] {':'}, 2);
if (parts.Length == 2)
{
_severity = parts[0].Trim();
_message = parts[1].Trim();
}
else
{
_severity = string.Empty;
_message = parts[0].Trim();
}
break;
case ProtocolVersion.Version3:
// Check the messageLength value. If it is 1178686529, this would be the
// "FATA" string, which would mean a protocol 2.0 error string.
if (PGUtil.ReadInt32(stream) == 1178686529)
{
string[] v2Parts = ("FATA" + PGUtil.ReadString(stream)).Split(new char[] {':'}, 2);
if (v2Parts.Length == 2)
{
_severity = v2Parts[0].Trim();
_message = v2Parts[1].Trim();
}
else
{
_severity = string.Empty;
_message = v2Parts[0].Trim();
}
protocol_version = ProtocolVersion.Version2;
}
else
{
for (char field = (char) stream.ReadByte(); field != 0; field = (char) stream.ReadByte())
{
switch (field)
{
case 'S':
_severity = PGUtil.ReadString(stream);
;
break;
case 'C':
_code = PGUtil.ReadString(stream);
;
break;
case 'M':
_message = PGUtil.ReadString(stream);
;
break;
case 'D':
_detail = PGUtil.ReadString(stream);
;
break;
case 'H':
_hint = PGUtil.ReadString(stream);
;
break;
case 'P':
_position = PGUtil.ReadString(stream);
;
break;
case 'p':
_internalPosition = PGUtil.ReadString(stream);
;
break;
case 'q':
_internalQuery = PGUtil.ReadString(stream);
;
break;
case 'W':
_where = PGUtil.ReadString(stream);
;
break;
case 'F':
_file = PGUtil.ReadString(stream);
;
break;
case 'L':
_line = PGUtil.ReadString(stream);
;
break;
case 'R':
_routine = PGUtil.ReadString(stream);
;
break;
}
}
}
break;
}
}
internal NpgsqlError(ProtocolVersion protocolVersion, String errorMessage)
{
protocol_version = protocolVersion;
_message = errorMessage;
}
/// <summary>
/// Backend protocol version in use.
/// </summary>
internal ProtocolVersion BackendProtocolVersion
{
get { return protocol_version; }
}
}
}