diff options
Diffstat (limited to '')
-rw-r--r-- | bin/Npgsql.xml | 5620 |
1 files changed, 5620 insertions, 0 deletions
diff --git a/bin/Npgsql.xml b/bin/Npgsql.xml new file mode 100644 index 0000000..8133430 --- /dev/null +++ b/bin/Npgsql.xml | |||
@@ -0,0 +1,5620 @@ | |||
1 | <?xml version="1.0"?> | ||
2 | <doc> | ||
3 | <assembly> | ||
4 | <name>Npgsql</name> | ||
5 | </assembly> | ||
6 | <members> | ||
7 | <member name="T:NpgsqlTypes.ArrayNativeToBackendTypeConverter"> | ||
8 | <summary> | ||
9 | Handles serialisation of .NET array or IEnumeration to pg format. | ||
10 | Arrays of arrays, enumerations of enumerations, arrays of enumerations etc. | ||
11 | are treated as multi-dimensional arrays (in much the same manner as an array of arrays | ||
12 | is used to emulate multi-dimensional arrays in languages that lack native support for them). | ||
13 | If such an enumeration of enumerations is "jagged" (as opposed to rectangular, cuboid, | ||
14 | hypercuboid, hyperhypercuboid, etc) then this class will "correctly" serialise it, but pg | ||
15 | will raise an error as it doesn't allow jagged arrays. | ||
16 | </summary> | ||
17 | </member> | ||
18 | <member name="M:NpgsqlTypes.ArrayNativeToBackendTypeConverter.#ctor(NpgsqlTypes.NpgsqlNativeTypeInfo)"> | ||
19 | <summary> | ||
20 | Create an ArrayNativeToBackendTypeConverter with the element converter passed | ||
21 | </summary> | ||
22 | <param name="elementConverter">The <see cref="T:NpgsqlTypes.NpgsqlNativeTypeInfo"/> that would be used to serialise the element type.</param> | ||
23 | </member> | ||
24 | <member name="M:NpgsqlTypes.ArrayNativeToBackendTypeConverter.ArrayToArrayText(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
25 | <summary> | ||
26 | Serialise the enumeration or array. | ||
27 | </summary> | ||
28 | </member> | ||
29 | <member name="M:NpgsqlTypes.ArrayNativeToBackendTypeConverter.ArrayToArrayBinary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> | ||
30 | <summary> | ||
31 | Convert a System.Array to PG binary format. | ||
32 | Write the array header and prepare to write array data to the stream. | ||
33 | </summary> | ||
34 | </member> | ||
35 | <member name="M:NpgsqlTypes.ArrayNativeToBackendTypeConverter.WriteBinaryArrayData(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Array,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.IO.MemoryStream,System.Int32,System.Int32[])"> | ||
36 | <summary> | ||
37 | Append all array data to the binary stream. | ||
38 | </summary> | ||
39 | </member> | ||
40 | <member name="T:NpgsqlTypes.ArrayBackendToNativeTypeConverter"> | ||
41 | <summary> | ||
42 | Handles parsing of pg arrays into .NET arrays. | ||
43 | </summary> | ||
44 | </member> | ||
45 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.TokenEnumeration(System.String)"> | ||
46 | <summary> | ||
47 | Takes a string representation of a pg 1-dimensional array | ||
48 | (or a 1-dimensional row within an n-dimensional array) | ||
49 | and allows enumeration of the string represenations of each items. | ||
50 | </summary> | ||
51 | </member> | ||
52 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ArrayChunkEnumeration(System.String)"> | ||
53 | <summary> | ||
54 | Takes a string representation of a pg n-dimensional array | ||
55 | and allows enumeration of the string represenations of the next | ||
56 | lower level of rows (which in turn can be taken as (n-1)-dimensional arrays. | ||
57 | </summary> | ||
58 | </member> | ||
59 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.RecursiveArrayListEnumeration(System.Collections.ArrayList)"> | ||
60 | <summary> | ||
61 | Takes an ArrayList which may be an ArrayList of ArrayLists, an ArrayList of ArrayLists of ArrayLists | ||
62 | and so on and enumerates the items that aren't ArrayLists (the leaf nodes if we think of the ArrayList | ||
63 | passed as a tree). Simply uses the ArrayLists' own IEnumerators to get that of the next, | ||
64 | pushing them onto a stack until we hit something that isn't an ArrayList. | ||
65 | <param name="list"><see cref="T:System.Collections.ArrayList">ArrayList</see> to enumerate</param> | ||
66 | <returns><see cref="T:System.Collections.IEnumerable">IEnumerable</see></returns> | ||
67 | </summary> | ||
68 | </member> | ||
69 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.#ctor(NpgsqlTypes.NpgsqlBackendTypeInfo)"> | ||
70 | <summary> | ||
71 | Create a new ArrayBackendToNativeTypeConverter | ||
72 | </summary> | ||
73 | <param name="elementConverter"><see cref="T:NpgsqlTypes.NpgsqlBackendTypeInfo"/> for the element type.</param> | ||
74 | </member> | ||
75 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ArrayTextToArray(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
76 | <summary> | ||
77 | Creates an array from pg text representation. | ||
78 | </summary> | ||
79 | </member> | ||
80 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ToArrayList(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | ||
81 | <summary> | ||
82 | Creates an array list from pg represenation of an array. | ||
83 | Multidimensional arrays are treated as ArrayLists of ArrayLists | ||
84 | </summary> | ||
85 | </member> | ||
86 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ToArray(System.Collections.ArrayList,System.Type)"> | ||
87 | <summary> | ||
88 | Creates an n-dimensional array from an ArrayList of ArrayLists or | ||
89 | a 1-dimensional array from something else. | ||
90 | </summary> | ||
91 | <param name="list"><see cref="T:System.Collections.ArrayList"/> to convert</param> | ||
92 | <param name="elementType">Type of the elements in the list</param> | ||
93 | <returns><see cref="T:System.Array"/> produced.</returns> | ||
94 | </member> | ||
95 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ArrayBinaryToArray(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> | ||
96 | <summary> | ||
97 | Creates an n-dimensional System.Array from PG binary representation. | ||
98 | This function reads the array header and sets up an n-dimensional System.Array object to hold its data. | ||
99 | PopulateArrayFromBinaryArray() is then called to carry out array population. | ||
100 | </summary> | ||
101 | </member> | ||
102 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.PopulateArrayFromBinaryArray(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32,System.Int32@,System.Int32[],System.Int32[],System.Int32,System.Array,System.Int32[])"> | ||
103 | <summary> | ||
104 | Recursively populates an array from PB binary data representation. | ||
105 | </summary> | ||
106 | </member> | ||
107 | <member name="T:NpgsqlTypes.ArrayBackendToNativeTypeConverter.IntSetIterator"> | ||
108 | <summary> | ||
109 | Takes an array of ints and treats them like the limits of a set of counters. | ||
110 | Retains a matching set of ints that is set to all zeros on the first ++ | ||
111 | On a ++ it increments the "right-most" int. If that int reaches it's | ||
112 | limit it is set to zero and the one before it is incremented, and so on. | ||
113 | |||
114 | Making this a more general purpose class is pretty straight-forward, but we'll just put what we need here. | ||
115 | </summary> | ||
116 | </member> | ||
117 | <member name="T:NpgsqlTypes.BitString"> | ||
118 | <summary> | ||
119 | <para>Implements a bit string; a collection of zero or more bits which can each be 1 or 0.</para> | ||
120 | <para>BitString's behave as a list of bools, though like most strings and unlike most collections the position | ||
121 | tends to be of as much significance as the value.</para> | ||
122 | <para>BitStrings are often used as masks, and are commonly cast to and from other values.</para> | ||
123 | </summary> | ||
124 | </member> | ||
125 | <member name="F:NpgsqlTypes.BitString.Empty"> | ||
126 | <summary> | ||
127 | Represents the empty string. | ||
128 | </summary> | ||
129 | </member> | ||
130 | <member name="M:NpgsqlTypes.BitString.#ctor(System.Collections.Generic.IEnumerable{System.Boolean})"> | ||
131 | <summary> | ||
132 | Create a BitString from an enumeration of boolean values. The BitString will contain | ||
133 | those booleans in the order they came in. | ||
134 | </summary> | ||
135 | <param name="bits">The boolean values.</param> | ||
136 | </member> | ||
137 | <member name="M:NpgsqlTypes.BitString.#ctor(System.Boolean,System.Int32)"> | ||
138 | <summary> | ||
139 | Creates a BitString filled with a given number of true or false values. | ||
140 | </summary> | ||
141 | <param name="value">The value to fill the string with.</param> | ||
142 | <param name="count">The number of bits to fill.</param> | ||
143 | </member> | ||
144 | <member name="M:NpgsqlTypes.BitString.#ctor(System.String)"> | ||
145 | <summary> | ||
146 | Creats a bitstring from a <see cref="T:System.String">string</see>. | ||
147 | <param name="str">The <see cref="T:System.String">string to copy from</see>.</param> | ||
148 | <seealso cref="M:NpgsqlTypes.BitString.Parse(System.String)"/> | ||
149 | </summary> | ||
150 | </member> | ||
151 | <member name="M:NpgsqlTypes.BitString.#ctor(System.Boolean)"> | ||
152 | <summary> | ||
153 | Creates a single-bit element from a boolean value. | ||
154 | </summary> | ||
155 | <param name="boolean">The <see cref="T:System.Boolean">bool</see> value which determines whether | ||
156 | the bit is 1 or 0.</param> | ||
157 | </member> | ||
158 | <member name="M:NpgsqlTypes.BitString.#ctor(System.UInt32)"> | ||
159 | <summary> | ||
160 | Creates a bitstring from an unsigned integer value. The string will be the shortest required to | ||
161 | contain the integer (e.g. 1 bit for 0 or 1, 2 for 2 or 3, 3 for 4-7, and so on). | ||
162 | </summary> | ||
163 | <param name="integer">The <see cref="T:System.UInt32">integer</see>.</param> | ||
164 | <remarks>This method is not CLS Compliant, and may not be available to some languages.</remarks> | ||
165 | </member> | ||
166 | <member name="M:NpgsqlTypes.BitString.#ctor(System.Int32)"> | ||
167 | <summary> | ||
168 | Creates a bitstring from an integer value. The string will be the shortest required to | ||
169 | contain the integer (e.g. 1 bit for 0 or 1, 2 for 2 or 3, 3 for 4-7, and so on). | ||
170 | </summary> | ||
171 | <param name="integer">The <see cref="T:System.Int32">integer</see>.</param> | ||
172 | </member> | ||
173 | <member name="M:NpgsqlTypes.BitString.IndexOf(System.Boolean)"> | ||
174 | <summary> | ||
175 | Finds the first instance of a given value | ||
176 | </summary> | ||
177 | <param name="item">The value - whether true or false - to search for.</param> | ||
178 | <returns>The index of the value found, or -1 if none are present.</returns> | ||
179 | </member> | ||
180 | <member name="M:NpgsqlTypes.BitString.Contains(System.Boolean)"> | ||
181 | <summary> | ||
182 | True if there is at least one bit with the value looked for. | ||
183 | </summary> | ||
184 | <param name="item">The value - true or false - to detect.</param> | ||
185 | <returns>True if at least one bit was the same as item, false otherwise.</returns> | ||
186 | </member> | ||
187 | <member name="M:NpgsqlTypes.BitString.CopyTo(System.Boolean[],System.Int32)"> | ||
188 | <summary> | ||
189 | Copies the bitstring to an array of bools. | ||
190 | </summary> | ||
191 | <param name="array">The <see cref="T:System.Boolean">boolean</see> array to copy to.</param> | ||
192 | <param name="arrayIndex">The index in the array to start copying from.</param> | ||
193 | </member> | ||
194 | <member name="M:NpgsqlTypes.BitString.GetEnumerator"> | ||
195 | <summary> | ||
196 | Returns an enumerator that enumerates through the string. | ||
197 | </summary> | ||
198 | <returns>The enumerator.</returns> | ||
199 | </member> | ||
200 | <member name="M:NpgsqlTypes.BitString.Concat(NpgsqlTypes.BitString)"> | ||
201 | <summary> | ||
202 | Creats a bitstring by concatenating another onto this one. | ||
203 | </summary> | ||
204 | <param name="append">The string to append to this one.</param> | ||
205 | <returns>The combined strings.</returns> | ||
206 | </member> | ||
207 | <member name="M:NpgsqlTypes.BitString.Substring(System.Int32,System.Int32)"> | ||
208 | <summary> | ||
209 | Returns a substring of this string. | ||
210 | </summary> | ||
211 | <param name="start">The position to start from, must be between 0 and the length of the string.</param> | ||
212 | <param name="length">The length of the string to return, must be greater than zero, and may not be | ||
213 | so large that the start + length exceeds the bounds of this instance.</param> | ||
214 | <returns>The Bitstring identified</returns> | ||
215 | </member> | ||
216 | <member name="M:NpgsqlTypes.BitString.Substring(System.Int32)"> | ||
217 | <summary> | ||
218 | Returns a substring of this string. | ||
219 | </summary> | ||
220 | <param name="start">The position to start from, must be between 0 and the length of the string, | ||
221 | the rest of the string is returned.</param> | ||
222 | <returns>The Bitstring identified</returns> | ||
223 | </member> | ||
224 | <member name="M:NpgsqlTypes.BitString.And(NpgsqlTypes.BitString)"> | ||
225 | <summary> | ||
226 | A logical and between this string and another. The two strings must be the same length. | ||
227 | </summary> | ||
228 | <param name="operand">Another BitString to AND with this one.</param> | ||
229 | <returns>A bitstring with 1 where both BitStrings had 1 and 0 otherwise.</returns> | ||
230 | </member> | ||
231 | <member name="M:NpgsqlTypes.BitString.Or(NpgsqlTypes.BitString)"> | ||
232 | <summary> | ||
233 | A logical or between this string and another. The two strings must be the same length. | ||
234 | </summary> | ||
235 | <param name="operand">Another BitString to OR with this one.</param> | ||
236 | <returns>A bitstring with 1 where either BitString had 1 and 0 otherwise.</returns> | ||
237 | </member> | ||
238 | <member name="M:NpgsqlTypes.BitString.Xor(NpgsqlTypes.BitString)"> | ||
239 | <summary> | ||
240 | A logical xor between this string and another. The two strings must be the same length. | ||
241 | </summary> | ||
242 | <param name="operand">Another BitString to XOR with this one.</param> | ||
243 | <returns>A bitstring with 1 where one BitStrings and the other had 0, | ||
244 | and 0 where they both had 1 or both had 0.</returns> | ||
245 | </member> | ||
246 | <member name="M:NpgsqlTypes.BitString.Not"> | ||
247 | <summary> | ||
248 | A bitstring that is the logical inverse of this one. | ||
249 | </summary> | ||
250 | <returns>A bitstring of the same length as this with 1 where this has 0 and vice-versa.</returns> | ||
251 | </member> | ||
252 | <member name="M:NpgsqlTypes.BitString.LShift(System.Int32)"> | ||
253 | <summary> | ||
254 | Shifts the string operand bits to the left, filling with zeros to produce a | ||
255 | string of the same length. | ||
256 | </summary> | ||
257 | <param name="operand">The number of bits to shift to the left.</param> | ||
258 | <returns>A left-shifted bitstring.</returns> | ||
259 | <remarks><para>The behaviour of LShift is closer to what one would expect from dealing | ||
260 | with PostgreSQL bit-strings than in using the same operations on integers in .NET</para> | ||
261 | <para>In particular, negative operands result in a right-shift, and operands greater than | ||
262 | the length of the string will shift it entirely, resulting in a zero-filled string.</para> | ||
263 | </remarks> | ||
264 | </member> | ||
265 | <member name="M:NpgsqlTypes.BitString.RShift(System.Int32)"> | ||
266 | <summary> | ||
267 | Shifts the string operand bits to the right, filling with zeros to produce a | ||
268 | string of the same length. | ||
269 | </summary> | ||
270 | <param name="operand">The number of bits to shift to the right.</param> | ||
271 | <returns>A right-shifted bitstring.</returns> | ||
272 | <remarks><para>The behaviour of RShift is closer to what one would expect from dealing | ||
273 | with PostgreSQL bit-strings than in using the same operations on integers in .NET</para> | ||
274 | <para>In particular, negative operands result in a left-shift, and operands greater than | ||
275 | the length of the string will shift it entirely, resulting in a zero-filled string. It also performs | ||
276 | a logical shift, rather than an arithmetic shift, so it always sets the vacated bit positions to zero | ||
277 | (like PostgreSQL and like .NET for unsigned integers but not for signed integers).</para> | ||
278 | </remarks> | ||
279 | </member> | ||
280 | <member name="M:NpgsqlTypes.BitString.Equals(NpgsqlTypes.BitString)"> | ||
281 | <summary> | ||
282 | Returns true if the this string is identical to the argument passed. | ||
283 | </summary> | ||
284 | </member> | ||
285 | <member name="M:NpgsqlTypes.BitString.CompareTo(NpgsqlTypes.BitString)"> | ||
286 | <summary> | ||
287 | Compares two strings. Strings are compared as strings, so while 0 being less than 1 will | ||
288 | mean a comparison between two strings of the same size is the same as treating them as numbers, | ||
289 | in the case of two strings of differing lengths the comparison starts at the right-most (most significant) | ||
290 | bit, and if all bits of the shorter string are exhausted without finding a comparison, then the larger | ||
291 | string is deemed to be greater than the shorter (0010 is greater than 0001 but less than 00100). | ||
292 | </summary> | ||
293 | <param name="other">Another string to compare with this one.</param> | ||
294 | <returns>A value if the two strings are identical, an integer less | ||
295 | than zero if this is less than the argument, and an integer greater | ||
296 | than zero otherwise.</returns> | ||
297 | </member> | ||
298 | <member name="M:NpgsqlTypes.BitString.CompareTo(System.Object)"> | ||
299 | <summary> | ||
300 | Compares the string with another object. | ||
301 | </summary> | ||
302 | <param name="obj">The object to compare with.</param> | ||
303 | <returns>If the object is null then this string is considered greater. If the object is another BitString | ||
304 | then they are compared as in <see cref="M:NpgsqlTypes.BitString.CompareTo(NpgsqlTypes.BitString)">the explicit comparison for BitStrings</see> | ||
305 | in any other case a <see cref="T:System.ArgumentException"/> is thrown.</returns> | ||
306 | </member> | ||
307 | <member name="M:NpgsqlTypes.BitString.Equals(System.Object)"> | ||
308 | <summary> | ||
309 | Compares this BitString with an object for equality. | ||
310 | </summary> | ||
311 | </member> | ||
312 | <member name="M:NpgsqlTypes.BitString.GetHashCode"> | ||
313 | <summary> | ||
314 | Returns a code for use in hashing operations. | ||
315 | </summary> | ||
316 | </member> | ||
317 | <member name="M:NpgsqlTypes.BitString.ToString(System.String)"> | ||
318 | <summary> | ||
319 | Returns a string representation of the BitString. | ||
320 | </summary> | ||
321 | <param name="format"> | ||
322 | A string which can contain a letter and optionally a number which sets a minimum size for the string | ||
323 | returned. In each case using the lower-case form of the letter will result in a lower-case string | ||
324 | being returned. | ||
325 | <list type="table"> | ||
326 | <item> | ||
327 | <term>B</term> | ||
328 | <description>A string of 1s and 0s.</description> | ||
329 | </item> | ||
330 | <item> | ||
331 | <term>X</term> | ||
332 | <description>An hexadecimal string (will result in an error unless the string's length is divisible by 4).</description> | ||
333 | </item> | ||
334 | <item> | ||
335 | <term>G</term> | ||
336 | <description>A string of 1s and 0s in single-quotes preceded by 'B' (Postgres bit string literal syntax).</description> | ||
337 | </item> | ||
338 | <term>Y</term> | ||
339 | <description>An hexadecimal string in single-quotes preceded by 'X' (Postgres bit literal syntax, will result in an error unless the string's length is divisible by 4.</description> | ||
340 | </list> | ||
341 | <term>C</term> | ||
342 | <description>The format produced by format-string "Y" if legal, otherwise that produced by format-string "G".</description> | ||
343 | <term>E</term> | ||
344 | <description>The most compact safe representation for Postgres. If single bit will be either a 0 or a 1. Otherwise if it | ||
345 | can be that produce by format string "Y" it will, otherwise if there are less than 9bits in length it will be that | ||
346 | produced by format-string "G". For longer strings that cannot be represented in hexadecimal it will be a string | ||
347 | representing the first part of the string in format "Y" followed by the PostgreSQL concatenation operator, followed | ||
348 | by the final bits in the format "G". E.g. "X'13DCE'||B'110'"</description> | ||
349 | If format is empty or null, it is treated as if "B" had been passed (the default repreesentation, and that | ||
350 | generally used by PostgreSQL for display). | ||
351 | </param> | ||
352 | <returns>The formatted string.</returns> | ||
353 | </member> | ||
354 | <member name="M:NpgsqlTypes.BitString.ToString"> | ||
355 | <summary> | ||
356 | Returns a string representation for the Bitstring | ||
357 | </summary> | ||
358 | <returns>A string containing '0' and '1' characters.</returns> | ||
359 | </member> | ||
360 | <member name="M:NpgsqlTypes.BitString.ToString(System.String,System.IFormatProvider)"> | ||
361 | <summary> | ||
362 | Returns the same string as <see cref="M:NpgsqlTypes.BitString.ToString(System.String)"/>. formatProvider is ignored. | ||
363 | </summary> | ||
364 | </member> | ||
365 | <member name="M:NpgsqlTypes.BitString.Parse(System.String)"> | ||
366 | <summary> | ||
367 | Parses a string to produce a BitString. Most formats that can be produced by | ||
368 | <see cref="M:NpgsqlTypes.BitString.ToString(System.String)"/> can be accepted, but hexadecimal | ||
369 | can be interpreted with the preceding X' to mark the following characters as | ||
370 | being hexadecimal rather than binary. | ||
371 | </summary> | ||
372 | </member> | ||
373 | <member name="M:NpgsqlTypes.BitString.op_BitwiseAnd(NpgsqlTypes.BitString,NpgsqlTypes.BitString)"> | ||
374 | <summary> | ||
375 | Performs a logical AND on the two operands. | ||
376 | </summary> | ||
377 | </member> | ||
378 | <member name="M:NpgsqlTypes.BitString.op_BitwiseOr(NpgsqlTypes.BitString,NpgsqlTypes.BitString)"> | ||
379 | <summary> | ||
380 | Performs a logcial OR on the two operands. | ||
381 | </summary> | ||
382 | </member> | ||
383 | <member name="M:NpgsqlTypes.BitString.op_ExclusiveOr(NpgsqlTypes.BitString,NpgsqlTypes.BitString)"> | ||
384 | <summary> | ||
385 | Perofrms a logical EXCLUSIVE-OR on the two operands | ||
386 | </summary> | ||
387 | </member> | ||
388 | <member name="M:NpgsqlTypes.BitString.op_OnesComplement(NpgsqlTypes.BitString)"> | ||
389 | <summary> | ||
390 | Performs a logical NOT on the operand. | ||
391 | </summary> | ||
392 | </member> | ||
393 | <member name="M:NpgsqlTypes.BitString.op_Addition(NpgsqlTypes.BitString,NpgsqlTypes.BitString)"> | ||
394 | <summary> | ||
395 | Concatenates the operands. | ||
396 | </summary> | ||
397 | </member> | ||
398 | <member name="M:NpgsqlTypes.BitString.op_LeftShift(NpgsqlTypes.BitString,System.Int32)"> | ||
399 | <summary> | ||
400 | Left-shifts the string BitString. | ||
401 | </summary> | ||
402 | </member> | ||
403 | <member name="M:NpgsqlTypes.BitString.op_RightShift(NpgsqlTypes.BitString,System.Int32)"> | ||
404 | <summary> | ||
405 | Right-shifts the string BitString. | ||
406 | </summary> | ||
407 | </member> | ||
408 | <member name="M:NpgsqlTypes.BitString.op_Equality(NpgsqlTypes.BitString,NpgsqlTypes.BitString)"> | ||
409 | <summary> | ||
410 | Compares the two operands. | ||
411 | </summary> | ||
412 | </member> | ||
413 | <member name="M:NpgsqlTypes.BitString.op_Inequality(NpgsqlTypes.BitString,NpgsqlTypes.BitString)"> | ||
414 | <summary> | ||
415 | Compares the two operands. | ||
416 | </summary> | ||
417 | </member> | ||
418 | <member name="M:NpgsqlTypes.BitString.op_LessThan(NpgsqlTypes.BitString,NpgsqlTypes.BitString)"> | ||
419 | <summary> | ||
420 | Compares the two operands. | ||
421 | </summary> | ||
422 | </member> | ||
423 | <member name="M:NpgsqlTypes.BitString.op_GreaterThan(NpgsqlTypes.BitString,NpgsqlTypes.BitString)"> | ||
424 | <summary> | ||
425 | Compares the two operands. | ||
426 | </summary> | ||
427 | </member> | ||
428 | <member name="M:NpgsqlTypes.BitString.op_LessThanOrEqual(NpgsqlTypes.BitString,NpgsqlTypes.BitString)"> | ||
429 | <summary> | ||
430 | Compares the two operands. | ||
431 | </summary> | ||
432 | </member> | ||
433 | <member name="M:NpgsqlTypes.BitString.op_GreaterThanOrEqual(NpgsqlTypes.BitString,NpgsqlTypes.BitString)"> | ||
434 | <summary> | ||
435 | Compares the two operands. | ||
436 | </summary> | ||
437 | </member> | ||
438 | <member name="M:NpgsqlTypes.BitString.ToString(System.Text.Encoding)"> | ||
439 | <summary> | ||
440 | Interprets the bitstring as a series of bits in an encoded character string, | ||
441 | encoded according to the Encoding passed, and returns that string. | ||
442 | The bitstring must contain a whole number of octets(bytes) and also be | ||
443 | valid according to the Encoding passed. | ||
444 | </summary> | ||
445 | <param name="encoding">The <see cref="T:System.Text.Encoding"/> to use in producing the string.</param> | ||
446 | <returns>The string that was encoded in the BitString.</returns> | ||
447 | </member> | ||
448 | <member name="M:NpgsqlTypes.BitString.ToByteEnumerable"> | ||
449 | <summary> | ||
450 | Interprets the bitstring as a series of octets (bytes) and returns those octets. Fails | ||
451 | if the Bitstring does not contain a whole number of octets (its length is not evenly | ||
452 | divisible by 8). | ||
453 | </summary> | ||
454 | </member> | ||
455 | <member name="M:NpgsqlTypes.BitString.ToSByteEnumerable"> | ||
456 | <summary> | ||
457 | Interprets the bitstring as a series of signed octets (bytes) and returns those octets. Fails | ||
458 | if the Bitstring does not contain a whole number of octets (its length is not evenly | ||
459 | divisible by 8). | ||
460 | <remarks>This method is not CLS-Compliant and may not be available to languages that cannot | ||
461 | handle signed bytes.</remarks> | ||
462 | </summary> | ||
463 | </member> | ||
464 | <member name="M:NpgsqlTypes.BitString.ToUInt16Enumerable"> | ||
465 | <summary> | ||
466 | Interprets the bitstring as a series of unsigned 16-bit integers and returns those integers. | ||
467 | Fails if the Bitstring's length is not evenly divisible by 16. | ||
468 | <remarks>This method is not CLS-Compliant and may not be available to languages that cannot | ||
469 | handle unsigned integers.</remarks> | ||
470 | </summary> | ||
471 | </member> | ||
472 | <member name="M:NpgsqlTypes.BitString.ToInt16Enumerable"> | ||
473 | <summary> | ||
474 | Interprets the bitstring as a series of 16-bit integers and returns those integers. | ||
475 | Fails if the Bitstring's length is not evenly divisible by 16. | ||
476 | </summary> | ||
477 | </member> | ||
478 | <member name="M:NpgsqlTypes.BitString.ToUInt32Enumerable"> | ||
479 | <summary> | ||
480 | Interprets the bitstring as a series of unsigned 32-bit integers and returns those integers. | ||
481 | Fails if the Bitstring's length is not evenly divisible by 32. | ||
482 | <remarks>This method is not CLS-Compliant and may not be available to languages that cannot | ||
483 | handle unsigned integers.</remarks> | ||
484 | </summary> | ||
485 | </member> | ||
486 | <member name="M:NpgsqlTypes.BitString.ToInt32Enumerable"> | ||
487 | <summary> | ||
488 | Interprets the bitstring as a series of signed 32-bit integers and returns those integers. | ||
489 | Fails if the Bitstring's length is not evenly divisible by 32. | ||
490 | </summary> | ||
491 | </member> | ||
492 | <member name="M:NpgsqlTypes.BitString.ToUInt64Enumerable"> | ||
493 | <summary> | ||
494 | Interprets the bitstring as a series of unsigned 64-bit integers and returns those integers. | ||
495 | Fails if the Bitstring's length is not evenly divisible by 64. | ||
496 | <remarks>This method is not CLS-Compliant and may not be available to languages that cannot | ||
497 | handle unsigned integers.</remarks> | ||
498 | </summary> | ||
499 | </member> | ||
500 | <member name="M:NpgsqlTypes.BitString.ToInt64Enumerable"> | ||
501 | <summary> | ||
502 | Interprets the bitstring as a series of signed 64-bit integers and returns those integers. | ||
503 | Fails if the Bitstring's length is not evenly divisible by 64. | ||
504 | </summary> | ||
505 | </member> | ||
506 | <member name="P:NpgsqlTypes.BitString.Length"> | ||
507 | <summary> | ||
508 | The length of the string. | ||
509 | </summary> | ||
510 | </member> | ||
511 | <member name="P:NpgsqlTypes.BitString.Item(System.Int32)"> | ||
512 | <summary> | ||
513 | Retrieves the value of the bit at the given index. | ||
514 | </summary> | ||
515 | </member> | ||
516 | <member name="T:NpgsqlTypes.NpgsqlInterval"> | ||
517 | <summary> | ||
518 | Represents the PostgreSQL interval datatype. | ||
519 | <remarks>PostgreSQL differs from .NET in how it's interval type doesn't assume 24 hours in a day | ||
520 | (to deal with 23- and 25-hour days caused by daylight savings adjustments) and has a concept | ||
521 | of months that doesn't exist in .NET's <see cref="T:System.TimeSpan"/> class. (Neither datatype | ||
522 | has any concessions for leap-seconds). | ||
523 | <para>For most uses just casting to and from TimeSpan will work correctly — in particular, | ||
524 | the results of subtracting one <see cref="T:System.DateTime"/> or the PostgreSQL date, time and | ||
525 | timestamp types from another should be the same whether you do so in .NET or PostgreSQL — | ||
526 | but if the handling of days and months in PostgreSQL is important to your application then you | ||
527 | should use this class instead of <see cref="T:System.TimeSpan"/>.</para> | ||
528 | <para>If you don't know whether these differences are important to your application, they | ||
529 | probably arent! Just use <see cref="T:System.TimeSpan"/> and do not use this class directly ☺</para> | ||
530 | <para>To avoid forcing unnecessary provider-specific concerns on users who need not be concerned | ||
531 | with them a call to <see cref="M:System.Data.IDataRecord.GetValue(System.Int32)"/> on a field containing an | ||
532 | <see cref="T:NpgsqlTypes.NpgsqlInterval"/> value will return a <see cref="T:System.TimeSpan"/> rather than an | ||
533 | <see cref="T:NpgsqlTypes.NpgsqlInterval"/>. If you need the extra functionality of <see cref="T:NpgsqlTypes.NpgsqlInterval"/> | ||
534 | then use <see cref="M:Npgsql.NpgsqlDataReader.GetInterval(System.Int32)"/>.</para> | ||
535 | </remarks> | ||
536 | <seealso cref="P:NpgsqlTypes.NpgsqlInterval.Ticks"/> | ||
537 | <seealso cref="M:NpgsqlTypes.NpgsqlInterval.JustifyDays"/> | ||
538 | <seealso cref="M:NpgsqlTypes.NpgsqlInterval.JustifyMonths"/> | ||
539 | <seealso cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/> | ||
540 | </summary> | ||
541 | </member> | ||
542 | <member name="F:NpgsqlTypes.NpgsqlInterval.TicksPerMicrosecond"> | ||
543 | <summary> | ||
544 | Represents the number of ticks (100ns periods) in one microsecond. This field is constant. | ||
545 | </summary> | ||
546 | </member> | ||
547 | <member name="F:NpgsqlTypes.NpgsqlInterval.TicksPerMillsecond"> | ||
548 | <summary> | ||
549 | Represents the number of ticks (100ns periods) in one millisecond. This field is constant. | ||
550 | </summary> | ||
551 | </member> | ||
552 | <member name="F:NpgsqlTypes.NpgsqlInterval.TicksPerSecond"> | ||
553 | <summary> | ||
554 | Represents the number of ticks (100ns periods) in one second. This field is constant. | ||
555 | </summary> | ||
556 | </member> | ||
557 | <member name="F:NpgsqlTypes.NpgsqlInterval.TicksPerMinute"> | ||
558 | <summary> | ||
559 | Represents the number of ticks (100ns periods) in one minute. This field is constant. | ||
560 | </summary> | ||
561 | </member> | ||
562 | <member name="F:NpgsqlTypes.NpgsqlInterval.TicksPerHour"> | ||
563 | <summary> | ||
564 | Represents the number of ticks (100ns periods) in one hour. This field is constant. | ||
565 | </summary> | ||
566 | </member> | ||
567 | <member name="F:NpgsqlTypes.NpgsqlInterval.TicksPerDay"> | ||
568 | <summary> | ||
569 | Represents the number of ticks (100ns periods) in one day. This field is constant. | ||
570 | </summary> | ||
571 | </member> | ||
572 | <member name="F:NpgsqlTypes.NpgsqlInterval.HoursPerDay"> | ||
573 | <summary> | ||
574 | Represents the number of hours in one day (assuming no daylight savings adjustments). This field is constant. | ||
575 | </summary> | ||
576 | </member> | ||
577 | <member name="F:NpgsqlTypes.NpgsqlInterval.DaysPerMonth"> | ||
578 | <summary> | ||
579 | Represents the number of days assumed in one month if month justification or unjustifcation is performed. | ||
580 | This is set to 30 for consistency with PostgreSQL. Note that this is means that month adjustments cause | ||
581 | a year to be taken as 30 × 12 = 360 rather than 356/366 days. | ||
582 | </summary> | ||
583 | </member> | ||
584 | <member name="F:NpgsqlTypes.NpgsqlInterval.TicksPerMonth"> | ||
585 | <summary> | ||
586 | Represents the number of ticks (100ns periods) in one day, assuming 30 days per month. <seealso cref="F:NpgsqlTypes.NpgsqlInterval.DaysPerMonth"/> | ||
587 | </summary> | ||
588 | </member> | ||
589 | <member name="F:NpgsqlTypes.NpgsqlInterval.MonthsPerYear"> | ||
590 | <summary> | ||
591 | Represents the number of months in a year. This field is constant. | ||
592 | </summary> | ||
593 | </member> | ||
594 | <member name="F:NpgsqlTypes.NpgsqlInterval.MaxValue"> | ||
595 | <summary> | ||
596 | Represents the maximum <see cref="T:NpgsqlTypes.NpgsqlInterval"/>. This field is read-only. | ||
597 | </summary> | ||
598 | </member> | ||
599 | <member name="F:NpgsqlTypes.NpgsqlInterval.MinValue"> | ||
600 | <summary> | ||
601 | Represents the minimum <see cref="T:NpgsqlTypes.NpgsqlInterval"/>. This field is read-only. | ||
602 | </summary> | ||
603 | </member> | ||
604 | <member name="F:NpgsqlTypes.NpgsqlInterval.Zero"> | ||
605 | <summary> | ||
606 | Represents the zero <see cref="T:NpgsqlTypes.NpgsqlInterval"/>. This field is read-only. | ||
607 | </summary> | ||
608 | </member> | ||
609 | <member name="M:NpgsqlTypes.NpgsqlInterval.#ctor(System.Int64)"> | ||
610 | <summary> | ||
611 | Initializes a new <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to the specified number of ticks. | ||
612 | </summary> | ||
613 | <param name="ticks">A time period expressed in 100ns units.</param> | ||
614 | </member> | ||
615 | <member name="M:NpgsqlTypes.NpgsqlInterval.#ctor(System.TimeSpan)"> | ||
616 | <summary> | ||
617 | Initializes a new <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to hold the same time as a <see cref="T:System.TimeSpan"/> | ||
618 | </summary> | ||
619 | <param name="timespan">A time period expressed in a <see cref="T:System.TimeSpan"/></param> | ||
620 | </member> | ||
621 | <member name="M:NpgsqlTypes.NpgsqlInterval.#ctor(System.Int32,System.Int32,System.Int64)"> | ||
622 | <summary> | ||
623 | Initializes a new <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to the specified number of months, days | ||
624 | & ticks. | ||
625 | </summary> | ||
626 | <param name="months">Number of months.</param> | ||
627 | <param name="days">Number of days.</param> | ||
628 | <param name="ticks">Number of 100ns units.</param> | ||
629 | </member> | ||
630 | <member name="M:NpgsqlTypes.NpgsqlInterval.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)"> | ||
631 | <summary> | ||
632 | Initializes a new <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to the specified number of | ||
633 | days, hours, minutes & seconds. | ||
634 | </summary> | ||
635 | <param name="days">Number of days.</param> | ||
636 | <param name="hours">Number of hours.</param> | ||
637 | <param name="minutes">Number of minutes.</param> | ||
638 | <param name="seconds">Number of seconds.</param> | ||
639 | </member> | ||
640 | <member name="M:NpgsqlTypes.NpgsqlInterval.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> | ||
641 | <summary> | ||
642 | Initializes a new <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to the specified number of | ||
643 | days, hours, minutes, seconds & milliseconds. | ||
644 | </summary> | ||
645 | <param name="days">Number of days.</param> | ||
646 | <param name="hours">Number of hours.</param> | ||
647 | <param name="minutes">Number of minutes.</param> | ||
648 | <param name="seconds">Number of seconds.</param> | ||
649 | <param name="milliseconds">Number of milliseconds.</param> | ||
650 | </member> | ||
651 | <member name="M:NpgsqlTypes.NpgsqlInterval.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> | ||
652 | <summary> | ||
653 | Initializes a new <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to the specified number of | ||
654 | months, days, hours, minutes, seconds & milliseconds. | ||
655 | </summary> | ||
656 | <param name="months">Number of months.</param> | ||
657 | <param name="days">Number of days.</param> | ||
658 | <param name="hours">Number of hours.</param> | ||
659 | <param name="minutes">Number of minutes.</param> | ||
660 | <param name="seconds">Number of seconds.</param> | ||
661 | <param name="milliseconds">Number of milliseconds.</param> | ||
662 | </member> | ||
663 | <member name="M:NpgsqlTypes.NpgsqlInterval.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> | ||
664 | <summary> | ||
665 | Initializes a new <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to the specified number of | ||
666 | years, months, days, hours, minutes, seconds & milliseconds. | ||
667 | <para>Years are calculated exactly equivalent to 12 months.</para> | ||
668 | </summary> | ||
669 | <param name="years">Number of years.</param> | ||
670 | <param name="months">Number of months.</param> | ||
671 | <param name="days">Number of days.</param> | ||
672 | <param name="hours">Number of hours.</param> | ||
673 | <param name="minutes">Number of minutes.</param> | ||
674 | <param name="seconds">Number of seconds.</param> | ||
675 | <param name="milliseconds">Number of milliseconds.</param> | ||
676 | </member> | ||
677 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromTicks(System.Int64)"> | ||
678 | <summary> | ||
679 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of ticks. | ||
680 | </summary> | ||
681 | <param name="ticks">The number of ticks (100ns units) in the interval.</param> | ||
682 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of ticks.</returns> | ||
683 | </member> | ||
684 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromMicroseconds(System.Double)"> | ||
685 | <summary> | ||
686 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of microseconds. | ||
687 | </summary> | ||
688 | <param name="micro">The number of microseconds in the interval.</param> | ||
689 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of microseconds.</returns> | ||
690 | </member> | ||
691 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromMilliseconds(System.Double)"> | ||
692 | <summary> | ||
693 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of milliseconds. | ||
694 | </summary> | ||
695 | <param name="milli">The number of milliseconds in the interval.</param> | ||
696 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of milliseconds.</returns> | ||
697 | </member> | ||
698 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromSeconds(System.Double)"> | ||
699 | <summary> | ||
700 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of seconds. | ||
701 | </summary> | ||
702 | <param name="seconds">The number of seconds in the interval.</param> | ||
703 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of seconds.</returns> | ||
704 | </member> | ||
705 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromMinutes(System.Double)"> | ||
706 | <summary> | ||
707 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of minutes. | ||
708 | </summary> | ||
709 | <param name="minutes">The number of minutes in the interval.</param> | ||
710 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of minutes.</returns> | ||
711 | </member> | ||
712 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromHours(System.Double)"> | ||
713 | <summary> | ||
714 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of hours. | ||
715 | </summary> | ||
716 | <param name="hours">The number of hours in the interval.</param> | ||
717 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of hours.</returns> | ||
718 | </member> | ||
719 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromDays(System.Double)"> | ||
720 | <summary> | ||
721 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of days. | ||
722 | </summary> | ||
723 | <param name="days">The number of days in the interval.</param> | ||
724 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of days.</returns> | ||
725 | </member> | ||
726 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromMonths(System.Double)"> | ||
727 | <summary> | ||
728 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of months. | ||
729 | </summary> | ||
730 | <param name="months">The number of months in the interval.</param> | ||
731 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of months.</returns> | ||
732 | </member> | ||
733 | <member name="M:NpgsqlTypes.NpgsqlInterval.Add(NpgsqlTypes.NpgsqlInterval)"> | ||
734 | <summary> | ||
735 | Adds another interval to this instance and returns the result. | ||
736 | </summary> | ||
737 | <param name="interval">An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to add to this instance.</param> | ||
738 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"></see> whose values are the sums of the two instances.</returns> | ||
739 | </member> | ||
740 | <member name="M:NpgsqlTypes.NpgsqlInterval.Subtract(NpgsqlTypes.NpgsqlInterval)"> | ||
741 | <summary> | ||
742 | Subtracts another interval from this instance and returns the result. | ||
743 | </summary> | ||
744 | <param name="interval">An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to subtract from this instance.</param> | ||
745 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"></see> whose values are the differences of the two instances.</returns> | ||
746 | </member> | ||
747 | <member name="M:NpgsqlTypes.NpgsqlInterval.Negate"> | ||
748 | <summary> | ||
749 | Returns an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> whose value is the negated value of this instance. | ||
750 | </summary> | ||
751 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> whose value is the negated value of this instance.</returns> | ||
752 | </member> | ||
753 | <member name="M:NpgsqlTypes.NpgsqlInterval.Duration"> | ||
754 | <summary> | ||
755 | This absolute value of this instance. In the case of some, but not all, components being negative, | ||
756 | the rules used for justification are used to determine if the instance is positive or negative. | ||
757 | </summary> | ||
758 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> whose value is the absolute value of this instance.</returns> | ||
759 | </member> | ||
760 | <member name="M:NpgsqlTypes.NpgsqlInterval.JustifyDays"> | ||
761 | <summary> | ||
762 | Equivalent to PostgreSQL's justify_days function. | ||
763 | </summary> | ||
764 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> based on this one, but with any hours outside of the range [-23, 23] | ||
765 | converted into days.</returns> | ||
766 | </member> | ||
767 | <member name="M:NpgsqlTypes.NpgsqlInterval.UnjustifyDays"> | ||
768 | <summary> | ||
769 | Opposite to PostgreSQL's justify_days function. | ||
770 | </summary> | ||
771 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> based on this one, but with any days converted to multiples of ±24hours.</returns> | ||
772 | </member> | ||
773 | <member name="M:NpgsqlTypes.NpgsqlInterval.JustifyMonths"> | ||
774 | <summary> | ||
775 | Equivalent to PostgreSQL's justify_months function. | ||
776 | </summary> | ||
777 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> based on this one, but with any days outside of the range [-30, 30] | ||
778 | converted into months.</returns> | ||
779 | </member> | ||
780 | <member name="M:NpgsqlTypes.NpgsqlInterval.UnjustifyMonths"> | ||
781 | <summary> | ||
782 | Opposite to PostgreSQL's justify_months function. | ||
783 | </summary> | ||
784 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> based on this one, but with any months converted to multiples of ±30days.</returns> | ||
785 | </member> | ||
786 | <member name="M:NpgsqlTypes.NpgsqlInterval.JustifyInterval"> | ||
787 | <summary> | ||
788 | Equivalent to PostgreSQL's justify_interval function. | ||
789 | </summary> | ||
790 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> based on this one, | ||
791 | but with any months converted to multiples of ±30days | ||
792 | and then with any days converted to multiples of ±24hours</returns> | ||
793 | </member> | ||
794 | <member name="M:NpgsqlTypes.NpgsqlInterval.UnjustifyInterval"> | ||
795 | <summary> | ||
796 | Opposite to PostgreSQL's justify_interval function. | ||
797 | </summary> | ||
798 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> based on this one, but with any months converted to multiples of ±30days and then any days converted to multiples of ±24hours;</returns> | ||
799 | </member> | ||
800 | <member name="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"> | ||
801 | <summary> | ||
802 | Produces a canonical NpgslInterval with 0 months and hours in the range of [-23, 23]. | ||
803 | <remarks> | ||
804 | <para> | ||
805 | While the fact that for many purposes, two different <see cref="T:NpgsqlTypes.NpgsqlInterval"/> instances could be considered | ||
806 | equivalent (e.g. one with 2days, 3hours and one with 1day 27hours) there are different possible canonical forms. | ||
807 | </para><para> | ||
808 | E.g. we could move all excess hours into days and all excess days into months and have the most readable form, | ||
809 | or we could move everything into the ticks and have the form that allows for the easiest arithmetic) the form | ||
810 | chosen has two important properties that make it the best choice. | ||
811 | </para><para>First, it is closest two how | ||
812 | <see cref="T:System.TimeSpan"/> objects are most often represented. Second, it is compatible with results of many | ||
813 | PostgreSQL functions, particularly with age() and the results of subtracting one date, time or timestamp from | ||
814 | another. | ||
815 | </para> | ||
816 | <para>Note that the results of casting a <see cref="T:System.TimeSpan"/> to <see cref="T:NpgsqlTypes.NpgsqlInterval"/> is | ||
817 | canonicalised.</para> | ||
818 | </remarks> | ||
819 | </summary> | ||
820 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> based on this one, but with months converted to multiples of ±30days and with any hours outside of the range [-23, 23] | ||
821 | converted into days.</returns> | ||
822 | </member> | ||
823 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_Implicit(System.TimeSpan)~NpgsqlTypes.NpgsqlInterval"> | ||
824 | <summary> | ||
825 | Implicit cast of a <see cref="T:System.TimeSpan"/> to an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> | ||
826 | </summary> | ||
827 | <param name="timespan">A <see cref="T:System.TimeSpan"/></param> | ||
828 | <returns>An eqivalent, canonical, <see cref="T:NpgsqlTypes.NpgsqlInterval"/>.</returns> | ||
829 | </member> | ||
830 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_Explicit(NpgsqlTypes.NpgsqlInterval)~System.TimeSpan"> | ||
831 | <summary> | ||
832 | Implicit cast of an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to a <see cref="T:System.TimeSpan"/>. | ||
833 | </summary> | ||
834 | <param name="interval">A <see cref="T:NpgsqlTypes.NpgsqlInterval"/>.</param> | ||
835 | <returns>An equivalent <see cref="T:System.TimeSpan"/>.</returns> | ||
836 | </member> | ||
837 | <member name="M:NpgsqlTypes.NpgsqlInterval.Equals(NpgsqlTypes.NpgsqlInterval)"> | ||
838 | <summary> | ||
839 | Returns true if another <see cref="T:NpgsqlTypes.NpgsqlInterval"/> is exactly the same as this instance. | ||
840 | </summary> | ||
841 | <param name="other">An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> for comparison.</param> | ||
842 | <returns>true if the two <see cref="T:NpgsqlTypes.NpgsqlInterval"/> instances are exactly the same, | ||
843 | false otherwise.</returns> | ||
844 | </member> | ||
845 | <member name="M:NpgsqlTypes.NpgsqlInterval.Equals(System.Object)"> | ||
846 | <summary> | ||
847 | Returns true if another object is an <see cref="T:NpgsqlTypes.NpgsqlInterval"/>, that is exactly the same as | ||
848 | this instance | ||
849 | </summary> | ||
850 | <param name="obj">An <see cref="T:System.Object"/> for comparison.</param> | ||
851 | <returns>true if the argument is an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> and is exactly the same | ||
852 | as this one, false otherwise.</returns> | ||
853 | </member> | ||
854 | <member name="M:NpgsqlTypes.NpgsqlInterval.Compare(NpgsqlTypes.NpgsqlInterval,NpgsqlTypes.NpgsqlInterval)"> | ||
855 | <summary> | ||
856 | Compares two <see cref="T:NpgsqlTypes.NpgsqlInterval"/> instances. | ||
857 | </summary> | ||
858 | <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlInterval"/>.</param> | ||
859 | <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlInterval"/>.</param> | ||
860 | <returns>0 if the two are equal or equivalent. A value greater than zero if x is greater than y, | ||
861 | a value less than zero if x is less than y.</returns> | ||
862 | </member> | ||
863 | <member name="M:NpgsqlTypes.NpgsqlInterval.GetHashCode"> | ||
864 | <summary> | ||
865 | A hash code suitable for uses with hashing algorithms. | ||
866 | </summary> | ||
867 | <returns>An signed integer.</returns> | ||
868 | </member> | ||
869 | <member name="M:NpgsqlTypes.NpgsqlInterval.CompareTo(NpgsqlTypes.NpgsqlInterval)"> | ||
870 | <summary> | ||
871 | Compares this instance with another/ | ||
872 | </summary> | ||
873 | <param name="other">An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare this with.</param> | ||
874 | <returns>0 if the instances are equal or equivalent. A value less than zero if | ||
875 | this instance is less than the argument. A value greater than zero if this instance | ||
876 | is greater than the instance.</returns> | ||
877 | </member> | ||
878 | <member name="M:NpgsqlTypes.NpgsqlInterval.CompareTo(System.Object)"> | ||
879 | <summary> | ||
880 | Compares this instance with another/ | ||
881 | </summary> | ||
882 | <param name="other">An object to compare this with.</param> | ||
883 | <returns>0 if the argument is an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> and the instances are equal or equivalent. | ||
884 | A value less than zero if the argument is an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> and | ||
885 | this instance is less than the argument. | ||
886 | A value greater than zero if the argument is an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> and this instance | ||
887 | is greater than the instance.</returns> | ||
888 | A value greater than zero if the argument is null. | ||
889 | <exception cref="T:System.ArgumentException">The argument is not an <see cref="T:NpgsqlTypes.NpgsqlInterval"/>.</exception> | ||
890 | </member> | ||
891 | <member name="M:NpgsqlTypes.NpgsqlInterval.Parse(System.String)"> | ||
892 | <summary> | ||
893 | Parses a <see cref="T:System.String"/> and returns a <see cref="T:NpgsqlTypes.NpgsqlInterval"/> instance. | ||
894 | Designed to use the formats generally returned by PostgreSQL. | ||
895 | </summary> | ||
896 | <param name="str">The <see cref="T:System.String"/> to parse.</param> | ||
897 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> represented by the argument.</returns> | ||
898 | <exception cref="T:System.ArgumentNullException">The string was null.</exception> | ||
899 | <exception cref="T:System.OverflowException">A value obtained from parsing the string exceeded the values allowed for the relevant component.</exception> | ||
900 | <exception cref="T:System.FormatException">The string was not in a format that could be parsed to produce an <see cref="T:NpgsqlTypes.NpgsqlInterval"/>.</exception> | ||
901 | </member> | ||
902 | <member name="M:NpgsqlTypes.NpgsqlInterval.TryParse(System.String,NpgsqlTypes.NpgsqlInterval@)"> | ||
903 | <summary> | ||
904 | Attempt to parse a <see cref="T:System.String"/> to produce an <see cref="T:NpgsqlTypes.NpgsqlInterval"/>. | ||
905 | </summary> | ||
906 | <param name="str">The <see cref="T:System.String"/> to parse.</param> | ||
907 | <param name="result">(out) The <see cref="T:NpgsqlTypes.NpgsqlInterval"/> produced, or <see cref="F:NpgsqlTypes.NpgsqlInterval.Zero"/> if the parsing failed.</param> | ||
908 | <returns>true if the parsing succeeded, false otherwise.</returns> | ||
909 | </member> | ||
910 | <member name="M:NpgsqlTypes.NpgsqlInterval.ToString"> | ||
911 | <summary> | ||
912 | Create a <see cref="T:System.String"/> representation of the <see cref="T:NpgsqlTypes.NpgsqlInterval"/> instance. | ||
913 | The format returned is of the form: | ||
914 | [M mon[s]] [d day[s]] [HH:mm:ss[.f[f[f[f[f[f[f[f[f]]]]]]]]]] | ||
915 | A zero <see cref="T:NpgsqlTypes.NpgsqlInterval"/> is represented as 00:00:00 | ||
916 | <remarks> | ||
917 | Ticks are 100ns, Postgress resolution is only to 1µs at most. Hence we lose 1 or more decimal | ||
918 | precision in storing values in the database. Despite this, this method will output that extra | ||
919 | digit of precision. It's forward-compatible with any future increases in resolution up to 100ns, | ||
920 | and also makes this ToString() more applicable to any other use-case. | ||
921 | </remarks> | ||
922 | </summary> | ||
923 | <returns>The <see cref="T:System.String"/> representation.</returns> | ||
924 | </member> | ||
925 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_Addition(NpgsqlTypes.NpgsqlInterval,NpgsqlTypes.NpgsqlInterval)"> | ||
926 | <summary> | ||
927 | Adds two <see cref="T:NpgsqlTypes.NpgsqlInterval"/> together. | ||
928 | </summary> | ||
929 | <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to add.</param> | ||
930 | <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to add.</param> | ||
931 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> whose values are the sum of the arguments.</returns> | ||
932 | </member> | ||
933 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_Subtraction(NpgsqlTypes.NpgsqlInterval,NpgsqlTypes.NpgsqlInterval)"> | ||
934 | <summary> | ||
935 | Subtracts one <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from another. | ||
936 | </summary> | ||
937 | <param name="x">The <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to subtract the other from.</param> | ||
938 | <param name="y">The <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to subtract from the other.</param> | ||
939 | <returns>An <see cref="T:NpgsqlTypes.NpgsqlInterval"/> whose values are the difference of the arguments</returns> | ||
940 | </member> | ||
941 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_Equality(NpgsqlTypes.NpgsqlInterval,NpgsqlTypes.NpgsqlInterval)"> | ||
942 | <summary> | ||
943 | Returns true if two <see cref="T:NpgsqlTypes.NpgsqlInterval"/> are exactly the same. | ||
944 | </summary> | ||
945 | <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
946 | <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
947 | <returns>true if the two arguments are exactly the same, false otherwise.</returns> | ||
948 | </member> | ||
949 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_Inequality(NpgsqlTypes.NpgsqlInterval,NpgsqlTypes.NpgsqlInterval)"> | ||
950 | <summary> | ||
951 | Returns false if two <see cref="T:NpgsqlTypes.NpgsqlInterval"/> are exactly the same. | ||
952 | </summary> | ||
953 | <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
954 | <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
955 | <returns>false if the two arguments are exactly the same, true otherwise.</returns> | ||
956 | </member> | ||
957 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_LessThan(NpgsqlTypes.NpgsqlInterval,NpgsqlTypes.NpgsqlInterval)"> | ||
958 | <summary> | ||
959 | Compares two <see cref="T:NpgsqlTypes.NpgsqlInterval"/> instances to see if the first is less than the second | ||
960 | </summary> | ||
961 | <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
962 | <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
963 | <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> is less than second, false otherwise.</returns> | ||
964 | </member> | ||
965 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_LessThanOrEqual(NpgsqlTypes.NpgsqlInterval,NpgsqlTypes.NpgsqlInterval)"> | ||
966 | <summary> | ||
967 | Compares two <see cref="T:NpgsqlTypes.NpgsqlInterval"/> instances to see if the first is less than or equivalent to the second | ||
968 | </summary> | ||
969 | <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
970 | <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
971 | <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> is less than or equivalent to second, false otherwise.</returns> | ||
972 | </member> | ||
973 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_GreaterThan(NpgsqlTypes.NpgsqlInterval,NpgsqlTypes.NpgsqlInterval)"> | ||
974 | <summary> | ||
975 | Compares two <see cref="T:NpgsqlTypes.NpgsqlInterval"/> instances to see if the first is greater than the second | ||
976 | </summary> | ||
977 | <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
978 | <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
979 | <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> is greater than second, false otherwise.</returns> | ||
980 | </member> | ||
981 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_GreaterThanOrEqual(NpgsqlTypes.NpgsqlInterval,NpgsqlTypes.NpgsqlInterval)"> | ||
982 | <summary> | ||
983 | Compares two <see cref="T:NpgsqlTypes.NpgsqlInterval"/> instances to see if the first is greater than or equivalent the second | ||
984 | </summary> | ||
985 | <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
986 | <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlInterval"/> to compare.</param> | ||
987 | <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlInterval"/> is greater than or equivalent to the second, false otherwise.</returns> | ||
988 | </member> | ||
989 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_UnaryPlus(NpgsqlTypes.NpgsqlInterval)"> | ||
990 | <summary> | ||
991 | Returns the instance. | ||
992 | </summary> | ||
993 | <param name="x">An <see cref="T:NpgsqlTypes.NpgsqlInterval"/>.</param> | ||
994 | <returns>The argument.</returns> | ||
995 | </member> | ||
996 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_UnaryNegation(NpgsqlTypes.NpgsqlInterval)"> | ||
997 | <summary> | ||
998 | Negates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> instance. | ||
999 | </summary> | ||
1000 | <param name="x">An <see cref="T:NpgsqlTypes.NpgsqlInterval"/>.</param> | ||
1001 | <returns>The negation of the argument.</returns> | ||
1002 | </member> | ||
1003 | <member name="P:NpgsqlTypes.NpgsqlInterval.Ticks"> | ||
1004 | <summary> | ||
1005 | The total number of ticks(100ns units) contained. This is the resolution of the | ||
1006 | <see cref="T:NpgsqlTypes.NpgsqlInterval"/> type. This ignores the number of days and | ||
1007 | months held. If you want them included use <see cref="M:NpgsqlTypes.NpgsqlInterval.UnjustifyInterval"/> first. | ||
1008 | <remarks>The resolution of the PostgreSQL | ||
1009 | interval type is by default 1µs = 1,000 ns. It may be smaller as follows: | ||
1010 | <list type="number"> | ||
1011 | <item> | ||
1012 | <term>interval(0)</term> | ||
1013 | <description>resolution of 1s (1 second)</description> | ||
1014 | </item> | ||
1015 | <item> | ||
1016 | <term>interval(1)</term> | ||
1017 | <description>resolution of 100ms = 0.1s (100 milliseconds)</description> | ||
1018 | </item> | ||
1019 | <item> | ||
1020 | <term>interval(2)</term> | ||
1021 | <description>resolution of 10ms = 0.01s (10 milliseconds)</description> | ||
1022 | </item> | ||
1023 | <item> | ||
1024 | <term>interval(3)</term> | ||
1025 | <description>resolution of 1ms = 0.001s (1 millisecond)</description> | ||
1026 | </item> | ||
1027 | <item> | ||
1028 | <term>interval(4)</term> | ||
1029 | <description>resolution of 100µs = 0.0001s (100 microseconds)</description> | ||
1030 | </item> | ||
1031 | <item> | ||
1032 | <term>interval(5)</term> | ||
1033 | <description>resolution of 10µs = 0.00001s (10 microseconds)</description> | ||
1034 | </item> | ||
1035 | <item> | ||
1036 | <term>interval(6) or interval</term> | ||
1037 | <description>resolution of 1µs = 0.000001s (1 microsecond)</description> | ||
1038 | </item> | ||
1039 | </list> | ||
1040 | <para>As such, if the 100-nanosecond resolution is significant to an application, a PostgreSQL interval will | ||
1041 | not suffice for those purposes.</para> | ||
1042 | <para>In more frequent cases though, the resolution of the interval suffices. | ||
1043 | <see cref="T:NpgsqlTypes.NpgsqlInterval"/> will always suffice to handle the resolution of any interval value, and upon | ||
1044 | writing to the database, will be rounded to the resolution used.</para> | ||
1045 | </remarks> | ||
1046 | <returns>The number of ticks in the instance.</returns> | ||
1047 | </summary> | ||
1048 | </member> | ||
1049 | <member name="P:NpgsqlTypes.NpgsqlInterval.Microseconds"> | ||
1050 | <summary> | ||
1051 | Gets the number of whole microseconds held in the instance. | ||
1052 | <returns>An in the range [-999999, 999999].</returns> | ||
1053 | </summary> | ||
1054 | </member> | ||
1055 | <member name="P:NpgsqlTypes.NpgsqlInterval.Milliseconds"> | ||
1056 | <summary> | ||
1057 | Gets the number of whole milliseconds held in the instance. | ||
1058 | <returns>An in the range [-999, 999].</returns> | ||
1059 | </summary> | ||
1060 | </member> | ||
1061 | <member name="P:NpgsqlTypes.NpgsqlInterval.Seconds"> | ||
1062 | <summary> | ||
1063 | Gets the number of whole seconds held in the instance. | ||
1064 | <returns>An in the range [-59, 59].</returns> | ||
1065 | </summary> | ||
1066 | </member> | ||
1067 | <member name="P:NpgsqlTypes.NpgsqlInterval.Minutes"> | ||
1068 | <summary> | ||
1069 | Gets the number of whole minutes held in the instance. | ||
1070 | <returns>An in the range [-59, 59].</returns> | ||
1071 | </summary> | ||
1072 | </member> | ||
1073 | <member name="P:NpgsqlTypes.NpgsqlInterval.Hours"> | ||
1074 | <summary> | ||
1075 | Gets the number of whole hours held in the instance. | ||
1076 | <remarks>Note that this can be less than -23 or greater than 23 unless <see cref="M:NpgsqlTypes.NpgsqlInterval.JustifyDays"/> | ||
1077 | has been used to produce this instance.</remarks> | ||
1078 | </summary> | ||
1079 | </member> | ||
1080 | <member name="P:NpgsqlTypes.NpgsqlInterval.Days"> | ||
1081 | <summary> | ||
1082 | Gets the number of days held in the instance. | ||
1083 | <remarks>Note that this does not pay attention to a time component with -24 or less hours or | ||
1084 | 24 or more hours, unless <see cref="M:NpgsqlTypes.NpgsqlInterval.JustifyDays"/> has been called to produce this instance.</remarks> | ||
1085 | </summary> | ||
1086 | </member> | ||
1087 | <member name="P:NpgsqlTypes.NpgsqlInterval.Months"> | ||
1088 | <summary> | ||
1089 | Gets the number of months held in the instance. | ||
1090 | <remarks>Note that this does not pay attention to a day component with -30 or less days or | ||
1091 | 30 or more days, unless <see cref="M:NpgsqlTypes.NpgsqlInterval.JustifyMonths"/> has been called to produce this instance.</remarks> | ||
1092 | </summary> | ||
1093 | </member> | ||
1094 | <member name="P:NpgsqlTypes.NpgsqlInterval.Time"> | ||
1095 | <summary> | ||
1096 | Returns a <see cref="T:System.TimeSpan"/> representing the time component of the instance. | ||
1097 | <remarks>Note that this may have a value beyond the range ±23:59:59.9999999 unless | ||
1098 | <see cref="M:NpgsqlTypes.NpgsqlInterval.JustifyDays"/> has been called to produce this instance.</remarks> | ||
1099 | </summary> | ||
1100 | </member> | ||
1101 | <member name="P:NpgsqlTypes.NpgsqlInterval.TotalTicks"> | ||
1102 | <summary> | ||
1103 | The total number of ticks (100ns units) in the instance, assuming 24 hours in each day and | ||
1104 | 30 days in a month. | ||
1105 | </summary> | ||
1106 | </member> | ||
1107 | <member name="P:NpgsqlTypes.NpgsqlInterval.TotalMicroseconds"> | ||
1108 | <summary> | ||
1109 | The total number of microseconds in the instance, assuming 24 hours in each day and | ||
1110 | 30 days in a month. | ||
1111 | </summary> | ||
1112 | </member> | ||
1113 | <member name="P:NpgsqlTypes.NpgsqlInterval.TotalMilliseconds"> | ||
1114 | <summary> | ||
1115 | The total number of milliseconds in the instance, assuming 24 hours in each day and | ||
1116 | 30 days in a month. | ||
1117 | </summary> | ||
1118 | </member> | ||
1119 | <member name="P:NpgsqlTypes.NpgsqlInterval.TotalSeconds"> | ||
1120 | <summary> | ||
1121 | The total number of seconds in the instance, assuming 24 hours in each day and | ||
1122 | 30 days in a month. | ||
1123 | </summary> | ||
1124 | </member> | ||
1125 | <member name="P:NpgsqlTypes.NpgsqlInterval.TotalMinutes"> | ||
1126 | <summary> | ||
1127 | The total number of minutes in the instance, assuming 24 hours in each day and | ||
1128 | 30 days in a month. | ||
1129 | </summary> | ||
1130 | </member> | ||
1131 | <member name="P:NpgsqlTypes.NpgsqlInterval.TotalHours"> | ||
1132 | <summary> | ||
1133 | The total number of hours in the instance, assuming 24 hours in each day and | ||
1134 | 30 days in a month. | ||
1135 | </summary> | ||
1136 | </member> | ||
1137 | <member name="P:NpgsqlTypes.NpgsqlInterval.TotalDays"> | ||
1138 | <summary> | ||
1139 | The total number of days in the instance, assuming 24 hours in each day and | ||
1140 | 30 days in a month. | ||
1141 | </summary> | ||
1142 | </member> | ||
1143 | <member name="P:NpgsqlTypes.NpgsqlInterval.TotalMonths"> | ||
1144 | <summary> | ||
1145 | The total number of months in the instance, assuming 24 hours in each day and | ||
1146 | 30 days in a month. | ||
1147 | </summary> | ||
1148 | </member> | ||
1149 | <member name="M:NpgsqlTypes.NpgsqlTime.Normalize"> | ||
1150 | <summary> | ||
1151 | Normalise this time; if it is 24:00:00, convert it to 00:00:00 | ||
1152 | </summary> | ||
1153 | <returns>This time, normalised</returns> | ||
1154 | </member> | ||
1155 | <member name="P:NpgsqlTypes.NpgsqlTime.Ticks"> | ||
1156 | <summary> | ||
1157 | The total number of ticks(100ns units) contained. This is the resolution of the | ||
1158 | <see cref="T:NpgsqlTypes.NpgsqlTime"/> type. | ||
1159 | <remarks>The resolution of the PostgreSQL | ||
1160 | interval type is by default 1µs = 1,000 ns. It may be smaller as follows: | ||
1161 | <list type="number"> | ||
1162 | <item> | ||
1163 | <term>time(0)</term> | ||
1164 | <description>resolution of 1s (1 second)</description> | ||
1165 | </item> | ||
1166 | <item> | ||
1167 | <term>time(1)</term> | ||
1168 | <description>resolution of 100ms = 0.1s (100 milliseconds)</description> | ||
1169 | </item> | ||
1170 | <item> | ||
1171 | <term>time(2)</term> | ||
1172 | <description>resolution of 10ms = 0.01s (10 milliseconds)</description> | ||
1173 | </item> | ||
1174 | <item> | ||
1175 | <term>time(3)</term> | ||
1176 | <description>resolution of 1ms = 0.001s (1 millisecond)</description> | ||
1177 | </item> | ||
1178 | <item> | ||
1179 | <term>time(4)</term> | ||
1180 | <description>resolution of 100µs = 0.0001s (100 microseconds)</description> | ||
1181 | </item> | ||
1182 | <item> | ||
1183 | <term>time(5)</term> | ||
1184 | <description>resolution of 10µs = 0.00001s (10 microseconds)</description> | ||
1185 | </item> | ||
1186 | <item> | ||
1187 | <term>time(6) or interval</term> | ||
1188 | <description>resolution of 1µs = 0.000001s (1 microsecond)</description> | ||
1189 | </item> | ||
1190 | </list> | ||
1191 | <para>As such, if the 100-nanosecond resolution is significant to an application, a PostgreSQL time will | ||
1192 | not suffice for those purposes.</para> | ||
1193 | <para>In more frequent cases though, the resolution of time suffices. | ||
1194 | <see cref="T:NpgsqlTypes.NpgsqlTime"/> will always suffice to handle the resolution of any time value, and upon | ||
1195 | writing to the database, will be rounded to the resolution used.</para> | ||
1196 | </remarks> | ||
1197 | <returns>The number of ticks in the instance.</returns> | ||
1198 | </summary> | ||
1199 | </member> | ||
1200 | <member name="P:NpgsqlTypes.NpgsqlTime.Microseconds"> | ||
1201 | <summary> | ||
1202 | Gets the number of whole microseconds held in the instance. | ||
1203 | <returns>An integer in the range [0, 999999].</returns> | ||
1204 | </summary> | ||
1205 | </member> | ||
1206 | <member name="P:NpgsqlTypes.NpgsqlTime.Milliseconds"> | ||
1207 | <summary> | ||
1208 | Gets the number of whole milliseconds held in the instance. | ||
1209 | <returns>An integer in the range [0, 999].</returns> | ||
1210 | </summary> | ||
1211 | </member> | ||
1212 | <member name="P:NpgsqlTypes.NpgsqlTime.Seconds"> | ||
1213 | <summary> | ||
1214 | Gets the number of whole seconds held in the instance. | ||
1215 | <returns>An interger in the range [0, 59].</returns> | ||
1216 | </summary> | ||
1217 | </member> | ||
1218 | <member name="P:NpgsqlTypes.NpgsqlTime.Minutes"> | ||
1219 | <summary> | ||
1220 | Gets the number of whole minutes held in the instance. | ||
1221 | <returns>An integer in the range [0, 59].</returns> | ||
1222 | </summary> | ||
1223 | </member> | ||
1224 | <member name="P:NpgsqlTypes.NpgsqlTime.Hours"> | ||
1225 | <summary> | ||
1226 | Gets the number of whole hours held in the instance. | ||
1227 | <remarks>Note that the time 24:00:00 can be stored for roundtrip compatibility. Any calculations on such a | ||
1228 | value will normalised it to 00:00:00.</remarks> | ||
1229 | </summary> | ||
1230 | </member> | ||
1231 | <member name="M:NpgsqlTypes.NpgsqlTimeTZ.Normalize"> | ||
1232 | <summary> | ||
1233 | Normalise this time; if it is 24:00:00, convert it to 00:00:00 | ||
1234 | </summary> | ||
1235 | <returns>This time, normalised</returns> | ||
1236 | </member> | ||
1237 | <member name="M:NpgsqlTypes.NpgsqlTimeTZ.CompareTo(NpgsqlTypes.NpgsqlTimeTZ)"> | ||
1238 | <summary> | ||
1239 | Compares this with another <see cref="T:NpgsqlTypes.NpgsqlTimeTZ"/>. As per postgres' rules, | ||
1240 | first the times are compared as if they were both in the same timezone. If they are equal then | ||
1241 | then timezones are compared (+01:00 being "smaller" than -01:00). | ||
1242 | </summary> | ||
1243 | <param name="other">the <see cref="T:NpgsqlTypes.NpgsqlTimeTZ"/> to compare with.</param> | ||
1244 | <returns>An integer which is 0 if they are equal, < 0 if this is the smaller and > 0 if this is the larger.</returns> | ||
1245 | </member> | ||
1246 | <member name="P:NpgsqlTypes.NpgsqlTimeTZ.Microseconds"> | ||
1247 | <summary> | ||
1248 | Gets the number of whole microseconds held in the instance. | ||
1249 | <returns>An integer in the range [0, 999999].</returns> | ||
1250 | </summary> | ||
1251 | </member> | ||
1252 | <member name="P:NpgsqlTypes.NpgsqlTimeTZ.Milliseconds"> | ||
1253 | <summary> | ||
1254 | Gets the number of whole milliseconds held in the instance. | ||
1255 | <returns>An integer in the range [0, 999].</returns> | ||
1256 | </summary> | ||
1257 | </member> | ||
1258 | <member name="P:NpgsqlTypes.NpgsqlTimeTZ.Seconds"> | ||
1259 | <summary> | ||
1260 | Gets the number of whole seconds held in the instance. | ||
1261 | <returns>An interger in the range [0, 59].</returns> | ||
1262 | </summary> | ||
1263 | </member> | ||
1264 | <member name="P:NpgsqlTypes.NpgsqlTimeTZ.Minutes"> | ||
1265 | <summary> | ||
1266 | Gets the number of whole minutes held in the instance. | ||
1267 | <returns>An integer in the range [0, 59].</returns> | ||
1268 | </summary> | ||
1269 | </member> | ||
1270 | <member name="P:NpgsqlTypes.NpgsqlTimeTZ.Hours"> | ||
1271 | <summary> | ||
1272 | Gets the number of whole hours held in the instance. | ||
1273 | <remarks>Note that the time 24:00:00 can be stored for roundtrip compatibility. Any calculations on such a | ||
1274 | value will normalised it to 00:00:00.</remarks> | ||
1275 | </summary> | ||
1276 | </member> | ||
1277 | <member name="T:NpgsqlTypes.LargeObjectManager"> | ||
1278 | <summary> | ||
1279 | Summary description for LargeObjectManager. | ||
1280 | </summary> | ||
1281 | </member> | ||
1282 | <member name="T:NpgsqlTypes.NativeToBackendTypeConverterOptions"> | ||
1283 | <summary> | ||
1284 | Options that control certain aspects of native to backend conversions that depend | ||
1285 | on backend version and status. | ||
1286 | </summary> | ||
1287 | </member> | ||
1288 | <member name="M:NpgsqlTypes.NativeToBackendTypeConverterOptions.System#ICloneable#Clone"> | ||
1289 | <summary> | ||
1290 | Clone the current object. | ||
1291 | </summary> | ||
1292 | <returns>A new NativeToBackendTypeConverterOptions object.</returns> | ||
1293 | </member> | ||
1294 | <member name="M:NpgsqlTypes.NativeToBackendTypeConverterOptions.Clone(NpgsqlTypes.NpgsqlBackendTypeMapping)"> | ||
1295 | <summary> | ||
1296 | Clone the current object with a different OID/Name mapping. | ||
1297 | </summary> | ||
1298 | <param name="oidToNameMapping">OID/Name mapping object to use in the new instance.</param> | ||
1299 | <returns>A new NativeToBackendTypeConverterOptions object.</returns> | ||
1300 | </member> | ||
1301 | <member name="T:NpgsqlTypes.BasicBackendToNativeTypeConverter"> | ||
1302 | <summary> | ||
1303 | Provide event handlers to convert all native supported basic data types from their backend | ||
1304 | text representation to a .NET object. | ||
1305 | </summary> | ||
1306 | </member> | ||
1307 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.TextBinaryToString(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> | ||
1308 | <summary> | ||
1309 | Convert UTF8 encoded text a string. | ||
1310 | </summary> | ||
1311 | </member> | ||
1312 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ByteaTextToByteArray(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1313 | <summary> | ||
1314 | Byte array from bytea encoded as ASCII text, escaped or hex format. | ||
1315 | </summary> | ||
1316 | </member> | ||
1317 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ByteaBinaryToByteArray(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> | ||
1318 | <summary> | ||
1319 | Byte array from bytea encoded as binary. | ||
1320 | </summary> | ||
1321 | </member> | ||
1322 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.BooleanTextToBoolean(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1323 | <summary> | ||
1324 | Convert a postgresql boolean to a System.Boolean. | ||
1325 | </summary> | ||
1326 | </member> | ||
1327 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.BooleanBinaryToBoolean(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> | ||
1328 | <summary> | ||
1329 | Convert a postgresql boolean to a System.Boolean. | ||
1330 | </summary> | ||
1331 | </member> | ||
1332 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToBit(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1333 | <summary> | ||
1334 | Convert a postgresql bit to a System.Boolean. | ||
1335 | </summary> | ||
1336 | </member> | ||
1337 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToDateTime(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1338 | <summary> | ||
1339 | Convert a postgresql datetime to a System.DateTime. | ||
1340 | </summary> | ||
1341 | </member> | ||
1342 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToDate(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1343 | <summary> | ||
1344 | Convert a postgresql date to a System.DateTime. | ||
1345 | </summary> | ||
1346 | </member> | ||
1347 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToTime(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1348 | <summary> | ||
1349 | Convert a postgresql time to a System.DateTime. | ||
1350 | </summary> | ||
1351 | </member> | ||
1352 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToMoney(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1353 | <summary> | ||
1354 | Convert a postgresql money to a System.Decimal. | ||
1355 | </summary> | ||
1356 | </member> | ||
1357 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.Float4Float8BinaryToFloatDouble(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> | ||
1358 | <summary> | ||
1359 | Convert a postgresql float4 or float8 to a System.Float or System.Double respectively. | ||
1360 | </summary> | ||
1361 | </member> | ||
1362 | <member name="T:NpgsqlTypes.ExtendedBackendToNativeTypeConverter"> | ||
1363 | <summary> | ||
1364 | Provide event handlers to convert extended native supported data types from their backend | ||
1365 | text representation to a .NET object. | ||
1366 | </summary> | ||
1367 | </member> | ||
1368 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToPoint(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1369 | <summary> | ||
1370 | Convert a postgresql point to a System.NpgsqlPoint. | ||
1371 | </summary> | ||
1372 | </member> | ||
1373 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToBox(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1374 | <summary> | ||
1375 | Convert a postgresql point to a System.RectangleF. | ||
1376 | </summary> | ||
1377 | </member> | ||
1378 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToLSeg(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1379 | <summary> | ||
1380 | LDeg. | ||
1381 | </summary> | ||
1382 | </member> | ||
1383 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToPath(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1384 | <summary> | ||
1385 | Path. | ||
1386 | </summary> | ||
1387 | </member> | ||
1388 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToPolygon(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1389 | <summary> | ||
1390 | Polygon. | ||
1391 | </summary> | ||
1392 | </member> | ||
1393 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToCircle(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1394 | <summary> | ||
1395 | Circle. | ||
1396 | </summary> | ||
1397 | </member> | ||
1398 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToInet(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1399 | <summary> | ||
1400 | Inet. | ||
1401 | </summary> | ||
1402 | </member> | ||
1403 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToMacAddress(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1404 | <summary> | ||
1405 | MAC Address. | ||
1406 | </summary> | ||
1407 | </member> | ||
1408 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToInterval(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1409 | <summary> | ||
1410 | interval | ||
1411 | </summary> | ||
1412 | </member> | ||
1413 | <member name="T:NpgsqlTypes.BasicNativeToBackendTypeConverter"> | ||
1414 | <summary> | ||
1415 | Provide event handlers to convert the basic native supported data types from | ||
1416 | native form to backend representation. | ||
1417 | </summary> | ||
1418 | </member> | ||
1419 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.StringToTextText(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1420 | <summary> | ||
1421 | Convert a string to UTF8 encoded text, escaped and quoted as required. | ||
1422 | </summary> | ||
1423 | </member> | ||
1424 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.StringToTextBinary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> | ||
1425 | <summary> | ||
1426 | Convert a string to UTF8 encoded text. | ||
1427 | </summary> | ||
1428 | </member> | ||
1429 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ByteArrayToByteaText(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1430 | <summary> | ||
1431 | Binary data, escaped and quoted as required. | ||
1432 | </summary> | ||
1433 | </member> | ||
1434 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ByteArrayToByteaTextEscaped(System.Byte[],NpgsqlTypes.BasicNativeToBackendTypeConverter.StringEncodingInfo)"> | ||
1435 | <summary> | ||
1436 | Binary data with possible older style octal escapes, quoted. | ||
1437 | </summary> | ||
1438 | </member> | ||
1439 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ByteArrayToByteaTextHexFormat(System.Byte[],NpgsqlTypes.BasicNativeToBackendTypeConverter.StringEncodingInfo)"> | ||
1440 | <summary> | ||
1441 | Binary data in the new hex format (>= 9.0), quoted. | ||
1442 | </summary> | ||
1443 | </member> | ||
1444 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ByteArrayToByteaBinary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> | ||
1445 | <summary> | ||
1446 | Binary data, raw. | ||
1447 | </summary> | ||
1448 | </member> | ||
1449 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.BooleanToBooleanText(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1450 | <summary> | ||
1451 | Convert to a postgresql boolean text format. | ||
1452 | </summary> | ||
1453 | </member> | ||
1454 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.BooleanToBooleanBinary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> | ||
1455 | <summary> | ||
1456 | Convert to a postgresql boolean binary format. | ||
1457 | </summary> | ||
1458 | </member> | ||
1459 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.Int16ToInt2Binary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> | ||
1460 | <summary> | ||
1461 | Convert to a postgresql binary int2. | ||
1462 | </summary> | ||
1463 | </member> | ||
1464 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.Int32ToInt4Binary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> | ||
1465 | <summary> | ||
1466 | Convert to a postgresql binary int4. | ||
1467 | </summary> | ||
1468 | </member> | ||
1469 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.Int64ToInt8Binary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> | ||
1470 | <summary> | ||
1471 | Convert to a postgresql binary int8. | ||
1472 | </summary> | ||
1473 | </member> | ||
1474 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToBit(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1475 | <summary> | ||
1476 | Convert to a postgresql bit. | ||
1477 | </summary> | ||
1478 | </member> | ||
1479 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToDateTime(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1480 | <summary> | ||
1481 | Convert to a postgresql timestamp. | ||
1482 | </summary> | ||
1483 | </member> | ||
1484 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToDate(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1485 | <summary> | ||
1486 | Convert to a postgresql date. | ||
1487 | </summary> | ||
1488 | </member> | ||
1489 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToTime(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1490 | <summary> | ||
1491 | Convert to a postgresql time. | ||
1492 | </summary> | ||
1493 | </member> | ||
1494 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToMoney(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1495 | <summary> | ||
1496 | Convert to a postgres money. | ||
1497 | </summary> | ||
1498 | </member> | ||
1499 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.SingleDoubleToFloat4Float8Text(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1500 | <summary> | ||
1501 | Convert to a postgres double with maximum precision. | ||
1502 | </summary> | ||
1503 | </member> | ||
1504 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.SingleToFloat4Binary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> | ||
1505 | <summary> | ||
1506 | Convert a System.Float to a postgres float4. | ||
1507 | </summary> | ||
1508 | </member> | ||
1509 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.DoubleToFloat8Binary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> | ||
1510 | <summary> | ||
1511 | Convert a System.Double to a postgres float8. | ||
1512 | </summary> | ||
1513 | </member> | ||
1514 | <member name="T:NpgsqlTypes.ExtendedNativeToBackendTypeConverter"> | ||
1515 | <summary> | ||
1516 | Provide event handlers to convert extended native supported data types from | ||
1517 | native form to backend representation. | ||
1518 | </summary> | ||
1519 | </member> | ||
1520 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToPoint(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1521 | <summary> | ||
1522 | Point. | ||
1523 | </summary> | ||
1524 | </member> | ||
1525 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToBox(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1526 | <summary> | ||
1527 | Box. | ||
1528 | </summary> | ||
1529 | </member> | ||
1530 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToLSeg(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1531 | <summary> | ||
1532 | LSeg. | ||
1533 | </summary> | ||
1534 | </member> | ||
1535 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToPath(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1536 | <summary> | ||
1537 | Open path. | ||
1538 | </summary> | ||
1539 | </member> | ||
1540 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToPolygon(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1541 | <summary> | ||
1542 | Polygon. | ||
1543 | </summary> | ||
1544 | </member> | ||
1545 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToMacAddress(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1546 | <summary> | ||
1547 | Convert to a postgres MAC Address. | ||
1548 | </summary> | ||
1549 | </member> | ||
1550 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToCircle(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1551 | <summary> | ||
1552 | Circle. | ||
1553 | </summary> | ||
1554 | </member> | ||
1555 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToIPAddress(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1556 | <summary> | ||
1557 | Convert to a postgres inet. | ||
1558 | </summary> | ||
1559 | </member> | ||
1560 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToInterval(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1561 | <summary> | ||
1562 | Convert to a postgres interval | ||
1563 | </summary> | ||
1564 | </member> | ||
1565 | <member name="T:NpgsqlTypes.ConvertBackendTextToNativeHandler"> | ||
1566 | <summary> | ||
1567 | Delegate called to convert the given backend text data to its native representation. | ||
1568 | </summary> | ||
1569 | </member> | ||
1570 | <member name="T:NpgsqlTypes.ConvertBackendBinaryToNativeHandler"> | ||
1571 | <summary> | ||
1572 | Delegate called to convert the given backend binary data to its native representation. | ||
1573 | </summary> | ||
1574 | </member> | ||
1575 | <member name="T:NpgsqlTypes.NpgsqlBackendTypeInfo"> | ||
1576 | <summary> | ||
1577 | Represents a backend data type. | ||
1578 | This class can be called upon to convert a backend field representation to a native object. | ||
1579 | </summary> | ||
1580 | </member> | ||
1581 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeInfo.#ctor(System.Int32,System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Type,NpgsqlTypes.ConvertBackendTextToNativeHandler,NpgsqlTypes.ConvertBackendBinaryToNativeHandler)"> | ||
1582 | <summary> | ||
1583 | Construct a new NpgsqlTypeInfo with the given attributes and conversion handlers. | ||
1584 | </summary> | ||
1585 | <param name="OID">Type OID provided by the backend server.</param> | ||
1586 | <param name="Name">Type name provided by the backend server.</param> | ||
1587 | <param name="NpgsqlDbType">NpgsqlDbType</param> | ||
1588 | <param name="DbType">DbType</param> | ||
1589 | <param name="Type">System type to convert fields of this type to.</param> | ||
1590 | <param name="ConvertBackendTextToNative">Data conversion handler for text encoding.</param> | ||
1591 | <param name="ConvertBackendBinaryToNative">Data conversion handler for binary data.</param> | ||
1592 | </member> | ||
1593 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeInfo.ConvertBackendBinaryToNative(System.Byte[],System.Int32,System.Int32)"> | ||
1594 | <summary> | ||
1595 | Perform a data conversion from a backend representation to | ||
1596 | a native object. | ||
1597 | </summary> | ||
1598 | <param name="BackendData">Data sent from the backend.</param> | ||
1599 | <param name="fieldValueSize">fieldValueSize</param> | ||
1600 | <param name="TypeModifier">Type modifier field sent from the backend.</param> | ||
1601 | </member> | ||
1602 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeInfo.ConvertBackendTextToNative(System.Byte[],System.Int16,System.Int32)"> | ||
1603 | <summary> | ||
1604 | Perform a data conversion from a backend representation to | ||
1605 | a native object. | ||
1606 | </summary> | ||
1607 | <param name="BackendData">Data sent from the backend.</param> | ||
1608 | <param name="TypeSize">TypeSize</param> | ||
1609 | <param name="TypeModifier">Type modifier field sent from the backend.</param> | ||
1610 | </member> | ||
1611 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeInfo.OID"> | ||
1612 | <summary> | ||
1613 | Type OID provided by the backend server. | ||
1614 | </summary> | ||
1615 | </member> | ||
1616 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeInfo.Name"> | ||
1617 | <summary> | ||
1618 | Type name provided by the backend server. | ||
1619 | </summary> | ||
1620 | </member> | ||
1621 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeInfo.NpgsqlDbType"> | ||
1622 | <summary> | ||
1623 | NpgsqlDbType. | ||
1624 | </summary> | ||
1625 | </member> | ||
1626 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeInfo.DbType"> | ||
1627 | <summary> | ||
1628 | NpgsqlDbType. | ||
1629 | </summary> | ||
1630 | </member> | ||
1631 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeInfo.Type"> | ||
1632 | <summary> | ||
1633 | Provider type to convert fields of this type to. | ||
1634 | </summary> | ||
1635 | </member> | ||
1636 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeInfo.FrameworkType"> | ||
1637 | <summary> | ||
1638 | System type to convert fields of this type to. | ||
1639 | </summary> | ||
1640 | </member> | ||
1641 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeInfo.SupportsBinaryBackendData"> | ||
1642 | <summary> | ||
1643 | Reports whether a backend binary to native decoder is available for this type. | ||
1644 | </summary> | ||
1645 | </member> | ||
1646 | <member name="T:NpgsqlTypes.ConvertNativeToBackendTextHandler"> | ||
1647 | <summary> | ||
1648 | Delegate called to convert the given native data to its backand representation. | ||
1649 | </summary> | ||
1650 | </member> | ||
1651 | <member name="T:NpgsqlTypes.NpgsqlNativeTypeInfo"> | ||
1652 | <summary> | ||
1653 | Represents a backend data type. | ||
1654 | This class can be called upon to convert a native object to its backend field representation, | ||
1655 | </summary> | ||
1656 | </member> | ||
1657 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeInfo.ArrayOf(NpgsqlTypes.NpgsqlNativeTypeInfo)"> | ||
1658 | <summary> | ||
1659 | Returns an NpgsqlNativeTypeInfo for an array where the elements are of the type | ||
1660 | described by the NpgsqlNativeTypeInfo supplied. | ||
1661 | </summary> | ||
1662 | </member> | ||
1663 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeInfo.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Boolean,NpgsqlTypes.ConvertNativeToBackendTextHandler,NpgsqlTypes.ConvertNativeToBackendBinaryHandler)"> | ||
1664 | <summary> | ||
1665 | Construct a new NpgsqlTypeInfo with the given attributes and conversion handlers. | ||
1666 | </summary> | ||
1667 | <param name="Name">Type name provided by the backend server.</param> | ||
1668 | <param name="DbType">DbType</param> | ||
1669 | <param name="Quote">Quote</param> | ||
1670 | <param name="NpgsqlDbType">NpgsqlDbType</param> | ||
1671 | <param name="ConvertNativeToBackendText">Data conversion handler for text backend encoding.</param> | ||
1672 | <param name="ConvertNativeToBackendBinary">Data conversion handler for binary backend encoding (for extended queries).</param> | ||
1673 | </member> | ||
1674 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeInfo.ConvertToBackend(System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> | ||
1675 | <summary> | ||
1676 | Perform a data conversion from a native object to | ||
1677 | a backend representation. | ||
1678 | DBNull and null values are handled differently depending if a plain query is used | ||
1679 | When | ||
1680 | </summary> | ||
1681 | <param name="NativeData">Native .NET object to be converted.</param> | ||
1682 | <param name="forExtendedQuery">Specifies that the value should be formatted for the extended query syntax.</param> | ||
1683 | <param name="options">Options to guide serialization. If null, a default options set is used.</param> | ||
1684 | <param name="arrayElement">Specifies that the value should be formatted as an extended query array element.</param> | ||
1685 | </member> | ||
1686 | <member name="P:NpgsqlTypes.NpgsqlNativeTypeInfo.Name"> | ||
1687 | <summary> | ||
1688 | Type name provided by the backend server. | ||
1689 | </summary> | ||
1690 | </member> | ||
1691 | <member name="P:NpgsqlTypes.NpgsqlNativeTypeInfo.NpgsqlDbType"> | ||
1692 | <summary> | ||
1693 | NpgsqlDbType. | ||
1694 | </summary> | ||
1695 | </member> | ||
1696 | <member name="P:NpgsqlTypes.NpgsqlNativeTypeInfo.DbType"> | ||
1697 | <summary> | ||
1698 | DbType. | ||
1699 | </summary> | ||
1700 | </member> | ||
1701 | <member name="P:NpgsqlTypes.NpgsqlNativeTypeInfo.Quote"> | ||
1702 | <summary> | ||
1703 | Apply quoting. | ||
1704 | </summary> | ||
1705 | </member> | ||
1706 | <member name="P:NpgsqlTypes.NpgsqlNativeTypeInfo.UseSize"> | ||
1707 | <summary> | ||
1708 | Use parameter size information. | ||
1709 | </summary> | ||
1710 | </member> | ||
1711 | <member name="P:NpgsqlTypes.NpgsqlNativeTypeInfo.SupportsBinaryBackendData"> | ||
1712 | <summary> | ||
1713 | Reports whether a native to backend binary encoder is available for this type. | ||
1714 | </summary> | ||
1715 | </member> | ||
1716 | <member name="T:NpgsqlTypes.NpgsqlBackendTypeMapping"> | ||
1717 | <summary> | ||
1718 | Provide mapping between type OID, type name, and a NpgsqlBackendTypeInfo object that represents it. | ||
1719 | </summary> | ||
1720 | </member> | ||
1721 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.#ctor"> | ||
1722 | <summary> | ||
1723 | Construct an empty mapping. | ||
1724 | </summary> | ||
1725 | </member> | ||
1726 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.#ctor(NpgsqlTypes.NpgsqlBackendTypeMapping)"> | ||
1727 | <summary> | ||
1728 | Copy constuctor. | ||
1729 | </summary> | ||
1730 | </member> | ||
1731 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.AddType(NpgsqlTypes.NpgsqlBackendTypeInfo)"> | ||
1732 | <summary> | ||
1733 | Add the given NpgsqlBackendTypeInfo to this mapping. | ||
1734 | </summary> | ||
1735 | </member> | ||
1736 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.AddType(System.Int32,System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Type,NpgsqlTypes.ConvertBackendTextToNativeHandler,NpgsqlTypes.ConvertBackendBinaryToNativeHandler)"> | ||
1737 | <summary> | ||
1738 | Add a new NpgsqlBackendTypeInfo with the given attributes and conversion handlers to this mapping. | ||
1739 | </summary> | ||
1740 | <param name="OID">Type OID provided by the backend server.</param> | ||
1741 | <param name="Name">Type name provided by the backend server.</param> | ||
1742 | <param name="NpgsqlDbType">NpgsqlDbType</param> | ||
1743 | <param name="DbType">DbType</param> | ||
1744 | <param name="Type">System type to convert fields of this type to.</param> | ||
1745 | <param name="BackendTextConvert">Data conversion handler for text encoding.</param> | ||
1746 | <param name="BackendBinaryConvert">Data conversion handler for binary data.</param> | ||
1747 | </member> | ||
1748 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.Clone"> | ||
1749 | <summary> | ||
1750 | Make a shallow copy of this type mapping. | ||
1751 | </summary> | ||
1752 | </member> | ||
1753 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.ContainsOID(System.Int32)"> | ||
1754 | <summary> | ||
1755 | Determine if a NpgsqlBackendTypeInfo with the given backend type OID exists in this mapping. | ||
1756 | </summary> | ||
1757 | </member> | ||
1758 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.ContainsName(System.String)"> | ||
1759 | <summary> | ||
1760 | Determine if a NpgsqlBackendTypeInfo with the given backend type name exists in this mapping. | ||
1761 | </summary> | ||
1762 | </member> | ||
1763 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeMapping.Count"> | ||
1764 | <summary> | ||
1765 | Get the number of type infos held. | ||
1766 | </summary> | ||
1767 | </member> | ||
1768 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeMapping.Item(System.Int32)"> | ||
1769 | <summary> | ||
1770 | Retrieve the NpgsqlBackendTypeInfo with the given backend type OID, or null if none found. | ||
1771 | </summary> | ||
1772 | </member> | ||
1773 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeMapping.Item(System.String)"> | ||
1774 | <summary> | ||
1775 | Retrieve the NpgsqlBackendTypeInfo with the given backend type name, or null if none found. | ||
1776 | </summary> | ||
1777 | </member> | ||
1778 | <member name="T:NpgsqlTypes.NpgsqlNativeTypeMapping"> | ||
1779 | <summary> | ||
1780 | Provide mapping between type Type, NpgsqlDbType and a NpgsqlNativeTypeInfo object that represents it. | ||
1781 | </summary> | ||
1782 | </member> | ||
1783 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.AddType(NpgsqlTypes.NpgsqlNativeTypeInfo)"> | ||
1784 | <summary> | ||
1785 | Add the given NpgsqlNativeTypeInfo to this mapping. | ||
1786 | </summary> | ||
1787 | </member> | ||
1788 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.AddType(System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Boolean,NpgsqlTypes.ConvertNativeToBackendTextHandler,NpgsqlTypes.ConvertNativeToBackendBinaryHandler)"> | ||
1789 | <summary> | ||
1790 | Add a new NpgsqlNativeTypeInfo with the given attributes and conversion handlers to this mapping. | ||
1791 | </summary> | ||
1792 | <param name="Name">Type name provided by the backend server.</param> | ||
1793 | <param name="NpgsqlDbType">NpgsqlDbType</param> | ||
1794 | <param name="DbType">DbType</param> | ||
1795 | <param name="Quote">Quote</param> | ||
1796 | <param name="NativeTextConvert">Data conversion handler for text backend encoding.</param> | ||
1797 | <param name="NativeBinaryConvert">Data conversion handler for binary backend encoding (for extended query).</param> | ||
1798 | </member> | ||
1799 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.TryGetValue(NpgsqlTypes.NpgsqlDbType,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> | ||
1800 | <summary> | ||
1801 | Retrieve the NpgsqlNativeTypeInfo with the given NpgsqlDbType. | ||
1802 | </summary> | ||
1803 | </member> | ||
1804 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.TryGetValue(System.Data.DbType,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> | ||
1805 | <summary> | ||
1806 | Retrieve the NpgsqlNativeTypeInfo with the given DbType. | ||
1807 | </summary> | ||
1808 | </member> | ||
1809 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.TryGetValue(System.Type,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> | ||
1810 | <summary> | ||
1811 | Retrieve the NpgsqlNativeTypeInfo with the given Type. | ||
1812 | </summary> | ||
1813 | </member> | ||
1814 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.ContainsName(System.String)"> | ||
1815 | <summary> | ||
1816 | Determine if a NpgsqlNativeTypeInfo with the given backend type name exists in this mapping. | ||
1817 | </summary> | ||
1818 | </member> | ||
1819 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.ContainsNpgsqlDbType(NpgsqlTypes.NpgsqlDbType)"> | ||
1820 | <summary> | ||
1821 | Determine if a NpgsqlNativeTypeInfo with the given NpgsqlDbType exists in this mapping. | ||
1822 | </summary> | ||
1823 | </member> | ||
1824 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.ContainsType(System.Type)"> | ||
1825 | <summary> | ||
1826 | Determine if a NpgsqlNativeTypeInfo with the given Type name exists in this mapping. | ||
1827 | </summary> | ||
1828 | </member> | ||
1829 | <member name="P:NpgsqlTypes.NpgsqlNativeTypeMapping.Count"> | ||
1830 | <summary> | ||
1831 | Get the number of type infos held. | ||
1832 | </summary> | ||
1833 | </member> | ||
1834 | <member name="T:NpgsqlTypes.NpgsqlPoint"> | ||
1835 | <summary> | ||
1836 | Represents a PostgreSQL Point type | ||
1837 | </summary> | ||
1838 | </member> | ||
1839 | <member name="T:NpgsqlTypes.NpgsqlLSeg"> | ||
1840 | <summary> | ||
1841 | Represents a PostgreSQL Line Segment type. | ||
1842 | </summary> | ||
1843 | </member> | ||
1844 | <member name="T:NpgsqlTypes.NpgsqlPath"> | ||
1845 | <summary> | ||
1846 | Represents a PostgreSQL Path type. | ||
1847 | </summary> | ||
1848 | </member> | ||
1849 | <member name="T:NpgsqlTypes.NpgsqlPolygon"> | ||
1850 | <summary> | ||
1851 | Represents a PostgreSQL Polygon type. | ||
1852 | </summary> | ||
1853 | </member> | ||
1854 | <member name="T:NpgsqlTypes.NpgsqlCircle"> | ||
1855 | <summary> | ||
1856 | Represents a PostgreSQL Circle type. | ||
1857 | </summary> | ||
1858 | </member> | ||
1859 | <member name="T:NpgsqlTypes.NpgsqlInet"> | ||
1860 | <summary> | ||
1861 | Represents a PostgreSQL inet type. | ||
1862 | </summary> | ||
1863 | </member> | ||
1864 | <member name="T:NpgsqlTypes.NpgsqlMacAddress"> | ||
1865 | <summary> | ||
1866 | Represents a PostgreSQL MacAddress type. | ||
1867 | </summary> | ||
1868 | </member> | ||
1869 | <member name="M:NpgsqlTypes.NpgsqlMacAddress.#ctor(System.String)"> | ||
1870 | <summary> | ||
1871 | |||
1872 | </summary> | ||
1873 | <param name="macAddr">The macAddr parameter must contain a string that can only consist of numbers | ||
1874 | and upper-case letters as hexadecimal digits. (See PhysicalAddress.Parse method on MSDN)</param> | ||
1875 | </member> | ||
1876 | <member name="T:NpgsqlTypes.NpgsqlTypesHelper"> | ||
1877 | <summary> | ||
1878 | This class contains helper methods for type conversion between | ||
1879 | the .Net type system and postgresql. | ||
1880 | </summary> | ||
1881 | </member> | ||
1882 | <member name="F:NpgsqlTypes.NpgsqlTypesHelper.BackendTypeMappingCache"> | ||
1883 | <summary> | ||
1884 | A cache of basic datatype mappings keyed by server version. This way we don't | ||
1885 | have to load the basic type mappings for every connection. | ||
1886 | </summary> | ||
1887 | </member> | ||
1888 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetBackendTypeInfo(System.String,NpgsqlTypes.NpgsqlBackendTypeInfo@)"> | ||
1889 | <summary> | ||
1890 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects | ||
1891 | of the given NpgsqlDbType. | ||
1892 | </summary> | ||
1893 | </member> | ||
1894 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetNativeTypeInfo(NpgsqlTypes.NpgsqlDbType,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> | ||
1895 | <summary> | ||
1896 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects | ||
1897 | of the given NpgsqlDbType. | ||
1898 | </summary> | ||
1899 | </member> | ||
1900 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetNativeTypeInfo(System.Data.DbType,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> | ||
1901 | <summary> | ||
1902 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects | ||
1903 | of the given DbType. | ||
1904 | </summary> | ||
1905 | </member> | ||
1906 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetNativeTypeInfo(System.Type,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> | ||
1907 | <summary> | ||
1908 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects | ||
1909 | of the given System.Type. | ||
1910 | </summary> | ||
1911 | </member> | ||
1912 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.ConvertBackendBytesToSystemType(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> | ||
1913 | <summary> | ||
1914 | This method is responsible to convert the byte[] received from the backend | ||
1915 | to the corresponding NpgsqlType. | ||
1916 | The given TypeInfo is called upon to do the conversion. | ||
1917 | If no TypeInfo object is provided, no conversion is performed. | ||
1918 | </summary> | ||
1919 | </member> | ||
1920 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.ConvertBackendStringToSystemType(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> | ||
1921 | <summary> | ||
1922 | This method is responsible to convert the string received from the backend | ||
1923 | to the corresponding NpgsqlType. | ||
1924 | The given TypeInfo is called upon to do the conversion. | ||
1925 | If no TypeInfo object is provided, no conversion is performed. | ||
1926 | </summary> | ||
1927 | </member> | ||
1928 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.PrepareDefaultTypesMap"> | ||
1929 | <summary> | ||
1930 | Create the one and only native to backend type map. | ||
1931 | This map is used when formatting native data | ||
1932 | types to backend representations. | ||
1933 | </summary> | ||
1934 | </member> | ||
1935 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.CreateAndLoadInitialTypesMapping(Npgsql.NpgsqlConnector)"> | ||
1936 | <summary> | ||
1937 | This method creates (or retrieves from cache) a mapping between type and OID | ||
1938 | of all natively supported postgresql data types. | ||
1939 | This is needed as from one version to another, this mapping can be changed and | ||
1940 | so we avoid hardcoding them. | ||
1941 | </summary> | ||
1942 | <returns>NpgsqlTypeMapping containing all known data types. The mapping must be | ||
1943 | cloned before it is modified because it is cached; changes made by one connection may | ||
1944 | effect another connection. | ||
1945 | </returns> | ||
1946 | </member> | ||
1947 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.LoadTypesMappings(Npgsql.NpgsqlConnector,NpgsqlTypes.NpgsqlBackendTypeMapping,System.Collections.Generic.IEnumerable{NpgsqlTypes.NpgsqlBackendTypeInfo})"> | ||
1948 | <summary> | ||
1949 | Attempt to map types by issuing a query against pg_type. | ||
1950 | This function takes a list of NpgsqlTypeInfo and attempts to resolve the OID field | ||
1951 | of each by querying pg_type. If the mapping is found, the type info object is | ||
1952 | updated (OID) and added to the provided NpgsqlTypeMapping object. | ||
1953 | </summary> | ||
1954 | <param name="conn">NpgsqlConnector to send query through.</param> | ||
1955 | <param name="TypeMappings">Mapping object to add types too.</param> | ||
1956 | <param name="TypeInfoList">List of types that need to have OID's mapped.</param> | ||
1957 | </member> | ||
1958 | <member name="P:Npgsql.Cache`1.CacheSize"> | ||
1959 | <summary> | ||
1960 | Set Cache Size. The default value is 20. | ||
1961 | </summary> | ||
1962 | </member> | ||
1963 | <member name="P:Npgsql.Cache`1.Item(System.String)"> | ||
1964 | <summary> | ||
1965 | Lookup cached entity. null will returned if not match. | ||
1966 | For both get{} and set{} apply LRU rule. | ||
1967 | </summary> | ||
1968 | <param name="key">key</param> | ||
1969 | <returns></returns> | ||
1970 | </member> | ||
1971 | <member name="T:Npgsql.BackendEncoding"> | ||
1972 | <summary> | ||
1973 | The globally available text encoding used for frontend/backend communication. | ||
1974 | </summary> | ||
1975 | </member> | ||
1976 | <member name="T:Npgsql.NpgsqlState"> | ||
1977 | <summary> This class represents the base class for the state pattern design pattern | ||
1978 | implementation. | ||
1979 | </summary> | ||
1980 | |||
1981 | <summary> This class represents the base class for the state pattern design pattern | ||
1982 | implementation. | ||
1983 | </summary> | ||
1984 | |||
1985 | <summary> This class represents the base class for the state pattern design pattern | ||
1986 | implementation. | ||
1987 | </summary> | ||
1988 | |||
1989 | </member> | ||
1990 | <member name="M:Npgsql.NpgsqlState.ChangeState(Npgsql.NpgsqlConnector,Npgsql.NpgsqlState)"> | ||
1991 | <summary> | ||
1992 | This method is used by the states to change the state of the context. | ||
1993 | </summary> | ||
1994 | </member> | ||
1995 | <member name="M:Npgsql.NpgsqlState.ProcessAndDiscardBackendResponses(Npgsql.NpgsqlConnector)"> | ||
1996 | <summary> | ||
1997 | Call ProcessBackendResponsesEnum(), and scan and discard all results. | ||
1998 | </summary> | ||
1999 | </member> | ||
2000 | <member name="M:Npgsql.NpgsqlState.ProcessBackendResponsesEnum(Npgsql.NpgsqlConnector)"> | ||
2001 | <summary> | ||
2002 | This method is responsible to handle all protocol messages sent from the backend. | ||
2003 | It holds all the logic to do it. | ||
2004 | To exchange data, it uses a Mediator object from which it reads/writes information | ||
2005 | to handle backend requests. | ||
2006 | </summary> | ||
2007 | |||
2008 | </member> | ||
2009 | <member name="M:Npgsql.NpgsqlState.CheckForContextSocketAvailability(Npgsql.NpgsqlConnector,System.Net.Sockets.SelectMode)"> | ||
2010 | <summary> | ||
2011 | Checks for context socket availability. | ||
2012 | Socket.Poll supports integer as microseconds parameter. | ||
2013 | This limits the usable command timeout value | ||
2014 | to 2,147 seconds: (2,147 x 1,000,000 less than max_int). | ||
2015 | In order to bypass this limit, the availability of | ||
2016 | the socket is checked in 2,147 seconds cycles | ||
2017 | </summary> | ||
2018 | <returns><c>true</c>, if for context socket availability was checked, <c>false</c> otherwise.</returns> | ||
2019 | <param name="context">Context.</param> | ||
2020 | <param name="selectMode">Select mode.</param> | ||
2021 | </member> | ||
2022 | <member name="M:Npgsql.HashAlgorithm.#ctor"> | ||
2023 | <summary> | ||
2024 | Called from constructor of derived class. | ||
2025 | </summary> | ||
2026 | </member> | ||
2027 | <member name="M:Npgsql.HashAlgorithm.Finalize"> | ||
2028 | <summary> | ||
2029 | Finalizer for HashAlgorithm | ||
2030 | </summary> | ||
2031 | </member> | ||
2032 | <member name="M:Npgsql.HashAlgorithm.ComputeHash(System.Byte[])"> | ||
2033 | <summary> | ||
2034 | Computes the entire hash of all the bytes in the byte array. | ||
2035 | </summary> | ||
2036 | </member> | ||
2037 | <member name="M:Npgsql.HashAlgorithm.HashCore(System.Byte[],System.Int32,System.Int32)"> | ||
2038 | <summary> | ||
2039 | When overridden in a derived class, drives the hashing function. | ||
2040 | </summary> | ||
2041 | <param name="rgb"></param> | ||
2042 | <param name="start"></param> | ||
2043 | <param name="size"></param> | ||
2044 | </member> | ||
2045 | <member name="M:Npgsql.HashAlgorithm.HashFinal"> | ||
2046 | <summary> | ||
2047 | When overridden in a derived class, this pads and hashes whatever data might be left in the buffers and then returns the hash created. | ||
2048 | </summary> | ||
2049 | </member> | ||
2050 | <member name="M:Npgsql.HashAlgorithm.Initialize"> | ||
2051 | <summary> | ||
2052 | When overridden in a derived class, initializes the object to prepare for hashing. | ||
2053 | </summary> | ||
2054 | </member> | ||
2055 | <member name="M:Npgsql.HashAlgorithm.TransformBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)"> | ||
2056 | <summary> | ||
2057 | Used for stream chaining. Computes hash as data passes through it. | ||
2058 | </summary> | ||
2059 | <param name="inputBuffer">The buffer from which to grab the data to be copied.</param> | ||
2060 | <param name="inputOffset">The offset into the input buffer to start reading at.</param> | ||
2061 | <param name="inputCount">The number of bytes to be copied.</param> | ||
2062 | <param name="outputBuffer">The buffer to write the copied data to.</param> | ||
2063 | <param name="outputOffset">At what point in the outputBuffer to write the data at.</param> | ||
2064 | </member> | ||
2065 | <member name="M:Npgsql.HashAlgorithm.TransformFinalBlock(System.Byte[],System.Int32,System.Int32)"> | ||
2066 | <summary> | ||
2067 | Used for stream chaining. Computes hash as data passes through it. Finishes off the hash. | ||
2068 | </summary> | ||
2069 | <param name="inputBuffer">The buffer from which to grab the data to be copied.</param> | ||
2070 | <param name="inputOffset">The offset into the input buffer to start reading at.</param> | ||
2071 | <param name="inputCount">The number of bytes to be copied.</param> | ||
2072 | </member> | ||
2073 | <member name="P:Npgsql.HashAlgorithm.CanTransformMultipleBlocks"> | ||
2074 | <summary> | ||
2075 | Get whether or not the hash can transform multiple blocks at a time. | ||
2076 | Note: MUST be overriden if descendant can transform multiple block | ||
2077 | on a single call! | ||
2078 | </summary> | ||
2079 | </member> | ||
2080 | <member name="P:Npgsql.HashAlgorithm.Hash"> | ||
2081 | <summary> | ||
2082 | Gets the previously computed hash. | ||
2083 | </summary> | ||
2084 | </member> | ||
2085 | <member name="P:Npgsql.HashAlgorithm.HashSize"> | ||
2086 | <summary> | ||
2087 | Returns the size in bits of the hash. | ||
2088 | </summary> | ||
2089 | </member> | ||
2090 | <member name="P:Npgsql.HashAlgorithm.InputBlockSize"> | ||
2091 | <summary> | ||
2092 | Must be overriden if not 1 | ||
2093 | </summary> | ||
2094 | </member> | ||
2095 | <member name="P:Npgsql.HashAlgorithm.OutputBlockSize"> | ||
2096 | <summary> | ||
2097 | Must be overriden if not 1 | ||
2098 | </summary> | ||
2099 | </member> | ||
2100 | <member name="T:Npgsql.MD5"> | ||
2101 | <summary> | ||
2102 | Common base class for all derived MD5 implementations. | ||
2103 | </summary> | ||
2104 | </member> | ||
2105 | <member name="M:Npgsql.MD5.#ctor"> | ||
2106 | <summary> | ||
2107 | Called from constructor of derived class. | ||
2108 | </summary> | ||
2109 | </member> | ||
2110 | <member name="M:Npgsql.MD5.Create"> | ||
2111 | <summary> | ||
2112 | Creates the default derived class. | ||
2113 | </summary> | ||
2114 | </member> | ||
2115 | <member name="T:Npgsql.MD5CryptoServiceProvider"> | ||
2116 | <summary> | ||
2117 | C# implementation of the MD5 cryptographic hash function. | ||
2118 | </summary> | ||
2119 | </member> | ||
2120 | <member name="M:Npgsql.MD5CryptoServiceProvider.#ctor"> | ||
2121 | <summary> | ||
2122 | Creates a new MD5CryptoServiceProvider. | ||
2123 | </summary> | ||
2124 | </member> | ||
2125 | <member name="M:Npgsql.MD5CryptoServiceProvider.HashCore(System.Byte[],System.Int32,System.Int32)"> | ||
2126 | <summary> | ||
2127 | Drives the hashing function. | ||
2128 | </summary> | ||
2129 | <param name="rgb">Byte array containing the data to hash.</param> | ||
2130 | <param name="start">Where in the input buffer to start.</param> | ||
2131 | <param name="size">Size in bytes of the data in the buffer to hash.</param> | ||
2132 | </member> | ||
2133 | <member name="M:Npgsql.MD5CryptoServiceProvider.HashFinal"> | ||
2134 | <summary> | ||
2135 | This finalizes the hash. Takes the data from the chaining variables and returns it. | ||
2136 | </summary> | ||
2137 | </member> | ||
2138 | <member name="M:Npgsql.MD5CryptoServiceProvider.Initialize"> | ||
2139 | <summary> | ||
2140 | Resets the class after use. Called automatically after hashing is done. | ||
2141 | </summary> | ||
2142 | </member> | ||
2143 | <member name="M:Npgsql.MD5CryptoServiceProvider.ProcessBlock(System.Byte[],System.Int32)"> | ||
2144 | <summary> | ||
2145 | This is the meat of the hash function. It is what processes each block one at a time. | ||
2146 | </summary> | ||
2147 | <param name="inputBuffer">Byte array to process data from.</param> | ||
2148 | <param name="inputOffset">Where in the byte array to start processing.</param> | ||
2149 | </member> | ||
2150 | <member name="M:Npgsql.MD5CryptoServiceProvider.ProcessFinalBlock(System.Byte[],System.Int32,System.Int32)"> | ||
2151 | <summary> | ||
2152 | Pads and then processes the final block. | ||
2153 | </summary> | ||
2154 | <param name="inputBuffer">Buffer to grab data from.</param> | ||
2155 | <param name="inputOffset">Position in buffer in bytes to get data from.</param> | ||
2156 | <param name="inputCount">How much data in bytes in the buffer to use.</param> | ||
2157 | </member> | ||
2158 | <member name="T:Npgsql.StringRowReaderV3"> | ||
2159 | <summary> | ||
2160 | Implements <see cref="T:Npgsql.RowReader"/> for version 3 of the protocol. | ||
2161 | </summary> | ||
2162 | </member> | ||
2163 | <member name="T:Npgsql.RowReader"> | ||
2164 | <summary> | ||
2165 | Reads a row, field by field, allowing a DataRow to be built appropriately. | ||
2166 | </summary> | ||
2167 | </member> | ||
2168 | <member name="T:Npgsql.IStreamOwner"> | ||
2169 | <summary> | ||
2170 | Marker interface which identifies a class which may take possession of a stream for the duration of | ||
2171 | it's lifetime (possibly temporarily giving that possession to another class for part of that time. | ||
2172 | |||
2173 | It inherits from IDisposable, since any such class must make sure it leaves the stream in a valid state. | ||
2174 | |||
2175 | The most important such class is that compiler-generated from ProcessBackendResponsesEnum. Of course | ||
2176 | we can't make that inherit from this interface, alas. | ||
2177 | </summary> | ||
2178 | </member> | ||
2179 | <member name="T:Npgsql.IServerResponseObject"> | ||
2180 | <summary> | ||
2181 | Marker interface which identifies a class which represents part of | ||
2182 | a response from the server. | ||
2183 | </summary> | ||
2184 | </member> | ||
2185 | <member name="T:Npgsql.RowReader.Streamer"> | ||
2186 | <summary> | ||
2187 | Reads part of a field, as needed (for <see cref="M:System.Data.IDataRecord.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> | ||
2188 | and <see cref="M:System.Data.IDataRecord.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> | ||
2189 | </summary> | ||
2190 | </member> | ||
2191 | <member name="T:Npgsql.RowReader.Streamer`1"> | ||
2192 | <summary> | ||
2193 | Adds further functionality to stream that is dependant upon the type of data read. | ||
2194 | </summary> | ||
2195 | </member> | ||
2196 | <member name="T:Npgsql.RowReader.CharStreamer"> | ||
2197 | <summary> | ||
2198 | Completes the implementation of Streamer for char data. | ||
2199 | </summary> | ||
2200 | </member> | ||
2201 | <member name="T:Npgsql.RowReader.ByteStreamer"> | ||
2202 | <summary> | ||
2203 | Completes the implementation of Streamer for byte data. | ||
2204 | </summary> | ||
2205 | </member> | ||
2206 | <member name="T:Npgsql.StringRowReaderV2"> | ||
2207 | <summary> | ||
2208 | Implements <see cref="T:Npgsql.RowReader"/> for version 2 of the protocol. | ||
2209 | </summary> | ||
2210 | </member> | ||
2211 | <member name="T:Npgsql.StringRowReaderV2.NullMap"> | ||
2212 | <summary> | ||
2213 | Encapsulates the null mapping bytes sent at the start of a version 2 | ||
2214 | datarow message, and the process of identifying the nullity of the data | ||
2215 | at a particular index | ||
2216 | </summary> | ||
2217 | </member> | ||
2218 | <member name="T:Npgsql.NpgsqlBackEndKeyData"> | ||
2219 | <summary> | ||
2220 | This class represents a BackEndKeyData message received | ||
2221 | from PostgreSQL | ||
2222 | </summary> | ||
2223 | </member> | ||
2224 | <member name="T:Npgsql.NpgsqlBind"> | ||
2225 | <summary> | ||
2226 | This class represents the Bind message sent to PostgreSQL | ||
2227 | server. | ||
2228 | </summary> | ||
2229 | |||
2230 | </member> | ||
2231 | <member name="T:Npgsql.ClientMessage"> | ||
2232 | <summary> | ||
2233 | For classes representing messages sent from the client to the server. | ||
2234 | </summary> | ||
2235 | </member> | ||
2236 | <member name="T:Npgsql.NpgsqlCancelRequest"> | ||
2237 | <summary> | ||
2238 | This class represents the CancelRequest message sent to PostgreSQL | ||
2239 | server. | ||
2240 | </summary> | ||
2241 | |||
2242 | </member> | ||
2243 | <member name="T:Npgsql.NpgsqlCommand"> | ||
2244 | <summary> | ||
2245 | Represents a SQL statement or function (stored procedure) to execute | ||
2246 | against a PostgreSQL database. This class cannot be inherited. | ||
2247 | </summary> | ||
2248 | <summary> | ||
2249 | Represents a SQL statement or function (stored procedure) to execute | ||
2250 | against a PostgreSQL database. This class cannot be inherited. | ||
2251 | </summary> | ||
2252 | <summary> | ||
2253 | Represents a SQL statement or function (stored procedure) to execute | ||
2254 | against a PostgreSQL database. This class cannot be inherited. | ||
2255 | </summary> | ||
2256 | </member> | ||
2257 | <member name="M:Npgsql.NpgsqlCommand.#ctor"> | ||
2258 | <summary> | ||
2259 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class. | ||
2260 | </summary> | ||
2261 | </member> | ||
2262 | <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String)"> | ||
2263 | <summary> | ||
2264 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class with the text of the query. | ||
2265 | </summary> | ||
2266 | <param name="cmdText">The text of the query.</param> | ||
2267 | </member> | ||
2268 | <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnection)"> | ||
2269 | <summary> | ||
2270 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class with the text of the query and a <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>. | ||
2271 | </summary> | ||
2272 | <param name="cmdText">The text of the query.</param> | ||
2273 | <param name="connection">A <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> that represents the connection to a PostgreSQL server.</param> | ||
2274 | </member> | ||
2275 | <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnection,Npgsql.NpgsqlTransaction)"> | ||
2276 | <summary> | ||
2277 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class with the text of the query, a <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>, and the <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>. | ||
2278 | </summary> | ||
2279 | <param name="cmdText">The text of the query.</param> | ||
2280 | <param name="connection">A <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> that represents the connection to a PostgreSQL server.</param> | ||
2281 | <param name="transaction">The <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see> in which the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> executes.</param> | ||
2282 | </member> | ||
2283 | <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnector,System.Int32)"> | ||
2284 | <summary> | ||
2285 | Used to execute internal commands. | ||
2286 | </summary> | ||
2287 | </member> | ||
2288 | <member name="M:Npgsql.NpgsqlCommand.Cancel"> | ||
2289 | <summary> | ||
2290 | Attempts to cancel the execution of a <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>. | ||
2291 | </summary> | ||
2292 | <remarks>This Method isn't implemented yet.</remarks> | ||
2293 | </member> | ||
2294 | <member name="M:Npgsql.NpgsqlCommand.System#ICloneable#Clone"> | ||
2295 | <summary> | ||
2296 | Create a new command based on this one. | ||
2297 | </summary> | ||
2298 | <returns>A new NpgsqlCommand object.</returns> | ||
2299 | </member> | ||
2300 | <member name="M:Npgsql.NpgsqlCommand.Clone"> | ||
2301 | <summary> | ||
2302 | Create a new command based on this one. | ||
2303 | </summary> | ||
2304 | <returns>A new NpgsqlCommand object.</returns> | ||
2305 | </member> | ||
2306 | <member name="M:Npgsql.NpgsqlCommand.CreateDbParameter"> | ||
2307 | <summary> | ||
2308 | Creates a new instance of an <see cref="T:System.Data.Common.DbParameter">DbParameter</see> object. | ||
2309 | </summary> | ||
2310 | <returns>An <see cref="T:System.Data.Common.DbParameter">DbParameter</see> object.</returns> | ||
2311 | </member> | ||
2312 | <member name="M:Npgsql.NpgsqlCommand.CreateParameter"> | ||
2313 | <summary> | ||
2314 | Creates a new instance of a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object. | ||
2315 | </summary> | ||
2316 | <returns>A <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns> | ||
2317 | </member> | ||
2318 | <member name="M:Npgsql.NpgsqlCommand.ExecuteBlind"> | ||
2319 | <summary> | ||
2320 | Slightly optimised version of ExecuteNonQuery() for internal use in cases where the number | ||
2321 | of affected rows is of no interest. | ||
2322 | This function must not be called with a query that returns result rows, after calling Prepare(), or. | ||
2323 | with a query that requires parameter substitution of any kind. | ||
2324 | </summary> | ||
2325 | </member> | ||
2326 | <member name="M:Npgsql.NpgsqlCommand.ExecuteNonQuery"> | ||
2327 | <summary> | ||
2328 | Executes a SQL statement against the connection and returns the number of rows affected. | ||
2329 | </summary> | ||
2330 | <returns>The number of rows affected if known; -1 otherwise.</returns> | ||
2331 | </member> | ||
2332 | <member name="M:Npgsql.NpgsqlCommand.ExecuteDbDataReader(System.Data.CommandBehavior)"> | ||
2333 | <summary> | ||
2334 | Sends the <see cref="P:Npgsql.NpgsqlCommand.CommandText">CommandText</see> to | ||
2335 | the <see cref="T:Npgsql.NpgsqlConnection">Connection</see> and builds a | ||
2336 | <see cref="T:Npgsql.NpgsqlDataReader">NpgsqlDataReader</see> | ||
2337 | using one of the <see cref="T:System.Data.CommandBehavior">CommandBehavior</see> values. | ||
2338 | </summary> | ||
2339 | <param name="behavior">One of the <see cref="T:System.Data.CommandBehavior">CommandBehavior</see> values.</param> | ||
2340 | <returns>A <see cref="T:Npgsql.NpgsqlDataReader">NpgsqlDataReader</see> object.</returns> | ||
2341 | </member> | ||
2342 | <member name="M:Npgsql.NpgsqlCommand.ExecuteReader"> | ||
2343 | <summary> | ||
2344 | Sends the <see cref="P:Npgsql.NpgsqlCommand.CommandText">CommandText</see> to | ||
2345 | the <see cref="T:Npgsql.NpgsqlConnection">Connection</see> and builds a | ||
2346 | <see cref="T:Npgsql.NpgsqlDataReader">NpgsqlDataReader</see>. | ||
2347 | </summary> | ||
2348 | <returns>A <see cref="T:Npgsql.NpgsqlDataReader">NpgsqlDataReader</see> object.</returns> | ||
2349 | </member> | ||
2350 | <member name="M:Npgsql.NpgsqlCommand.ExecuteReader(System.Data.CommandBehavior)"> | ||
2351 | <summary> | ||
2352 | Sends the <see cref="P:Npgsql.NpgsqlCommand.CommandText">CommandText</see> to | ||
2353 | the <see cref="T:Npgsql.NpgsqlConnection">Connection</see> and builds a | ||
2354 | <see cref="T:Npgsql.NpgsqlDataReader">NpgsqlDataReader</see> | ||
2355 | using one of the <see cref="T:System.Data.CommandBehavior">CommandBehavior</see> values. | ||
2356 | </summary> | ||
2357 | <param name="cb">One of the <see cref="T:System.Data.CommandBehavior">CommandBehavior</see> values.</param> | ||
2358 | <returns>A <see cref="T:Npgsql.NpgsqlDataReader">NpgsqlDataReader</see> object.</returns> | ||
2359 | <remarks>Currently the CommandBehavior parameter is ignored.</remarks> | ||
2360 | </member> | ||
2361 | <member name="M:Npgsql.NpgsqlCommand.BindParameters"> | ||
2362 | <summary> | ||
2363 | This method binds the parameters from parameters collection to the bind | ||
2364 | message. | ||
2365 | </summary> | ||
2366 | </member> | ||
2367 | <member name="M:Npgsql.NpgsqlCommand.ExecuteScalar"> | ||
2368 | <summary> | ||
2369 | Executes the query, and returns the first column of the first row | ||
2370 | in the result set returned by the query. Extra columns or rows are ignored. | ||
2371 | </summary> | ||
2372 | <returns>The first column of the first row in the result set, | ||
2373 | or a null reference if the result set is empty.</returns> | ||
2374 | </member> | ||
2375 | <member name="M:Npgsql.NpgsqlCommand.Prepare"> | ||
2376 | <summary> | ||
2377 | Creates a prepared version of the command on a PostgreSQL server. | ||
2378 | </summary> | ||
2379 | </member> | ||
2380 | <member name="M:Npgsql.NpgsqlCommand.CheckConnectionState"> | ||
2381 | <summary> | ||
2382 | This method checks the connection state to see if the connection | ||
2383 | is set or it is open. If one of this conditions is not met, throws | ||
2384 | an InvalidOperationException | ||
2385 | </summary> | ||
2386 | </member> | ||
2387 | <member name="M:Npgsql.NpgsqlCommand.GetCommandText"> | ||
2388 | <summary> | ||
2389 | This method substitutes the <see cref="P:Npgsql.NpgsqlCommand.Parameters">Parameters</see>, if exist, in the command | ||
2390 | to their actual values. | ||
2391 | The parameter name format is <b>:ParameterName</b>. | ||
2392 | </summary> | ||
2393 | <returns>A version of <see cref="P:Npgsql.NpgsqlCommand.CommandText">CommandText</see> with the <see cref="P:Npgsql.NpgsqlCommand.Parameters">Parameters</see> inserted.</returns> | ||
2394 | </member> | ||
2395 | <member name="M:Npgsql.NpgsqlCommand.GetCommandText(System.Boolean,System.Boolean)"> | ||
2396 | <summary> | ||
2397 | Process this.commandText, trimming each distinct command and substituting paramater | ||
2398 | tokens. | ||
2399 | </summary> | ||
2400 | <param name="prepare"></param> | ||
2401 | <param name="forExtendQuery"></param> | ||
2402 | <returns>UTF8 encoded command ready to be sent to the backend.</returns> | ||
2403 | </member> | ||
2404 | <member name="M:Npgsql.NpgsqlCommand.GetDistinctTrimmedCommands(System.String)"> | ||
2405 | <summary> | ||
2406 | Find the beginning and end of each distinct SQL command and produce | ||
2407 | a list of descriptors, one for each command. Commands described are trimmed of | ||
2408 | leading and trailing white space and their terminating semi-colons. | ||
2409 | </summary> | ||
2410 | <param name="src">Raw command text.</param> | ||
2411 | <returns>List of chunk descriptors.</returns> | ||
2412 | </member> | ||
2413 | <member name="M:Npgsql.NpgsqlCommand.AppendCommandReplacingParameterValues(System.IO.Stream,System.String,System.Int32,System.Int32,System.Boolean,System.Boolean)"> | ||
2414 | <summary> | ||
2415 | Append a region of a source command text to an output command, performing parameter token | ||
2416 | substitutions. | ||
2417 | </summary> | ||
2418 | <param name="dest">Stream to which to append output.</param> | ||
2419 | <param name="src">Command text.</param> | ||
2420 | <param name="begin">Starting index within src.</param> | ||
2421 | <param name="length">Length of region to be processed.</param> | ||
2422 | <param name="prepare"></param> | ||
2423 | <param name="forExtendedQuery"></param> | ||
2424 | </member> | ||
2425 | <member name="P:Npgsql.NpgsqlCommand.CommandText"> | ||
2426 | <summary> | ||
2427 | Gets or sets the SQL statement or function (stored procedure) to execute at the data source. | ||
2428 | </summary> | ||
2429 | <value>The Transact-SQL statement or stored procedure to execute. The default is an empty string.</value> | ||
2430 | </member> | ||
2431 | <member name="P:Npgsql.NpgsqlCommand.CommandTimeout"> | ||
2432 | <summary> | ||
2433 | Gets or sets the wait time before terminating the attempt | ||
2434 | to execute a command and generating an error. | ||
2435 | </summary> | ||
2436 | <value>The time (in seconds) to wait for the command to execute. | ||
2437 | The default is 20 seconds.</value> | ||
2438 | </member> | ||
2439 | <member name="P:Npgsql.NpgsqlCommand.CommandType"> | ||
2440 | <summary> | ||
2441 | Gets or sets a value indicating how the | ||
2442 | <see cref="P:Npgsql.NpgsqlCommand.CommandText">CommandText</see> property is to be interpreted. | ||
2443 | </summary> | ||
2444 | <value>One of the <see cref="T:System.Data.CommandType">CommandType</see> values. The default is <see cref="T:System.Data.CommandType">CommandType.Text</see>.</value> | ||
2445 | </member> | ||
2446 | <member name="P:Npgsql.NpgsqlCommand.Connection"> | ||
2447 | <summary> | ||
2448 | Gets or sets the <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> | ||
2449 | used by this instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>. | ||
2450 | </summary> | ||
2451 | <value>The connection to a data source. The default value is a null reference.</value> | ||
2452 | </member> | ||
2453 | <member name="P:Npgsql.NpgsqlCommand.Parameters"> | ||
2454 | <summary> | ||
2455 | Gets the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see>. | ||
2456 | </summary> | ||
2457 | <value>The parameters of the SQL statement or function (stored procedure). The default is an empty collection.</value> | ||
2458 | </member> | ||
2459 | <member name="P:Npgsql.NpgsqlCommand.Transaction"> | ||
2460 | <summary> | ||
2461 | Gets or sets the <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see> | ||
2462 | within which the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> executes. | ||
2463 | </summary> | ||
2464 | <value>The <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>. | ||
2465 | The default value is a null reference.</value> | ||
2466 | </member> | ||
2467 | <member name="P:Npgsql.NpgsqlCommand.UpdatedRowSource"> | ||
2468 | <summary> | ||
2469 | Gets or sets how command results are applied to the <see cref="T:System.Data.DataRow">DataRow</see> | ||
2470 | when used by the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)">Update</see> | ||
2471 | method of the <see cref="T:System.Data.Common.DbDataAdapter">DbDataAdapter</see>. | ||
2472 | </summary> | ||
2473 | <value>One of the <see cref="T:System.Data.UpdateRowSource">UpdateRowSource</see> values.</value> | ||
2474 | </member> | ||
2475 | <member name="P:Npgsql.NpgsqlCommand.LastInsertedOID"> | ||
2476 | <summary> | ||
2477 | Returns oid of inserted row. This is only updated when using executenonQuery and when command inserts just a single row. If table is created without oids, this will always be 0. | ||
2478 | </summary> | ||
2479 | </member> | ||
2480 | <member name="T:Npgsql.NpgsqlCommandBuilder"> | ||
2481 | <summary> | ||
2482 | This class is responsible to create database commands for automatic insert, update and delete operations. | ||
2483 | </summary> | ||
2484 | </member> | ||
2485 | <member name="M:Npgsql.NpgsqlCommandBuilder.#ctor"> | ||
2486 | <summary> | ||
2487 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommandBuilder"/> class. | ||
2488 | </summary> | ||
2489 | </member> | ||
2490 | <member name="M:Npgsql.NpgsqlCommandBuilder.#ctor(Npgsql.NpgsqlDataAdapter)"> | ||
2491 | <summary> | ||
2492 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommandBuilder"/> class. | ||
2493 | </summary> | ||
2494 | <param name="adapter">The adapter.</param> | ||
2495 | </member> | ||
2496 | <member name="M:Npgsql.NpgsqlCommandBuilder.DeriveParameters(Npgsql.NpgsqlCommand)"> | ||
2497 | <summary> | ||
2498 | |||
2499 | This method is reponsible to derive the command parameter list with values obtained from function definition. | ||
2500 | It clears the Parameters collection of command. Also, if there is any parameter type which is not supported by Npgsql, an InvalidOperationException will be thrown. | ||
2501 | Parameters name will be parameter1, parameter2, ... | ||
2502 | </summary> | ||
2503 | <param name="command">NpgsqlCommand whose function parameters will be obtained.</param> | ||
2504 | </member> | ||
2505 | <member name="M:Npgsql.NpgsqlCommandBuilder.GetInsertCommand"> | ||
2506 | <summary> | ||
2507 | Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required | ||
2508 | to perform insertions at the data source. | ||
2509 | </summary> | ||
2510 | <returns> | ||
2511 | The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform insertions. | ||
2512 | </returns> | ||
2513 | </member> | ||
2514 | <member name="M:Npgsql.NpgsqlCommandBuilder.GetInsertCommand(System.Boolean)"> | ||
2515 | <summary> | ||
2516 | Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform insertions | ||
2517 | at the data source, optionally using columns for parameter names. | ||
2518 | </summary> | ||
2519 | <param name="useColumnsForParameterNames"> | ||
2520 | If <c>true</c>, generate parameter names matching column names, if possible. | ||
2521 | If <c>false</c>, generate @p1, @p2, and so on. | ||
2522 | </param> | ||
2523 | <returns> | ||
2524 | The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform insertions. | ||
2525 | </returns> | ||
2526 | </member> | ||
2527 | <member name="M:Npgsql.NpgsqlCommandBuilder.GetUpdateCommand"> | ||
2528 | <summary> | ||
2529 | Gets the automatically generated System.Data.Common.DbCommand object required | ||
2530 | to perform updates at the data source. | ||
2531 | </summary> | ||
2532 | <returns> | ||
2533 | The automatically generated System.Data.Common.DbCommand object required to perform updates. | ||
2534 | </returns> | ||
2535 | </member> | ||
2536 | <member name="M:Npgsql.NpgsqlCommandBuilder.GetUpdateCommand(System.Boolean)"> | ||
2537 | <summary> | ||
2538 | Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform updates | ||
2539 | at the data source, optionally using columns for parameter names. | ||
2540 | </summary> | ||
2541 | <param name="useColumnsForParameterNames"> | ||
2542 | If <c>true</c>, generate parameter names matching column names, if possible. | ||
2543 | If <c>false</c>, generate @p1, @p2, and so on. | ||
2544 | </param> | ||
2545 | <returns> | ||
2546 | The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform updates. | ||
2547 | </returns> | ||
2548 | </member> | ||
2549 | <member name="M:Npgsql.NpgsqlCommandBuilder.GetDeleteCommand"> | ||
2550 | <summary> | ||
2551 | Gets the automatically generated System.Data.Common.DbCommand object required | ||
2552 | to perform deletions at the data source. | ||
2553 | </summary> | ||
2554 | <returns> | ||
2555 | The automatically generated System.Data.Common.DbCommand object required to perform deletions. | ||
2556 | </returns> | ||
2557 | </member> | ||
2558 | <member name="M:Npgsql.NpgsqlCommandBuilder.GetDeleteCommand(System.Boolean)"> | ||
2559 | <summary> | ||
2560 | Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform deletions | ||
2561 | at the data source, optionally using columns for parameter names. | ||
2562 | </summary> | ||
2563 | <param name="useColumnsForParameterNames"> | ||
2564 | If <c>true</c>, generate parameter names matching column names, if possible. | ||
2565 | If <c>false</c>, generate @p1, @p2, and so on. | ||
2566 | </param> | ||
2567 | <returns> | ||
2568 | The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform deletions. | ||
2569 | </returns> | ||
2570 | </member> | ||
2571 | <member name="M:Npgsql.NpgsqlCommandBuilder.ApplyParameterInfo(System.Data.Common.DbParameter,System.Data.DataRow,System.Data.StatementType,System.Boolean)"> | ||
2572 | <summary> | ||
2573 | Applies the parameter information. | ||
2574 | </summary> | ||
2575 | <param name="p">The parameter.</param> | ||
2576 | <param name="row">The row.</param> | ||
2577 | <param name="statementType">Type of the statement.</param> | ||
2578 | <param name="whereClause">if set to <c>true</c> [where clause].</param> | ||
2579 | </member> | ||
2580 | <member name="M:Npgsql.NpgsqlCommandBuilder.GetParameterName(System.Int32)"> | ||
2581 | <summary> | ||
2582 | Returns the name of the specified parameter in the format of @p#. | ||
2583 | </summary> | ||
2584 | <param name="parameterOrdinal">The number to be included as part of the parameter's name..</param> | ||
2585 | <returns> | ||
2586 | The name of the parameter with the specified number appended as part of the parameter name. | ||
2587 | </returns> | ||
2588 | </member> | ||
2589 | <member name="M:Npgsql.NpgsqlCommandBuilder.GetParameterName(System.String)"> | ||
2590 | <summary> | ||
2591 | Returns the full parameter name, given the partial parameter name. | ||
2592 | </summary> | ||
2593 | <param name="parameterName">The partial name of the parameter.</param> | ||
2594 | <returns> | ||
2595 | The full parameter name corresponding to the partial parameter name requested. | ||
2596 | </returns> | ||
2597 | </member> | ||
2598 | <member name="M:Npgsql.NpgsqlCommandBuilder.GetParameterPlaceholder(System.Int32)"> | ||
2599 | <summary> | ||
2600 | Returns the placeholder for the parameter in the associated SQL statement. | ||
2601 | </summary> | ||
2602 | <param name="parameterOrdinal">The number to be included as part of the parameter's name.</param> | ||
2603 | <returns> | ||
2604 | The name of the parameter with the specified number appended. | ||
2605 | </returns> | ||
2606 | </member> | ||
2607 | <member name="M:Npgsql.NpgsqlCommandBuilder.SetRowUpdatingHandler(System.Data.Common.DbDataAdapter)"> | ||
2608 | <summary> | ||
2609 | Registers the <see cref="T:NpgsqlCommandBuilder" /> to handle the <see cref="E:NpgsqlDataAdapter.RowUpdating"/> event for a <see cref="T:NpgsqlDataAdapter" />. | ||
2610 | </summary> | ||
2611 | <param name="adapter">The <see cref="T:System.Data.Common.DbDataAdapter" /> to be used for the update.</param> | ||
2612 | </member> | ||
2613 | <member name="M:Npgsql.NpgsqlCommandBuilder.RowUpdatingHandler(System.Object,NpgsqlRowUpdatingEventArgs)"> | ||
2614 | <summary> | ||
2615 | Adds an event handler for the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdating"/> event. | ||
2616 | </summary> | ||
2617 | <param name="sender">The sender</param> | ||
2618 | <param name="e">A <see cref="T:NpgsqlRowUpdatingEventArgs"/> instance containing information about the event.</param> | ||
2619 | </member> | ||
2620 | <member name="M:Npgsql.NpgsqlCommandBuilder.QuoteIdentifier(System.String)"> | ||
2621 | <summary> | ||
2622 | Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier, including properly escaping any embedded quotes in the identifier. | ||
2623 | </summary> | ||
2624 | <param name="unquotedIdentifier">The original unquoted identifier.</param> | ||
2625 | <returns> | ||
2626 | The quoted version of the identifier. Embedded quotes within the identifier are properly escaped. | ||
2627 | </returns> | ||
2628 | <PermissionSet> | ||
2629 | <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*"/> | ||
2630 | </PermissionSet> | ||
2631 | <exception cref="T:System.ArgumentNullException">Unquoted identifier parameter cannot be null</exception> | ||
2632 | </member> | ||
2633 | <member name="M:Npgsql.NpgsqlCommandBuilder.UnquoteIdentifier(System.String)"> | ||
2634 | <summary> | ||
2635 | Given a quoted identifier, returns the correct unquoted form of that identifier, including properly un-escaping any embedded quotes in the identifier. | ||
2636 | </summary> | ||
2637 | <param name="quotedIdentifier">The identifier that will have its embedded quotes removed.</param> | ||
2638 | <returns> | ||
2639 | The unquoted identifier, with embedded quotes properly un-escaped. | ||
2640 | </returns> | ||
2641 | <PermissionSet> | ||
2642 | <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*"/> | ||
2643 | </PermissionSet> | ||
2644 | <exception cref="T:System.ArgumentNullException">Quoted identifier parameter cannot be null</exception> | ||
2645 | </member> | ||
2646 | <member name="P:Npgsql.NpgsqlCommandBuilder.QuotePrefix"> | ||
2647 | <summary> | ||
2648 | Gets or sets the beginning character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens. | ||
2649 | </summary> | ||
2650 | <returns> | ||
2651 | The beginning character or characters to use. The default is an empty string. | ||
2652 | </returns> | ||
2653 | <PermissionSet> | ||
2654 | <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" /> | ||
2655 | </PermissionSet> | ||
2656 | </member> | ||
2657 | <member name="P:Npgsql.NpgsqlCommandBuilder.QuoteSuffix"> | ||
2658 | <summary> | ||
2659 | Gets or sets the ending character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens. | ||
2660 | </summary> | ||
2661 | <returns> | ||
2662 | The ending character or characters to use. The default is an empty string. | ||
2663 | </returns> | ||
2664 | <PermissionSet> | ||
2665 | <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" /> | ||
2666 | </PermissionSet> | ||
2667 | </member> | ||
2668 | <member name="T:Npgsql.NoticeEventHandler"> | ||
2669 | <summary> | ||
2670 | Represents the method that handles the <see cref="E:Npgsql.NpgsqlConnection.Notification">Notice</see> events. | ||
2671 | </summary> | ||
2672 | <param name="sender">The source of the event.</param> | ||
2673 | <param name="e">A <see cref="T:Npgsql.NpgsqlNoticeEventArgs">NpgsqlNoticeEventArgs</see> that contains the event data.</param> | ||
2674 | </member> | ||
2675 | <member name="T:Npgsql.NotificationEventHandler"> | ||
2676 | <summary> | ||
2677 | Represents the method that handles the <see cref="E:Npgsql.NpgsqlConnection.Notification">Notification</see> events. | ||
2678 | </summary> | ||
2679 | <param name="sender">The source of the event.</param> | ||
2680 | <param name="e">A <see cref="T:Npgsql.NpgsqlNotificationEventArgs">NpgsqlNotificationEventArgs</see> that contains the event data.</param> | ||
2681 | </member> | ||
2682 | <member name="T:Npgsql.NpgsqlConnection"> | ||
2683 | <summary> | ||
2684 | This class represents a connection to a | ||
2685 | PostgreSQL server. | ||
2686 | </summary> | ||
2687 | </member> | ||
2688 | <member name="M:Npgsql.NpgsqlConnection.#ctor"> | ||
2689 | <summary> | ||
2690 | Initializes a new instance of the | ||
2691 | <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> class. | ||
2692 | </summary> | ||
2693 | </member> | ||
2694 | <member name="M:Npgsql.NpgsqlConnection.#ctor(System.String)"> | ||
2695 | <summary> | ||
2696 | Initializes a new instance of the | ||
2697 | <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> class | ||
2698 | and sets the <see cref="P:Npgsql.NpgsqlConnection.ConnectionString">ConnectionString</see>. | ||
2699 | </summary> | ||
2700 | <param name="ConnectionString">The connection used to open the PostgreSQL database.</param> | ||
2701 | </member> | ||
2702 | <member name="M:Npgsql.NpgsqlConnection.#ctor(Npgsql.NpgsqlConnectionStringBuilder)"> | ||
2703 | <summary> | ||
2704 | Initializes a new instance of the | ||
2705 | <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> class | ||
2706 | and sets the <see cref="P:Npgsql.NpgsqlConnection.ConnectionString">ConnectionString</see>. | ||
2707 | </summary> | ||
2708 | <param name="ConnectionString">The connection used to open the PostgreSQL database.</param> | ||
2709 | </member> | ||
2710 | <member name="M:Npgsql.NpgsqlConnection.BeginDbTransaction(System.Data.IsolationLevel)"> | ||
2711 | <summary> | ||
2712 | Begins a database transaction with the specified isolation level. | ||
2713 | </summary> | ||
2714 | <param name="isolationLevel">The <see cref="T:System.Data.IsolationLevel">isolation level</see> under which the transaction should run.</param> | ||
2715 | <returns>An <see cref="T:System.Data.Common.DbTransaction">DbTransaction</see> | ||
2716 | object representing the new transaction.</returns> | ||
2717 | <remarks> | ||
2718 | Currently the IsolationLevel ReadCommitted and Serializable are supported by the PostgreSQL backend. | ||
2719 | There's no support for nested transactions. | ||
2720 | </remarks> | ||
2721 | </member> | ||
2722 | <member name="M:Npgsql.NpgsqlConnection.BeginTransaction"> | ||
2723 | <summary> | ||
2724 | Begins a database transaction. | ||
2725 | </summary> | ||
2726 | <returns>A <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see> | ||
2727 | object representing the new transaction.</returns> | ||
2728 | <remarks> | ||
2729 | Currently there's no support for nested transactions. | ||
2730 | </remarks> | ||
2731 | </member> | ||
2732 | <member name="M:Npgsql.NpgsqlConnection.BeginTransaction(System.Data.IsolationLevel)"> | ||
2733 | <summary> | ||
2734 | Begins a database transaction with the specified isolation level. | ||
2735 | </summary> | ||
2736 | <param name="level">The <see cref="T:System.Data.IsolationLevel">isolation level</see> under which the transaction should run.</param> | ||
2737 | <returns>A <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see> | ||
2738 | object representing the new transaction.</returns> | ||
2739 | <remarks> | ||
2740 | Currently the IsolationLevel ReadCommitted and Serializable are supported by the PostgreSQL backend. | ||
2741 | There's no support for nested transactions. | ||
2742 | </remarks> | ||
2743 | </member> | ||
2744 | <member name="M:Npgsql.NpgsqlConnection.Open"> | ||
2745 | <summary> | ||
2746 | Opens a database connection with the property settings specified by the | ||
2747 | <see cref="P:Npgsql.NpgsqlConnection.ConnectionString">ConnectionString</see>. | ||
2748 | </summary> | ||
2749 | </member> | ||
2750 | <member name="M:Npgsql.NpgsqlConnection.ChangeDatabase(System.String)"> | ||
2751 | <summary> | ||
2752 | This method changes the current database by disconnecting from the actual | ||
2753 | database and connecting to the specified. | ||
2754 | </summary> | ||
2755 | <param name="dbName">The name of the database to use in place of the current database.</param> | ||
2756 | </member> | ||
2757 | <member name="M:Npgsql.NpgsqlConnection.Close"> | ||
2758 | <summary> | ||
2759 | Releases the connection to the database. If the connection is pooled, it will be | ||
2760 | made available for re-use. If it is non-pooled, the actual connection will be shutdown. | ||
2761 | </summary> | ||
2762 | </member> | ||
2763 | <member name="M:Npgsql.NpgsqlConnection.PromotableLocalTransactionEnded"> | ||
2764 | <summary> | ||
2765 | When a connection is closed within an enclosing TransactionScope and the transaction | ||
2766 | hasn't been promoted, we defer the actual closing until the scope ends. | ||
2767 | </summary> | ||
2768 | </member> | ||
2769 | <member name="M:Npgsql.NpgsqlConnection.CreateDbCommand"> | ||
2770 | <summary> | ||
2771 | Creates and returns a <see cref="T:System.Data.Common.DbCommand">DbCommand</see> | ||
2772 | object associated with the <see cref="T:System.Data.Common.DbConnection">IDbConnection</see>. | ||
2773 | </summary> | ||
2774 | <returns>A <see cref="T:System.Data.Common.DbCommand">DbCommand</see> object.</returns> | ||
2775 | </member> | ||
2776 | <member name="M:Npgsql.NpgsqlConnection.CreateCommand"> | ||
2777 | <summary> | ||
2778 | Creates and returns a <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> | ||
2779 | object associated with the <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>. | ||
2780 | </summary> | ||
2781 | <returns>A <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> object.</returns> | ||
2782 | </member> | ||
2783 | <member name="M:Npgsql.NpgsqlConnection.Dispose(System.Boolean)"> | ||
2784 | <summary> | ||
2785 | Releases all resources used by the | ||
2786 | <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>. | ||
2787 | </summary> | ||
2788 | <param name="disposing"><b>true</b> when called from Dispose(); | ||
2789 | <b>false</b> when being called from the finalizer.</param> | ||
2790 | </member> | ||
2791 | <member name="M:Npgsql.NpgsqlConnection.System#ICloneable#Clone"> | ||
2792 | <summary> | ||
2793 | Create a new connection based on this one. | ||
2794 | </summary> | ||
2795 | <returns>A new NpgsqlConnection object.</returns> | ||
2796 | </member> | ||
2797 | <member name="M:Npgsql.NpgsqlConnection.Clone"> | ||
2798 | <summary> | ||
2799 | Create a new connection based on this one. | ||
2800 | </summary> | ||
2801 | <returns>A new NpgsqlConnection object.</returns> | ||
2802 | </member> | ||
2803 | <member name="M:Npgsql.NpgsqlConnection.CopyConnectionStringBuilder"> | ||
2804 | <summary> | ||
2805 | Returns a copy of the NpgsqlConnectionStringBuilder that contains the parsed connection string values. | ||
2806 | </summary> | ||
2807 | </member> | ||
2808 | <member name="M:Npgsql.NpgsqlConnection.DefaultCertificateSelectionCallback(System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Cryptography.X509Certificates.X509Certificate,System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection)"> | ||
2809 | <summary> | ||
2810 | Default SSL CertificateSelectionCallback implementation. | ||
2811 | </summary> | ||
2812 | </member> | ||
2813 | <member name="M:Npgsql.NpgsqlConnection.DefaultCertificateValidationCallback(System.Security.Cryptography.X509Certificates.X509Certificate,System.Int32[])"> | ||
2814 | <summary> | ||
2815 | Default SSL CertificateValidationCallback implementation. | ||
2816 | </summary> | ||
2817 | </member> | ||
2818 | <member name="M:Npgsql.NpgsqlConnection.DefaultPrivateKeySelectionCallback(System.Security.Cryptography.X509Certificates.X509Certificate,System.String)"> | ||
2819 | <summary> | ||
2820 | Default SSL PrivateKeySelectionCallback implementation. | ||
2821 | </summary> | ||
2822 | </member> | ||
2823 | <member name="M:Npgsql.NpgsqlConnection.DefaultProvideClientCertificatesCallback(System.Security.Cryptography.X509Certificates.X509CertificateCollection)"> | ||
2824 | <summary> | ||
2825 | Default SSL ProvideClientCertificatesCallback implementation. | ||
2826 | </summary> | ||
2827 | </member> | ||
2828 | <member name="M:Npgsql.NpgsqlConnection.DefaultValidateRemoteCertificateCallback(System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors)"> | ||
2829 | <summary> | ||
2830 | Default SSL ValidateRemoteCertificateCallback implementation. | ||
2831 | </summary> | ||
2832 | </member> | ||
2833 | <member name="M:Npgsql.NpgsqlConnection.LogConnectionString"> | ||
2834 | <summary> | ||
2835 | Write each key/value pair in the connection string to the log. | ||
2836 | </summary> | ||
2837 | </member> | ||
2838 | <member name="M:Npgsql.NpgsqlConnection.LoadConnectionStringBuilder(System.String)"> | ||
2839 | <summary> | ||
2840 | Sets the `settings` ConnectionStringBuilder based on the given `connectionString` | ||
2841 | </summary> | ||
2842 | <param name="connectionString">The connection string to load the builder from</param> | ||
2843 | </member> | ||
2844 | <member name="M:Npgsql.NpgsqlConnection.LoadConnectionStringBuilder(Npgsql.NpgsqlConnectionStringBuilder)"> | ||
2845 | <summary> | ||
2846 | Sets the `settings` ConnectionStringBuilder based on the given `connectionString` | ||
2847 | </summary> | ||
2848 | <param name="connectionString">The connection string to load the builder from</param> | ||
2849 | </member> | ||
2850 | <member name="M:Npgsql.NpgsqlConnection.RefreshConnectionString"> | ||
2851 | <summary> | ||
2852 | Refresh the cached _connectionString whenever the builder settings change | ||
2853 | </summary> | ||
2854 | </member> | ||
2855 | <member name="M:Npgsql.NpgsqlConnection.GetSchema"> | ||
2856 | <summary> | ||
2857 | Returns the supported collections | ||
2858 | </summary> | ||
2859 | </member> | ||
2860 | <member name="M:Npgsql.NpgsqlConnection.GetSchema(System.String)"> | ||
2861 | <summary> | ||
2862 | Returns the schema collection specified by the collection name. | ||
2863 | </summary> | ||
2864 | <param name="collectionName">The collection name.</param> | ||
2865 | <returns>The collection specified.</returns> | ||
2866 | </member> | ||
2867 | <member name="M:Npgsql.NpgsqlConnection.GetSchema(System.String,System.String[])"> | ||
2868 | <summary> | ||
2869 | Returns the schema collection specified by the collection name filtered by the restrictions. | ||
2870 | </summary> | ||
2871 | <param name="collectionName">The collection name.</param> | ||
2872 | <param name="restrictions"> | ||
2873 | The restriction values to filter the results. A description of the restrictions is contained | ||
2874 | in the Restrictions collection. | ||
2875 | </param> | ||
2876 | <returns>The collection specified.</returns> | ||
2877 | </member> | ||
2878 | <member name="E:Npgsql.NpgsqlConnection.Notice"> | ||
2879 | <summary> | ||
2880 | Occurs on NoticeResponses from the PostgreSQL backend. | ||
2881 | </summary> | ||
2882 | </member> | ||
2883 | <member name="E:Npgsql.NpgsqlConnection.Notification"> | ||
2884 | <summary> | ||
2885 | Occurs on NotificationResponses from the PostgreSQL backend. | ||
2886 | </summary> | ||
2887 | </member> | ||
2888 | <member name="E:Npgsql.NpgsqlConnection.ProvideClientCertificatesCallback"> | ||
2889 | <summary> | ||
2890 | Called to provide client certificates for SSL handshake. | ||
2891 | </summary> | ||
2892 | </member> | ||
2893 | <member name="E:Npgsql.NpgsqlConnection.CertificateSelectionCallback"> | ||
2894 | <summary> | ||
2895 | Mono.Security.Protocol.Tls.CertificateSelectionCallback delegate. | ||
2896 | </summary> | ||
2897 | </member> | ||
2898 | <member name="E:Npgsql.NpgsqlConnection.CertificateValidationCallback"> | ||
2899 | <summary> | ||
2900 | Mono.Security.Protocol.Tls.CertificateValidationCallback delegate. | ||
2901 | </summary> | ||
2902 | </member> | ||
2903 | <member name="E:Npgsql.NpgsqlConnection.PrivateKeySelectionCallback"> | ||
2904 | <summary> | ||
2905 | Mono.Security.Protocol.Tls.PrivateKeySelectionCallback delegate. | ||
2906 | </summary> | ||
2907 | </member> | ||
2908 | <member name="E:Npgsql.NpgsqlConnection.ValidateRemoteCertificateCallback"> | ||
2909 | <summary> | ||
2910 | Called to validate server's certificate during SSL handshake | ||
2911 | </summary> | ||
2912 | </member> | ||
2913 | <member name="P:Npgsql.NpgsqlConnection.ConnectionString"> | ||
2914 | <summary> | ||
2915 | Gets or sets the string used to connect to a PostgreSQL database. | ||
2916 | Valid values are: | ||
2917 | <ul> | ||
2918 | <li> | ||
2919 | Server: Address/Name of Postgresql Server; | ||
2920 | </li> | ||
2921 | <li> | ||
2922 | Port: Port to connect to; | ||
2923 | </li> | ||
2924 | <li> | ||
2925 | Protocol: Protocol version to use, instead of automatic; Integer 2 or 3; | ||
2926 | </li> | ||
2927 | <li> | ||
2928 | Database: Database name. Defaults to user name if not specified; | ||
2929 | </li> | ||
2930 | <li> | ||
2931 | User Id: User name; | ||
2932 | </li> | ||
2933 | <li> | ||
2934 | Password: Password for clear text authentication; | ||
2935 | </li> | ||
2936 | <li> | ||
2937 | SSL: True or False. Controls whether to attempt a secure connection. Default = False; | ||
2938 | </li> | ||
2939 | <li> | ||
2940 | Pooling: True or False. Controls whether connection pooling is used. Default = True; | ||
2941 | </li> | ||
2942 | <li> | ||
2943 | MinPoolSize: Min size of connection pool; | ||
2944 | </li> | ||
2945 | <li> | ||
2946 | MaxPoolSize: Max size of connection pool; | ||
2947 | </li> | ||
2948 | <li> | ||
2949 | Timeout: Time to wait for connection open in seconds. Default is 15. | ||
2950 | </li> | ||
2951 | <li> | ||
2952 | CommandTimeout: Time to wait for command to finish execution before throw an exception. In seconds. Default is 20. | ||
2953 | </li> | ||
2954 | <li> | ||
2955 | Sslmode: Mode for ssl connection control. Can be Prefer, Require, Allow or Disable. Default is Disable. Check user manual for explanation of values. | ||
2956 | </li> | ||
2957 | <li> | ||
2958 | ConnectionLifeTime: Time to wait before closing unused connections in the pool in seconds. Default is 15. | ||
2959 | </li> | ||
2960 | <li> | ||
2961 | SyncNotification: Specifies if Npgsql should use synchronous notifications. | ||
2962 | </li> | ||
2963 | <li> | ||
2964 | SearchPath: Changes search path to specified and public schemas. | ||
2965 | </li> | ||
2966 | </ul> | ||
2967 | </summary> | ||
2968 | <value>The connection string that includes the server name, | ||
2969 | the database name, and other parameters needed to establish | ||
2970 | the initial connection. The default value is an empty string. | ||
2971 | </value> | ||
2972 | </member> | ||
2973 | <member name="P:Npgsql.NpgsqlConnection.Host"> | ||
2974 | <summary> | ||
2975 | Backend server host name. | ||
2976 | </summary> | ||
2977 | </member> | ||
2978 | <member name="P:Npgsql.NpgsqlConnection.Port"> | ||
2979 | <summary> | ||
2980 | Backend server port. | ||
2981 | </summary> | ||
2982 | </member> | ||
2983 | <member name="P:Npgsql.NpgsqlConnection.SSL"> | ||
2984 | <summary> | ||
2985 | If true, the connection will attempt to use SSL. | ||
2986 | </summary> | ||
2987 | </member> | ||
2988 | <member name="P:Npgsql.NpgsqlConnection.ConnectionTimeout"> | ||
2989 | <summary> | ||
2990 | Gets the time to wait while trying to establish a connection | ||
2991 | before terminating the attempt and generating an error. | ||
2992 | </summary> | ||
2993 | <value>The time (in seconds) to wait for a connection to open. The default value is 15 seconds.</value> | ||
2994 | </member> | ||
2995 | <member name="P:Npgsql.NpgsqlConnection.CommandTimeout"> | ||
2996 | <summary> | ||
2997 | Gets the time to wait while trying to execute a command | ||
2998 | before terminating the attempt and generating an error. | ||
2999 | </summary> | ||
3000 | <value>The time (in seconds) to wait for a command to complete. The default value is 20 seconds.</value> | ||
3001 | </member> | ||
3002 | <member name="P:Npgsql.NpgsqlConnection.ConnectionLifeTime"> | ||
3003 | <summary> | ||
3004 | Gets the time to wait before closing unused connections in the pool if the count | ||
3005 | of all connections exeeds MinPoolSize. | ||
3006 | </summary> | ||
3007 | <remarks> | ||
3008 | If connection pool contains unused connections for ConnectionLifeTime seconds, | ||
3009 | the half of them will be closed. If there will be unused connections in a second | ||
3010 | later then again the half of them will be closed and so on. | ||
3011 | This strategy provide smooth change of connection count in the pool. | ||
3012 | </remarks> | ||
3013 | <value>The time (in seconds) to wait. The default value is 15 seconds.</value> | ||
3014 | </member> | ||
3015 | <member name="P:Npgsql.NpgsqlConnection.Database"> | ||
3016 | <summary> | ||
3017 | Gets the name of the current database or the database to be used after a connection is opened. | ||
3018 | </summary> | ||
3019 | <value>The name of the current database or the name of the database to be | ||
3020 | used after a connection is opened. The default value is the empty string.</value> | ||
3021 | </member> | ||
3022 | <member name="P:Npgsql.NpgsqlConnection.PreloadReader"> | ||
3023 | <summary> | ||
3024 | Whether datareaders are loaded in their entirety (for compatibility with earlier code). | ||
3025 | </summary> | ||
3026 | </member> | ||
3027 | <member name="P:Npgsql.NpgsqlConnection.DataSource"> | ||
3028 | <summary> | ||
3029 | Gets the database server name. | ||
3030 | </summary> | ||
3031 | </member> | ||
3032 | <member name="P:Npgsql.NpgsqlConnection.SyncNotification"> | ||
3033 | <summary> | ||
3034 | Gets flag indicating if we are using Synchronous notification or not. | ||
3035 | The default value is false. | ||
3036 | </summary> | ||
3037 | </member> | ||
3038 | <member name="P:Npgsql.NpgsqlConnection.FullState"> | ||
3039 | <summary> | ||
3040 | Gets the current state of the connection. | ||
3041 | </summary> | ||
3042 | <value>A bitwise combination of the <see cref="T:System.Data.ConnectionState">ConnectionState</see> values. The default is <b>Closed</b>.</value> | ||
3043 | </member> | ||
3044 | <member name="P:Npgsql.NpgsqlConnection.State"> | ||
3045 | <summary> | ||
3046 | Gets whether the current state of the connection is Open or Closed | ||
3047 | </summary> | ||
3048 | <value>ConnectionState.Open or ConnectionState.Closed</value> | ||
3049 | </member> | ||
3050 | <member name="P:Npgsql.NpgsqlConnection.PostgreSqlVersion"> | ||
3051 | <summary> | ||
3052 | Version of the PostgreSQL backend. | ||
3053 | This can only be called when there is an active connection. | ||
3054 | </summary> | ||
3055 | </member> | ||
3056 | <member name="P:Npgsql.NpgsqlConnection.BackendProtocolVersion"> | ||
3057 | <summary> | ||
3058 | Protocol version in use. | ||
3059 | This can only be called when there is an active connection. | ||
3060 | </summary> | ||
3061 | </member> | ||
3062 | <member name="P:Npgsql.NpgsqlConnection.ProcessID"> | ||
3063 | <summary> | ||
3064 | Process id of backend server. | ||
3065 | This can only be called when there is an active connection. | ||
3066 | </summary> | ||
3067 | </member> | ||
3068 | <member name="P:Npgsql.NpgsqlConnection.UseConformantStrings"> | ||
3069 | <summary> | ||
3070 | Report whether the backend is expecting standard conformant strings. | ||
3071 | In version 8.1, Postgres began reporting this value (false), but did not actually support standard conformant strings. | ||
3072 | In version 8.2, Postgres began supporting standard conformant strings, but defaulted this flag to false. | ||
3073 | As of version 9.1, this flag defaults to true. | ||
3074 | </summary> | ||
3075 | </member> | ||
3076 | <member name="P:Npgsql.NpgsqlConnection.Supports_E_StringPrefix"> | ||
3077 | <summary> | ||
3078 | Report whether the backend understands the string literal E prefix (>= 8.1). | ||
3079 | </summary> | ||
3080 | </member> | ||
3081 | <member name="P:Npgsql.NpgsqlConnection.SupportsHexByteFormat"> | ||
3082 | <summary> | ||
3083 | Report whether the backend understands the hex byte format (>= 9.0). | ||
3084 | </summary> | ||
3085 | </member> | ||
3086 | <member name="P:Npgsql.NpgsqlConnection.Connector"> | ||
3087 | <summary> | ||
3088 | The connector object connected to the backend. | ||
3089 | </summary> | ||
3090 | </member> | ||
3091 | <member name="P:Npgsql.NpgsqlConnection.ConnectionStringValues"> | ||
3092 | <summary> | ||
3093 | Gets the NpgsqlConnectionStringBuilder containing the parsed connection string values. | ||
3094 | </summary> | ||
3095 | </member> | ||
3096 | <member name="P:Npgsql.NpgsqlConnection.UserName"> | ||
3097 | <summary> | ||
3098 | User name. | ||
3099 | </summary> | ||
3100 | </member> | ||
3101 | <member name="P:Npgsql.NpgsqlConnection.Password"> | ||
3102 | <summary> | ||
3103 | Password. | ||
3104 | </summary> | ||
3105 | </member> | ||
3106 | <member name="P:Npgsql.NpgsqlConnection.Pooling"> | ||
3107 | <summary> | ||
3108 | Determine if connection pooling will be used for this connection. | ||
3109 | </summary> | ||
3110 | </member> | ||
3111 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Clone"> | ||
3112 | <summary> | ||
3113 | Return an exact copy of this NpgsqlConnectionString. | ||
3114 | </summary> | ||
3115 | </member> | ||
3116 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.CheckIntegratedSecuritySupport"> | ||
3117 | <summary> | ||
3118 | No integrated security if we're on mono and .NET 4.5 because of ClaimsIdentity, | ||
3119 | see https://github.com/npgsql/Npgsql/issues/133 | ||
3120 | </summary> | ||
3121 | </member> | ||
3122 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.SetValue(System.String,Npgsql.Keywords,System.Object)"> | ||
3123 | <summary> | ||
3124 | This function will set value for known key, both private member and base[key]. | ||
3125 | </summary> | ||
3126 | <param name="keyword"></param> | ||
3127 | <param name="key"></param> | ||
3128 | <param name="value"></param> | ||
3129 | <returns>value, coerced as needed to the stored type.</returns> | ||
3130 | </member> | ||
3131 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.SetValue(Npgsql.Keywords,System.Object)"> | ||
3132 | <summary> | ||
3133 | The function will modify private member only, not base[key]. | ||
3134 | </summary> | ||
3135 | <param name="keyword"></param> | ||
3136 | <param name="value"></param> | ||
3137 | <returns>value, coerced as needed to the stored type.</returns> | ||
3138 | </member> | ||
3139 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.GetValue(Npgsql.Keywords)"> | ||
3140 | <summary> | ||
3141 | The function will access private member only, not base[key]. | ||
3142 | </summary> | ||
3143 | <param name="keyword"></param> | ||
3144 | <returns>value.</returns> | ||
3145 | </member> | ||
3146 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Clear"> | ||
3147 | <summary> | ||
3148 | Clear the member and assign them to the default value. | ||
3149 | </summary> | ||
3150 | </member> | ||
3151 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Host"> | ||
3152 | <summary> | ||
3153 | Gets or sets the backend server host name. | ||
3154 | </summary> | ||
3155 | </member> | ||
3156 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Port"> | ||
3157 | <summary> | ||
3158 | Gets or sets the backend server port. | ||
3159 | </summary> | ||
3160 | </member> | ||
3161 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Protocol"> | ||
3162 | <summary> | ||
3163 | Gets or sets the specified backend communication protocol version. | ||
3164 | </summary> | ||
3165 | </member> | ||
3166 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Database"> | ||
3167 | <summary> | ||
3168 | Gets or sets the name of the database to be used after a connection is opened. | ||
3169 | </summary> | ||
3170 | <value>The name of the database to be | ||
3171 | used after a connection is opened.</value> | ||
3172 | </member> | ||
3173 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.UserName"> | ||
3174 | <summary> | ||
3175 | Gets or sets the login user name. | ||
3176 | </summary> | ||
3177 | </member> | ||
3178 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.WindowsIdentityUserName"> | ||
3179 | <summary> | ||
3180 | This is a pretty horrible hack to fix https://github.com/npgsql/Npgsql/issues/133 | ||
3181 | In a nutshell, starting with .NET 4.5 WindowsIdentity inherits from ClaimsIdentity | ||
3182 | which doesn't exist in mono, and calling UserName getter above bombs. | ||
3183 | The workaround is that the function that actually deals with WindowsIdentity never | ||
3184 | gets called on mono, so never gets JITted and the problem goes away. | ||
3185 | </summary> | ||
3186 | </member> | ||
3187 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.PasswordAsByteArray"> | ||
3188 | <summary> | ||
3189 | Gets or sets the login password as a UTF8 encoded byte array. | ||
3190 | </summary> | ||
3191 | </member> | ||
3192 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Password"> | ||
3193 | <summary> | ||
3194 | Sets the login password as a string. | ||
3195 | </summary> | ||
3196 | </member> | ||
3197 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SSL"> | ||
3198 | <summary> | ||
3199 | Gets or sets a value indicating whether to attempt to use SSL. | ||
3200 | </summary> | ||
3201 | </member> | ||
3202 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SslMode"> | ||
3203 | <summary> | ||
3204 | Gets or sets a value indicating whether to attempt to use SSL. | ||
3205 | </summary> | ||
3206 | </member> | ||
3207 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Encoding"> | ||
3208 | <summary> | ||
3209 | Gets the backend encoding. Always returns "UTF8". | ||
3210 | </summary> | ||
3211 | </member> | ||
3212 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Timeout"> | ||
3213 | <summary> | ||
3214 | Gets or sets the time to wait while trying to establish a connection | ||
3215 | before terminating the attempt and generating an error. | ||
3216 | </summary> | ||
3217 | <value>The time (in seconds) to wait for a connection to open. The default value is 15 seconds.</value> | ||
3218 | </member> | ||
3219 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SearchPath"> | ||
3220 | <summary> | ||
3221 | Gets or sets the schema search path. | ||
3222 | </summary> | ||
3223 | </member> | ||
3224 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Pooling"> | ||
3225 | <summary> | ||
3226 | Gets or sets a value indicating whether connection pooling should be used. | ||
3227 | </summary> | ||
3228 | </member> | ||
3229 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ConnectionLifeTime"> | ||
3230 | <summary> | ||
3231 | Gets or sets the time to wait before closing unused connections in the pool if the count | ||
3232 | of all connections exeeds MinPoolSize. | ||
3233 | </summary> | ||
3234 | <remarks> | ||
3235 | If connection pool contains unused connections for ConnectionLifeTime seconds, | ||
3236 | the half of them will be closed. If there will be unused connections in a second | ||
3237 | later then again the half of them will be closed and so on. | ||
3238 | This strategy provide smooth change of connection count in the pool. | ||
3239 | </remarks> | ||
3240 | <value>The time (in seconds) to wait. The default value is 15 seconds.</value> | ||
3241 | </member> | ||
3242 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.MinPoolSize"> | ||
3243 | <summary> | ||
3244 | Gets or sets the minimum connection pool size. | ||
3245 | </summary> | ||
3246 | </member> | ||
3247 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.MaxPoolSize"> | ||
3248 | <summary> | ||
3249 | Gets or sets the maximum connection pool size. | ||
3250 | </summary> | ||
3251 | </member> | ||
3252 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SyncNotification"> | ||
3253 | <summary> | ||
3254 | Gets or sets a value indicating whether to listen for notifications and report them between command activity. | ||
3255 | </summary> | ||
3256 | </member> | ||
3257 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.CommandTimeout"> | ||
3258 | <summary> | ||
3259 | Gets the time to wait while trying to execute a command | ||
3260 | before terminating the attempt and generating an error. | ||
3261 | </summary> | ||
3262 | <value>The time (in seconds) to wait for a command to complete. The default value is 20 seconds.</value> | ||
3263 | </member> | ||
3264 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.PreloadReader"> | ||
3265 | <summary> | ||
3266 | Gets or sets a value indicating whether datareaders are loaded in their entirety (for compatibility with earlier code). | ||
3267 | </summary> | ||
3268 | </member> | ||
3269 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Compatible"> | ||
3270 | <summary> | ||
3271 | Compatibilty version. When possible, behaviour caused by breaking changes will be preserved | ||
3272 | if this version is less than that where the breaking change was introduced. | ||
3273 | </summary> | ||
3274 | </member> | ||
3275 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ApplicationName"> | ||
3276 | <summary> | ||
3277 | Gets or sets the ootional application name parameter to be sent to the backend during connection initiation. | ||
3278 | </summary> | ||
3279 | </member> | ||
3280 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.AlwaysPrepare"> | ||
3281 | <summary> | ||
3282 | Gets or sets a value indicating whether to silently Prepare() all commands before execution. | ||
3283 | </summary> | ||
3284 | </member> | ||
3285 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Item(System.String)"> | ||
3286 | <summary> | ||
3287 | Case insensative accessor for indivual connection string values. | ||
3288 | </summary> | ||
3289 | </member> | ||
3290 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.ValueDescription.#ctor(System.Type,System.Boolean,Npgsql.NpgsqlConnectionStringBuilder.ValueNativeToString)"> | ||
3291 | <summary> | ||
3292 | Set both ImplicitDefault and ExplicitDefault to the <paramref name="t"/>'s default value. | ||
3293 | </summary> | ||
3294 | <param name="t"></param> | ||
3295 | <param name="storeInBase"></param> | ||
3296 | <param name="nativeToString"></param> | ||
3297 | </member> | ||
3298 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.ValueDescription.#ctor(System.IComparable,System.Boolean,Npgsql.NpgsqlConnectionStringBuilder.ValueNativeToString)"> | ||
3299 | <summary> | ||
3300 | Set ImplicitDefault to the default value of <paramref name="explicitDefault"/>'s type, | ||
3301 | and ExplicitDefault to <paramref name="explicitDefault"/>. | ||
3302 | </summary> | ||
3303 | <param name="explicitDefault"></param> | ||
3304 | <param name="storeInBase"></param> | ||
3305 | <param name="nativeToString"></param> | ||
3306 | </member> | ||
3307 | <member name="T:Npgsql.ProvideClientCertificatesCallback"> | ||
3308 | <summary> | ||
3309 | Represents the method that allows the application to provide a certificate collection to be used for SSL clien authentication | ||
3310 | </summary> | ||
3311 | <param name="certificates">A <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection">X509CertificateCollection</see> to be filled with one or more client certificates.</param> | ||
3312 | </member> | ||
3313 | <member name="T:Npgsql.ValidateRemoteCertificateCallback"> | ||
3314 | <summary> | ||
3315 | Represents the method that is called to validate the certificate provided by the server during an SSL handshake | ||
3316 | </summary> | ||
3317 | <param name="cert">The server's certificate</param> | ||
3318 | <param name="chain">The certificate chain containing the certificate's CA and any intermediate authorities</param> | ||
3319 | <param name="errors">Any errors that were detected</param> | ||
3320 | </member> | ||
3321 | <member name="T:Npgsql.NpgsqlConnector"> | ||
3322 | <summary> | ||
3323 | !!! Helper class, for compilation only. | ||
3324 | Connector implements the logic for the Connection Objects to | ||
3325 | access the physical connection to the database, and isolate | ||
3326 | the application developer from connection pooling internals. | ||
3327 | </summary> | ||
3328 | </member> | ||
3329 | <member name="M:Npgsql.NpgsqlConnector.#ctor(Npgsql.NpgsqlConnectionStringBuilder,System.Boolean,System.Boolean)"> | ||
3330 | <summary> | ||
3331 | Constructor. | ||
3332 | </summary> | ||
3333 | <param name="ConnectionString">Connection string.</param> | ||
3334 | <param name="Pooled">Pooled</param> | ||
3335 | <param name="Shared">Controls whether the connector can be shared.</param> | ||
3336 | </member> | ||
3337 | <member name="M:Npgsql.NpgsqlConnector.IsValid"> | ||
3338 | <summary> | ||
3339 | This method checks if the connector is still ok. | ||
3340 | We try to send a simple query text, select 1 as ConnectionTest; | ||
3341 | </summary> | ||
3342 | </member> | ||
3343 | <member name="M:Npgsql.NpgsqlConnector.ReleaseResources"> | ||
3344 | <summary> | ||
3345 | This method is responsible for releasing all resources associated with this Connector. | ||
3346 | </summary> | ||
3347 | </member> | ||
3348 | <member name="M:Npgsql.NpgsqlConnector.ReleasePlansPortals"> | ||
3349 | <summary> | ||
3350 | This method is responsible to release all portals used by this Connector. | ||
3351 | </summary> | ||
3352 | </member> | ||
3353 | <member name="M:Npgsql.NpgsqlConnector.DefaultCertificateSelectionCallback(System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Cryptography.X509Certificates.X509Certificate,System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection)"> | ||
3354 | <summary> | ||
3355 | Default SSL CertificateSelectionCallback implementation. | ||
3356 | </summary> | ||
3357 | </member> | ||
3358 | <member name="M:Npgsql.NpgsqlConnector.DefaultCertificateValidationCallback(System.Security.Cryptography.X509Certificates.X509Certificate,System.Int32[])"> | ||
3359 | <summary> | ||
3360 | Default SSL CertificateValidationCallback implementation. | ||
3361 | </summary> | ||
3362 | </member> | ||
3363 | <member name="M:Npgsql.NpgsqlConnector.DefaultPrivateKeySelectionCallback(System.Security.Cryptography.X509Certificates.X509Certificate,System.String)"> | ||
3364 | <summary> | ||
3365 | Default SSL PrivateKeySelectionCallback implementation. | ||
3366 | </summary> | ||
3367 | </member> | ||
3368 | <member name="M:Npgsql.NpgsqlConnector.DefaultProvideClientCertificatesCallback(System.Security.Cryptography.X509Certificates.X509CertificateCollection)"> | ||
3369 | <summary> | ||
3370 | Default SSL ProvideClientCertificatesCallback implementation. | ||
3371 | </summary> | ||
3372 | </member> | ||
3373 | <member name="M:Npgsql.NpgsqlConnector.DefaultValidateRemoteCertificateCallback(System.Object,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors)"> | ||
3374 | <summary> | ||
3375 | Default SSL ValidateRemoteCertificateCallback implementation. | ||
3376 | </summary> | ||
3377 | </member> | ||
3378 | <member name="M:Npgsql.NpgsqlConnector.ProcessServerVersion"> | ||
3379 | <summary> | ||
3380 | This method is required to set all the version dependent features flags. | ||
3381 | SupportsPrepare means the server can use prepared query plans (7.3+) | ||
3382 | </summary> | ||
3383 | </member> | ||
3384 | <member name="M:Npgsql.NpgsqlConnector.Open"> | ||
3385 | <summary> | ||
3386 | Opens the physical connection to the server. | ||
3387 | </summary> | ||
3388 | <remarks>Usually called by the RequestConnector | ||
3389 | Method of the connection pool manager.</remarks> | ||
3390 | </member> | ||
3391 | <member name="M:Npgsql.NpgsqlConnector.Close"> | ||
3392 | <summary> | ||
3393 | Closes the physical connection to the server. | ||
3394 | </summary> | ||
3395 | </member> | ||
3396 | <member name="M:Npgsql.NpgsqlConnector.NextPortalName"> | ||
3397 | <summary> | ||
3398 | Returns next portal index. | ||
3399 | </summary> | ||
3400 | </member> | ||
3401 | <member name="M:Npgsql.NpgsqlConnector.NextPlanName"> | ||
3402 | <summary> | ||
3403 | Returns next plan index. | ||
3404 | </summary> | ||
3405 | </member> | ||
3406 | <member name="E:Npgsql.NpgsqlConnector.Notice"> | ||
3407 | <summary> | ||
3408 | Occurs on NoticeResponses from the PostgreSQL backend. | ||
3409 | </summary> | ||
3410 | </member> | ||
3411 | <member name="E:Npgsql.NpgsqlConnector.Notification"> | ||
3412 | <summary> | ||
3413 | Occurs on NotificationResponses from the PostgreSQL backend. | ||
3414 | </summary> | ||
3415 | </member> | ||
3416 | <member name="E:Npgsql.NpgsqlConnector.ProvideClientCertificatesCallback"> | ||
3417 | <summary> | ||
3418 | Called to provide client certificates for SSL handshake. | ||
3419 | </summary> | ||
3420 | </member> | ||
3421 | <member name="E:Npgsql.NpgsqlConnector.CertificateSelectionCallback"> | ||
3422 | <summary> | ||
3423 | Mono.Security.Protocol.Tls.CertificateSelectionCallback delegate. | ||
3424 | </summary> | ||
3425 | </member> | ||
3426 | <member name="E:Npgsql.NpgsqlConnector.CertificateValidationCallback"> | ||
3427 | <summary> | ||
3428 | Mono.Security.Protocol.Tls.CertificateValidationCallback delegate. | ||
3429 | </summary> | ||
3430 | </member> | ||
3431 | <member name="E:Npgsql.NpgsqlConnector.PrivateKeySelectionCallback"> | ||
3432 | <summary> | ||
3433 | Mono.Security.Protocol.Tls.PrivateKeySelectionCallback delegate. | ||
3434 | </summary> | ||
3435 | </member> | ||
3436 | <member name="E:Npgsql.NpgsqlConnector.ValidateRemoteCertificateCallback"> | ||
3437 | <summary> | ||
3438 | Called to validate server's certificate during SSL handshake | ||
3439 | </summary> | ||
3440 | </member> | ||
3441 | <member name="P:Npgsql.NpgsqlConnector.State"> | ||
3442 | <summary> | ||
3443 | Gets the current state of the connection. | ||
3444 | </summary> | ||
3445 | </member> | ||
3446 | <member name="P:Npgsql.NpgsqlConnector.ConnectionString"> | ||
3447 | <summary> | ||
3448 | Return Connection String. | ||
3449 | </summary> | ||
3450 | </member> | ||
3451 | <member name="P:Npgsql.NpgsqlConnector.ServerVersion"> | ||
3452 | <summary> | ||
3453 | Version of backend server this connector is connected to. | ||
3454 | </summary> | ||
3455 | </member> | ||
3456 | <member name="P:Npgsql.NpgsqlConnector.BackendProtocolVersion"> | ||
3457 | <summary> | ||
3458 | Backend protocol version in use by this connector. | ||
3459 | </summary> | ||
3460 | </member> | ||
3461 | <member name="P:Npgsql.NpgsqlConnector.Socket"> | ||
3462 | <summary> | ||
3463 | The physical connection socket to the backend. | ||
3464 | </summary> | ||
3465 | </member> | ||
3466 | <member name="P:Npgsql.NpgsqlConnector.BaseStream"> | ||
3467 | <summary> | ||
3468 | The physical connection stream to the backend. | ||
3469 | </summary> | ||
3470 | </member> | ||
3471 | <member name="P:Npgsql.NpgsqlConnector.Stream"> | ||
3472 | <summary> | ||
3473 | The top level stream to the backend. | ||
3474 | </summary> | ||
3475 | </member> | ||
3476 | <member name="P:Npgsql.NpgsqlConnector.IsInitialized"> | ||
3477 | <summary> | ||
3478 | Reports if this connector is fully connected. | ||
3479 | </summary> | ||
3480 | </member> | ||
3481 | <member name="P:Npgsql.NpgsqlConnector.Mediator"> | ||
3482 | <summary> | ||
3483 | The connection mediator. | ||
3484 | </summary> | ||
3485 | </member> | ||
3486 | <member name="P:Npgsql.NpgsqlConnector.Transaction"> | ||
3487 | <summary> | ||
3488 | Report if the connection is in a transaction. | ||
3489 | </summary> | ||
3490 | </member> | ||
3491 | <member name="P:Npgsql.NpgsqlConnector.SupportsPrepare"> | ||
3492 | <summary> | ||
3493 | Report whether the current connection can support prepare functionality. | ||
3494 | </summary> | ||
3495 | </member> | ||
3496 | <member name="P:Npgsql.NpgsqlConnector.NativeToBackendTypeConverterOptions"> | ||
3497 | <summary> | ||
3498 | Options that control certain aspects of native to backend conversions that depend | ||
3499 | on backend version and status. | ||
3500 | </summary> | ||
3501 | </member> | ||
3502 | <member name="T:Npgsql.NpgsqlConnectorPool"> | ||
3503 | <summary> | ||
3504 | This class manages all connector objects, pooled AND non-pooled. | ||
3505 | </summary> | ||
3506 | </member> | ||
3507 | <member name="F:Npgsql.NpgsqlConnectorPool.ConnectorPoolMgr"> | ||
3508 | <value>Unique static instance of the connector pool | ||
3509 | mamager.</value> | ||
3510 | </member> | ||
3511 | <member name="F:Npgsql.NpgsqlConnectorPool.PooledConnectors"> | ||
3512 | <value>Map of index to unused pooled connectors, avaliable to the | ||
3513 | next RequestConnector() call.</value> | ||
3514 | <remarks>This hashmap will be indexed by connection string. | ||
3515 | This key will hold a list of queues of pooled connectors available to be used.</remarks> | ||
3516 | </member> | ||
3517 | <member name="F:Npgsql.NpgsqlConnectorPool.Timer"> | ||
3518 | <value>Timer for tracking unused connections in pools.</value> | ||
3519 | </member> | ||
3520 | <member name="M:Npgsql.NpgsqlConnectorPool.RequestConnector(Npgsql.NpgsqlConnection)"> | ||
3521 | <summary> | ||
3522 | Searches the shared and pooled connector lists for a | ||
3523 | matching connector object or creates a new one. | ||
3524 | </summary> | ||
3525 | <param name="Connection">The NpgsqlConnection that is requesting | ||
3526 | the connector. Its ConnectionString will be used to search the | ||
3527 | pool for available connectors.</param> | ||
3528 | <returns>A connector object.</returns> | ||
3529 | </member> | ||
3530 | <member name="M:Npgsql.NpgsqlConnectorPool.RequestPooledConnectorInternal(Npgsql.NpgsqlConnection)"> | ||
3531 | <summary> | ||
3532 | Find a pooled connector. Handle shared/non-shared here. | ||
3533 | </summary> | ||
3534 | </member> | ||
3535 | <member name="M:Npgsql.NpgsqlConnectorPool.ReleaseConnector(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)"> | ||
3536 | <summary> | ||
3537 | Releases a connector, possibly back to the pool for future use. | ||
3538 | </summary> | ||
3539 | <remarks> | ||
3540 | Pooled connectors will be put back into the pool if there is room. | ||
3541 | Shared connectors should just have their use count decremented | ||
3542 | since they always stay in the shared pool. | ||
3543 | </remarks> | ||
3544 | <param name="Connection">Connection to which the connector is leased.</param> | ||
3545 | <param name="Connector">The connector to release.</param> | ||
3546 | </member> | ||
3547 | <member name="M:Npgsql.NpgsqlConnectorPool.ReleaseConnectorInternal(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)"> | ||
3548 | <summary> | ||
3549 | Release a pooled connector. Handle shared/non-shared here. | ||
3550 | </summary> | ||
3551 | </member> | ||
3552 | <member name="M:Npgsql.NpgsqlConnectorPool.GetPooledConnector(Npgsql.NpgsqlConnection)"> | ||
3553 | <summary> | ||
3554 | Find an available pooled connector in the non-shared pool, or create | ||
3555 | a new one if none found. | ||
3556 | </summary> | ||
3557 | </member> | ||
3558 | <member name="M:Npgsql.NpgsqlConnectorPool.UngetConnector(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)"> | ||
3559 | <summary> | ||
3560 | Put a pooled connector into the pool queue. | ||
3561 | </summary> | ||
3562 | <param name="Connection">Connection <paramref name="Connector"/> is leased to.</param> | ||
3563 | <param name="Connector">Connector to pool</param> | ||
3564 | </member> | ||
3565 | <member name="T:Npgsql.NpgsqlConnectorPool.ConnectorQueue"> | ||
3566 | <summary> | ||
3567 | A queue with an extra Int32 for keeping track of busy connections. | ||
3568 | </summary> | ||
3569 | </member> | ||
3570 | <member name="F:Npgsql.NpgsqlConnectorPool.ConnectorQueue.Available"> | ||
3571 | <summary> | ||
3572 | Connections available to the end user | ||
3573 | </summary> | ||
3574 | </member> | ||
3575 | <member name="F:Npgsql.NpgsqlConnectorPool.ConnectorQueue.Busy"> | ||
3576 | <summary> | ||
3577 | Connections currently in use | ||
3578 | </summary> | ||
3579 | </member> | ||
3580 | <member name="T:Npgsql.NpgsqlCopyFormat"> | ||
3581 | <summary> | ||
3582 | Represents information about COPY operation data transfer format as returned by server. | ||
3583 | </summary> | ||
3584 | </member> | ||
3585 | <member name="M:Npgsql.NpgsqlCopyFormat.#ctor(System.Byte,System.Int16[])"> | ||
3586 | <summary> | ||
3587 | Only created when a CopyInResponse or CopyOutResponse is received by NpgsqlState.ProcessBackendResponses() | ||
3588 | </summary> | ||
3589 | </member> | ||
3590 | <member name="M:Npgsql.NpgsqlCopyFormat.FieldIsBinary(System.Int32)"> | ||
3591 | <summary> | ||
3592 | Returns true if this operation is currently active and field at given location is in binary format. | ||
3593 | </summary> | ||
3594 | </member> | ||
3595 | <member name="P:Npgsql.NpgsqlCopyFormat.IsBinary"> | ||
3596 | <summary> | ||
3597 | Returns true if this operation is currently active and in binary format. | ||
3598 | </summary> | ||
3599 | </member> | ||
3600 | <member name="P:Npgsql.NpgsqlCopyFormat.FieldCount"> | ||
3601 | <summary> | ||
3602 | Returns number of fields if this operation is currently active, otherwise -1 | ||
3603 | </summary> | ||
3604 | </member> | ||
3605 | <member name="T:Npgsql.NpgsqlCopyIn"> | ||
3606 | <summary> | ||
3607 | Represents a PostgreSQL COPY FROM STDIN operation with a corresponding SQL statement | ||
3608 | to execute against a PostgreSQL database | ||
3609 | and an associated stream used to read data from (if provided by user) | ||
3610 | or for writing it (when generated by driver). | ||
3611 | Eg. new NpgsqlCopyIn("COPY mytable FROM STDIN", connection, streamToRead).Start(); | ||
3612 | </summary> | ||
3613 | </member> | ||
3614 | <member name="M:Npgsql.NpgsqlCopyIn.#ctor(System.String,Npgsql.NpgsqlConnection)"> | ||
3615 | <summary> | ||
3616 | Creates NpgsqlCommand to run given query upon Start(). Data for the requested COPY IN operation can then be written to CopyData stream followed by a call to End() or Cancel(). | ||
3617 | </summary> | ||
3618 | </member> | ||
3619 | <member name="M:Npgsql.NpgsqlCopyIn.#ctor(Npgsql.NpgsqlCommand,Npgsql.NpgsqlConnection)"> | ||
3620 | <summary> | ||
3621 | Given command is run upon Start(). Data for the requested COPY IN operation can then be written to CopyData stream followed by a call to End() or Cancel(). | ||
3622 | </summary> | ||
3623 | </member> | ||
3624 | <member name="M:Npgsql.NpgsqlCopyIn.#ctor(Npgsql.NpgsqlCommand,Npgsql.NpgsqlConnection,System.IO.Stream)"> | ||
3625 | <summary> | ||
3626 | Given command is executed upon Start() and all data from fromStream is passed to it as copy data. | ||
3627 | </summary> | ||
3628 | </member> | ||
3629 | <member name="M:Npgsql.NpgsqlCopyIn.FieldIsBinary(System.Int32)"> | ||
3630 | <summary> | ||
3631 | Returns true if this operation is currently active and field at given location is in binary format. | ||
3632 | </summary> | ||
3633 | </member> | ||
3634 | <member name="M:Npgsql.NpgsqlCopyIn.Start"> | ||
3635 | <summary> | ||
3636 | Command specified upon creation is executed as a non-query. | ||
3637 | If CopyStream is set upon creation, it will be flushed to server as copy data, and operation will be finished immediately. | ||
3638 | Otherwise the CopyStream member can be used for writing copy data to server and operation finished with a call to End() or Cancel(). | ||
3639 | </summary> | ||
3640 | </member> | ||
3641 | <member name="M:Npgsql.NpgsqlCopyIn.End"> | ||
3642 | <summary> | ||
3643 | Called after writing all data to CopyStream to successfully complete this copy operation. | ||
3644 | </summary> | ||
3645 | </member> | ||
3646 | <member name="M:Npgsql.NpgsqlCopyIn.Cancel(System.String)"> | ||
3647 | <summary> | ||
3648 | Withdraws an already started copy operation. The operation will fail with given error message. | ||
3649 | Will do nothing if current operation is not active. | ||
3650 | </summary> | ||
3651 | </member> | ||
3652 | <member name="P:Npgsql.NpgsqlCopyIn.IsActive"> | ||
3653 | <summary> | ||
3654 | Returns true if the connection is currently reserved for this operation. | ||
3655 | </summary> | ||
3656 | </member> | ||
3657 | <member name="P:Npgsql.NpgsqlCopyIn.CopyStream"> | ||
3658 | <summary> | ||
3659 | The stream provided by user or generated upon Start(). | ||
3660 | User may provide a stream to constructor; it is used to pass to server all data read from it. | ||
3661 | Otherwise, call to Start() sets this to a writable NpgsqlCopyInStream that passes all data written to it to server. | ||
3662 | In latter case this is only available while the copy operation is active and null otherwise. | ||
3663 | </summary> | ||
3664 | </member> | ||
3665 | <member name="P:Npgsql.NpgsqlCopyIn.IsBinary"> | ||
3666 | <summary> | ||
3667 | Returns true if this operation is currently active and in binary format. | ||
3668 | </summary> | ||
3669 | </member> | ||
3670 | <member name="P:Npgsql.NpgsqlCopyIn.FieldCount"> | ||
3671 | <summary> | ||
3672 | Returns number of fields expected on each input row if this operation is currently active, otherwise -1 | ||
3673 | </summary> | ||
3674 | </member> | ||
3675 | <member name="P:Npgsql.NpgsqlCopyIn.NpgsqlCommand"> | ||
3676 | <summary> | ||
3677 | The Command used to execute this copy operation. | ||
3678 | </summary> | ||
3679 | </member> | ||
3680 | <member name="P:Npgsql.NpgsqlCopyIn.CopyBufferSize"> | ||
3681 | <summary> | ||
3682 | Set before a COPY IN query to define size of internal buffer for reading from given CopyStream. | ||
3683 | </summary> | ||
3684 | </member> | ||
3685 | <member name="T:Npgsql.NpgsqlCopyInState"> | ||
3686 | <summary> | ||
3687 | Represents an ongoing COPY FROM STDIN operation. | ||
3688 | Provides methods to push data to server and end or cancel the operation. | ||
3689 | </summary> | ||
3690 | </member> | ||
3691 | <member name="M:Npgsql.NpgsqlCopyInState.StartCopy(Npgsql.NpgsqlConnector,Npgsql.NpgsqlCopyFormat)"> | ||
3692 | <summary> | ||
3693 | Called from NpgsqlState.ProcessBackendResponses upon CopyInResponse. | ||
3694 | If CopyStream is already set, it is used to read data to push to server, after which the copy is completed. | ||
3695 | Otherwise CopyStream is set to a writable NpgsqlCopyInStream that calls SendCopyData each time it is written to. | ||
3696 | </summary> | ||
3697 | </member> | ||
3698 | <member name="M:Npgsql.NpgsqlCopyInState.SendCopyData(Npgsql.NpgsqlConnector,System.Byte[],System.Int32,System.Int32)"> | ||
3699 | <summary> | ||
3700 | Sends given packet to server as a CopyData message. | ||
3701 | Does not check for notifications! Use another thread for that. | ||
3702 | </summary> | ||
3703 | </member> | ||
3704 | <member name="M:Npgsql.NpgsqlCopyInState.SendCopyDone(Npgsql.NpgsqlConnector)"> | ||
3705 | <summary> | ||
3706 | Sends CopyDone message to server. Handles responses, ie. may throw an exception. | ||
3707 | </summary> | ||
3708 | </member> | ||
3709 | <member name="M:Npgsql.NpgsqlCopyInState.SendCopyFail(Npgsql.NpgsqlConnector,System.String)"> | ||
3710 | <summary> | ||
3711 | Sends CopyFail message to server. Handles responses, ie. should always throw an exception: | ||
3712 | in CopyIn state the server responds to CopyFail with an error response; | ||
3713 | outside of a CopyIn state the server responds to CopyFail with an error response; | ||
3714 | without network connection or whatever, there's going to eventually be a failure, timeout or user intervention. | ||
3715 | </summary> | ||
3716 | </member> | ||
3717 | <member name="P:Npgsql.NpgsqlCopyInState.CopyFormat"> | ||
3718 | <summary> | ||
3719 | Copy format information returned from server. | ||
3720 | </summary> | ||
3721 | </member> | ||
3722 | <member name="T:Npgsql.NpgsqlCopyInStream"> | ||
3723 | <summary> | ||
3724 | Stream for writing data to a table on a PostgreSQL version 7.4 or newer database during an active COPY FROM STDIN operation. | ||
3725 | <b>Passes data exactly as is and when given</b>, so see to it that you use server encoding, correct format and reasonably sized writes! | ||
3726 | </summary> | ||
3727 | </member> | ||
3728 | <member name="M:Npgsql.NpgsqlCopyInStream.#ctor(Npgsql.NpgsqlConnector)"> | ||
3729 | <summary> | ||
3730 | Created only by NpgsqlCopyInState.StartCopy() | ||
3731 | </summary> | ||
3732 | </member> | ||
3733 | <member name="M:Npgsql.NpgsqlCopyInStream.Close"> | ||
3734 | <summary> | ||
3735 | Successfully completes copying data to server. Returns after operation is finished. | ||
3736 | Does nothing if this stream is not the active copy operation writer. | ||
3737 | </summary> | ||
3738 | </member> | ||
3739 | <member name="M:Npgsql.NpgsqlCopyInStream.Cancel(System.String)"> | ||
3740 | <summary> | ||
3741 | Withdraws an already started copy operation. The operation will fail with given error message. | ||
3742 | Does nothing if this stream is not the active copy operation writer. | ||
3743 | </summary> | ||
3744 | </member> | ||
3745 | <member name="M:Npgsql.NpgsqlCopyInStream.Write(System.Byte[],System.Int32,System.Int32)"> | ||
3746 | <summary> | ||
3747 | Writes given bytes to server. | ||
3748 | Fails if this stream is not the active copy operation writer. | ||
3749 | </summary> | ||
3750 | </member> | ||
3751 | <member name="M:Npgsql.NpgsqlCopyInStream.Flush"> | ||
3752 | <summary> | ||
3753 | Flushes stream contents to server. | ||
3754 | Fails if this stream is not the active copy operation writer. | ||
3755 | </summary> | ||
3756 | </member> | ||
3757 | <member name="M:Npgsql.NpgsqlCopyInStream.Read(System.Byte[],System.Int32,System.Int32)"> | ||
3758 | <summary> | ||
3759 | Not readable | ||
3760 | </summary> | ||
3761 | </member> | ||
3762 | <member name="M:Npgsql.NpgsqlCopyInStream.Seek(System.Int64,System.IO.SeekOrigin)"> | ||
3763 | <summary> | ||
3764 | Not seekable | ||
3765 | </summary> | ||
3766 | </member> | ||
3767 | <member name="M:Npgsql.NpgsqlCopyInStream.SetLength(System.Int64)"> | ||
3768 | <summary> | ||
3769 | Not supported | ||
3770 | </summary> | ||
3771 | </member> | ||
3772 | <member name="P:Npgsql.NpgsqlCopyInStream.IsActive"> | ||
3773 | <summary> | ||
3774 | True while this stream can be used to write copy data to server | ||
3775 | </summary> | ||
3776 | </member> | ||
3777 | <member name="P:Npgsql.NpgsqlCopyInStream.CanRead"> | ||
3778 | <summary> | ||
3779 | False | ||
3780 | </summary> | ||
3781 | </member> | ||
3782 | <member name="P:Npgsql.NpgsqlCopyInStream.CanWrite"> | ||
3783 | <summary> | ||
3784 | True | ||
3785 | </summary> | ||
3786 | </member> | ||
3787 | <member name="P:Npgsql.NpgsqlCopyInStream.CanSeek"> | ||
3788 | <summary> | ||
3789 | False | ||
3790 | </summary> | ||
3791 | </member> | ||
3792 | <member name="P:Npgsql.NpgsqlCopyInStream.Length"> | ||
3793 | <summary> | ||
3794 | Number of bytes written so far | ||
3795 | </summary> | ||
3796 | </member> | ||
3797 | <member name="P:Npgsql.NpgsqlCopyInStream.Position"> | ||
3798 | <summary> | ||
3799 | Number of bytes written so far; not settable | ||
3800 | </summary> | ||
3801 | </member> | ||
3802 | <member name="T:Npgsql.NpgsqlCopyOut"> | ||
3803 | <summary> | ||
3804 | Represents a PostgreSQL COPY TO STDOUT operation with a corresponding SQL statement | ||
3805 | to execute against a PostgreSQL database | ||
3806 | and an associated stream used to write results to (if provided by user) | ||
3807 | or for reading the results (when generated by driver). | ||
3808 | Eg. new NpgsqlCopyOut("COPY (SELECT * FROM mytable) TO STDOUT", connection, streamToWrite).Start(); | ||
3809 | </summary> | ||
3810 | </member> | ||
3811 | <member name="M:Npgsql.NpgsqlCopyOut.#ctor(System.String,Npgsql.NpgsqlConnection)"> | ||
3812 | <summary> | ||
3813 | Creates NpgsqlCommand to run given query upon Start(), after which CopyStream provides data from database as requested in the query. | ||
3814 | </summary> | ||
3815 | </member> | ||
3816 | <member name="M:Npgsql.NpgsqlCopyOut.#ctor(Npgsql.NpgsqlCommand,Npgsql.NpgsqlConnection)"> | ||
3817 | <summary> | ||
3818 | Given command is run upon Start(), after which CopyStream provides data from database as requested in the query. | ||
3819 | </summary> | ||
3820 | </member> | ||
3821 | <member name="M:Npgsql.NpgsqlCopyOut.#ctor(Npgsql.NpgsqlCommand,Npgsql.NpgsqlConnection,System.IO.Stream)"> | ||
3822 | <summary> | ||
3823 | Given command is executed upon Start() and all requested copy data is written to toStream immediately. | ||
3824 | </summary> | ||
3825 | </member> | ||
3826 | <member name="M:Npgsql.NpgsqlCopyOut.FieldIsBinary(System.Int32)"> | ||
3827 | <summary> | ||
3828 | Returns true if this operation is currently active and field at given location is in binary format. | ||
3829 | </summary> | ||
3830 | </member> | ||
3831 | <member name="M:Npgsql.NpgsqlCopyOut.Start"> | ||
3832 | <summary> | ||
3833 | Command specified upon creation is executed as a non-query. | ||
3834 | If CopyStream is set upon creation, all copy data from server will be written to it, and operation will be finished immediately. | ||
3835 | Otherwise the CopyStream member can be used for reading copy data from server until no more data is available. | ||
3836 | </summary> | ||
3837 | </member> | ||
3838 | <member name="M:Npgsql.NpgsqlCopyOut.End"> | ||
3839 | <summary> | ||
3840 | Flush generated CopyStream at once. Effectively reads and discard all the rest of copy data from server. | ||
3841 | </summary> | ||
3842 | </member> | ||
3843 | <member name="P:Npgsql.NpgsqlCopyOut.IsActive"> | ||
3844 | <summary> | ||
3845 | Returns true if the connection is currently reserved for this operation. | ||
3846 | </summary> | ||
3847 | </member> | ||
3848 | <member name="P:Npgsql.NpgsqlCopyOut.CopyStream"> | ||
3849 | <summary> | ||
3850 | The stream provided by user or generated upon Start() | ||
3851 | </summary> | ||
3852 | </member> | ||
3853 | <member name="P:Npgsql.NpgsqlCopyOut.NpgsqlCommand"> | ||
3854 | <summary> | ||
3855 | The Command used to execute this copy operation. | ||
3856 | </summary> | ||
3857 | </member> | ||
3858 | <member name="P:Npgsql.NpgsqlCopyOut.IsBinary"> | ||
3859 | <summary> | ||
3860 | Returns true if this operation is currently active and in binary format. | ||
3861 | </summary> | ||
3862 | </member> | ||
3863 | <member name="P:Npgsql.NpgsqlCopyOut.FieldCount"> | ||
3864 | <summary> | ||
3865 | Returns number of fields if this operation is currently active, otherwise -1 | ||
3866 | </summary> | ||
3867 | </member> | ||
3868 | <member name="P:Npgsql.NpgsqlCopyOut.Read"> | ||
3869 | <summary> | ||
3870 | Faster alternative to using the generated CopyStream. | ||
3871 | </summary> | ||
3872 | </member> | ||
3873 | <member name="T:Npgsql.NpgsqlCopyOutState"> | ||
3874 | <summary> | ||
3875 | Represents an ongoing COPY TO STDOUT operation. | ||
3876 | Provides methods to read data from server or end the operation. | ||
3877 | </summary> | ||
3878 | </member> | ||
3879 | <member name="M:Npgsql.NpgsqlCopyOutState.StartCopy(Npgsql.NpgsqlConnector,Npgsql.NpgsqlCopyFormat)"> | ||
3880 | <summary> | ||
3881 | Called from NpgsqlState.ProcessBackendResponses upon CopyOutResponse. | ||
3882 | If CopyStream is already set, it is used to write data received from server, after which the copy ends. | ||
3883 | Otherwise CopyStream is set to a readable NpgsqlCopyOutStream that receives data from server. | ||
3884 | </summary> | ||
3885 | </member> | ||
3886 | <member name="M:Npgsql.NpgsqlCopyOutState.GetCopyData(Npgsql.NpgsqlConnector)"> | ||
3887 | <summary> | ||
3888 | Called from NpgsqlOutStream.Read to read copy data from server. | ||
3889 | </summary> | ||
3890 | </member> | ||
3891 | <member name="P:Npgsql.NpgsqlCopyOutState.CopyFormat"> | ||
3892 | <summary> | ||
3893 | Copy format information returned from server. | ||
3894 | </summary> | ||
3895 | </member> | ||
3896 | <member name="T:Npgsql.NpgsqlCopyOutStream"> | ||
3897 | <summary> | ||
3898 | Stream for reading data from a table or select on a PostgreSQL version 7.4 or newer database during an active COPY TO STDOUT operation. | ||
3899 | <b>Passes data exactly as provided by the server.</b> | ||
3900 | </summary> | ||
3901 | </member> | ||
3902 | <member name="M:Npgsql.NpgsqlCopyOutStream.#ctor(Npgsql.NpgsqlConnector)"> | ||
3903 | <summary> | ||
3904 | Created only by NpgsqlCopyOutState.StartCopy() | ||
3905 | </summary> | ||
3906 | </member> | ||
3907 | <member name="M:Npgsql.NpgsqlCopyOutStream.Close"> | ||
3908 | <summary> | ||
3909 | Discards copy data as long as server pushes it. Returns after operation is finished. | ||
3910 | Does nothing if this stream is not the active copy operation reader. | ||
3911 | </summary> | ||
3912 | </member> | ||
3913 | <member name="M:Npgsql.NpgsqlCopyOutStream.Write(System.Byte[],System.Int32,System.Int32)"> | ||
3914 | <summary> | ||
3915 | Not writable. | ||
3916 | </summary> | ||
3917 | </member> | ||
3918 | <member name="M:Npgsql.NpgsqlCopyOutStream.Flush"> | ||
3919 | <summary> | ||
3920 | Not flushable. | ||
3921 | </summary> | ||
3922 | </member> | ||
3923 | <member name="M:Npgsql.NpgsqlCopyOutStream.Read(System.Byte[],System.Int32,System.Int32)"> | ||
3924 | <summary> | ||
3925 | Copies data read from server to given byte buffer. | ||
3926 | Since server returns data row by row, length will differ each time, but it is only zero once the operation ends. | ||
3927 | Can be mixed with calls to the more efficient NpgsqlCopyOutStream.Read() : byte[] though that would not make much sense. | ||
3928 | </summary> | ||
3929 | </member> | ||
3930 | <member name="M:Npgsql.NpgsqlCopyOutStream.Seek(System.Int64,System.IO.SeekOrigin)"> | ||
3931 | <summary> | ||
3932 | Not seekable | ||
3933 | </summary> | ||
3934 | </member> | ||
3935 | <member name="M:Npgsql.NpgsqlCopyOutStream.SetLength(System.Int64)"> | ||
3936 | <summary> | ||
3937 | Not supported | ||
3938 | </summary> | ||
3939 | </member> | ||
3940 | <member name="M:Npgsql.NpgsqlCopyOutStream.Read"> | ||
3941 | <summary> | ||
3942 | Returns a whole row of data from server without extra work. | ||
3943 | If standard Stream.Read(...) has been called before, it's internal buffers remains are returned. | ||
3944 | </summary> | ||
3945 | </member> | ||
3946 | <member name="P:Npgsql.NpgsqlCopyOutStream.IsActive"> | ||
3947 | <summary> | ||
3948 | True while this stream can be used to read copy data from server | ||
3949 | </summary> | ||
3950 | </member> | ||
3951 | <member name="P:Npgsql.NpgsqlCopyOutStream.CanRead"> | ||
3952 | <summary> | ||
3953 | True | ||
3954 | </summary> | ||
3955 | </member> | ||
3956 | <member name="P:Npgsql.NpgsqlCopyOutStream.CanWrite"> | ||
3957 | <summary> | ||
3958 | False | ||
3959 | </summary> | ||
3960 | </member> | ||
3961 | <member name="P:Npgsql.NpgsqlCopyOutStream.CanSeek"> | ||
3962 | <summary> | ||
3963 | False | ||
3964 | </summary> | ||
3965 | </member> | ||
3966 | <member name="P:Npgsql.NpgsqlCopyOutStream.Length"> | ||
3967 | <summary> | ||
3968 | Number of bytes read so far | ||
3969 | </summary> | ||
3970 | </member> | ||
3971 | <member name="P:Npgsql.NpgsqlCopyOutStream.Position"> | ||
3972 | <summary> | ||
3973 | Number of bytes read so far; can not be set. | ||
3974 | </summary> | ||
3975 | </member> | ||
3976 | <member name="T:Npgsql.NpgsqlCopySerializer"> | ||
3977 | <summary> | ||
3978 | Writes given objects into a stream for PostgreSQL COPY in default copy format (not CSV or BINARY). | ||
3979 | </summary> | ||
3980 | </member> | ||
3981 | <member name="T:Npgsql.NpgsqlRowUpdatedEventHandler"> | ||
3982 | <summary> | ||
3983 | Represents the method that handles the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdated">RowUpdated</see> events. | ||
3984 | </summary> | ||
3985 | <param name="sender">The source of the event.</param> | ||
3986 | <param name="e">A <see cref="T:NpgsqlRowUpdatedEventArgs">NpgsqlRowUpdatedEventArgs</see> that contains the event data.</param> | ||
3987 | </member> | ||
3988 | <member name="T:Npgsql.NpgsqlRowUpdatingEventHandler"> | ||
3989 | <summary> | ||
3990 | Represents the method that handles the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdating">RowUpdating</see> events. | ||
3991 | </summary> | ||
3992 | <param name="sender">The source of the event.</param> | ||
3993 | <param name="e">A <see cref="T:NpgsqlRowUpdatingEventArgs">NpgsqlRowUpdatingEventArgs</see> that contains the event data.</param> | ||
3994 | </member> | ||
3995 | <member name="T:Npgsql.NpgsqlDataAdapter"> | ||
3996 | <summary> | ||
3997 | This class represents an adapter from many commands: select, update, insert and delete to fill <see cref="T:System.Data.DataSet">Datasets.</see> | ||
3998 | </summary> | ||
3999 | </member> | ||
4000 | <member name="T:Npgsql.NpgsqlDataReader"> | ||
4001 | <summary> | ||
4002 | Provides a means of reading a forward-only stream of rows from a PostgreSQL backend. This class cannot be inherited. | ||
4003 | </summary> | ||
4004 | </member> | ||
4005 | <member name="M:Npgsql.NpgsqlDataReader.GetDataTypeName(System.Int32)"> | ||
4006 | <summary> | ||
4007 | Return the data type name of the column at index <param name="Index"></param>. | ||
4008 | </summary> | ||
4009 | </member> | ||
4010 | <member name="M:Npgsql.NpgsqlDataReader.GetFieldType(System.Int32)"> | ||
4011 | <summary> | ||
4012 | Return the data type of the column at index <param name="Index"></param>. | ||
4013 | </summary> | ||
4014 | </member> | ||
4015 | <member name="M:Npgsql.NpgsqlDataReader.GetProviderSpecificFieldType(System.Int32)"> | ||
4016 | <summary> | ||
4017 | Return the Npgsql specific data type of the column at requested ordinal. | ||
4018 | </summary> | ||
4019 | <param name="ordinal">column position</param> | ||
4020 | <returns>Appropriate Npgsql type for column.</returns> | ||
4021 | </member> | ||
4022 | <member name="M:Npgsql.NpgsqlDataReader.GetName(System.Int32)"> | ||
4023 | <summary> | ||
4024 | Return the column name of the column at index <param name="Index"></param>. | ||
4025 | </summary> | ||
4026 | </member> | ||
4027 | <member name="M:Npgsql.NpgsqlDataReader.GetDataTypeOID(System.Int32)"> | ||
4028 | <summary> | ||
4029 | Return the data type OID of the column at index <param name="Index"></param>. | ||
4030 | </summary> | ||
4031 | FIXME: Why this method returns String? | ||
4032 | </member> | ||
4033 | <member name="M:Npgsql.NpgsqlDataReader.GetOrdinal(System.String)"> | ||
4034 | <summary> | ||
4035 | Return the column name of the column named <param name="Name"></param>. | ||
4036 | </summary> | ||
4037 | </member> | ||
4038 | <member name="M:Npgsql.NpgsqlDataReader.GetFieldDbType(System.Int32)"> | ||
4039 | <summary> | ||
4040 | Return the data DbType of the column at index <param name="Index"></param>. | ||
4041 | </summary> | ||
4042 | </member> | ||
4043 | <member name="M:Npgsql.NpgsqlDataReader.GetFieldNpgsqlDbType(System.Int32)"> | ||
4044 | <summary> | ||
4045 | Return the data NpgsqlDbType of the column at index <param name="Index"></param>. | ||
4046 | </summary> | ||
4047 | </member> | ||
4048 | <member name="M:Npgsql.NpgsqlDataReader.GetInterval(System.Int32)"> | ||
4049 | <summary> | ||
4050 | Get the value of a column as a <see cref="T:NpgsqlTypes.NpgsqlInterval"/>. | ||
4051 | <remarks>If the differences between <see cref="T:NpgsqlTypes.NpgsqlInterval"/> and <see cref="T:System.TimeSpan"/> | ||
4052 | in handling of days and months is not important to your application, use <see cref="M:Npgsql.NpgsqlDataReader.GetTimeSpan(System.Int32)"/> | ||
4053 | instead.</remarks> | ||
4054 | </summary> | ||
4055 | <param name="i">Index of the field to find.</param> | ||
4056 | <returns><see cref="T:NpgsqlTypes.NpgsqlInterval"/> value of the field.</returns> | ||
4057 | </member> | ||
4058 | <member name="M:Npgsql.NpgsqlDataReader.GetGuid(System.Int32)"> | ||
4059 | <summary> | ||
4060 | Gets the value of a column converted to a Guid. | ||
4061 | </summary> | ||
4062 | </member> | ||
4063 | <member name="M:Npgsql.NpgsqlDataReader.GetInt16(System.Int32)"> | ||
4064 | <summary> | ||
4065 | Gets the value of a column as Int16. | ||
4066 | </summary> | ||
4067 | </member> | ||
4068 | <member name="M:Npgsql.NpgsqlDataReader.GetInt32(System.Int32)"> | ||
4069 | <summary> | ||
4070 | Gets the value of a column as Int32. | ||
4071 | </summary> | ||
4072 | </member> | ||
4073 | <member name="M:Npgsql.NpgsqlDataReader.GetInt64(System.Int32)"> | ||
4074 | <summary> | ||
4075 | Gets the value of a column as Int64. | ||
4076 | </summary> | ||
4077 | </member> | ||
4078 | <member name="M:Npgsql.NpgsqlDataReader.GetFloat(System.Int32)"> | ||
4079 | <summary> | ||
4080 | Gets the value of a column as Single. | ||
4081 | </summary> | ||
4082 | </member> | ||
4083 | <member name="M:Npgsql.NpgsqlDataReader.GetDouble(System.Int32)"> | ||
4084 | <summary> | ||
4085 | Gets the value of a column as Double. | ||
4086 | </summary> | ||
4087 | </member> | ||
4088 | <member name="M:Npgsql.NpgsqlDataReader.GetString(System.Int32)"> | ||
4089 | <summary> | ||
4090 | Gets the value of a column as String. | ||
4091 | </summary> | ||
4092 | </member> | ||
4093 | <member name="M:Npgsql.NpgsqlDataReader.GetDecimal(System.Int32)"> | ||
4094 | <summary> | ||
4095 | Gets the value of a column as Decimal. | ||
4096 | </summary> | ||
4097 | </member> | ||
4098 | <member name="M:Npgsql.NpgsqlDataReader.GetTimeSpan(System.Int32)"> | ||
4099 | <summary> | ||
4100 | Gets the value of a column as TimeSpan. | ||
4101 | </summary> | ||
4102 | </member> | ||
4103 | <member name="M:Npgsql.NpgsqlDataReader.GetValues(System.Object[])"> | ||
4104 | <summary> | ||
4105 | Copy values from each column in the current row into <paramref name="values"/>. | ||
4106 | </summary> | ||
4107 | <param name="values">Destination for column values.</param> | ||
4108 | <returns>The number of column values copied.</returns> | ||
4109 | </member> | ||
4110 | <member name="M:Npgsql.NpgsqlDataReader.GetProviderSpecificValues(System.Object[])"> | ||
4111 | <summary> | ||
4112 | Copy values from each column in the current row into <paramref name="values"></paramref>. | ||
4113 | </summary> | ||
4114 | <param name="values">An array appropriately sized to store values from all columns.</param> | ||
4115 | <returns>The number of column values copied.</returns> | ||
4116 | </member> | ||
4117 | <member name="M:Npgsql.NpgsqlDataReader.GetBoolean(System.Int32)"> | ||
4118 | <summary> | ||
4119 | Gets the value of a column as Boolean. | ||
4120 | </summary> | ||
4121 | </member> | ||
4122 | <member name="M:Npgsql.NpgsqlDataReader.GetByte(System.Int32)"> | ||
4123 | <summary> | ||
4124 | Gets the value of a column as Byte. Not implemented. | ||
4125 | </summary> | ||
4126 | </member> | ||
4127 | <member name="M:Npgsql.NpgsqlDataReader.GetChar(System.Int32)"> | ||
4128 | <summary> | ||
4129 | Gets the value of a column as Char. | ||
4130 | </summary> | ||
4131 | </member> | ||
4132 | <member name="M:Npgsql.NpgsqlDataReader.GetDateTime(System.Int32)"> | ||
4133 | <summary> | ||
4134 | Gets the value of a column as DateTime. | ||
4135 | </summary> | ||
4136 | </member> | ||
4137 | <member name="M:Npgsql.NpgsqlDataReader.GetSchemaTable"> | ||
4138 | <summary> | ||
4139 | Returns a System.Data.DataTable that describes the column metadata of the DataReader. | ||
4140 | </summary> | ||
4141 | </member> | ||
4142 | <member name="M:Npgsql.NpgsqlDataReader.GetTableNameFromQuery"> | ||
4143 | <summary> | ||
4144 | This methods parses the command text and tries to get the tablename | ||
4145 | from it. | ||
4146 | </summary> | ||
4147 | </member> | ||
4148 | <member name="E:Npgsql.NpgsqlDataReader.ReaderClosed"> | ||
4149 | <summary> | ||
4150 | Is raised whenever Close() is called. | ||
4151 | </summary> | ||
4152 | </member> | ||
4153 | <member name="P:Npgsql.NpgsqlDataReader.FieldCount"> | ||
4154 | <summary> | ||
4155 | Gets the number of columns in the current row. | ||
4156 | </summary> | ||
4157 | </member> | ||
4158 | <member name="P:Npgsql.NpgsqlDataReader.Item(System.Int32)"> | ||
4159 | <summary> | ||
4160 | Gets the value of a column in its native format. | ||
4161 | </summary> | ||
4162 | </member> | ||
4163 | <member name="P:Npgsql.NpgsqlDataReader.Item(System.String)"> | ||
4164 | <summary> | ||
4165 | Gets the value of a column in its native format. | ||
4166 | </summary> | ||
4167 | </member> | ||
4168 | <member name="P:Npgsql.NpgsqlDataReader.Depth"> | ||
4169 | <summary> | ||
4170 | Gets a value indicating the depth of nesting for the current row. Always returns zero. | ||
4171 | </summary> | ||
4172 | </member> | ||
4173 | <member name="P:Npgsql.NpgsqlDataReader.IsClosed"> | ||
4174 | <summary> | ||
4175 | Gets a value indicating whether the data reader is closed. | ||
4176 | </summary> | ||
4177 | </member> | ||
4178 | <member name="F:Npgsql.NpgsqlDataReader.KeyLookup.primaryKey"> | ||
4179 | <summary> | ||
4180 | Contains the column names as the keys | ||
4181 | </summary> | ||
4182 | </member> | ||
4183 | <member name="F:Npgsql.NpgsqlDataReader.KeyLookup.uniqueColumns"> | ||
4184 | <summary> | ||
4185 | Contains all unique columns | ||
4186 | </summary> | ||
4187 | </member> | ||
4188 | <member name="T:Npgsql.ForwardsOnlyDataReader"> | ||
4189 | <summary> | ||
4190 | This is the primary implementation of NpgsqlDataReader. It is the one used in normal cases (where the | ||
4191 | preload-reader option is not set in the connection string to resolve some potential backwards-compatibility | ||
4192 | issues), the only implementation used internally, and in cases where CachingDataReader is used, it is still | ||
4193 | used to do the actual "leg-work" of turning a response stream from the server into a datareader-style | ||
4194 | object - with CachingDataReader then filling it's cache from here. | ||
4195 | </summary> | ||
4196 | </member> | ||
4197 | <member name="M:Npgsql.ForwardsOnlyDataReader.GetNextResponseObject(System.Boolean)"> | ||
4198 | <summary> | ||
4199 | Iterate through the objects returned through from the server. | ||
4200 | If it's a CompletedResponse the rowsaffected count is updated appropriately, | ||
4201 | and we iterate again, otherwise we return it (perhaps updating our cache of pending | ||
4202 | rows if appropriate). | ||
4203 | </summary> | ||
4204 | <returns>The next <see cref="T:Npgsql.IServerResponseObject"/> we will deal with.</returns> | ||
4205 | </member> | ||
4206 | <member name="M:Npgsql.ForwardsOnlyDataReader.GetNextRowDescription"> | ||
4207 | <summary> | ||
4208 | Advances the data reader to the next result, when multiple result sets were returned by the PostgreSQL backend. | ||
4209 | </summary> | ||
4210 | <returns>True if the reader was advanced, otherwise false.</returns> | ||
4211 | </member> | ||
4212 | <member name="M:Npgsql.ForwardsOnlyDataReader.Dispose(System.Boolean)"> | ||
4213 | <summary> | ||
4214 | Releases the resources used by the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>. | ||
4215 | </summary> | ||
4216 | </member> | ||
4217 | <member name="M:Npgsql.ForwardsOnlyDataReader.Close"> | ||
4218 | <summary> | ||
4219 | Closes the data reader object. | ||
4220 | </summary> | ||
4221 | </member> | ||
4222 | <member name="M:Npgsql.ForwardsOnlyDataReader.NextResult"> | ||
4223 | <summary> | ||
4224 | Advances the data reader to the next result, when multiple result sets were returned by the PostgreSQL backend. | ||
4225 | </summary> | ||
4226 | <returns>True if the reader was advanced, otherwise false.</returns> | ||
4227 | </member> | ||
4228 | <member name="M:Npgsql.ForwardsOnlyDataReader.Read"> | ||
4229 | <summary> | ||
4230 | Advances the data reader to the next row. | ||
4231 | </summary> | ||
4232 | <returns>True if the reader was advanced, otherwise false.</returns> | ||
4233 | </member> | ||
4234 | <member name="M:Npgsql.ForwardsOnlyDataReader.GetValue(System.Int32)"> | ||
4235 | <summary> | ||
4236 | Return the value of the column at index <param name="Index"></param>. | ||
4237 | </summary> | ||
4238 | </member> | ||
4239 | <member name="M:Npgsql.ForwardsOnlyDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"> | ||
4240 | <summary> | ||
4241 | Gets raw data from a column. | ||
4242 | </summary> | ||
4243 | </member> | ||
4244 | <member name="M:Npgsql.ForwardsOnlyDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"> | ||
4245 | <summary> | ||
4246 | Gets raw data from a column. | ||
4247 | </summary> | ||
4248 | </member> | ||
4249 | <member name="M:Npgsql.ForwardsOnlyDataReader.IsDBNull(System.Int32)"> | ||
4250 | <summary> | ||
4251 | Report whether the value in a column is DBNull. | ||
4252 | </summary> | ||
4253 | </member> | ||
4254 | <member name="P:Npgsql.ForwardsOnlyDataReader.RecordsAffected"> | ||
4255 | <summary> | ||
4256 | Gets the number of rows changed, inserted, or deleted by execution of the SQL statement. | ||
4257 | </summary> | ||
4258 | </member> | ||
4259 | <member name="P:Npgsql.ForwardsOnlyDataReader.HasRows"> | ||
4260 | <summary> | ||
4261 | Indicates if NpgsqlDatareader has rows to be read. | ||
4262 | </summary> | ||
4263 | </member> | ||
4264 | <member name="T:Npgsql.CachingDataReader"> | ||
4265 | <summary> | ||
4266 | <para>Provides an implementation of NpgsqlDataReader in which all data is pre-loaded into memory. | ||
4267 | This operates by first creating a ForwardsOnlyDataReader as usual, and then loading all of it's | ||
4268 | Rows into memory. There is a general principle that when there is a trade-off between a class design that | ||
4269 | is more efficient and/or scalable on the one hand and one that is less efficient but has more functionality | ||
4270 | (in this case the internal-only functionality of caching results) that one can build the less efficent class | ||
4271 | from the most efficient without significant extra loss in efficiency, but not the other way around. The relationship | ||
4272 | between ForwardsOnlyDataReader and CachingDataReader is an example of this).</para> | ||
4273 | <para>Since the interface presented to the user is still forwards-only, queues are used to | ||
4274 | store this information, so that dequeueing as we go we give the garbage collector the best opportunity | ||
4275 | possible to reclaim any memory that is no longer in use.</para> | ||
4276 | <para>ForwardsOnlyDataReader being used to actually | ||
4277 | obtain the information from the server means that the "leg-work" is still only done (and need only be | ||
4278 | maintained) in one place.</para> | ||
4279 | <para>This class exists to allow for certain potential backwards-compatibility issues to be resolved | ||
4280 | with little effort on the part of affected users. It is considerably less efficient than ForwardsOnlyDataReader | ||
4281 | and hence never used internally.</para> | ||
4282 | </summary> | ||
4283 | </member> | ||
4284 | <member name="T:Npgsql.NpgsqlDescribe"> | ||
4285 | <summary> | ||
4286 | This is the base class for NpgsqlDescribeStatement and NpgsqlDescribePortal. | ||
4287 | </summary> | ||
4288 | |||
4289 | </member> | ||
4290 | <member name="T:Npgsql.NpgsqlDescribeStatement"> | ||
4291 | <summary> | ||
4292 | This class represents the Statement Describe message sent to PostgreSQL | ||
4293 | server. | ||
4294 | </summary> | ||
4295 | |||
4296 | </member> | ||
4297 | <member name="T:Npgsql.NpgsqlDescribePortal"> | ||
4298 | <summary> | ||
4299 | This class represents the Portal Describe message sent to PostgreSQL | ||
4300 | server. | ||
4301 | </summary> | ||
4302 | |||
4303 | </member> | ||
4304 | <member name="T:Npgsql.NpgsqlNoticeEventArgs"> | ||
4305 | <summary> | ||
4306 | EventArgs class to send Notice parameters, which are just NpgsqlError's in a lighter context. | ||
4307 | </summary> | ||
4308 | </member> | ||
4309 | <member name="F:Npgsql.NpgsqlNoticeEventArgs.Notice"> | ||
4310 | <summary> | ||
4311 | Notice information. | ||
4312 | </summary> | ||
4313 | </member> | ||
4314 | <member name="T:Npgsql.NpgsqlError"> | ||
4315 | <summary> | ||
4316 | This class represents the ErrorResponse and NoticeResponse | ||
4317 | message sent from PostgreSQL server. | ||
4318 | </summary> | ||
4319 | </member> | ||
4320 | <member name="M:Npgsql.NpgsqlError.ToString"> | ||
4321 | <summary> | ||
4322 | Return a string representation of this error object. | ||
4323 | </summary> | ||
4324 | </member> | ||
4325 | <member name="P:Npgsql.NpgsqlError.Severity"> | ||
4326 | <summary> | ||
4327 | Severity code. All versions. | ||
4328 | </summary> | ||
4329 | </member> | ||
4330 | <member name="P:Npgsql.NpgsqlError.Code"> | ||
4331 | <summary> | ||
4332 | Error code. PostgreSQL 7.4 and up. | ||
4333 | </summary> | ||
4334 | </member> | ||
4335 | <member name="P:Npgsql.NpgsqlError.Message"> | ||
4336 | <summary> | ||
4337 | Terse error message. All versions. | ||
4338 | </summary> | ||
4339 | </member> | ||
4340 | <member name="P:Npgsql.NpgsqlError.Detail"> | ||
4341 | <summary> | ||
4342 | Detailed error message. PostgreSQL 7.4 and up. | ||
4343 | </summary> | ||
4344 | </member> | ||
4345 | <member name="P:Npgsql.NpgsqlError.Hint"> | ||
4346 | <summary> | ||
4347 | Suggestion to help resolve the error. PostgreSQL 7.4 and up. | ||
4348 | </summary> | ||
4349 | </member> | ||
4350 | <member name="P:Npgsql.NpgsqlError.Position"> | ||
4351 | <summary> | ||
4352 | Position (one based) within the query string where the error was encounterd. PostgreSQL 7.4 and up. | ||
4353 | </summary> | ||
4354 | </member> | ||
4355 | <member name="P:Npgsql.NpgsqlError.InternalPosition"> | ||
4356 | <summary> | ||
4357 | 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. | ||
4358 | </summary> | ||
4359 | </member> | ||
4360 | <member name="P:Npgsql.NpgsqlError.InternalQuery"> | ||
4361 | <summary> | ||
4362 | 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. | ||
4363 | </summary> | ||
4364 | </member> | ||
4365 | <member name="P:Npgsql.NpgsqlError.Where"> | ||
4366 | <summary> | ||
4367 | Trace back information. PostgreSQL 7.4 and up. | ||
4368 | </summary> | ||
4369 | </member> | ||
4370 | <member name="P:Npgsql.NpgsqlError.File"> | ||
4371 | <summary> | ||
4372 | Source file (in backend) reporting the error. PostgreSQL 7.4 and up. | ||
4373 | </summary> | ||
4374 | </member> | ||
4375 | <member name="P:Npgsql.NpgsqlError.Line"> | ||
4376 | <summary> | ||
4377 | Source file line number (in backend) reporting the error. PostgreSQL 7.4 and up. | ||
4378 | </summary> | ||
4379 | </member> | ||
4380 | <member name="P:Npgsql.NpgsqlError.Routine"> | ||
4381 | <summary> | ||
4382 | Source routine (in backend) reporting the error. PostgreSQL 7.4 and up. | ||
4383 | </summary> | ||
4384 | </member> | ||
4385 | <member name="P:Npgsql.NpgsqlError.SchemaName"> | ||
4386 | <summary> | ||
4387 | Schema name which relates to the error. PostgreSQL 9.3 and up. | ||
4388 | </summary> | ||
4389 | </member> | ||
4390 | <member name="P:Npgsql.NpgsqlError.TableName"> | ||
4391 | <summary> | ||
4392 | Table name which relates to the error. PostgreSQL 9.3 and up. | ||
4393 | </summary> | ||
4394 | </member> | ||
4395 | <member name="P:Npgsql.NpgsqlError.ColumnName"> | ||
4396 | <summary> | ||
4397 | Column name which relates to the error. PostgreSQL 9.3 and up. | ||
4398 | </summary> | ||
4399 | </member> | ||
4400 | <member name="P:Npgsql.NpgsqlError.DataTypeName"> | ||
4401 | <summary> | ||
4402 | Data type of column which relates to the error. PostgreSQL 9.3 and up. | ||
4403 | </summary> | ||
4404 | </member> | ||
4405 | <member name="P:Npgsql.NpgsqlError.ConstraintName"> | ||
4406 | <summary> | ||
4407 | Constraint name which relates to the error. PostgreSQL 9.3 and up. | ||
4408 | </summary> | ||
4409 | </member> | ||
4410 | <member name="P:Npgsql.NpgsqlError.ErrorSql"> | ||
4411 | <summary> | ||
4412 | String containing the sql sent which produced this error. | ||
4413 | </summary> | ||
4414 | </member> | ||
4415 | <member name="P:Npgsql.NpgsqlError.BackendProtocolVersion"> | ||
4416 | <summary> | ||
4417 | Backend protocol version in use. | ||
4418 | </summary> | ||
4419 | </member> | ||
4420 | <member name="T:Npgsql.NpgsqlError.ErrorFieldTypeCodes"> | ||
4421 | <summary> | ||
4422 | Error and notice message field codes | ||
4423 | </summary> | ||
4424 | </member> | ||
4425 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.Severity"> | ||
4426 | <summary> | ||
4427 | Severity: the field contents are ERROR, FATAL, or PANIC (in an error message), | ||
4428 | or WARNING, NOTICE, DEBUG, INFO, or LOG (in a notice message), or a localized | ||
4429 | translation of one of these. Always present. | ||
4430 | </summary> | ||
4431 | </member> | ||
4432 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.Code"> | ||
4433 | <summary> | ||
4434 | Code: the SQLSTATE code for the error (see Appendix A). Not localizable. Always present. | ||
4435 | </summary> | ||
4436 | </member> | ||
4437 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.Message"> | ||
4438 | <summary> | ||
4439 | Message: the primary human-readable error message. This should be accurate | ||
4440 | but terse (typically one line). Always present. | ||
4441 | </summary> | ||
4442 | </member> | ||
4443 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.Detail"> | ||
4444 | <summary> | ||
4445 | Detail: an optional secondary error message carrying more detail about the problem. | ||
4446 | Might run to multiple lines. | ||
4447 | </summary> | ||
4448 | </member> | ||
4449 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.Hint"> | ||
4450 | <summary> | ||
4451 | Hint: an optional suggestion what to do about the problem. This is intended to differ | ||
4452 | from Detail in that it offers advice (potentially inappropriate) rather than hard facts. | ||
4453 | Might run to multiple lines. | ||
4454 | </summary> | ||
4455 | </member> | ||
4456 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.Position"> | ||
4457 | <summary> | ||
4458 | Position: the field value is a decimal ASCII integer, indicating an error cursor | ||
4459 | position as an index into the original query string. The first character has index 1, | ||
4460 | and positions are measured in characters not bytes. | ||
4461 | </summary> | ||
4462 | </member> | ||
4463 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.InternalPosition"> | ||
4464 | <summary> | ||
4465 | Internal position: this is defined the same as the P field, but it is used when the | ||
4466 | cursor position refers to an internally generated command rather than the one submitted | ||
4467 | by the client. | ||
4468 | The q field will always appear when this field appears. | ||
4469 | </summary> | ||
4470 | </member> | ||
4471 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.InternalQuery"> | ||
4472 | <summary> | ||
4473 | Internal query: the text of a failed internally-generated command. | ||
4474 | This could be, for example, a SQL query issued by a PL/pgSQL function. | ||
4475 | </summary> | ||
4476 | </member> | ||
4477 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.Where"> | ||
4478 | <summary> | ||
4479 | Where: an indication of the context in which the error occurred. | ||
4480 | Presently this includes a call stack traceback of active procedural language functions | ||
4481 | and internally-generated queries. The trace is one entry per line, most recent first. | ||
4482 | </summary> | ||
4483 | </member> | ||
4484 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.SchemaName"> | ||
4485 | <summary> | ||
4486 | Schema name: if the error was associated with a specific database object, | ||
4487 | the name of the schema containing that object, if any. | ||
4488 | </summary> | ||
4489 | </member> | ||
4490 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.TableName"> | ||
4491 | <summary> | ||
4492 | Table name: if the error was associated with a specific table, the name of the table. | ||
4493 | (Refer to the schema name field for the name of the table's schema.) | ||
4494 | </summary> | ||
4495 | </member> | ||
4496 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.ColumnName"> | ||
4497 | <summary> | ||
4498 | Column name: if the error was associated with a specific table column, the name of the column. | ||
4499 | (Refer to the schema and table name fields to identify the table.) | ||
4500 | </summary> | ||
4501 | </member> | ||
4502 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.DataTypeName"> | ||
4503 | <summary> | ||
4504 | Data type name: if the error was associated with a specific data type, the name of the data type. | ||
4505 | (Refer to the schema name field for the name of the data type's schema.) | ||
4506 | </summary> | ||
4507 | </member> | ||
4508 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.ConstraintName"> | ||
4509 | <summary> | ||
4510 | Constraint name: if the error was associated with a specific constraint, the name of the constraint. | ||
4511 | Refer to fields listed above for the associated table or domain. | ||
4512 | (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.) | ||
4513 | </summary> | ||
4514 | </member> | ||
4515 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.File"> | ||
4516 | <summary> | ||
4517 | File: the file name of the source-code location where the error was reported. | ||
4518 | </summary> | ||
4519 | </member> | ||
4520 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.Line"> | ||
4521 | <summary> | ||
4522 | Line: the line number of the source-code location where the error was reported. | ||
4523 | </summary> | ||
4524 | </member> | ||
4525 | <member name="F:Npgsql.NpgsqlError.ErrorFieldTypeCodes.Routine"> | ||
4526 | <summary> | ||
4527 | Routine: the name of the source-code routine reporting the error. | ||
4528 | </summary> | ||
4529 | </member> | ||
4530 | <member name="T:Npgsql.LogLevel"> | ||
4531 | <summary> | ||
4532 | The level of verbosity of the NpgsqlEventLog | ||
4533 | </summary> | ||
4534 | </member> | ||
4535 | <member name="F:Npgsql.LogLevel.None"> | ||
4536 | <summary> | ||
4537 | Don't log at all | ||
4538 | </summary> | ||
4539 | </member> | ||
4540 | <member name="F:Npgsql.LogLevel.Normal"> | ||
4541 | <summary> | ||
4542 | Only log the most common issues | ||
4543 | </summary> | ||
4544 | </member> | ||
4545 | <member name="F:Npgsql.LogLevel.Debug"> | ||
4546 | <summary> | ||
4547 | Log everything | ||
4548 | </summary> | ||
4549 | </member> | ||
4550 | <member name="T:Npgsql.NpgsqlEventLog"> | ||
4551 | <summary> | ||
4552 | This class handles all the Npgsql event and debug logging | ||
4553 | </summary> | ||
4554 | </member> | ||
4555 | <member name="M:Npgsql.NpgsqlEventLog.LogMsg(System.String,Npgsql.LogLevel)"> | ||
4556 | <summary> | ||
4557 | Writes a string to the Npgsql event log if msglevel is bigger then <see cref="P:Npgsql.NpgsqlEventLog.Level">NpgsqlEventLog.Level</see> | ||
4558 | </summary> | ||
4559 | <remarks> | ||
4560 | This method is obsolete and should no longer be used. | ||
4561 | It is likely to be removed in future versions of Npgsql | ||
4562 | </remarks> | ||
4563 | <param name="message">The message to write to the event log</param> | ||
4564 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4565 | </member> | ||
4566 | <member name="M:Npgsql.NpgsqlEventLog.LogMsg(System.Resources.ResourceManager,System.String,Npgsql.LogLevel,System.Object[])"> | ||
4567 | <summary> | ||
4568 | Writes a string to the Npgsql event log if msglevel is bigger then <see cref="P:Npgsql.NpgsqlEventLog.Level">NpgsqlEventLog.Level</see> | ||
4569 | </summary> | ||
4570 | <param name="resman">The <see cref="T:System.Resources.ResourceManager">ResourceManager</see> to get the localized resources</param> | ||
4571 | <param name="ResourceString">The name of the resource that should be fetched by the <see cref="T:System.Resources.ResourceManager">ResourceManager</see></param> | ||
4572 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4573 | <param name="Parameters">The additional parameters that shall be included into the log-message (must be compatible with the string in the resource):</param> | ||
4574 | </member> | ||
4575 | <member name="M:Npgsql.NpgsqlEventLog.LogIndexerGet(Npgsql.LogLevel,System.String,System.Object)"> | ||
4576 | <summary> | ||
4577 | Writes the default log-message for the action of calling the Get-part of an Indexer to the log file. | ||
4578 | </summary> | ||
4579 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4580 | <param name="ClassName">The name of the class that contains the Indexer</param> | ||
4581 | <param name="IndexerParam">The parameter given to the Indexer</param> | ||
4582 | </member> | ||
4583 | <member name="M:Npgsql.NpgsqlEventLog.LogIndexerSet(Npgsql.LogLevel,System.String,System.Object,System.Object)"> | ||
4584 | <summary> | ||
4585 | Writes the default log-message for the action of calling the Set-part of an Indexer to the logfile. | ||
4586 | </summary> | ||
4587 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4588 | <param name="ClassName">The name of the class that contains the Indexer</param> | ||
4589 | <param name="IndexerParam">The parameter given to the Indexer</param> | ||
4590 | <param name="value">The value the Indexer is set to</param> | ||
4591 | </member> | ||
4592 | <member name="M:Npgsql.NpgsqlEventLog.LogPropertyGet(Npgsql.LogLevel,System.String,System.String)"> | ||
4593 | <summary> | ||
4594 | Writes the default log-message for the action of calling the Get-part of a Property to the logfile. | ||
4595 | </summary> | ||
4596 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4597 | <param name="ClassName">The name of the class that contains the Property</param> | ||
4598 | <param name="PropertyName">The name of the Property</param> | ||
4599 | </member> | ||
4600 | <member name="M:Npgsql.NpgsqlEventLog.LogPropertySet(Npgsql.LogLevel,System.String,System.String,System.Object)"> | ||
4601 | <summary> | ||
4602 | Writes the default log-message for the action of calling the Set-part of a Property to the logfile. | ||
4603 | </summary> | ||
4604 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4605 | <param name="ClassName">The name of the class that contains the Property</param> | ||
4606 | <param name="PropertyName">The name of the Property</param> | ||
4607 | <param name="value">The value the Property is set to</param> | ||
4608 | </member> | ||
4609 | <member name="M:Npgsql.NpgsqlEventLog.LogMethodEnter(Npgsql.LogLevel,System.String,System.String)"> | ||
4610 | <summary> | ||
4611 | Writes the default log-message for the action of calling a Method without Arguments to the logfile. | ||
4612 | </summary> | ||
4613 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4614 | <param name="ClassName">The name of the class that contains the Method</param> | ||
4615 | <param name="MethodName">The name of the Method</param> | ||
4616 | </member> | ||
4617 | <member name="M:Npgsql.NpgsqlEventLog.LogMethodEnter(Npgsql.LogLevel,System.String,System.String,System.Object)"> | ||
4618 | <summary> | ||
4619 | Writes the default log-message for the action of calling a Method with one Argument to the logfile. | ||
4620 | </summary> | ||
4621 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4622 | <param name="ClassName">The name of the class that contains the Method</param> | ||
4623 | <param name="MethodName">The name of the Method</param> | ||
4624 | <param name="MethodParameter">The value of the Argument of the Method</param> | ||
4625 | </member> | ||
4626 | <member name="M:Npgsql.NpgsqlEventLog.LogMethodEnter(Npgsql.LogLevel,System.String,System.String,System.Object,System.Object)"> | ||
4627 | <summary> | ||
4628 | Writes the default log-message for the action of calling a Method with two Arguments to the logfile. | ||
4629 | </summary> | ||
4630 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4631 | <param name="ClassName">The name of the class that contains the Method</param> | ||
4632 | <param name="MethodName">The name of the Method</param> | ||
4633 | <param name="MethodParameter1">The value of the first Argument of the Method</param> | ||
4634 | <param name="MethodParameter2">The value of the second Argument of the Method</param> | ||
4635 | </member> | ||
4636 | <member name="M:Npgsql.NpgsqlEventLog.LogMethodEnter(Npgsql.LogLevel,System.String,System.String,System.Object,System.Object,System.Object)"> | ||
4637 | <summary> | ||
4638 | Writes the default log-message for the action of calling a Method with three Arguments to the logfile. | ||
4639 | </summary> | ||
4640 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4641 | <param name="ClassName">The name of the class that contains the Method</param> | ||
4642 | <param name="MethodName">The name of the Method</param> | ||
4643 | <param name="MethodParameter1">The value of the first Argument of the Method</param> | ||
4644 | <param name="MethodParameter2">The value of the second Argument of the Method</param> | ||
4645 | <param name="MethodParameter3">The value of the third Argument of the Method</param> | ||
4646 | </member> | ||
4647 | <member name="M:Npgsql.NpgsqlEventLog.LogMethodEnter(Npgsql.LogLevel,System.String,System.String,System.Object[])"> | ||
4648 | <summary> | ||
4649 | Writes the default log-message for the action of calling a Method with more than three Arguments to the logfile. | ||
4650 | </summary> | ||
4651 | <param name="msglevel">The minimum <see cref="T:Npgsql.LogLevel">LogLevel</see> for which this message should be logged.</param> | ||
4652 | <param name="ClassName">The name of the class that contains the Method</param> | ||
4653 | <param name="MethodName">The name of the Method</param> | ||
4654 | <param name="MethodParameters">A <see cref="T:System.Object">Object</see>-Array with zero or more Ojects that are Arguments of the Method.</param> | ||
4655 | </member> | ||
4656 | <member name="P:Npgsql.NpgsqlEventLog.Level"> | ||
4657 | <summary> | ||
4658 | Sets/Returns the level of information to log to the logfile. | ||
4659 | </summary> | ||
4660 | <value>The current <see cref="T:Npgsql.LogLevel">LogLevel</see></value> | ||
4661 | </member> | ||
4662 | <member name="P:Npgsql.NpgsqlEventLog.LogName"> | ||
4663 | <summary> | ||
4664 | Sets/Returns the filename to use for logging. | ||
4665 | </summary> | ||
4666 | <value>The filename of the current Log file.</value> | ||
4667 | </member> | ||
4668 | <member name="P:Npgsql.NpgsqlEventLog.EchoMessages"> | ||
4669 | <summary> | ||
4670 | Sets/Returns whether Log messages should be echoed to the console | ||
4671 | </summary> | ||
4672 | <value><b>true</b> if Log messages are echoed to the console, otherwise <b>false</b></value> | ||
4673 | </member> | ||
4674 | <member name="T:Npgsql.NpgsqlException"> | ||
4675 | <summary> | ||
4676 | The exception that is thrown when the PostgreSQL backend reports errors. | ||
4677 | </summary> | ||
4678 | </member> | ||
4679 | <member name="M:Npgsql.NpgsqlException.#ctor(System.Collections.IList)"> | ||
4680 | <summary> | ||
4681 | Construct a backend error exception based on a list of one or more | ||
4682 | backend errors. The basic Exception.Message will be built from the | ||
4683 | first (usually the only) error in the list. | ||
4684 | </summary> | ||
4685 | </member> | ||
4686 | <member name="M:Npgsql.NpgsqlException.ToString"> | ||
4687 | <summary> | ||
4688 | Format a .NET style exception string. | ||
4689 | Include all errors in the list, including any hints. | ||
4690 | </summary> | ||
4691 | </member> | ||
4692 | <member name="M:Npgsql.NpgsqlException.AppendString(System.IO.StringWriter,System.String,System.String)"> | ||
4693 | <summary> | ||
4694 | Append a line to the given Stream, first checking for zero-length. | ||
4695 | </summary> | ||
4696 | </member> | ||
4697 | <member name="P:Npgsql.NpgsqlException.Item(System.Int32)"> | ||
4698 | <summary> | ||
4699 | Provide access to the entire list of errors provided by the PostgreSQL backend. | ||
4700 | </summary> | ||
4701 | </member> | ||
4702 | <member name="P:Npgsql.NpgsqlException.Severity"> | ||
4703 | <summary> | ||
4704 | Severity code. All versions. | ||
4705 | </summary> | ||
4706 | </member> | ||
4707 | <member name="P:Npgsql.NpgsqlException.Code"> | ||
4708 | <summary> | ||
4709 | Error code. PostgreSQL 7.4 and up. | ||
4710 | </summary> | ||
4711 | </member> | ||
4712 | <member name="P:Npgsql.NpgsqlException.BaseMessage"> | ||
4713 | <summary> | ||
4714 | Basic error message. All versions. | ||
4715 | </summary> | ||
4716 | </member> | ||
4717 | <member name="P:Npgsql.NpgsqlException.Detail"> | ||
4718 | <summary> | ||
4719 | Detailed error message. PostgreSQL 7.4 and up. | ||
4720 | </summary> | ||
4721 | </member> | ||
4722 | <member name="P:Npgsql.NpgsqlException.Hint"> | ||
4723 | <summary> | ||
4724 | Suggestion to help resolve the error. PostgreSQL 7.4 and up. | ||
4725 | </summary> | ||
4726 | </member> | ||
4727 | <member name="P:Npgsql.NpgsqlException.Position"> | ||
4728 | <summary> | ||
4729 | Position (one based) within the query string where the error was encounterd. PostgreSQL 7.4 and up. | ||
4730 | </summary> | ||
4731 | </member> | ||
4732 | <member name="P:Npgsql.NpgsqlException.Where"> | ||
4733 | <summary> | ||
4734 | Trace back information. PostgreSQL 7.4 and up. | ||
4735 | </summary> | ||
4736 | </member> | ||
4737 | <member name="P:Npgsql.NpgsqlException.File"> | ||
4738 | <summary> | ||
4739 | Source file (in backend) reporting the error. PostgreSQL 7.4 and up. | ||
4740 | </summary> | ||
4741 | </member> | ||
4742 | <member name="P:Npgsql.NpgsqlException.Line"> | ||
4743 | <summary> | ||
4744 | Source file line number (in backend) reporting the error. PostgreSQL 7.4 and up. | ||
4745 | </summary> | ||
4746 | </member> | ||
4747 | <member name="P:Npgsql.NpgsqlException.Routine"> | ||
4748 | <summary> | ||
4749 | Source routine (in backend) reporting the error. PostgreSQL 7.4 and up. | ||
4750 | </summary> | ||
4751 | </member> | ||
4752 | <member name="P:Npgsql.NpgsqlException.SchemaName"> | ||
4753 | <summary> | ||
4754 | Schema name which relates to the error. PostgreSQL 9.3 and up. | ||
4755 | </summary> | ||
4756 | </member> | ||
4757 | <member name="P:Npgsql.NpgsqlException.TableName"> | ||
4758 | <summary> | ||
4759 | Table name which relates to the error. PostgreSQL 9.3 and up. | ||
4760 | </summary> | ||
4761 | </member> | ||
4762 | <member name="P:Npgsql.NpgsqlException.ColumnName"> | ||
4763 | <summary> | ||
4764 | Column name which relates to the error. PostgreSQL 9.3 and up. | ||
4765 | </summary> | ||
4766 | </member> | ||
4767 | <member name="P:Npgsql.NpgsqlException.DataTypeName"> | ||
4768 | <summary> | ||
4769 | Data type of column which relates to the error. PostgreSQL 9.3 and up. | ||
4770 | </summary> | ||
4771 | </member> | ||
4772 | <member name="P:Npgsql.NpgsqlException.ConstraintName"> | ||
4773 | <summary> | ||
4774 | Constraint name which relates to the error. PostgreSQL 9.3 and up. | ||
4775 | </summary> | ||
4776 | </member> | ||
4777 | <member name="P:Npgsql.NpgsqlException.ErrorSql"> | ||
4778 | <summary> | ||
4779 | String containing the sql sent which produced this error. | ||
4780 | </summary> | ||
4781 | </member> | ||
4782 | <member name="P:Npgsql.NpgsqlException.Errors"> | ||
4783 | <summary> | ||
4784 | Returns the entire list of errors provided by the PostgreSQL backend. | ||
4785 | </summary> | ||
4786 | </member> | ||
4787 | <member name="T:Npgsql.NpgsqlExecute"> | ||
4788 | <summary> | ||
4789 | This class represents the Execute message sent to PostgreSQL | ||
4790 | server. | ||
4791 | </summary> | ||
4792 | |||
4793 | </member> | ||
4794 | <member name="T:Npgsql.NpgsqlFactory"> | ||
4795 | <summary> | ||
4796 | A factory to create instances of various Npgsql objects. | ||
4797 | </summary> | ||
4798 | </member> | ||
4799 | <member name="M:Npgsql.NpgsqlFactory.CreateCommand"> | ||
4800 | <summary> | ||
4801 | Creates an NpgsqlCommand object. | ||
4802 | </summary> | ||
4803 | </member> | ||
4804 | <member name="T:Npgsql.NpgsqlFlush"> | ||
4805 | <summary> | ||
4806 | This class represents the Flush message sent to PostgreSQL | ||
4807 | server. | ||
4808 | </summary> | ||
4809 | |||
4810 | </member> | ||
4811 | <member name="T:Npgsql.SimpleClientMessage"> | ||
4812 | <summary> | ||
4813 | For classes representing simple messages, | ||
4814 | consisting only of a message code and length identifier, | ||
4815 | sent from the client to the server. | ||
4816 | </summary> | ||
4817 | </member> | ||
4818 | <member name="T:Npgsql.NpgsqlMediator"> | ||
4819 | <summary> | ||
4820 | This class is responsible for serving as bridge between the backend | ||
4821 | protocol handling and the core classes. It is used as the mediator for | ||
4822 | exchanging data generated/sent from/to backend. | ||
4823 | </summary> | ||
4824 | |||
4825 | </member> | ||
4826 | <member name="T:Npgsql.NpgsqlNotificationEventArgs"> | ||
4827 | <summary> | ||
4828 | EventArgs class to send Notification parameters. | ||
4829 | </summary> | ||
4830 | </member> | ||
4831 | <member name="F:Npgsql.NpgsqlNotificationEventArgs.PID"> | ||
4832 | <summary> | ||
4833 | Process ID of the PostgreSQL backend that sent this notification. | ||
4834 | </summary> | ||
4835 | </member> | ||
4836 | <member name="F:Npgsql.NpgsqlNotificationEventArgs.Condition"> | ||
4837 | <summary> | ||
4838 | Condition that triggered that notification. | ||
4839 | </summary> | ||
4840 | </member> | ||
4841 | <member name="F:Npgsql.NpgsqlNotificationEventArgs.AdditionalInformation"> | ||
4842 | <summary> | ||
4843 | Additional Information From Notifiying Process (for future use, currently postgres always sets this to an empty string) | ||
4844 | </summary> | ||
4845 | </member> | ||
4846 | <member name="T:Npgsql.NpgsqlParameter"> | ||
4847 | <summary> | ||
4848 | This class represents a parameter to a command that will be sent to server | ||
4849 | </summary> | ||
4850 | </member> | ||
4851 | <member name="M:Npgsql.NpgsqlParameter.#ctor"> | ||
4852 | <summary> | ||
4853 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> class. | ||
4854 | </summary> | ||
4855 | </member> | ||
4856 | <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Object)"> | ||
4857 | <summary> | ||
4858 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> | ||
4859 | class with the parameter m_Name and a value of the new <b>NpgsqlParameter</b>. | ||
4860 | </summary> | ||
4861 | <param m_Name="parameterName">The m_Name of the parameter to map.</param> | ||
4862 | <param m_Name="value">An <see cref="T:System.Object">Object</see> that is the value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param> | ||
4863 | <remarks> | ||
4864 | <p>When you specify an <see cref="T:System.Object">Object</see> | ||
4865 | in the value parameter, the <see cref="T:System.Data.DbType">DbType</see> is | ||
4866 | inferred from the .NET Framework type of the <b>Object</b>.</p> | ||
4867 | <p>When using this constructor, you must be aware of a possible misuse of the constructor which takes a DbType parameter. | ||
4868 | This happens when calling this constructor passing an int 0 and the compiler thinks you are passing a value of DbType. | ||
4869 | Use <code> Convert.ToInt32(value) </code> for example to have compiler calling the correct constructor.</p> | ||
4870 | </remarks> | ||
4871 | </member> | ||
4872 | <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType)"> | ||
4873 | <summary> | ||
4874 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> | ||
4875 | class with the parameter m_Name and the data type. | ||
4876 | </summary> | ||
4877 | <param m_Name="parameterName">The m_Name of the parameter to map.</param> | ||
4878 | <param m_Name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param> | ||
4879 | </member> | ||
4880 | <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32)"> | ||
4881 | <summary> | ||
4882 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> | ||
4883 | class with the parameter m_Name, the <see cref="T:System.Data.DbType">DbType</see>, and the size. | ||
4884 | </summary> | ||
4885 | <param m_Name="parameterName">The m_Name of the parameter to map.</param> | ||
4886 | <param m_Name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param> | ||
4887 | <param m_Name="size">The length of the parameter.</param> | ||
4888 | </member> | ||
4889 | <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String)"> | ||
4890 | <summary> | ||
4891 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> | ||
4892 | class with the parameter m_Name, the <see cref="T:System.Data.DbType">DbType</see>, the size, | ||
4893 | and the source column m_Name. | ||
4894 | </summary> | ||
4895 | <param m_Name="parameterName">The m_Name of the parameter to map.</param> | ||
4896 | <param m_Name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param> | ||
4897 | <param m_Name="size">The length of the parameter.</param> | ||
4898 | <param m_Name="sourceColumn">The m_Name of the source column.</param> | ||
4899 | </member> | ||
4900 | <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String,System.Data.ParameterDirection,System.Boolean,System.Byte,System.Byte,System.Data.DataRowVersion,System.Object)"> | ||
4901 | <summary> | ||
4902 | Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> | ||
4903 | class with the parameter m_Name, the <see cref="T:System.Data.DbType">DbType</see>, the size, | ||
4904 | the source column m_Name, a <see cref="T:System.Data.ParameterDirection">ParameterDirection</see>, | ||
4905 | the precision of the parameter, the scale of the parameter, a | ||
4906 | <see cref="T:System.Data.DataRowVersion">DataRowVersion</see> to use, and the | ||
4907 | value of the parameter. | ||
4908 | </summary> | ||
4909 | <param m_Name="parameterName">The m_Name of the parameter to map.</param> | ||
4910 | <param m_Name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param> | ||
4911 | <param m_Name="size">The length of the parameter.</param> | ||
4912 | <param m_Name="sourceColumn">The m_Name of the source column.</param> | ||
4913 | <param m_Name="direction">One of the <see cref="T:System.Data.ParameterDirection">ParameterDirection</see> values.</param> | ||
4914 | <param m_Name="isNullable"><b>true</b> if the value of the field can be null, otherwise <b>false</b>.</param> | ||
4915 | <param m_Name="precision">The total number of digits to the left and right of the decimal point to which | ||
4916 | <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved.</param> | ||
4917 | <param m_Name="scale">The total number of decimal places to which | ||
4918 | <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved.</param> | ||
4919 | <param m_Name="sourceVersion">One of the <see cref="T:System.Data.DataRowVersion">DataRowVersion</see> values.</param> | ||
4920 | <param m_Name="value">An <see cref="T:System.Object">Object</see> that is the value | ||
4921 | of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param> | ||
4922 | </member> | ||
4923 | <member name="M:Npgsql.NpgsqlParameter.Clone"> | ||
4924 | <summary> | ||
4925 | Creates a new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> that | ||
4926 | is a copy of the current instance. | ||
4927 | </summary> | ||
4928 | <returns>A new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> that is a copy of this instance.</returns> | ||
4929 | </member> | ||
4930 | <member name="P:Npgsql.NpgsqlParameter.Collection"> | ||
4931 | <summary> | ||
4932 | The collection to which this parameter belongs, if any. | ||
4933 | </summary> | ||
4934 | </member> | ||
4935 | <member name="P:Npgsql.NpgsqlParameter.Precision"> | ||
4936 | <summary> | ||
4937 | Gets or sets the maximum number of digits used to represent the | ||
4938 | <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> property. | ||
4939 | </summary> | ||
4940 | <value>The maximum number of digits used to represent the | ||
4941 | <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> property. | ||
4942 | The default value is 0, which indicates that the data provider | ||
4943 | sets the precision for <b>Value</b>.</value> | ||
4944 | </member> | ||
4945 | <member name="P:Npgsql.NpgsqlParameter.Scale"> | ||
4946 | <summary> | ||
4947 | Gets or sets the number of decimal places to which | ||
4948 | <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved. | ||
4949 | </summary> | ||
4950 | <value>The number of decimal places to which | ||
4951 | <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved. The default is 0.</value> | ||
4952 | </member> | ||
4953 | <member name="P:Npgsql.NpgsqlParameter.Size"> | ||
4954 | <summary> | ||
4955 | Gets or sets the maximum size, in bytes, of the data within the column. | ||
4956 | </summary> | ||
4957 | <value>The maximum size, in bytes, of the data within the column. | ||
4958 | The default value is inferred from the parameter value.</value> | ||
4959 | </member> | ||
4960 | <member name="P:Npgsql.NpgsqlParameter.DbType"> | ||
4961 | <summary> | ||
4962 | Gets or sets the <see cref="T:System.Data.DbType">DbType</see> of the parameter. | ||
4963 | </summary> | ||
4964 | <value>One of the <see cref="T:System.Data.DbType">DbType</see> values. The default is <b>String</b>.</value> | ||
4965 | </member> | ||
4966 | <member name="P:Npgsql.NpgsqlParameter.NpgsqlDbType"> | ||
4967 | <summary> | ||
4968 | Gets or sets the <see cref="T:System.Data.DbType">DbType</see> of the parameter. | ||
4969 | </summary> | ||
4970 | <value>One of the <see cref="T:System.Data.DbType">DbType</see> values. The default is <b>String</b>.</value> | ||
4971 | </member> | ||
4972 | <member name="P:Npgsql.NpgsqlParameter.Direction"> | ||
4973 | <summary> | ||
4974 | Gets or sets a value indicating whether the parameter is input-only, | ||
4975 | output-only, bidirectional, or a stored procedure return value parameter. | ||
4976 | </summary> | ||
4977 | <value>One of the <see cref="T:System.Data.ParameterDirection">ParameterDirection</see> | ||
4978 | values. The default is <b>Input</b>.</value> | ||
4979 | </member> | ||
4980 | <member name="P:Npgsql.NpgsqlParameter.IsNullable"> | ||
4981 | <summary> | ||
4982 | Gets or sets a value indicating whether the parameter accepts null values. | ||
4983 | </summary> | ||
4984 | <value><b>true</b> if null values are accepted; otherwise, <b>false</b>. The default is <b>false</b>.</value> | ||
4985 | </member> | ||
4986 | <member name="P:Npgsql.NpgsqlParameter.ParameterName"> | ||
4987 | <summary> | ||
4988 | Gets or sets the m_Name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>. | ||
4989 | </summary> | ||
4990 | <value>The m_Name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>. | ||
4991 | The default is an empty string.</value> | ||
4992 | </member> | ||
4993 | <member name="P:Npgsql.NpgsqlParameter.CleanName"> | ||
4994 | <summary> | ||
4995 | The m_Name scrubbed of any optional marker | ||
4996 | </summary> | ||
4997 | </member> | ||
4998 | <member name="P:Npgsql.NpgsqlParameter.SourceColumn"> | ||
4999 | <summary> | ||
5000 | Gets or sets the m_Name of the source column that is mapped to the | ||
5001 | <see cref="T:System.Data.DataSet">DataSet</see> and used for loading or | ||
5002 | returning the <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see>. | ||
5003 | </summary> | ||
5004 | <value>The m_Name of the source column that is mapped to the | ||
5005 | <see cref="T:System.Data.DataSet">DataSet</see>. The default is an empty string.</value> | ||
5006 | </member> | ||
5007 | <member name="P:Npgsql.NpgsqlParameter.SourceVersion"> | ||
5008 | <summary> | ||
5009 | Gets or sets the <see cref="T:System.Data.DataRowVersion">DataRowVersion</see> | ||
5010 | to use when loading <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see>. | ||
5011 | </summary> | ||
5012 | <value>One of the <see cref="T:System.Data.DataRowVersion">DataRowVersion</see> values. | ||
5013 | The default is <b>Current</b>.</value> | ||
5014 | </member> | ||
5015 | <member name="P:Npgsql.NpgsqlParameter.Value"> | ||
5016 | <summary> | ||
5017 | Gets or sets the value of the parameter. | ||
5018 | </summary> | ||
5019 | <value>An <see cref="T:System.Object">Object</see> that is the value of the parameter. | ||
5020 | The default value is null.</value> | ||
5021 | </member> | ||
5022 | <member name="P:Npgsql.NpgsqlParameter.NpgsqlValue"> | ||
5023 | <summary> | ||
5024 | Gets or sets the value of the parameter. | ||
5025 | </summary> | ||
5026 | <value>An <see cref="T:System.Object">Object</see> that is the value of the parameter. | ||
5027 | The default value is null.</value> | ||
5028 | </member> | ||
5029 | <member name="T:Npgsql.NpgsqlParameterCollection"> | ||
5030 | <summary> | ||
5031 | Represents a collection of parameters relevant to a <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> | ||
5032 | as well as their respective mappings to columns in a <see cref="T:System.Data.DataSet">DataSet</see>. | ||
5033 | This class cannot be inherited. | ||
5034 | </summary> | ||
5035 | </member> | ||
5036 | <member name="M:Npgsql.NpgsqlParameterCollection.#ctor"> | ||
5037 | <summary> | ||
5038 | Initializes a new instance of the NpgsqlParameterCollection class. | ||
5039 | </summary> | ||
5040 | </member> | ||
5041 | <member name="M:Npgsql.NpgsqlParameterCollection.InvalidateHashLookups"> | ||
5042 | <summary> | ||
5043 | Invalidate the hash lookup tables. This should be done any time a change | ||
5044 | may throw the lookups out of sync with the list. | ||
5045 | </summary> | ||
5046 | </member> | ||
5047 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(Npgsql.NpgsqlParameter)"> | ||
5048 | <summary> | ||
5049 | Adds the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see>. | ||
5050 | </summary> | ||
5051 | <param name="value">The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param> | ||
5052 | <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns> | ||
5053 | </member> | ||
5054 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,System.Object)"> | ||
5055 | <summary> | ||
5056 | Obsolete. Use AddWithValue instead. | ||
5057 | </summary> | ||
5058 | <remarks> | ||
5059 | Use caution when using this overload of the | ||
5060 | <b>Add</b> method to specify integer parameter values. | ||
5061 | Because this overload takes a <i>value</i> of type Object, | ||
5062 | you must convert the integral value to an <b>Object</b> | ||
5063 | type when the value is zero, as the following C# example demonstrates. | ||
5064 | <code>parameters.Add(":pname", Convert.ToInt32(0));</code> | ||
5065 | If you do not perform this conversion, the compiler will assume you | ||
5066 | are attempting to call the NpgsqlParameterCollection.Add(string, DbType) overload. | ||
5067 | </remarks> | ||
5068 | </member> | ||
5069 | <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,System.Object)"> | ||
5070 | <summary> | ||
5071 | Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the specified parameter name and value. | ||
5072 | </summary> | ||
5073 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param> | ||
5074 | <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param> | ||
5075 | <returns>The paramater that was added.</returns> | ||
5076 | </member> | ||
5077 | <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,NpgsqlTypes.NpgsqlDbType,System.Object)"> | ||
5078 | <summary> | ||
5079 | Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the specified parameter name and value. | ||
5080 | </summary> | ||
5081 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param> | ||
5082 | <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param> | ||
5083 | <param name="parameterType">One of the NpgsqlDbType values.</param> | ||
5084 | <returns>The paramater that was added.</returns> | ||
5085 | </member> | ||
5086 | <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.Object)"> | ||
5087 | <summary> | ||
5088 | Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the specified parameter name and value. | ||
5089 | </summary> | ||
5090 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param> | ||
5091 | <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param> | ||
5092 | <param name="parameterType">One of the NpgsqlDbType values.</param> | ||
5093 | <param name="size">The length of the column.</param> | ||
5094 | <returns>The paramater that was added.</returns> | ||
5095 | </member> | ||
5096 | <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String,System.Object)"> | ||
5097 | <summary> | ||
5098 | Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the specified parameter name and value. | ||
5099 | </summary> | ||
5100 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param> | ||
5101 | <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param> | ||
5102 | <param name="parameterType">One of the NpgsqlDbType values.</param> | ||
5103 | <param name="size">The length of the column.</param> | ||
5104 | <param name="sourceColumn">The name of the source column.</param> | ||
5105 | <returns>The paramater that was added.</returns> | ||
5106 | </member> | ||
5107 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType)"> | ||
5108 | <summary> | ||
5109 | Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the parameter name and the data type. | ||
5110 | </summary> | ||
5111 | <param name="parameterName">The name of the parameter.</param> | ||
5112 | <param name="parameterType">One of the DbType values.</param> | ||
5113 | <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns> | ||
5114 | </member> | ||
5115 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32)"> | ||
5116 | <summary> | ||
5117 | Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> with the parameter name, the data type, and the column length. | ||
5118 | </summary> | ||
5119 | <param name="parameterName">The name of the parameter.</param> | ||
5120 | <param name="parameterType">One of the DbType values.</param> | ||
5121 | <param name="size">The length of the column.</param> | ||
5122 | <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns> | ||
5123 | </member> | ||
5124 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String)"> | ||
5125 | <summary> | ||
5126 | Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> with the parameter name, the data type, the column length, and the source column name. | ||
5127 | </summary> | ||
5128 | <param name="parameterName">The name of the parameter.</param> | ||
5129 | <param name="parameterType">One of the DbType values.</param> | ||
5130 | <param name="size">The length of the column.</param> | ||
5131 | <param name="sourceColumn">The name of the source column.</param> | ||
5132 | <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns> | ||
5133 | </member> | ||
5134 | <member name="M:Npgsql.NpgsqlParameterCollection.RemoveAt(System.String)"> | ||
5135 | <summary> | ||
5136 | Removes the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> from the collection using the parameter name. | ||
5137 | </summary> | ||
5138 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to retrieve.</param> | ||
5139 | </member> | ||
5140 | <member name="M:Npgsql.NpgsqlParameterCollection.Contains(System.String)"> | ||
5141 | <summary> | ||
5142 | Gets a value indicating whether a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> with the specified parameter name exists in the collection. | ||
5143 | </summary> | ||
5144 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to find.</param> | ||
5145 | <returns><b>true</b> if the collection contains the parameter; otherwise, <b>false</b>.</returns> | ||
5146 | </member> | ||
5147 | <member name="M:Npgsql.NpgsqlParameterCollection.IndexOf(System.String)"> | ||
5148 | <summary> | ||
5149 | Gets the location of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> in the collection with a specific parameter name. | ||
5150 | </summary> | ||
5151 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to find.</param> | ||
5152 | <returns>The zero-based location of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> in the collection.</returns> | ||
5153 | </member> | ||
5154 | <member name="M:Npgsql.NpgsqlParameterCollection.RemoveAt(System.Int32)"> | ||
5155 | <summary> | ||
5156 | Removes the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> from the collection using a specific index. | ||
5157 | </summary> | ||
5158 | <param name="index">The zero-based index of the parameter.</param> | ||
5159 | </member> | ||
5160 | <member name="M:Npgsql.NpgsqlParameterCollection.Insert(System.Int32,System.Object)"> | ||
5161 | <summary> | ||
5162 | Inserts a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> into the collection at the specified index. | ||
5163 | </summary> | ||
5164 | <param name="index">The zero-based index where the parameter is to be inserted within the collection.</param> | ||
5165 | <param name="oValue">The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param> | ||
5166 | </member> | ||
5167 | <member name="M:Npgsql.NpgsqlParameterCollection.Remove(System.String)"> | ||
5168 | <summary> | ||
5169 | Removes the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> from the collection. | ||
5170 | </summary> | ||
5171 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to remove from the collection.</param> | ||
5172 | </member> | ||
5173 | <member name="M:Npgsql.NpgsqlParameterCollection.Remove(System.Object)"> | ||
5174 | <summary> | ||
5175 | Removes the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> from the collection. | ||
5176 | </summary> | ||
5177 | <param name="oValue">The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to remove from the collection.</param> | ||
5178 | </member> | ||
5179 | <member name="M:Npgsql.NpgsqlParameterCollection.Contains(System.Object)"> | ||
5180 | <summary> | ||
5181 | Gets a value indicating whether a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> exists in the collection. | ||
5182 | </summary> | ||
5183 | <param name="value">The value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to find.</param> | ||
5184 | <returns>true if the collection contains the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object; otherwise, false.</returns> | ||
5185 | </member> | ||
5186 | <member name="M:Npgsql.NpgsqlParameterCollection.TryGetValue(System.String,Npgsql.NpgsqlParameter@)"> | ||
5187 | <summary> | ||
5188 | Gets a value indicating whether a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> with the specified parameter name exists in the collection. | ||
5189 | </summary> | ||
5190 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to find.</param> | ||
5191 | <param name="parameter">A reference to the requested parameter is returned in this out param if it is found in the list. This value is null if the parameter is not found.</param> | ||
5192 | <returns><b>true</b> if the collection contains the parameter and param will contain the parameter; otherwise, <b>false</b>.</returns> | ||
5193 | </member> | ||
5194 | <member name="M:Npgsql.NpgsqlParameterCollection.Clear"> | ||
5195 | <summary> | ||
5196 | Removes all items from the collection. | ||
5197 | </summary> | ||
5198 | </member> | ||
5199 | <member name="M:Npgsql.NpgsqlParameterCollection.IndexOf(System.Object)"> | ||
5200 | <summary> | ||
5201 | Gets the location of a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> in the collection. | ||
5202 | </summary> | ||
5203 | <param name="value">The value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to find.</param> | ||
5204 | <returns>The zero-based index of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object in the collection.</returns> | ||
5205 | </member> | ||
5206 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.Object)"> | ||
5207 | <summary> | ||
5208 | Adds the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see>. | ||
5209 | </summary> | ||
5210 | <param name="value">The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param> | ||
5211 | <returns>The zero-based index of the new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns> | ||
5212 | </member> | ||
5213 | <member name="M:Npgsql.NpgsqlParameterCollection.CopyTo(System.Array,System.Int32)"> | ||
5214 | <summary> | ||
5215 | Copies <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> objects from the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> to the specified array. | ||
5216 | </summary> | ||
5217 | <param name="array">An <see cref="T:System.Array">Array</see> to which to copy the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> objects in the collection.</param> | ||
5218 | <param name="index">The starting index of the array.</param> | ||
5219 | </member> | ||
5220 | <member name="M:Npgsql.NpgsqlParameterCollection.GetEnumerator"> | ||
5221 | <summary> | ||
5222 | Returns an enumerator that can iterate through the collection. | ||
5223 | </summary> | ||
5224 | <returns>An <see cref="T:System.Collections.IEnumerator">IEnumerator</see> that can be used to iterate through the collection.</returns> | ||
5225 | </member> | ||
5226 | <member name="M:Npgsql.NpgsqlParameterCollection.CheckType(System.Object)"> | ||
5227 | <summary> | ||
5228 | In methods taking an object as argument this method is used to verify | ||
5229 | that the argument has the type <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> | ||
5230 | </summary> | ||
5231 | <param name="Object">The object to verify</param> | ||
5232 | </member> | ||
5233 | <member name="P:Npgsql.NpgsqlParameterCollection.Item(System.String)"> | ||
5234 | <summary> | ||
5235 | Gets the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> with the specified name. | ||
5236 | </summary> | ||
5237 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to retrieve.</param> | ||
5238 | <value>The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> with the specified name, or a null reference if the parameter is not found.</value> | ||
5239 | </member> | ||
5240 | <member name="P:Npgsql.NpgsqlParameterCollection.Item(System.Int32)"> | ||
5241 | <summary> | ||
5242 | Gets the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> at the specified index. | ||
5243 | </summary> | ||
5244 | <param name="index">The zero-based index of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to retrieve.</param> | ||
5245 | <value>The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> at the specified index.</value> | ||
5246 | </member> | ||
5247 | <member name="P:Npgsql.NpgsqlParameterCollection.Count"> | ||
5248 | <summary> | ||
5249 | Gets the number of <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> objects in the collection. | ||
5250 | </summary> | ||
5251 | <value>The number of <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> objects in the collection.</value> | ||
5252 | </member> | ||
5253 | <member name="T:Npgsql.NpgsqlParameterStatus"> | ||
5254 | <summary> | ||
5255 | This class represents the ParameterStatus message sent from PostgreSQL | ||
5256 | server. | ||
5257 | </summary> | ||
5258 | |||
5259 | </member> | ||
5260 | <member name="T:Npgsql.NpgsqlParse"> | ||
5261 | <summary> | ||
5262 | This class represents the Parse message sent to PostgreSQL | ||
5263 | server. | ||
5264 | </summary> | ||
5265 | |||
5266 | </member> | ||
5267 | <member name="T:Npgsql.NpgsqlPasswordPacket"> | ||
5268 | <summary> | ||
5269 | This class represents a PasswordPacket message sent to backend | ||
5270 | PostgreSQL. | ||
5271 | </summary> | ||
5272 | </member> | ||
5273 | <member name="M:Npgsql.NpgsqlPromotableSinglePhaseNotification.Prepare"> | ||
5274 | <summary> | ||
5275 | Used when a connection is closed | ||
5276 | </summary> | ||
5277 | </member> | ||
5278 | <member name="T:Npgsql.NpgsqlQuery"> | ||
5279 | <summary> | ||
5280 | Summary description for NpgsqlQuery | ||
5281 | </summary> | ||
5282 | </member> | ||
5283 | <member name="T:Npgsql.NpgsqlRow"> | ||
5284 | <summary> | ||
5285 | This is the abstract base class for NpgsqlAsciiRow and NpgsqlBinaryRow. | ||
5286 | </summary> | ||
5287 | </member> | ||
5288 | <member name="T:Npgsql.NpgsqlRowDescription"> | ||
5289 | <summary> | ||
5290 | This class represents a RowDescription message sent from | ||
5291 | the PostgreSQL. | ||
5292 | </summary> | ||
5293 | |||
5294 | </member> | ||
5295 | <member name="T:Npgsql.NpgsqlRowDescription.FieldData"> | ||
5296 | <summary> | ||
5297 | This struct represents the internal data of the RowDescription message. | ||
5298 | </summary> | ||
5299 | </member> | ||
5300 | <member name="T:Npgsql.NpgsqlSchema"> | ||
5301 | <summary> | ||
5302 | Provides the underlying mechanism for reading schema information. | ||
5303 | </summary> | ||
5304 | </member> | ||
5305 | <member name="M:Npgsql.NpgsqlSchema.GetMetaDataCollections"> | ||
5306 | <summary> | ||
5307 | Returns the MetaDataCollections that lists all possible collections. | ||
5308 | </summary> | ||
5309 | <returns>The MetaDataCollections</returns> | ||
5310 | </member> | ||
5311 | <member name="M:Npgsql.NpgsqlSchema.GetRestrictions"> | ||
5312 | <summary> | ||
5313 | Returns the Restrictions that contains the meaning and position of the values in the restrictions array. | ||
5314 | </summary> | ||
5315 | <returns>The Restrictions</returns> | ||
5316 | </member> | ||
5317 | <member name="M:Npgsql.NpgsqlSchema.GetDatabases(Npgsql.NpgsqlConnection,System.String[])"> | ||
5318 | <summary> | ||
5319 | Returns the Databases that contains a list of all accessable databases. | ||
5320 | </summary> | ||
5321 | <param name="conn">The database connection on which to run the metadataquery.</param> | ||
5322 | <param name="restrictions">The restrictions to filter the collection.</param> | ||
5323 | <returns>The Databases</returns> | ||
5324 | </member> | ||
5325 | <member name="M:Npgsql.NpgsqlSchema.GetTables(Npgsql.NpgsqlConnection,System.String[])"> | ||
5326 | <summary> | ||
5327 | Returns the Tables that contains table and view names and the database and schema they come from. | ||
5328 | </summary> | ||
5329 | <param name="conn">The database connection on which to run the metadataquery.</param> | ||
5330 | <param name="restrictions">The restrictions to filter the collection.</param> | ||
5331 | <returns>The Tables</returns> | ||
5332 | </member> | ||
5333 | <member name="M:Npgsql.NpgsqlSchema.GetColumns(Npgsql.NpgsqlConnection,System.String[])"> | ||
5334 | <summary> | ||
5335 | Returns the Columns that contains information about columns in tables. | ||
5336 | </summary> | ||
5337 | <param name="conn">The database connection on which to run the metadataquery.</param> | ||
5338 | <param name="restrictions">The restrictions to filter the collection.</param> | ||
5339 | <returns>The Columns.</returns> | ||
5340 | </member> | ||
5341 | <member name="M:Npgsql.NpgsqlSchema.GetViews(Npgsql.NpgsqlConnection,System.String[])"> | ||
5342 | <summary> | ||
5343 | Returns the Views that contains view names and the database and schema they come from. | ||
5344 | </summary> | ||
5345 | <param name="conn">The database connection on which to run the metadataquery.</param> | ||
5346 | <param name="restrictions">The restrictions to filter the collection.</param> | ||
5347 | <returns>The Views</returns> | ||
5348 | </member> | ||
5349 | <member name="M:Npgsql.NpgsqlSchema.GetUsers(Npgsql.NpgsqlConnection,System.String[])"> | ||
5350 | <summary> | ||
5351 | Returns the Users containing user names and the sysid of those users. | ||
5352 | </summary> | ||
5353 | <param name="conn">The database connection on which to run the metadataquery.</param> | ||
5354 | <param name="restrictions">The restrictions to filter the collection.</param> | ||
5355 | <returns>The Users.</returns> | ||
5356 | </member> | ||
5357 | <member name="T:Npgsql.NpgsqlStartupPacket"> | ||
5358 | <summary> | ||
5359 | This class represents a StartupPacket message of PostgreSQL | ||
5360 | protocol. | ||
5361 | </summary> | ||
5362 | |||
5363 | </member> | ||
5364 | <member name="T:Npgsql.CompletedResponse"> | ||
5365 | <summary> | ||
5366 | Represents a completed response message. | ||
5367 | </summary> | ||
5368 | </member> | ||
5369 | <member name="T:Npgsql.NpgsqlSync"> | ||
5370 | <summary> | ||
5371 | This class represents the Sync message sent to PostgreSQL | ||
5372 | server. | ||
5373 | </summary> | ||
5374 | |||
5375 | </member> | ||
5376 | <member name="T:Npgsql.NpgsqlTransaction"> | ||
5377 | <summary> | ||
5378 | Represents a transaction to be made in a PostgreSQL database. This class cannot be inherited. | ||
5379 | </summary> | ||
5380 | </member> | ||
5381 | <member name="M:Npgsql.NpgsqlTransaction.Commit"> | ||
5382 | <summary> | ||
5383 | Commits the database transaction. | ||
5384 | </summary> | ||
5385 | </member> | ||
5386 | <member name="M:Npgsql.NpgsqlTransaction.Rollback"> | ||
5387 | <summary> | ||
5388 | Rolls back a transaction from a pending state. | ||
5389 | </summary> | ||
5390 | </member> | ||
5391 | <member name="M:Npgsql.NpgsqlTransaction.Rollback(System.String)"> | ||
5392 | <summary> | ||
5393 | Rolls back a transaction from a pending savepoint state. | ||
5394 | </summary> | ||
5395 | </member> | ||
5396 | <member name="M:Npgsql.NpgsqlTransaction.Save(System.String)"> | ||
5397 | <summary> | ||
5398 | Creates a transaction save point. | ||
5399 | </summary> | ||
5400 | </member> | ||
5401 | <member name="M:Npgsql.NpgsqlTransaction.Cancel"> | ||
5402 | <summary> | ||
5403 | Cancel the transaction without telling the backend about it. This is | ||
5404 | used to make the transaction go away when closing a connection. | ||
5405 | </summary> | ||
5406 | </member> | ||
5407 | <member name="P:Npgsql.NpgsqlTransaction.Connection"> | ||
5408 | <summary> | ||
5409 | Gets the <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> | ||
5410 | object associated with the transaction, or a null reference if the | ||
5411 | transaction is no longer valid. | ||
5412 | </summary> | ||
5413 | <value>The <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> | ||
5414 | object associated with the transaction.</value> | ||
5415 | </member> | ||
5416 | <member name="P:Npgsql.NpgsqlTransaction.IsolationLevel"> | ||
5417 | <summary> | ||
5418 | Specifies the <see cref="T:System.Data.IsolationLevel">IsolationLevel</see> for this transaction. | ||
5419 | </summary> | ||
5420 | <value>The <see cref="T:System.Data.IsolationLevel">IsolationLevel</see> for this transaction. | ||
5421 | The default is <b>ReadCommitted</b>.</value> | ||
5422 | </member> | ||
5423 | <member name="T:Npgsql.PGUtil"> | ||
5424 | <summary> | ||
5425 | This class provides many util methods to handle | ||
5426 | reading and writing of PostgreSQL protocol messages. | ||
5427 | </summary> | ||
5428 | </member> | ||
5429 | <member name="M:Npgsql.PGUtil.ConvertProtocolVersion(Npgsql.ProtocolVersion)"> | ||
5430 | <summary> | ||
5431 | This method takes a ProtocolVersion and returns an integer | ||
5432 | version number that the Postgres backend will recognize in a | ||
5433 | startup packet. | ||
5434 | </summary> | ||
5435 | </member> | ||
5436 | <member name="M:Npgsql.PGUtil.ExtractServerVersion(System.String)"> | ||
5437 | <summary> | ||
5438 | This method takes a version string as returned by SELECT VERSION() and returns | ||
5439 | a valid version string ("7.2.2" for example). | ||
5440 | This is only needed when running protocol version 2. | ||
5441 | This does not do any validity checks. | ||
5442 | </summary> | ||
5443 | </member> | ||
5444 | <member name="M:Npgsql.PGUtil.ReadString(System.IO.Stream)"> | ||
5445 | <summary> | ||
5446 | This method gets a C NULL terminated string from the network stream. | ||
5447 | It keeps reading a byte in each time until a NULL byte is returned. | ||
5448 | It returns the resultant string of bytes read. | ||
5449 | This string is sent from backend. | ||
5450 | </summary> | ||
5451 | </member> | ||
5452 | <member name="M:Npgsql.PGUtil.ReadBytes(System.IO.Stream,System.Byte[],System.Int32,System.Int32)"> | ||
5453 | <summary> | ||
5454 | Reads requested number of bytes from stream with retries until Stream.Read returns 0 or count is reached. | ||
5455 | </summary> | ||
5456 | <param name="stream">Stream to read</param> | ||
5457 | <param name="buffer">byte buffer to fill</param> | ||
5458 | <param name="offset">starting position to fill the buffer</param> | ||
5459 | <param name="count">number of bytes to read</param> | ||
5460 | <returns>The number of bytes read. May be less than count if no more bytes are available.</returns> | ||
5461 | </member> | ||
5462 | <member name="M:Npgsql.PGUtil.ReadBytes(System.Byte[],System.Int32,System.Int32,System.Boolean)"> | ||
5463 | <summary> | ||
5464 | Reads requested number of bytes from <paramref name="src"/>. If output matches <paramref name="src"/> exactly, and <paramref name="forceCopy"/> == false, <paramref name="src"/> is returned directly. | ||
5465 | </summary> | ||
5466 | <param name="src">Source array.</param> | ||
5467 | <param name="offset">Starting position to read from <paramref name="src"/></param> | ||
5468 | <param name="count">Number of bytes to read</param> | ||
5469 | <param name="forceCopy">Force a copy, even if the output is an exact copy of <paramref name="src"/>.</param> | ||
5470 | <returns>byte[] containing data requested.</returns> | ||
5471 | </member> | ||
5472 | <member name="M:Npgsql.PGUtil.WriteString(System.IO.Stream,System.String)"> | ||
5473 | <summary> | ||
5474 | This method writes a string to the network stream. | ||
5475 | </summary> | ||
5476 | </member> | ||
5477 | <member name="M:Npgsql.PGUtil.WriteString(System.IO.Stream,System.String,System.Object[])"> | ||
5478 | <summary> | ||
5479 | This method writes a string to the network stream. | ||
5480 | </summary> | ||
5481 | </member> | ||
5482 | <member name="M:Npgsql.PGUtil.WriteStringNullTerminated(System.IO.Stream,System.String)"> | ||
5483 | <summary> | ||
5484 | This method writes a C NULL terminated string to the network stream. | ||
5485 | It appends a NULL terminator to the end of the String. | ||
5486 | </summary> | ||
5487 | </member> | ||
5488 | <member name="M:Npgsql.PGUtil.WriteStringNullTerminated(System.IO.Stream,System.String,System.Object[])"> | ||
5489 | <summary> | ||
5490 | This method writes a C NULL terminated string to the network stream. | ||
5491 | It appends a NULL terminator to the end of the String. | ||
5492 | </summary> | ||
5493 | </member> | ||
5494 | <member name="M:Npgsql.PGUtil.WriteBytes(System.IO.Stream,System.Byte)"> | ||
5495 | <summary> | ||
5496 | This method writes a byte to the stream. It also enables logging of them. | ||
5497 | </summary> | ||
5498 | </member> | ||
5499 | <member name="M:Npgsql.PGUtil.WriteBytesNullTerminated(System.IO.Stream,System.Byte)"> | ||
5500 | <summary> | ||
5501 | This method writes a byte to the stream. It also enables logging of them. | ||
5502 | </summary> | ||
5503 | </member> | ||
5504 | <member name="M:Npgsql.PGUtil.WriteBytes(System.IO.Stream,System.Byte[])"> | ||
5505 | <summary> | ||
5506 | This method writes a set of bytes to the stream. It also enables logging of them. | ||
5507 | </summary> | ||
5508 | </member> | ||
5509 | <member name="M:Npgsql.PGUtil.WriteBytesNullTerminated(System.IO.Stream,System.Byte[])"> | ||
5510 | <summary> | ||
5511 | This method writes a set of bytes to the stream. It also enables logging of them. | ||
5512 | </summary> | ||
5513 | </member> | ||
5514 | <member name="M:Npgsql.PGUtil.WriteLimString(System.IO.Stream,System.String,System.Int32)"> | ||
5515 | <summary> | ||
5516 | This method writes a C NULL terminated string limited in length to the | ||
5517 | backend server. | ||
5518 | It pads the string with null bytes to the size specified. | ||
5519 | </summary> | ||
5520 | </member> | ||
5521 | <member name="M:Npgsql.PGUtil.WriteLimBytes(System.IO.Stream,System.Byte[],System.Int32)"> | ||
5522 | <summary> | ||
5523 | This method writes a C NULL terminated byte[] limited in length to the | ||
5524 | backend server. | ||
5525 | It pads the string with null bytes to the size specified. | ||
5526 | </summary> | ||
5527 | </member> | ||
5528 | <member name="M:Npgsql.PGUtil.WriteInt32(System.IO.Stream,System.Int32)"> | ||
5529 | <summary> | ||
5530 | Write a 32-bit integer to the given stream in the correct byte order. | ||
5531 | </summary> | ||
5532 | </member> | ||
5533 | <member name="M:Npgsql.PGUtil.ReadInt32(System.IO.Stream)"> | ||
5534 | <summary> | ||
5535 | Read a 32-bit integer from the given stream in the correct byte order. | ||
5536 | </summary> | ||
5537 | </member> | ||
5538 | <member name="M:Npgsql.PGUtil.ReadInt32(System.Byte[],System.Int32)"> | ||
5539 | <summary> | ||
5540 | Read a 32-bit integer from the given array in the correct byte order. | ||
5541 | </summary> | ||
5542 | </member> | ||
5543 | <member name="M:Npgsql.PGUtil.WriteInt16(System.IO.Stream,System.Int16)"> | ||
5544 | <summary> | ||
5545 | Write a 16-bit integer to the given stream in the correct byte order. | ||
5546 | </summary> | ||
5547 | </member> | ||
5548 | <member name="M:Npgsql.PGUtil.ReadInt16(System.IO.Stream)"> | ||
5549 | <summary> | ||
5550 | Read a 16-bit integer from the given stream in the correct byte order. | ||
5551 | </summary> | ||
5552 | </member> | ||
5553 | <member name="M:Npgsql.PGUtil.ReadInt16(System.Byte[],System.Int32)"> | ||
5554 | <summary> | ||
5555 | Read a 16-bit integer from the given array in the correct byte order. | ||
5556 | </summary> | ||
5557 | </member> | ||
5558 | <member name="M:Npgsql.PGUtil.HostNetworkByteOrderSwap(System.Byte[],System.Boolean)"> | ||
5559 | <summary> | ||
5560 | Copy and possibly reverse a byte array, depending on host architecture endienness. | ||
5561 | </summary> | ||
5562 | <param name="src">Source byte array.</param> | ||
5563 | <param name="forceCopy">Force a copy even if no swap is performed.</param> | ||
5564 | <returns><paramref name="src"/>, reversed if on a little-endian architecture, copied if required.</returns> | ||
5565 | </member> | ||
5566 | <member name="M:Npgsql.PGUtil.HostNetworkByteOrderSwap(System.Byte[],System.Int32,System.Int32,System.Boolean)"> | ||
5567 | <summary> | ||
5568 | Copy and possibly reverse a byte array, depending on host architecture endienness. | ||
5569 | </summary> | ||
5570 | <param name="src">Source byte array.</param> | ||
5571 | <param name="start">Starting offset in source array.</param> | ||
5572 | <param name="length">Number of bytes to copy.</param> | ||
5573 | <param name="forceCopy">Force a copy even if no swap is performed.</param> | ||
5574 | <returns><paramref name="src"/>, reversed if on a little-endian architecture, copied if required.</returns> | ||
5575 | </member> | ||
5576 | <member name="T:Npgsql.ProtocolVersion"> | ||
5577 | <summary> | ||
5578 | Represent the frontend/backend protocol version. | ||
5579 | </summary> | ||
5580 | </member> | ||
5581 | <member name="T:Npgsql.ServerVersion"> | ||
5582 | <summary> | ||
5583 | Represent the backend server version. | ||
5584 | As this class offers no functionality beyond that offered by <see cref="T:System.Version"/> it has been | ||
5585 | deprecated in favour of that class. | ||
5586 | </summary> | ||
5587 | |||
5588 | </member> | ||
5589 | <member name="M:Npgsql.ServerVersion.ToString"> | ||
5590 | <summary> | ||
5591 | Returns the string representation of this version in three place dot notation (Major.Minor.Patch). | ||
5592 | </summary> | ||
5593 | </member> | ||
5594 | <member name="P:Npgsql.ServerVersion.Major"> | ||
5595 | <summary> | ||
5596 | Server version major number. | ||
5597 | </summary> | ||
5598 | </member> | ||
5599 | <member name="P:Npgsql.ServerVersion.Minor"> | ||
5600 | <summary> | ||
5601 | Server version minor number. | ||
5602 | </summary> | ||
5603 | </member> | ||
5604 | <member name="P:Npgsql.ServerVersion.Patch"> | ||
5605 | <summary> | ||
5606 | Server version patch level number. | ||
5607 | </summary> | ||
5608 | </member> | ||
5609 | <member name="T:Npgsql.SSPIHandler"> | ||
5610 | <summary> | ||
5611 | A class to handle everything associated with SSPI authentication | ||
5612 | </summary> | ||
5613 | </member> | ||
5614 | <member name="T:Npgsql.SSPIHandler.SecBufferDesc"> | ||
5615 | <summary> | ||
5616 | Simplified SecBufferDesc struct with only one SecBuffer | ||
5617 | </summary> | ||
5618 | </member> | ||
5619 | </members> | ||
5620 | </doc> | ||