diff options
Diffstat (limited to 'bin/Npgsql.xml')
-rw-r--r-- | bin/Npgsql.xml | 1547 |
1 files changed, 1231 insertions, 316 deletions
diff --git a/bin/Npgsql.xml b/bin/Npgsql.xml index aec35c1..8133430 100644 --- a/bin/Npgsql.xml +++ b/bin/Npgsql.xml | |||
@@ -21,11 +21,22 @@ | |||
21 | </summary> | 21 | </summary> |
22 | <param name="elementConverter">The <see cref="T:NpgsqlTypes.NpgsqlNativeTypeInfo"/> that would be used to serialise the element type.</param> | 22 | <param name="elementConverter">The <see cref="T:NpgsqlTypes.NpgsqlNativeTypeInfo"/> that would be used to serialise the element type.</param> |
23 | </member> | 23 | </member> |
24 | <member name="M:NpgsqlTypes.ArrayNativeToBackendTypeConverter.FromArray(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 24 | <member name="M:NpgsqlTypes.ArrayNativeToBackendTypeConverter.ArrayToArrayText(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
25 | <summary> | 25 | <summary> |
26 | Serialise the enumeration or array. | 26 | Serialise the enumeration or array. |
27 | </summary> | 27 | </summary> |
28 | </member> | 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> | ||
29 | <member name="T:NpgsqlTypes.ArrayBackendToNativeTypeConverter"> | 40 | <member name="T:NpgsqlTypes.ArrayBackendToNativeTypeConverter"> |
30 | <summary> | 41 | <summary> |
31 | Handles parsing of pg arrays into .NET arrays. | 42 | Handles parsing of pg arrays into .NET arrays. |
@@ -61,9 +72,9 @@ | |||
61 | </summary> | 72 | </summary> |
62 | <param name="elementConverter"><see cref="T:NpgsqlTypes.NpgsqlBackendTypeInfo"/> for the element type.</param> | 73 | <param name="elementConverter"><see cref="T:NpgsqlTypes.NpgsqlBackendTypeInfo"/> for the element type.</param> |
63 | </member> | 74 | </member> |
64 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ToArray(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 75 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ArrayTextToArray(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
65 | <summary> | 76 | <summary> |
66 | Creates an array from pg representation. | 77 | Creates an array from pg text representation. |
67 | </summary> | 78 | </summary> |
68 | </member> | 79 | </member> |
69 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ToArrayList(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 80 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ToArrayList(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> |
@@ -75,21 +86,34 @@ | |||
75 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ToArray(System.Collections.ArrayList,System.Type)"> | 86 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ToArray(System.Collections.ArrayList,System.Type)"> |
76 | <summary> | 87 | <summary> |
77 | Creates an n-dimensional array from an ArrayList of ArrayLists or | 88 | Creates an n-dimensional array from an ArrayList of ArrayLists or |
78 | a 1-dimensional array from something else. | 89 | a 1-dimensional array from something else. |
79 | </summary> | 90 | </summary> |
80 | <param name="list"><see cref="T:System.Collections.ArrayList"/> to convert</param> | 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> | ||
81 | <returns><see cref="T:System.Array"/> produced.</returns> | 93 | <returns><see cref="T:System.Array"/> produced.</returns> |
82 | </member> | 94 | </member> |
83 | <member name="T:NpgsqlTypes.ArrayBackendToNativeTypeConverter.IntSetIterator"> | 95 | <member name="M:NpgsqlTypes.ArrayBackendToNativeTypeConverter.ArrayBinaryToArray(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> |
84 | <summary> | 96 | <summary> |
85 | Takes an array of ints and treats them like the limits of a set of counters. | 97 | Creates an n-dimensional System.Array from PG binary representation. |
86 | Retains a matching set of ints that is set to all zeros on the first ++ | 98 | This function reads the array header and sets up an n-dimensional System.Array object to hold its data. |
87 | On a ++ it increments the "right-most" int. If that int reaches it's | 99 | PopulateArrayFromBinaryArray() is then called to carry out array population. |
88 | limit it is set to zero and the one before it is incremented, and so on. | 100 | </summary> |
89 | 101 | </member> | |
90 | Making this a more general purpose class is pretty straight-forward, but we'll just put what we need here. | 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. | ||
91 | </summary> | 105 | </summary> |
92 | </member> | 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> | ||
93 | <member name="T:NpgsqlTypes.BitString"> | 117 | <member name="T:NpgsqlTypes.BitString"> |
94 | <summary> | 118 | <summary> |
95 | <para>Implements a bit string; a collection of zero or more bits which can each be 1 or 0.</para> | 119 | <para>Implements a bit string; a collection of zero or more bits which can each be 1 or 0.</para> |
@@ -121,7 +145,7 @@ | |||
121 | <summary> | 145 | <summary> |
122 | Creats a bitstring from a <see cref="T:System.String">string</see>. | 146 | Creats a bitstring from a <see cref="T:System.String">string</see>. |
123 | <param name="str">The <see cref="T:System.String">string to copy from</see>.</param> | 147 | <param name="str">The <see cref="T:System.String">string to copy from</see>.</param> |
124 | <seealso cref="!:Npgsql.BitString.Parse(System.String)"/> | 148 | <seealso cref="M:NpgsqlTypes.BitString.Parse(System.String)"/> |
125 | </summary> | 149 | </summary> |
126 | </member> | 150 | </member> |
127 | <member name="M:NpgsqlTypes.BitString.#ctor(System.Boolean)"> | 151 | <member name="M:NpgsqlTypes.BitString.#ctor(System.Boolean)"> |
@@ -277,7 +301,7 @@ | |||
277 | </summary> | 301 | </summary> |
278 | <param name="obj">The object to compare with.</param> | 302 | <param name="obj">The object to compare with.</param> |
279 | <returns>If the object is null then this string is considered greater. If the object is another BitString | 303 | <returns>If the object is null then this string is considered greater. If the object is another BitString |
280 | then they are compared as in <see cref="!:CompareTo(Npgsql.BitString)">the explicit comparison for BitStrings</see> | 304 | then they are compared as in <see cref="M:NpgsqlTypes.BitString.CompareTo(NpgsqlTypes.BitString)">the explicit comparison for BitStrings</see> |
281 | in any other case a <see cref="T:System.ArgumentException"/> is thrown.</returns> | 305 | in any other case a <see cref="T:System.ArgumentException"/> is thrown.</returns> |
282 | </member> | 306 | </member> |
283 | <member name="M:NpgsqlTypes.BitString.Equals(System.Object)"> | 307 | <member name="M:NpgsqlTypes.BitString.Equals(System.Object)"> |
@@ -504,7 +528,7 @@ | |||
504 | <para>If you don't know whether these differences are important to your application, they | 528 | <para>If you don't know whether these differences are important to your application, they |
505 | probably arent! Just use <see cref="T:System.TimeSpan"/> and do not use this class directly ☺</para> | 529 | probably arent! Just use <see cref="T:System.TimeSpan"/> and do not use this class directly ☺</para> |
506 | <para>To avoid forcing unnecessary provider-specific concerns on users who need not be concerned | 530 | <para>To avoid forcing unnecessary provider-specific concerns on users who need not be concerned |
507 | with them a call to <see cref="!:IDataRecord.GetValue(int)"/> on a field containing an | 531 | with them a call to <see cref="M:System.Data.IDataRecord.GetValue(System.Int32)"/> on a field containing an |
508 | <see cref="T:NpgsqlTypes.NpgsqlInterval"/> value will return a <see cref="T:System.TimeSpan"/> rather than an | 532 | <see cref="T:NpgsqlTypes.NpgsqlInterval"/> value will return a <see cref="T:System.TimeSpan"/> rather than an |
509 | <see cref="T:NpgsqlTypes.NpgsqlInterval"/>. If you need the extra functionality of <see cref="T:NpgsqlTypes.NpgsqlInterval"/> | 533 | <see cref="T:NpgsqlTypes.NpgsqlInterval"/>. If you need the extra functionality of <see cref="T:NpgsqlTypes.NpgsqlInterval"/> |
510 | then use <see cref="M:Npgsql.NpgsqlDataReader.GetInterval(System.Int32)"/>.</para> | 534 | then use <see cref="M:Npgsql.NpgsqlDataReader.GetInterval(System.Int32)"/>.</para> |
@@ -661,49 +685,49 @@ | |||
661 | <summary> | 685 | <summary> |
662 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of microseconds. | 686 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of microseconds. |
663 | </summary> | 687 | </summary> |
664 | <param name="ticks">The number of microseconds in the interval.</param> | 688 | <param name="micro">The number of microseconds in the interval.</param> |
665 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of microseconds.</returns> | 689 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of microseconds.</returns> |
666 | </member> | 690 | </member> |
667 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromMilliseconds(System.Double)"> | 691 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromMilliseconds(System.Double)"> |
668 | <summary> | 692 | <summary> |
669 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of milliseconds. | 693 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of milliseconds. |
670 | </summary> | 694 | </summary> |
671 | <param name="ticks">The number of milliseconds in the interval.</param> | 695 | <param name="milli">The number of milliseconds in the interval.</param> |
672 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of milliseconds.</returns> | 696 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of milliseconds.</returns> |
673 | </member> | 697 | </member> |
674 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromSeconds(System.Double)"> | 698 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromSeconds(System.Double)"> |
675 | <summary> | 699 | <summary> |
676 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of seconds. | 700 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of seconds. |
677 | </summary> | 701 | </summary> |
678 | <param name="ticks">The number of seconds in the interval.</param> | 702 | <param name="seconds">The number of seconds in the interval.</param> |
679 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of seconds.</returns> | 703 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of seconds.</returns> |
680 | </member> | 704 | </member> |
681 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromMinutes(System.Double)"> | 705 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromMinutes(System.Double)"> |
682 | <summary> | 706 | <summary> |
683 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of minutes. | 707 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of minutes. |
684 | </summary> | 708 | </summary> |
685 | <param name="ticks">The number of minutes in the interval.</param> | 709 | <param name="minutes">The number of minutes in the interval.</param> |
686 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of minutes.</returns> | 710 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of minutes.</returns> |
687 | </member> | 711 | </member> |
688 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromHours(System.Double)"> | 712 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromHours(System.Double)"> |
689 | <summary> | 713 | <summary> |
690 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of hours. | 714 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of hours. |
691 | </summary> | 715 | </summary> |
692 | <param name="ticks">The number of hours in the interval.</param> | 716 | <param name="hours">The number of hours in the interval.</param> |
693 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of hours.</returns> | 717 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of hours.</returns> |
694 | </member> | 718 | </member> |
695 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromDays(System.Double)"> | 719 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromDays(System.Double)"> |
696 | <summary> | 720 | <summary> |
697 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of days. | 721 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of days. |
698 | </summary> | 722 | </summary> |
699 | <param name="ticks">The number of days in the interval.</param> | 723 | <param name="days">The number of days in the interval.</param> |
700 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of days.</returns> | 724 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of days.</returns> |
701 | </member> | 725 | </member> |
702 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromMonths(System.Double)"> | 726 | <member name="M:NpgsqlTypes.NpgsqlInterval.FromMonths(System.Double)"> |
703 | <summary> | 727 | <summary> |
704 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of months. | 728 | Creates an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> from a number of months. |
705 | </summary> | 729 | </summary> |
706 | <param name="ticks">The number of months in the interval.</param> | 730 | <param name="months">The number of months in the interval.</param> |
707 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of months.</returns> | 731 | <returns>A <see cref="M:NpgsqlTypes.NpgsqlInterval.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlInterval"/> with the given number of months.</returns> |
708 | </member> | 732 | </member> |
709 | <member name="M:NpgsqlTypes.NpgsqlInterval.Add(NpgsqlTypes.NpgsqlInterval)"> | 733 | <member name="M:NpgsqlTypes.NpgsqlInterval.Add(NpgsqlTypes.NpgsqlInterval)"> |
@@ -773,7 +797,29 @@ | |||
773 | </summary> | 797 | </summary> |
774 | <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> | 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> |
775 | </member> | 799 | </member> |
776 | <!-- Badly formed XML comment ignored for member "M:NpgsqlTypes.NpgsqlInterval.Canonicalize" --> | 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> | ||
777 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_Implicit(System.TimeSpan)~NpgsqlTypes.NpgsqlInterval"> | 823 | <member name="M:NpgsqlTypes.NpgsqlInterval.op_Implicit(System.TimeSpan)~NpgsqlTypes.NpgsqlInterval"> |
778 | <summary> | 824 | <summary> |
779 | Implicit cast of a <see cref="T:System.TimeSpan"/> to an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> | 825 | Implicit cast of a <see cref="T:System.TimeSpan"/> to an <see cref="T:NpgsqlTypes.NpgsqlInterval"/> |
@@ -1233,91 +1279,84 @@ | |||
1233 | Summary description for LargeObjectManager. | 1279 | Summary description for LargeObjectManager. |
1234 | </summary> | 1280 | </summary> |
1235 | </member> | 1281 | </member> |
1236 | <member name="T:NpgsqlTypes.BasicBackendToNativeTypeConverter"> | 1282 | <member name="T:NpgsqlTypes.NativeToBackendTypeConverterOptions"> |
1237 | <summary> | ||
1238 | Provide event handlers to convert all native supported basic data types from their backend | ||
1239 | text representation to a .NET object. | ||
1240 | </summary> | ||
1241 | </member> | ||
1242 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToBinary(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | ||
1243 | <summary> | 1283 | <summary> |
1244 | Binary data. | 1284 | Options that control certain aspects of native to backend conversions that depend |
1285 | on backend version and status. | ||
1245 | </summary> | 1286 | </summary> |
1246 | </member> | 1287 | </member> |
1247 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToBoolean(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1288 | <member name="M:NpgsqlTypes.NativeToBackendTypeConverterOptions.System#ICloneable#Clone"> |
1248 | <summary> | 1289 | <summary> |
1249 | Convert a postgresql boolean to a System.Boolean. | 1290 | Clone the current object. |
1250 | </summary> | 1291 | </summary> |
1292 | <returns>A new NativeToBackendTypeConverterOptions object.</returns> | ||
1251 | </member> | 1293 | </member> |
1252 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToBit(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1294 | <member name="M:NpgsqlTypes.NativeToBackendTypeConverterOptions.Clone(NpgsqlTypes.NpgsqlBackendTypeMapping)"> |
1253 | <summary> | 1295 | <summary> |
1254 | Convert a postgresql bit to a System.Boolean. | 1296 | Clone the current object with a different OID/Name mapping. |
1255 | </summary> | 1297 | </summary> |
1298 | <param name="oidToNameMapping">OID/Name mapping object to use in the new instance.</param> | ||
1299 | <returns>A new NativeToBackendTypeConverterOptions object.</returns> | ||
1256 | </member> | 1300 | </member> |
1257 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToDateTime(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1301 | <member name="T:NpgsqlTypes.BasicBackendToNativeTypeConverter"> |
1258 | <summary> | 1302 | <summary> |
1259 | Convert a postgresql datetime to a System.DateTime. | 1303 | Provide event handlers to convert all native supported basic data types from their backend |
1304 | text representation to a .NET object. | ||
1260 | </summary> | 1305 | </summary> |
1261 | </member> | 1306 | </member> |
1262 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToDate(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1307 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.TextBinaryToString(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> |
1263 | <summary> | 1308 | <summary> |
1264 | Convert a postgresql date to a System.DateTime. | 1309 | Convert UTF8 encoded text a string. |
1265 | </summary> | 1310 | </summary> |
1266 | </member> | 1311 | </member> |
1267 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToTime(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1312 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ByteaTextToByteArray(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1268 | <summary> | 1313 | <summary> |
1269 | Convert a postgresql time to a System.DateTime. | 1314 | Byte array from bytea encoded as ASCII text, escaped or hex format. |
1270 | </summary> | 1315 | </summary> |
1271 | </member> | 1316 | </member> |
1272 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToMoney(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1317 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ByteaBinaryToByteArray(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> |
1273 | <summary> | 1318 | <summary> |
1274 | Convert a postgresql money to a System.Decimal. | 1319 | Byte array from bytea encoded as binary. |
1275 | </summary> | 1320 | </summary> |
1276 | </member> | 1321 | </member> |
1277 | <member name="T:NpgsqlTypes.BasicNativeToBackendTypeConverter"> | 1322 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.BooleanTextToBoolean(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1278 | <summary> | 1323 | <summary> |
1279 | Provide event handlers to convert the basic native supported data types from | 1324 | Convert a postgresql boolean to a System.Boolean. |
1280 | native form to backend representation. | ||
1281 | </summary> | ||
1282 | </member> | ||
1283 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToBinary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | ||
1284 | <summary> | ||
1285 | Binary data. | ||
1286 | </summary> | 1325 | </summary> |
1287 | </member> | 1326 | </member> |
1288 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToBoolean(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1327 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.BooleanBinaryToBoolean(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> |
1289 | <summary> | 1328 | <summary> |
1290 | Convert to a postgresql boolean. | 1329 | Convert a postgresql boolean to a System.Boolean. |
1291 | </summary> | 1330 | </summary> |
1292 | </member> | 1331 | </member> |
1293 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToBit(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1332 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToBit(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1294 | <summary> | 1333 | <summary> |
1295 | Convert to a postgresql bit. | 1334 | Convert a postgresql bit to a System.Boolean. |
1296 | </summary> | 1335 | </summary> |
1297 | </member> | 1336 | </member> |
1298 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToDateTime(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1337 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToDateTime(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1299 | <summary> | 1338 | <summary> |
1300 | Convert to a postgresql timestamp. | 1339 | Convert a postgresql datetime to a System.DateTime. |
1301 | </summary> | 1340 | </summary> |
1302 | </member> | 1341 | </member> |
1303 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToDate(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1342 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToDate(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1304 | <summary> | 1343 | <summary> |
1305 | Convert to a postgresql date. | 1344 | Convert a postgresql date to a System.DateTime. |
1306 | </summary> | 1345 | </summary> |
1307 | </member> | 1346 | </member> |
1308 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToTime(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1347 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToTime(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1309 | <summary> | 1348 | <summary> |
1310 | Convert to a postgresql time. | 1349 | Convert a postgresql time to a System.DateTime. |
1311 | </summary> | 1350 | </summary> |
1312 | </member> | 1351 | </member> |
1313 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToMoney(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1352 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.ToMoney(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1314 | <summary> | 1353 | <summary> |
1315 | Convert to a postgres money. | 1354 | Convert a postgresql money to a System.Decimal. |
1316 | </summary> | 1355 | </summary> |
1317 | </member> | 1356 | </member> |
1318 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToSingleDouble(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1357 | <member name="M:NpgsqlTypes.BasicBackendToNativeTypeConverter.Float4Float8BinaryToFloatDouble(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int32,System.Int32)"> |
1319 | <summary> | 1358 | <summary> |
1320 | Convert to a postgres double with maximum precision. | 1359 | Convert a postgresql float4 or float8 to a System.Float or System.Double respectively. |
1321 | </summary> | 1360 | </summary> |
1322 | </member> | 1361 | </member> |
1323 | <member name="T:NpgsqlTypes.ExtendedBackendToNativeTypeConverter"> | 1362 | <member name="T:NpgsqlTypes.ExtendedBackendToNativeTypeConverter"> |
@@ -1326,225 +1365,211 @@ | |||
1326 | text representation to a .NET object. | 1365 | text representation to a .NET object. |
1327 | </summary> | 1366 | </summary> |
1328 | </member> | 1367 | </member> |
1329 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToPoint(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1368 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToPoint(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1330 | <summary> | 1369 | <summary> |
1331 | Convert a postgresql point to a System.NpgsqlPoint. | 1370 | Convert a postgresql point to a System.NpgsqlPoint. |
1332 | </summary> | 1371 | </summary> |
1333 | </member> | 1372 | </member> |
1334 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToBox(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1373 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToBox(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1335 | <summary> | 1374 | <summary> |
1336 | Convert a postgresql point to a System.RectangleF. | 1375 | Convert a postgresql point to a System.RectangleF. |
1337 | </summary> | 1376 | </summary> |
1338 | </member> | 1377 | </member> |
1339 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToLSeg(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1378 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToLSeg(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1340 | <summary> | 1379 | <summary> |
1341 | LDeg. | 1380 | LDeg. |
1342 | </summary> | 1381 | </summary> |
1343 | </member> | 1382 | </member> |
1344 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToPath(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1383 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToPath(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1345 | <summary> | 1384 | <summary> |
1346 | Path. | 1385 | Path. |
1347 | </summary> | 1386 | </summary> |
1348 | </member> | 1387 | </member> |
1349 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToPolygon(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1388 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToPolygon(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1350 | <summary> | 1389 | <summary> |
1351 | Polygon. | 1390 | Polygon. |
1352 | </summary> | 1391 | </summary> |
1353 | </member> | 1392 | </member> |
1354 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToCircle(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1393 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToCircle(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1355 | <summary> | 1394 | <summary> |
1356 | Circle. | 1395 | Circle. |
1357 | </summary> | 1396 | </summary> |
1358 | </member> | 1397 | </member> |
1359 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToInet(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1398 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToInet(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1360 | <summary> | 1399 | <summary> |
1361 | Inet. | 1400 | Inet. |
1362 | </summary> | 1401 | </summary> |
1363 | </member> | 1402 | </member> |
1364 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToMacAddress(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1403 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToMacAddress(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1365 | <summary> | 1404 | <summary> |
1366 | MAC Address. | 1405 | MAC Address. |
1367 | </summary> | 1406 | </summary> |
1368 | </member> | 1407 | </member> |
1369 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToInterval(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1408 | <member name="M:NpgsqlTypes.ExtendedBackendToNativeTypeConverter.ToInterval(NpgsqlTypes.NpgsqlBackendTypeInfo,System.Byte[],System.Int16,System.Int32)"> |
1370 | <summary> | 1409 | <summary> |
1371 | interval | 1410 | interval |
1372 | </summary> | 1411 | </summary> |
1373 | </member> | 1412 | </member> |
1374 | <member name="T:NpgsqlTypes.ExtendedNativeToBackendTypeConverter"> | 1413 | <member name="T:NpgsqlTypes.BasicNativeToBackendTypeConverter"> |
1375 | <summary> | 1414 | <summary> |
1376 | Provide event handlers to convert extended native supported data types from | 1415 | Provide event handlers to convert the basic native supported data types from |
1377 | native form to backend representation. | 1416 | native form to backend representation. |
1378 | </summary> | 1417 | </summary> |
1379 | </member> | 1418 | </member> |
1380 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToPoint(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1419 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.StringToTextText(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1381 | <summary> | 1420 | <summary> |
1382 | Point. | 1421 | Convert a string to UTF8 encoded text, escaped and quoted as required. |
1383 | </summary> | 1422 | </summary> |
1384 | </member> | 1423 | </member> |
1385 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToBox(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1424 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.StringToTextBinary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> |
1386 | <summary> | 1425 | <summary> |
1387 | Box. | 1426 | Convert a string to UTF8 encoded text. |
1388 | </summary> | 1427 | </summary> |
1389 | </member> | 1428 | </member> |
1390 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToLSeg(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1429 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ByteArrayToByteaText(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1391 | <summary> | 1430 | <summary> |
1392 | LSeg. | 1431 | Binary data, escaped and quoted as required. |
1393 | </summary> | 1432 | </summary> |
1394 | </member> | 1433 | </member> |
1395 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToPath(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1434 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ByteArrayToByteaTextEscaped(System.Byte[],NpgsqlTypes.BasicNativeToBackendTypeConverter.StringEncodingInfo)"> |
1396 | <summary> | 1435 | <summary> |
1397 | Open path. | 1436 | Binary data with possible older style octal escapes, quoted. |
1398 | </summary> | 1437 | </summary> |
1399 | </member> | 1438 | </member> |
1400 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToPolygon(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1439 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ByteArrayToByteaTextHexFormat(System.Byte[],NpgsqlTypes.BasicNativeToBackendTypeConverter.StringEncodingInfo)"> |
1401 | <summary> | 1440 | <summary> |
1402 | Polygon. | 1441 | Binary data in the new hex format (>= 9.0), quoted. |
1403 | </summary> | 1442 | </summary> |
1404 | </member> | 1443 | </member> |
1405 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToMacAddress(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1444 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ByteArrayToByteaBinary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> |
1406 | <summary> | 1445 | <summary> |
1407 | Convert to a postgres MAC Address. | 1446 | Binary data, raw. |
1408 | </summary> | 1447 | </summary> |
1409 | </member> | 1448 | </member> |
1410 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToCircle(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1449 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.BooleanToBooleanText(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1411 | <summary> | 1450 | <summary> |
1412 | Circle. | 1451 | Convert to a postgresql boolean text format. |
1413 | </summary> | 1452 | </summary> |
1414 | </member> | 1453 | </member> |
1415 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToIPAddress(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1454 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.BooleanToBooleanBinary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> |
1416 | <summary> | 1455 | <summary> |
1417 | Convert to a postgres inet. | 1456 | Convert to a postgresql boolean binary format. |
1418 | </summary> | 1457 | </summary> |
1419 | </member> | 1458 | </member> |
1420 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToInterval(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean)"> | 1459 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.Int16ToInt2Binary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> |
1421 | <summary> | 1460 | <summary> |
1422 | Convert to a postgres interval | 1461 | Convert to a postgresql binary int2. |
1423 | </summary> | 1462 | </summary> |
1424 | </member> | 1463 | </member> |
1425 | <member name="T:NpgsqlTypes.NpgsqlPoint"> | 1464 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.Int32ToInt4Binary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> |
1426 | <summary> | 1465 | <summary> |
1427 | Represents a PostgreSQL Point type | 1466 | Convert to a postgresql binary int4. |
1428 | </summary> | 1467 | </summary> |
1429 | </member> | 1468 | </member> |
1430 | <member name="T:NpgsqlTypes.NpgsqlLSeg"> | 1469 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.Int64ToInt8Binary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> |
1431 | <summary> | 1470 | <summary> |
1432 | Represents a PostgreSQL Line Segment type. | 1471 | Convert to a postgresql binary int8. |
1433 | </summary> | 1472 | </summary> |
1434 | </member> | 1473 | </member> |
1435 | <member name="T:NpgsqlTypes.NpgsqlPath"> | 1474 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToBit(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1436 | <summary> | 1475 | <summary> |
1437 | Represents a PostgreSQL Path type. | 1476 | Convert to a postgresql bit. |
1438 | </summary> | 1477 | </summary> |
1439 | </member> | 1478 | </member> |
1440 | <member name="T:NpgsqlTypes.NpgsqlPolygon"> | 1479 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToDateTime(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1441 | <summary> | 1480 | <summary> |
1442 | Represents a PostgreSQL Polygon type. | 1481 | Convert to a postgresql timestamp. |
1443 | </summary> | 1482 | </summary> |
1444 | </member> | 1483 | </member> |
1445 | <member name="T:NpgsqlTypes.NpgsqlCircle"> | 1484 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToDate(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1446 | <summary> | 1485 | <summary> |
1447 | Represents a PostgreSQL Circle type. | 1486 | Convert to a postgresql date. |
1448 | </summary> | 1487 | </summary> |
1449 | </member> | 1488 | </member> |
1450 | <member name="T:NpgsqlTypes.NpgsqlInet"> | 1489 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToTime(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1451 | <summary> | 1490 | <summary> |
1452 | Represents a PostgreSQL inet type. | 1491 | Convert to a postgresql time. |
1453 | </summary> | 1492 | </summary> |
1454 | </member> | 1493 | </member> |
1455 | <member name="T:NpgsqlTypes.NpgsqlMacAddress"> | 1494 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.ToMoney(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1456 | <summary> | 1495 | <summary> |
1457 | Represents a PostgreSQL MacAddress type. | 1496 | Convert to a postgres money. |
1458 | </summary> | 1497 | </summary> |
1459 | </member> | 1498 | </member> |
1460 | <member name="M:NpgsqlTypes.NpgsqlMacAddress.#ctor(System.String)"> | 1499 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.SingleDoubleToFloat4Float8Text(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1461 | <summary> | 1500 | <summary> |
1462 | 1501 | Convert to a postgres double with maximum precision. | |
1463 | </summary> | 1502 | </summary> |
1464 | <param name="macAddr">The macAddr parameter must contain a string that can only consist of numbers | ||
1465 | and upper-case letters as hexadecimal digits. (See PhysicalAddress.Parse method on MSDN)</param> | ||
1466 | </member> | 1503 | </member> |
1467 | <member name="T:NpgsqlTypes.NpgsqlTypesHelper"> | 1504 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.SingleToFloat4Binary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> |
1468 | <summary> | 1505 | <summary> |
1469 | This class contains helper methods for type conversion between | 1506 | Convert a System.Float to a postgres float4. |
1470 | the .Net type system and postgresql. | ||
1471 | </summary> | 1507 | </summary> |
1472 | </member> | 1508 | </member> |
1473 | <member name="F:NpgsqlTypes.NpgsqlTypesHelper.BackendTypeMappingCache"> | 1509 | <member name="M:NpgsqlTypes.BasicNativeToBackendTypeConverter.DoubleToFloat8Binary(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,NpgsqlTypes.NativeToBackendTypeConverterOptions)"> |
1474 | <summary> | 1510 | <summary> |
1475 | A cache of basic datatype mappings keyed by server version. This way we don't | 1511 | Convert a System.Double to a postgres float8. |
1476 | have to load the basic type mappings for every connection. | ||
1477 | </summary> | 1512 | </summary> |
1478 | </member> | 1513 | </member> |
1479 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetBackendTypeInfo(System.String,NpgsqlTypes.NpgsqlBackendTypeInfo@)"> | 1514 | <member name="T:NpgsqlTypes.ExtendedNativeToBackendTypeConverter"> |
1480 | <summary> | 1515 | <summary> |
1481 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects | 1516 | Provide event handlers to convert extended native supported data types from |
1482 | of the given NpgsqlDbType. | 1517 | native form to backend representation. |
1483 | </summary> | 1518 | </summary> |
1484 | </member> | 1519 | </member> |
1485 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetNativeTypeInfo(NpgsqlTypes.NpgsqlDbType,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> | 1520 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToPoint(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1486 | <summary> | 1521 | <summary> |
1487 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects | 1522 | Point. |
1488 | of the given NpgsqlDbType. | ||
1489 | </summary> | 1523 | </summary> |
1490 | </member> | 1524 | </member> |
1491 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetNativeTypeInfo(System.Data.DbType,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> | 1525 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToBox(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1492 | <summary> | 1526 | <summary> |
1493 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects | 1527 | Box. |
1494 | of the given DbType. | ||
1495 | </summary> | 1528 | </summary> |
1496 | </member> | 1529 | </member> |
1497 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetNativeTypeInfo(System.Type,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> | 1530 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToLSeg(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1498 | <summary> | 1531 | <summary> |
1499 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects | 1532 | LSeg. |
1500 | of the given System.Type. | ||
1501 | </summary> | 1533 | </summary> |
1502 | </member> | 1534 | </member> |
1503 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.ConvertBackendStringToSystemType(NpgsqlTypes.NpgsqlBackendTypeInfo,System.String,System.Int16,System.Int32)"> | 1535 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToPath(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1504 | <summary> | 1536 | <summary> |
1505 | This method is responsible to convert the string received from the backend | 1537 | Open path. |
1506 | to the corresponding NpgsqlType. | 1538 | </summary> |
1507 | The given TypeInfo is called upon to do the conversion. | ||
1508 | If no TypeInfo object is provided, no conversion is performed. | ||
1509 | </summary> | ||
1510 | </member> | 1539 | </member> |
1511 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.PrepareDefaultTypesMap"> | 1540 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToPolygon(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1512 | <summary> | 1541 | <summary> |
1513 | Create the one and only native to backend type map. | 1542 | Polygon. |
1514 | This map is used when formatting native data | ||
1515 | types to backend representations. | ||
1516 | </summary> | 1543 | </summary> |
1517 | </member> | 1544 | </member> |
1518 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.CreateAndLoadInitialTypesMapping(Npgsql.NpgsqlConnector)"> | 1545 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToMacAddress(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1519 | <summary> | 1546 | <summary> |
1520 | This method creates (or retrieves from cache) a mapping between type and OID | 1547 | Convert to a postgres MAC Address. |
1521 | of all natively supported postgresql data types. | 1548 | </summary> |
1522 | This is needed as from one version to another, this mapping can be changed and | ||
1523 | so we avoid hardcoding them. | ||
1524 | </summary> | ||
1525 | <returns>NpgsqlTypeMapping containing all known data types. The mapping must be | ||
1526 | cloned before it is modified because it is cached; changes made by one connection may | ||
1527 | effect another connection.</returns> | ||
1528 | </member> | 1549 | </member> |
1529 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.LoadTypesMappings(Npgsql.NpgsqlConnector,NpgsqlTypes.NpgsqlBackendTypeMapping,System.Collections.Generic.IEnumerable{NpgsqlTypes.NpgsqlBackendTypeInfo})"> | 1550 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToCircle(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1530 | <summary> | 1551 | <summary> |
1531 | Attempt to map types by issuing a query against pg_type. | 1552 | Circle. |
1532 | This function takes a list of NpgsqlTypeInfo and attempts to resolve the OID field | ||
1533 | of each by querying pg_type. If the mapping is found, the type info object is | ||
1534 | updated (OID) and added to the provided NpgsqlTypeMapping object. | ||
1535 | </summary> | 1553 | </summary> |
1536 | <param name="conn">NpgsqlConnector to send query through.</param> | ||
1537 | <param name="TypeMappings">Mapping object to add types too.</param> | ||
1538 | <param name="TypeInfoList">List of types that need to have OID's mapped.</param> | ||
1539 | </member> | 1554 | </member> |
1540 | <member name="T:NpgsqlTypes.ConvertBackendToNativeHandler"> | 1555 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToIPAddress(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1541 | <summary> | 1556 | <summary> |
1542 | Delegate called to convert the given backend data to its native representation. | 1557 | Convert to a postgres inet. |
1543 | </summary> | 1558 | </summary> |
1544 | </member> | 1559 | </member> |
1545 | <member name="T:NpgsqlTypes.ConvertNativeToBackendHandler"> | 1560 | <member name="M:NpgsqlTypes.ExtendedNativeToBackendTypeConverter.ToInterval(NpgsqlTypes.NpgsqlNativeTypeInfo,System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1546 | <summary> | 1561 | <summary> |
1547 | Delegate called to convert the given native data to its backand representation. | 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. | ||
1548 | </summary> | 1573 | </summary> |
1549 | </member> | 1574 | </member> |
1550 | <member name="T:NpgsqlTypes.NpgsqlBackendTypeInfo"> | 1575 | <member name="T:NpgsqlTypes.NpgsqlBackendTypeInfo"> |
@@ -1553,22 +1578,34 @@ | |||
1553 | This class can be called upon to convert a backend field representation to a native object. | 1578 | This class can be called upon to convert a backend field representation to a native object. |
1554 | </summary> | 1579 | </summary> |
1555 | </member> | 1580 | </member> |
1556 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeInfo.#ctor(System.Int32,System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Type,NpgsqlTypes.ConvertBackendToNativeHandler)"> | 1581 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeInfo.#ctor(System.Int32,System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Type,NpgsqlTypes.ConvertBackendTextToNativeHandler,NpgsqlTypes.ConvertBackendBinaryToNativeHandler)"> |
1557 | <summary> | 1582 | <summary> |
1558 | Construct a new NpgsqlTypeInfo with the given attributes and conversion handlers. | 1583 | Construct a new NpgsqlTypeInfo with the given attributes and conversion handlers. |
1559 | </summary> | 1584 | </summary> |
1560 | <param name="OID">Type OID provided by the backend server.</param> | 1585 | <param name="OID">Type OID provided by the backend server.</param> |
1561 | <param name="Name">Type name provided by the backend server.</param> | 1586 | <param name="Name">Type name provided by the backend server.</param> |
1562 | <param name="NpgsqlDbType">NpgsqlDbType</param> | 1587 | <param name="NpgsqlDbType">NpgsqlDbType</param> |
1588 | <param name="DbType">DbType</param> | ||
1563 | <param name="Type">System type to convert fields of this type to.</param> | 1589 | <param name="Type">System type to convert fields of this type to.</param> |
1564 | <param name="ConvertBackendToNative">Data conversion handler.</param> | 1590 | <param name="ConvertBackendTextToNative">Data conversion handler for text encoding.</param> |
1591 | <param name="ConvertBackendBinaryToNative">Data conversion handler for binary data.</param> | ||
1565 | </member> | 1592 | </member> |
1566 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeInfo.ConvertToNative(System.String,System.Int16,System.Int32)"> | 1593 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeInfo.ConvertBackendBinaryToNative(System.Byte[],System.Int32,System.Int32)"> |
1567 | <summary> | 1594 | <summary> |
1568 | Perform a data conversion from a backend representation to | 1595 | Perform a data conversion from a backend representation to |
1569 | a native object. | 1596 | a native object. |
1570 | </summary> | 1597 | </summary> |
1571 | <param name="BackendData">Data sent from the backend.</param> | 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> | ||
1572 | <param name="TypeModifier">Type modifier field sent from the backend.</param> | 1609 | <param name="TypeModifier">Type modifier field sent from the backend.</param> |
1573 | </member> | 1610 | </member> |
1574 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeInfo.OID"> | 1611 | <member name="P:NpgsqlTypes.NpgsqlBackendTypeInfo.OID"> |
@@ -1601,6 +1638,16 @@ | |||
1601 | System type to convert fields of this type to. | 1638 | System type to convert fields of this type to. |
1602 | </summary> | 1639 | </summary> |
1603 | </member> | 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> | ||
1604 | <member name="T:NpgsqlTypes.NpgsqlNativeTypeInfo"> | 1651 | <member name="T:NpgsqlTypes.NpgsqlNativeTypeInfo"> |
1605 | <summary> | 1652 | <summary> |
1606 | Represents a backend data type. | 1653 | Represents a backend data type. |
@@ -1613,24 +1660,28 @@ | |||
1613 | described by the NpgsqlNativeTypeInfo supplied. | 1660 | described by the NpgsqlNativeTypeInfo supplied. |
1614 | </summary> | 1661 | </summary> |
1615 | </member> | 1662 | </member> |
1616 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeInfo.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Boolean,NpgsqlTypes.ConvertNativeToBackendHandler)"> | 1663 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeInfo.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Boolean,NpgsqlTypes.ConvertNativeToBackendTextHandler,NpgsqlTypes.ConvertNativeToBackendBinaryHandler)"> |
1617 | <summary> | 1664 | <summary> |
1618 | Construct a new NpgsqlTypeInfo with the given attributes and conversion handlers. | 1665 | Construct a new NpgsqlTypeInfo with the given attributes and conversion handlers. |
1619 | </summary> | 1666 | </summary> |
1620 | <param name="Name">Type name provided by the backend server.</param> | 1667 | <param name="Name">Type name provided by the backend server.</param> |
1668 | <param name="DbType">DbType</param> | ||
1669 | <param name="Quote">Quote</param> | ||
1621 | <param name="NpgsqlDbType">NpgsqlDbType</param> | 1670 | <param name="NpgsqlDbType">NpgsqlDbType</param> |
1622 | <param name="ConvertNativeToBackend">Data conversion handler.</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> | ||
1623 | </member> | 1673 | </member> |
1624 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeInfo.ConvertToBackend(System.Object,System.Boolean)"> | 1674 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeInfo.ConvertToBackend(System.Object,System.Boolean,NpgsqlTypes.NativeToBackendTypeConverterOptions,System.Boolean)"> |
1625 | <summary> | 1675 | <summary> |
1626 | Perform a data conversion from a native object to | 1676 | Perform a data conversion from a native object to |
1627 | a backend representation. | 1677 | a backend representation. |
1628 | DBNull and null values are handled differently depending if a plain query is used | 1678 | DBNull and null values are handled differently depending if a plain query is used |
1629 | When | 1679 | When |
1630 | </summary> | 1680 | </summary> |
1631 | <param name="NativeData">Native .NET object to be converted.</param> | 1681 | <param name="NativeData">Native .NET object to be converted.</param> |
1632 | <param name="ForExtendedQuery">Flag indicating if the conversion has to be done for | 1682 | <param name="forExtendedQuery">Specifies that the value should be formatted for the extended query syntax.</param> |
1633 | plain queries or extended queries</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> | ||
1634 | </member> | 1685 | </member> |
1635 | <member name="P:NpgsqlTypes.NpgsqlNativeTypeInfo.Name"> | 1686 | <member name="P:NpgsqlTypes.NpgsqlNativeTypeInfo.Name"> |
1636 | <summary> | 1687 | <summary> |
@@ -1657,6 +1708,11 @@ | |||
1657 | Use parameter size information. | 1708 | Use parameter size information. |
1658 | </summary> | 1709 | </summary> |
1659 | </member> | 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> | ||
1660 | <member name="T:NpgsqlTypes.NpgsqlBackendTypeMapping"> | 1716 | <member name="T:NpgsqlTypes.NpgsqlBackendTypeMapping"> |
1661 | <summary> | 1717 | <summary> |
1662 | Provide mapping between type OID, type name, and a NpgsqlBackendTypeInfo object that represents it. | 1718 | Provide mapping between type OID, type name, and a NpgsqlBackendTypeInfo object that represents it. |
@@ -1677,15 +1733,17 @@ | |||
1677 | Add the given NpgsqlBackendTypeInfo to this mapping. | 1733 | Add the given NpgsqlBackendTypeInfo to this mapping. |
1678 | </summary> | 1734 | </summary> |
1679 | </member> | 1735 | </member> |
1680 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.AddType(System.Int32,System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Type,NpgsqlTypes.ConvertBackendToNativeHandler)"> | 1736 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.AddType(System.Int32,System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Type,NpgsqlTypes.ConvertBackendTextToNativeHandler,NpgsqlTypes.ConvertBackendBinaryToNativeHandler)"> |
1681 | <summary> | 1737 | <summary> |
1682 | Add a new NpgsqlBackendTypeInfo with the given attributes and conversion handlers to this mapping. | 1738 | Add a new NpgsqlBackendTypeInfo with the given attributes and conversion handlers to this mapping. |
1683 | </summary> | 1739 | </summary> |
1684 | <param name="OID">Type OID provided by the backend server.</param> | 1740 | <param name="OID">Type OID provided by the backend server.</param> |
1685 | <param name="Name">Type name provided by the backend server.</param> | 1741 | <param name="Name">Type name provided by the backend server.</param> |
1686 | <param name="NpgsqlDbType">NpgsqlDbType</param> | 1742 | <param name="NpgsqlDbType">NpgsqlDbType</param> |
1743 | <param name="DbType">DbType</param> | ||
1687 | <param name="Type">System type to convert fields of this type to.</param> | 1744 | <param name="Type">System type to convert fields of this type to.</param> |
1688 | <param name="BackendConvert">Data conversion handler.</param> | 1745 | <param name="BackendTextConvert">Data conversion handler for text encoding.</param> |
1746 | <param name="BackendBinaryConvert">Data conversion handler for binary data.</param> | ||
1689 | </member> | 1747 | </member> |
1690 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.Clone"> | 1748 | <member name="M:NpgsqlTypes.NpgsqlBackendTypeMapping.Clone"> |
1691 | <summary> | 1749 | <summary> |
@@ -1727,13 +1785,16 @@ | |||
1727 | Add the given NpgsqlNativeTypeInfo to this mapping. | 1785 | Add the given NpgsqlNativeTypeInfo to this mapping. |
1728 | </summary> | 1786 | </summary> |
1729 | </member> | 1787 | </member> |
1730 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.AddType(System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Boolean,NpgsqlTypes.ConvertNativeToBackendHandler)"> | 1788 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.AddType(System.String,NpgsqlTypes.NpgsqlDbType,System.Data.DbType,System.Boolean,NpgsqlTypes.ConvertNativeToBackendTextHandler,NpgsqlTypes.ConvertNativeToBackendBinaryHandler)"> |
1731 | <summary> | 1789 | <summary> |
1732 | Add a new NpgsqlNativeTypeInfo with the given attributes and conversion handlers to this mapping. | 1790 | Add a new NpgsqlNativeTypeInfo with the given attributes and conversion handlers to this mapping. |
1733 | </summary> | 1791 | </summary> |
1734 | <param name="Name">Type name provided by the backend server.</param> | 1792 | <param name="Name">Type name provided by the backend server.</param> |
1735 | <param name="NpgsqlDbType">NpgsqlDbType</param> | 1793 | <param name="NpgsqlDbType">NpgsqlDbType</param> |
1736 | <param name="NativeConvert">Data conversion handler.</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> | ||
1737 | </member> | 1798 | </member> |
1738 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.TryGetValue(NpgsqlTypes.NpgsqlDbType,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> | 1799 | <member name="M:NpgsqlTypes.NpgsqlNativeTypeMapping.TryGetValue(NpgsqlTypes.NpgsqlDbType,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> |
1739 | <summary> | 1800 | <summary> |
@@ -1770,28 +1831,130 @@ | |||
1770 | Get the number of type infos held. | 1831 | Get the number of type infos held. |
1771 | </summary> | 1832 | </summary> |
1772 | </member> | 1833 | </member> |
1773 | <member name="M:Npgsql.SqlGenerators.SqlBaseGenerator.GetColumnsForJoin(Npgsql.SqlGenerators.JoinExpression,Npgsql.SqlGenerators.ProjectionExpression,Npgsql.SqlGenerators.VisitedExpression)"> | 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"> | ||
1774 | <summary> | 1877 | <summary> |
1775 | Given a join expression and a projection, fetch all columns in the projection | 1878 | This class contains helper methods for type conversion between |
1776 | that reference columns in the join. | 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. | ||
1777 | </summary> | 1892 | </summary> |
1778 | </member> | 1893 | </member> |
1779 | <member name="M:Npgsql.SqlGenerators.SqlBaseGenerator.GetFromNames(Npgsql.SqlGenerators.InputExpression,System.Collections.Generic.List{System.String})"> | 1894 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetNativeTypeInfo(NpgsqlTypes.NpgsqlDbType,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> |
1780 | <summary> | 1895 | <summary> |
1781 | Given an InputExpression append all from names (including nested joins) to the list. | 1896 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects |
1897 | of the given NpgsqlDbType. | ||
1782 | </summary> | 1898 | </summary> |
1783 | </member> | 1899 | </member> |
1784 | <member name="M:Npgsql.SqlGenerators.SqlBaseGenerator.GetReplacementColumn(Npgsql.SqlGenerators.JoinExpression,Npgsql.SqlGenerators.ColumnExpression)"> | 1900 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetNativeTypeInfo(System.Data.DbType,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> |
1785 | <summary> | 1901 | <summary> |
1786 | Get new ColumnExpression that will be used in projection that had it's existing columns moved. | 1902 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects |
1787 | These should be simple references to the inner column | 1903 | of the given DbType. |
1788 | </summary> | 1904 | </summary> |
1789 | </member> | 1905 | </member> |
1790 | <member name="M:Npgsql.SqlGenerators.SqlBaseGenerator.AdjustPropertyAccess(Npgsql.SqlGenerators.ColumnExpression[],System.String)"> | 1906 | <member name="M:NpgsqlTypes.NpgsqlTypesHelper.TryGetNativeTypeInfo(System.Type,NpgsqlTypes.NpgsqlNativeTypeInfo@)"> |
1791 | <summary> | 1907 | <summary> |
1792 | Every property accessed in the list of columns must be adjusted for a new scope | 1908 | Find a NpgsqlNativeTypeInfo in the default types map that can handle objects |
1909 | of the given System.Type. | ||
1793 | </summary> | 1910 | </summary> |
1794 | </member> | 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> | ||
1795 | <member name="P:Npgsql.Cache`1.CacheSize"> | 1958 | <member name="P:Npgsql.Cache`1.CacheSize"> |
1796 | <summary> | 1959 | <summary> |
1797 | Set Cache Size. The default value is 20. | 1960 | Set Cache Size. The default value is 20. |
@@ -1805,6 +1968,57 @@ | |||
1805 | <param name="key">key</param> | 1968 | <param name="key">key</param> |
1806 | <returns></returns> | 1969 | <returns></returns> |
1807 | </member> | 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> | ||
1808 | <member name="M:Npgsql.HashAlgorithm.#ctor"> | 2022 | <member name="M:Npgsql.HashAlgorithm.#ctor"> |
1809 | <summary> | 2023 | <summary> |
1810 | Called from constructor of derived class. | 2024 | Called from constructor of derived class. |
@@ -1952,21 +2166,26 @@ | |||
1952 | </summary> | 2166 | </summary> |
1953 | </member> | 2167 | </member> |
1954 | <member name="T:Npgsql.IStreamOwner"> | 2168 | <member name="T:Npgsql.IStreamOwner"> |
1955 | <summary> | 2169 | <summary> |
1956 | Marker interface which identifies a class which may take possession of a stream for the duration of | 2170 | Marker interface which identifies a class which may take possession of a stream for the duration of |
1957 | it's lifetime (possibly temporarily giving that possession to another class for part of that time. | 2171 | it's lifetime (possibly temporarily giving that possession to another class for part of that time. |
1958 | 2172 | ||
1959 | It inherits from IDisposable, since any such class must make sure it leaves the stream in a valid state. | 2173 | It inherits from IDisposable, since any such class must make sure it leaves the stream in a valid state. |
1960 | 2174 | ||
1961 | The most important such class is that compiler-generated from ProcessBackendResponsesEnum. Of course | 2175 | The most important such class is that compiler-generated from ProcessBackendResponsesEnum. Of course |
1962 | we can't make that inherit from this interface, alas. | 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. | ||
1963 | </summary> | 2183 | </summary> |
1964 | </member> | 2184 | </member> |
1965 | <!-- Badly formed XML comment ignored for member "T:Npgsql.IServerResponseObject" --> | ||
1966 | <member name="T:Npgsql.RowReader.Streamer"> | 2185 | <member name="T:Npgsql.RowReader.Streamer"> |
1967 | <summary> | 2186 | <summary> |
1968 | Reads part of a field, as needed (for <see cref="!:System.Data.IDataRecord.GetChars()"/> | 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)"/> |
1969 | and <see cref="!:System.Data.IDataRecord.GetBytes()"/> | 2188 | and <see cref="M:System.Data.IDataRecord.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> |
1970 | </summary> | 2189 | </summary> |
1971 | </member> | 2190 | </member> |
1972 | <member name="T:Npgsql.RowReader.Streamer`1"> | 2191 | <member name="T:Npgsql.RowReader.Streamer`1"> |
@@ -2021,57 +2240,15 @@ | |||
2021 | </summary> | 2240 | </summary> |
2022 | 2241 | ||
2023 | </member> | 2242 | </member> |
2024 | <member name="T:Npgsql.NpgsqlState"> | 2243 | <member name="T:Npgsql.NpgsqlCommand"> |
2025 | <summary> This class represents the base class for the state pattern design pattern | ||
2026 | implementation. | ||
2027 | </summary> | ||
2028 | |||
2029 | </member> | ||
2030 | <member name="M:Npgsql.NpgsqlState.ChangeState(Npgsql.NpgsqlConnector,Npgsql.NpgsqlState)"> | ||
2031 | <summary> | ||
2032 | This method is used by the states to change the state of the context. | ||
2033 | </summary> | ||
2034 | </member> | ||
2035 | <member name="M:Npgsql.NpgsqlState.ProcessBackendResponses(Npgsql.NpgsqlConnector)"> | ||
2036 | <summary> | ||
2037 | This method is responsible to handle all protocol messages sent from the backend. | ||
2038 | It holds all the logic to do it. | ||
2039 | To exchange data, it uses a Mediator object from which it reads/writes information | ||
2040 | to handle backend requests. | ||
2041 | </summary> | ||
2042 | |||
2043 | </member> | ||
2044 | <member name="M:Npgsql.NpgsqlState.ProcessBackendResponsesEnum(Npgsql.NpgsqlConnector)"> | ||
2045 | <summary> | ||
2046 | This method is responsible to handle all protocol messages sent from the backend. | ||
2047 | It holds all the logic to do it. | ||
2048 | To exchange data, it uses a Mediator object from which it reads/writes information | ||
2049 | to handle backend requests. | ||
2050 | </summary> | ||
2051 | |||
2052 | </member> | ||
2053 | <member name="M:Npgsql.NpgsqlState.CheckForContextSocketAvailability(Npgsql.NpgsqlConnector,System.Net.Sockets.SelectMode)"> | ||
2054 | <summary> | 2244 | <summary> |
2055 | Checks for context socket availability. | 2245 | Represents a SQL statement or function (stored procedure) to execute |
2056 | Socket.Poll supports integer as microseconds parameter. | 2246 | against a PostgreSQL database. This class cannot be inherited. |
2057 | This limits the usable command timeout value | ||
2058 | to 2,147 seconds: (2,147 x 1,000,000 less than max_int). | ||
2059 | In order to bypass this limit, the availability of | ||
2060 | the socket is checked in 2,147 seconds cycles | ||
2061 | </summary> | 2247 | </summary> |
2062 | <returns><c>true</c>, if for context socket availability was checked, <c>false</c> otherwise.</returns> | ||
2063 | <param name="context">Context.</param> | ||
2064 | <param name="selectMode">Select mode.</param> | ||
2065 | </member> | ||
2066 | <member name="M:Npgsql.NpgsqlClosedState.ResolveIPHost(System.String)"> | ||
2067 | <summary> | 2248 | <summary> |
2068 | Resolve a host name or IP address. | 2249 | Represents a SQL statement or function (stored procedure) to execute |
2069 | This is needed because if you call Dns.Resolve() with an IP address, it will attempt | 2250 | against a PostgreSQL database. This class cannot be inherited. |
2070 | to resolve it as a host name, when it should just convert it to an IP address. | ||
2071 | </summary> | 2251 | </summary> |
2072 | <param name="HostName"></param> | ||
2073 | </member> | ||
2074 | <member name="T:Npgsql.NpgsqlCommand"> | ||
2075 | <summary> | 2252 | <summary> |
2076 | Represents a SQL statement or function (stored procedure) to execute | 2253 | Represents a SQL statement or function (stored procedure) to execute |
2077 | against a PostgreSQL database. This class cannot be inherited. | 2254 | against a PostgreSQL database. This class cannot be inherited. |
@@ -2103,7 +2280,7 @@ | |||
2103 | <param name="connection">A <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> that represents the connection to a PostgreSQL server.</param> | 2280 | <param name="connection">A <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> that represents the connection to a PostgreSQL server.</param> |
2104 | <param name="transaction">The <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see> in which the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> executes.</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> |
2105 | </member> | 2282 | </member> |
2106 | <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnector)"> | 2283 | <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnector,System.Int32)"> |
2107 | <summary> | 2284 | <summary> |
2108 | Used to execute internal commands. | 2285 | Used to execute internal commands. |
2109 | </summary> | 2286 | </summary> |
@@ -2140,8 +2317,10 @@ | |||
2140 | </member> | 2317 | </member> |
2141 | <member name="M:Npgsql.NpgsqlCommand.ExecuteBlind"> | 2318 | <member name="M:Npgsql.NpgsqlCommand.ExecuteBlind"> |
2142 | <summary> | 2319 | <summary> |
2143 | Slightly optimised version of ExecuteNonQuery() for internal ues in cases where the number | 2320 | Slightly optimised version of ExecuteNonQuery() for internal use in cases where the number |
2144 | of affected rows is of no interest. | 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. | ||
2145 | </summary> | 2324 | </summary> |
2146 | </member> | 2325 | </member> |
2147 | <member name="M:Npgsql.NpgsqlCommand.ExecuteNonQuery"> | 2326 | <member name="M:Npgsql.NpgsqlCommand.ExecuteNonQuery"> |
@@ -2213,6 +2392,36 @@ | |||
2213 | </summary> | 2392 | </summary> |
2214 | <returns>A version of <see cref="P:Npgsql.NpgsqlCommand.CommandText">CommandText</see> with the <see cref="P:Npgsql.NpgsqlCommand.Parameters">Parameters</see> inserted.</returns> | 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> |
2215 | </member> | 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> | ||
2216 | <member name="P:Npgsql.NpgsqlCommand.CommandText"> | 2425 | <member name="P:Npgsql.NpgsqlCommand.CommandText"> |
2217 | <summary> | 2426 | <summary> |
2218 | Gets or sets the SQL statement or function (stored procedure) to execute at the data source. | 2427 | Gets or sets the SQL statement or function (stored procedure) to execute at the data source. |
@@ -2273,20 +2482,194 @@ | |||
2273 | This class is responsible to create database commands for automatic insert, update and delete operations. | 2482 | This class is responsible to create database commands for automatic insert, update and delete operations. |
2274 | </summary> | 2483 | </summary> |
2275 | </member> | 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> | ||
2276 | <member name="M:Npgsql.NpgsqlCommandBuilder.DeriveParameters(Npgsql.NpgsqlCommand)"> | 2496 | <member name="M:Npgsql.NpgsqlCommandBuilder.DeriveParameters(Npgsql.NpgsqlCommand)"> |
2277 | <summary> | 2497 | <summary> |
2278 | 2498 | ||
2279 | This method is reponsible to derive the command parameter list with values obtained from function definition. | 2499 | This method is reponsible to derive the command parameter list with values obtained from function definition. |
2280 | 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. | 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. |
2281 | Parameters name will be parameter1, parameter2, ... | 2501 | Parameters name will be parameter1, parameter2, ... |
2282 | For while, only parameter name and NpgsqlDbType are obtained. | ||
2283 | </summary> | 2502 | </summary> |
2284 | <param name="command">NpgsqlCommand whose function parameters will be obtained.</param> | 2503 | <param name="command">NpgsqlCommand whose function parameters will be obtained.</param> |
2285 | </member> | 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> | ||
2286 | <member name="T:Npgsql.NoticeEventHandler"> | 2668 | <member name="T:Npgsql.NoticeEventHandler"> |
2287 | <summary> | 2669 | <summary> |
2288 | Represents the method that handles the <see cref="E:Npgsql.NpgsqlConnection.Notification">Notice</see> events. | 2670 | Represents the method that handles the <see cref="E:Npgsql.NpgsqlConnection.Notification">Notice</see> events. |
2289 | </summary> | 2671 | </summary> |
2672 | <param name="sender">The source of the event.</param> | ||
2290 | <param name="e">A <see cref="T:Npgsql.NpgsqlNoticeEventArgs">NpgsqlNoticeEventArgs</see> that contains the event data.</param> | 2673 | <param name="e">A <see cref="T:Npgsql.NpgsqlNoticeEventArgs">NpgsqlNoticeEventArgs</see> that contains the event data.</param> |
2291 | </member> | 2674 | </member> |
2292 | <member name="T:Npgsql.NotificationEventHandler"> | 2675 | <member name="T:Npgsql.NotificationEventHandler"> |
@@ -2316,6 +2699,14 @@ | |||
2316 | </summary> | 2699 | </summary> |
2317 | <param name="ConnectionString">The connection used to open the PostgreSQL database.</param> | 2700 | <param name="ConnectionString">The connection used to open the PostgreSQL database.</param> |
2318 | </member> | 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> | ||
2319 | <member name="M:Npgsql.NpgsqlConnection.BeginDbTransaction(System.Data.IsolationLevel)"> | 2710 | <member name="M:Npgsql.NpgsqlConnection.BeginDbTransaction(System.Data.IsolationLevel)"> |
2320 | <summary> | 2711 | <summary> |
2321 | Begins a database transaction with the specified isolation level. | 2712 | Begins a database transaction with the specified isolation level. |
@@ -2366,7 +2757,13 @@ | |||
2366 | <member name="M:Npgsql.NpgsqlConnection.Close"> | 2757 | <member name="M:Npgsql.NpgsqlConnection.Close"> |
2367 | <summary> | 2758 | <summary> |
2368 | Releases the connection to the database. If the connection is pooled, it will be | 2759 | Releases the connection to the database. If the connection is pooled, it will be |
2369 | made available for re-use. If it is non-pooled, the actual connection will be shutdown. | 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. | ||
2370 | </summary> | 2767 | </summary> |
2371 | </member> | 2768 | </member> |
2372 | <member name="M:Npgsql.NpgsqlConnection.CreateDbCommand"> | 2769 | <member name="M:Npgsql.NpgsqlConnection.CreateDbCommand"> |
@@ -2403,6 +2800,11 @@ | |||
2403 | </summary> | 2800 | </summary> |
2404 | <returns>A new NpgsqlConnection object.</returns> | 2801 | <returns>A new NpgsqlConnection object.</returns> |
2405 | </member> | 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> | ||
2406 | <member name="M:Npgsql.NpgsqlConnection.DefaultCertificateSelectionCallback(System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Cryptography.X509Certificates.X509Certificate,System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection)"> | 2808 | <member name="M:Npgsql.NpgsqlConnection.DefaultCertificateSelectionCallback(System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Cryptography.X509Certificates.X509Certificate,System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection)"> |
2407 | <summary> | 2809 | <summary> |
2408 | Default SSL CertificateSelectionCallback implementation. | 2810 | Default SSL CertificateSelectionCallback implementation. |
@@ -2423,11 +2825,33 @@ | |||
2423 | Default SSL ProvideClientCertificatesCallback implementation. | 2825 | Default SSL ProvideClientCertificatesCallback implementation. |
2424 | </summary> | 2826 | </summary> |
2425 | </member> | 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> | ||
2426 | <member name="M:Npgsql.NpgsqlConnection.LogConnectionString"> | 2833 | <member name="M:Npgsql.NpgsqlConnection.LogConnectionString"> |
2427 | <summary> | 2834 | <summary> |
2428 | Write each key/value pair in the connection string to the log. | 2835 | Write each key/value pair in the connection string to the log. |
2429 | </summary> | 2836 | </summary> |
2430 | </member> | 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> | ||
2431 | <member name="M:Npgsql.NpgsqlConnection.GetSchema"> | 2855 | <member name="M:Npgsql.NpgsqlConnection.GetSchema"> |
2432 | <summary> | 2856 | <summary> |
2433 | Returns the supported collections | 2857 | Returns the supported collections |
@@ -2481,6 +2905,11 @@ | |||
2481 | Mono.Security.Protocol.Tls.PrivateKeySelectionCallback delegate. | 2905 | Mono.Security.Protocol.Tls.PrivateKeySelectionCallback delegate. |
2482 | </summary> | 2906 | </summary> |
2483 | </member> | 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> | ||
2484 | <member name="P:Npgsql.NpgsqlConnection.ConnectionString"> | 2913 | <member name="P:Npgsql.NpgsqlConnection.ConnectionString"> |
2485 | <summary> | 2914 | <summary> |
2486 | Gets or sets the string used to connect to a PostgreSQL database. | 2915 | Gets or sets the string used to connect to a PostgreSQL database. |
@@ -2636,6 +3065,24 @@ | |||
2636 | This can only be called when there is an active connection. | 3065 | This can only be called when there is an active connection. |
2637 | </summary> | 3066 | </summary> |
2638 | </member> | 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> | ||
2639 | <member name="P:Npgsql.NpgsqlConnection.Connector"> | 3086 | <member name="P:Npgsql.NpgsqlConnection.Connector"> |
2640 | <summary> | 3087 | <summary> |
2641 | The connector object connected to the backend. | 3088 | The connector object connected to the backend. |
@@ -2666,12 +3113,20 @@ | |||
2666 | Return an exact copy of this NpgsqlConnectionString. | 3113 | Return an exact copy of this NpgsqlConnectionString. |
2667 | </summary> | 3114 | </summary> |
2668 | </member> | 3115 | </member> |
2669 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.SetValue(System.String,System.Object)"> | 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)"> | ||
2670 | <summary> | 3123 | <summary> |
2671 | This function will set value for known key, both private member and base[key]. | 3124 | This function will set value for known key, both private member and base[key]. |
2672 | </summary> | 3125 | </summary> |
2673 | <param name="keyword"></param> | 3126 | <param name="keyword"></param> |
3127 | <param name="key"></param> | ||
2674 | <param name="value"></param> | 3128 | <param name="value"></param> |
3129 | <returns>value, coerced as needed to the stored type.</returns> | ||
2675 | </member> | 3130 | </member> |
2676 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.SetValue(Npgsql.Keywords,System.Object)"> | 3131 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.SetValue(Npgsql.Keywords,System.Object)"> |
2677 | <summary> | 3132 | <summary> |
@@ -2679,29 +3134,190 @@ | |||
2679 | </summary> | 3134 | </summary> |
2680 | <param name="keyword"></param> | 3135 | <param name="keyword"></param> |
2681 | <param name="value"></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> | ||
2682 | </member> | 3145 | </member> |
2683 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Clear"> | 3146 | <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Clear"> |
2684 | <summary> | 3147 | <summary> |
2685 | Clear the member and assign them to the default value. | 3148 | Clear the member and assign them to the default value. |
2686 | </summary> | 3149 | </summary> |
2687 | </member> | 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> | ||
2688 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Compatible"> | 3269 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Compatible"> |
2689 | <summary> | 3270 | <summary> |
2690 | Compatibilty version. When possible, behaviour caused by breaking changes will be preserved | 3271 | Compatibilty version. When possible, behaviour caused by breaking changes will be preserved |
2691 | if this version is less than that where the breaking change was introduced. | 3272 | if this version is less than that where the breaking change was introduced. |
2692 | </summary> | 3273 | </summary> |
2693 | </member> | 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> | ||
2694 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Item(System.String)"> | 3285 | <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Item(System.String)"> |
2695 | <summary> | 3286 | <summary> |
2696 | Case insensative accessor for indivual connection string values. | 3287 | Case insensative accessor for indivual connection string values. |
2697 | </summary> | 3288 | </summary> |
2698 | </member> | 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> | ||
2699 | <member name="T:Npgsql.ProvideClientCertificatesCallback"> | 3307 | <member name="T:Npgsql.ProvideClientCertificatesCallback"> |
2700 | <summary> | 3308 | <summary> |
2701 | Represents the method that allows the application to provide a certificate collection to be used for SSL clien authentication | 3309 | Represents the method that allows the application to provide a certificate collection to be used for SSL clien authentication |
2702 | </summary> | 3310 | </summary> |
2703 | <param name="certificates">A <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection">X509CertificateCollection</see> to be filled with one or more client certificates.</param> | 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> |
2704 | </member> | 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> | ||
2705 | <member name="T:Npgsql.NpgsqlConnector"> | 3321 | <member name="T:Npgsql.NpgsqlConnector"> |
2706 | <summary> | 3322 | <summary> |
2707 | !!! Helper class, for compilation only. | 3323 | !!! Helper class, for compilation only. |
@@ -2714,6 +3330,8 @@ | |||
2714 | <summary> | 3330 | <summary> |
2715 | Constructor. | 3331 | Constructor. |
2716 | </summary> | 3332 | </summary> |
3333 | <param name="ConnectionString">Connection string.</param> | ||
3334 | <param name="Pooled">Pooled</param> | ||
2717 | <param name="Shared">Controls whether the connector can be shared.</param> | 3335 | <param name="Shared">Controls whether the connector can be shared.</param> |
2718 | </member> | 3336 | </member> |
2719 | <member name="M:Npgsql.NpgsqlConnector.IsValid"> | 3337 | <member name="M:Npgsql.NpgsqlConnector.IsValid"> |
@@ -2752,6 +3370,11 @@ | |||
2752 | Default SSL ProvideClientCertificatesCallback implementation. | 3370 | Default SSL ProvideClientCertificatesCallback implementation. |
2753 | </summary> | 3371 | </summary> |
2754 | </member> | 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> | ||
2755 | <member name="M:Npgsql.NpgsqlConnector.ProcessServerVersion"> | 3378 | <member name="M:Npgsql.NpgsqlConnector.ProcessServerVersion"> |
2756 | <summary> | 3379 | <summary> |
2757 | This method is required to set all the version dependent features flags. | 3380 | This method is required to set all the version dependent features flags. |
@@ -2810,6 +3433,11 @@ | |||
2810 | Mono.Security.Protocol.Tls.PrivateKeySelectionCallback delegate. | 3433 | Mono.Security.Protocol.Tls.PrivateKeySelectionCallback delegate. |
2811 | </summary> | 3434 | </summary> |
2812 | </member> | 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> | ||
2813 | <member name="P:Npgsql.NpgsqlConnector.State"> | 3441 | <member name="P:Npgsql.NpgsqlConnector.State"> |
2814 | <summary> | 3442 | <summary> |
2815 | Gets the current state of the connection. | 3443 | Gets the current state of the connection. |
@@ -2830,14 +3458,19 @@ | |||
2830 | Backend protocol version in use by this connector. | 3458 | Backend protocol version in use by this connector. |
2831 | </summary> | 3459 | </summary> |
2832 | </member> | 3460 | </member> |
2833 | <member name="P:Npgsql.NpgsqlConnector.Stream"> | 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"> | ||
2834 | <summary> | 3467 | <summary> |
2835 | The physical connection stream to the backend. | 3468 | The physical connection stream to the backend. |
2836 | </summary> | 3469 | </summary> |
2837 | </member> | 3470 | </member> |
2838 | <member name="P:Npgsql.NpgsqlConnector.Socket"> | 3471 | <member name="P:Npgsql.NpgsqlConnector.Stream"> |
2839 | <summary> | 3472 | <summary> |
2840 | The physical connection socket to the backend. | 3473 | The top level stream to the backend. |
2841 | </summary> | 3474 | </summary> |
2842 | </member> | 3475 | </member> |
2843 | <member name="P:Npgsql.NpgsqlConnector.IsInitialized"> | 3476 | <member name="P:Npgsql.NpgsqlConnector.IsInitialized"> |
@@ -2860,6 +3493,12 @@ | |||
2860 | Report whether the current connection can support prepare functionality. | 3493 | Report whether the current connection can support prepare functionality. |
2861 | </summary> | 3494 | </summary> |
2862 | </member> | 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> | ||
2863 | <member name="T:Npgsql.NpgsqlConnectorPool"> | 3502 | <member name="T:Npgsql.NpgsqlConnectorPool"> |
2864 | <summary> | 3503 | <summary> |
2865 | This class manages all connector objects, pooled AND non-pooled. | 3504 | This class manages all connector objects, pooled AND non-pooled. |
@@ -2888,11 +3527,6 @@ | |||
2888 | pool for available connectors.</param> | 3527 | pool for available connectors.</param> |
2889 | <returns>A connector object.</returns> | 3528 | <returns>A connector object.</returns> |
2890 | </member> | 3529 | </member> |
2891 | <member name="M:Npgsql.NpgsqlConnectorPool.RequestPooledConnector(Npgsql.NpgsqlConnection)"> | ||
2892 | <summary> | ||
2893 | Find a pooled connector. Handle locking and timeout here. | ||
2894 | </summary> | ||
2895 | </member> | ||
2896 | <member name="M:Npgsql.NpgsqlConnectorPool.RequestPooledConnectorInternal(Npgsql.NpgsqlConnection)"> | 3530 | <member name="M:Npgsql.NpgsqlConnectorPool.RequestPooledConnectorInternal(Npgsql.NpgsqlConnection)"> |
2897 | <summary> | 3531 | <summary> |
2898 | Find a pooled connector. Handle shared/non-shared here. | 3532 | Find a pooled connector. Handle shared/non-shared here. |
@@ -2907,48 +3541,25 @@ | |||
2907 | Shared connectors should just have their use count decremented | 3541 | Shared connectors should just have their use count decremented |
2908 | since they always stay in the shared pool. | 3542 | since they always stay in the shared pool. |
2909 | </remarks> | 3543 | </remarks> |
3544 | <param name="Connection">Connection to which the connector is leased.</param> | ||
2910 | <param name="Connector">The connector to release.</param> | 3545 | <param name="Connector">The connector to release.</param> |
2911 | </member> | 3546 | </member> |
2912 | <member name="M:Npgsql.NpgsqlConnectorPool.ReleasePooledConnector(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)"> | 3547 | <member name="M:Npgsql.NpgsqlConnectorPool.ReleaseConnectorInternal(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)"> |
2913 | <summary> | ||
2914 | Release a pooled connector. Handle locking here. | ||
2915 | </summary> | ||
2916 | </member> | ||
2917 | <member name="M:Npgsql.NpgsqlConnectorPool.ReleasePooledConnectorInternal(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)"> | ||
2918 | <summary> | 3548 | <summary> |
2919 | Release a pooled connector. Handle shared/non-shared here. | 3549 | Release a pooled connector. Handle shared/non-shared here. |
2920 | </summary> | 3550 | </summary> |
2921 | </member> | 3551 | </member> |
2922 | <member name="M:Npgsql.NpgsqlConnectorPool.GetNonPooledConnector(Npgsql.NpgsqlConnection)"> | ||
2923 | <summary> | ||
2924 | Create a connector without any pooling functionality. | ||
2925 | </summary> | ||
2926 | </member> | ||
2927 | <member name="M:Npgsql.NpgsqlConnectorPool.GetPooledConnector(Npgsql.NpgsqlConnection)"> | 3552 | <member name="M:Npgsql.NpgsqlConnectorPool.GetPooledConnector(Npgsql.NpgsqlConnection)"> |
2928 | <summary> | 3553 | <summary> |
2929 | Find an available pooled connector in the non-shared pool, or create | 3554 | Find an available pooled connector in the non-shared pool, or create |
2930 | a new one if none found. | 3555 | a new one if none found. |
2931 | </summary> | 3556 | </summary> |
2932 | </member> | 3557 | </member> |
2933 | <member name="M:Npgsql.NpgsqlConnectorPool.FixPoolCountBecauseOfConnectionDisposeFalse(Npgsql.NpgsqlConnection)"> | 3558 | <member name="M:Npgsql.NpgsqlConnectorPool.UngetConnector(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)"> |
2934 | <summary> | ||
2935 | This method is only called when NpgsqlConnection.Dispose(false) is called which means a | ||
2936 | finalization. This also means, an NpgsqlConnection was leak. We clear pool count so that | ||
2937 | client doesn't end running out of connections from pool. When the connection is finalized, its underlying | ||
2938 | socket is closed. | ||
2939 | </summary> | ||
2940 | </member> | ||
2941 | <member name="M:Npgsql.NpgsqlConnectorPool.UngetNonPooledConnector(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)"> | ||
2942 | <summary> | ||
2943 | Close the connector. | ||
2944 | </summary> | ||
2945 | <param name="Connection"></param> | ||
2946 | <param name="Connector">Connector to release</param> | ||
2947 | </member> | ||
2948 | <member name="M:Npgsql.NpgsqlConnectorPool.UngetPooledConnector(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)"> | ||
2949 | <summary> | 3559 | <summary> |
2950 | Put a pooled connector into the pool queue. | 3560 | Put a pooled connector into the pool queue. |
2951 | </summary> | 3561 | </summary> |
3562 | <param name="Connection">Connection <paramref name="Connector"/> is leased to.</param> | ||
2952 | <param name="Connector">Connector to pool</param> | 3563 | <param name="Connector">Connector to pool</param> |
2953 | </member> | 3564 | </member> |
2954 | <member name="T:Npgsql.NpgsqlConnectorPool.ConnectorQueue"> | 3565 | <member name="T:Npgsql.NpgsqlConnectorPool.ConnectorQueue"> |
@@ -3437,8 +4048,8 @@ | |||
3437 | <member name="M:Npgsql.NpgsqlDataReader.GetInterval(System.Int32)"> | 4048 | <member name="M:Npgsql.NpgsqlDataReader.GetInterval(System.Int32)"> |
3438 | <summary> | 4049 | <summary> |
3439 | Get the value of a column as a <see cref="T:NpgsqlTypes.NpgsqlInterval"/>. | 4050 | Get the value of a column as a <see cref="T:NpgsqlTypes.NpgsqlInterval"/>. |
3440 | <remarks>If the differences between <see cref="T:NpgsqlTypes.NpgsqlInterval"/> and <see cref="!:System.Timespan"/> | 4051 | <remarks>If the differences between <see cref="T:NpgsqlTypes.NpgsqlInterval"/> and <see cref="T:System.TimeSpan"/> |
3441 | in handling of days and months is not important to your application, use <see cref="!:GetTimeSpan()"/> | 4052 | in handling of days and months is not important to your application, use <see cref="M:Npgsql.NpgsqlDataReader.GetTimeSpan(System.Int32)"/> |
3442 | instead.</remarks> | 4053 | instead.</remarks> |
3443 | </summary> | 4054 | </summary> |
3444 | <param name="i">Index of the field to find.</param> | 4055 | <param name="i">Index of the field to find.</param> |
@@ -3491,13 +4102,14 @@ | |||
3491 | </member> | 4102 | </member> |
3492 | <member name="M:Npgsql.NpgsqlDataReader.GetValues(System.Object[])"> | 4103 | <member name="M:Npgsql.NpgsqlDataReader.GetValues(System.Object[])"> |
3493 | <summary> | 4104 | <summary> |
3494 | Copy values from each column in the current row into <param name="Values"></param>. | 4105 | Copy values from each column in the current row into <paramref name="values"/>. |
3495 | </summary> | 4106 | </summary> |
4107 | <param name="values">Destination for column values.</param> | ||
3496 | <returns>The number of column values copied.</returns> | 4108 | <returns>The number of column values copied.</returns> |
3497 | </member> | 4109 | </member> |
3498 | <member name="M:Npgsql.NpgsqlDataReader.GetProviderSpecificValues(System.Object[])"> | 4110 | <member name="M:Npgsql.NpgsqlDataReader.GetProviderSpecificValues(System.Object[])"> |
3499 | <summary> | 4111 | <summary> |
3500 | Copy values from each column in the current row into <param name="Values"></param>. | 4112 | Copy values from each column in the current row into <paramref name="values"></paramref>. |
3501 | </summary> | 4113 | </summary> |
3502 | <param name="values">An array appropriately sized to store values from all columns.</param> | 4114 | <param name="values">An array appropriately sized to store values from all columns.</param> |
3503 | <returns>The number of column values copied.</returns> | 4115 | <returns>The number of column values copied.</returns> |
@@ -3575,14 +4187,14 @@ | |||
3575 | </member> | 4187 | </member> |
3576 | <member name="T:Npgsql.ForwardsOnlyDataReader"> | 4188 | <member name="T:Npgsql.ForwardsOnlyDataReader"> |
3577 | <summary> | 4189 | <summary> |
3578 | This is the primary implementation of NpgsqlDataReader. It is the one used in normal cases (where the | 4190 | This is the primary implementation of NpgsqlDataReader. It is the one used in normal cases (where the |
3579 | preload-reader option is not set in the connection string to resolve some potential backwards-compatibility | 4191 | preload-reader option is not set in the connection string to resolve some potential backwards-compatibility |
3580 | issues), the only implementation used internally, and in cases where CachingDataReader is used, it is still | 4192 | issues), the only implementation used internally, and in cases where CachingDataReader is used, it is still |
3581 | used to do the actual "leg-work" of turning a response stream from the server into a datareader-style | 4193 | used to do the actual "leg-work" of turning a response stream from the server into a datareader-style |
3582 | object - with CachingDataReader then filling it's cache from here. | 4194 | object - with CachingDataReader then filling it's cache from here. |
3583 | </summary> | 4195 | </summary> |
3584 | </member> | 4196 | </member> |
3585 | <member name="M:Npgsql.ForwardsOnlyDataReader.GetNextResponseObject"> | 4197 | <member name="M:Npgsql.ForwardsOnlyDataReader.GetNextResponseObject(System.Boolean)"> |
3586 | <summary> | 4198 | <summary> |
3587 | Iterate through the objects returned through from the server. | 4199 | Iterate through the objects returned through from the server. |
3588 | If it's a CompletedResponse the rowsaffected count is updated appropriately, | 4200 | If it's a CompletedResponse the rowsaffected count is updated appropriately, |
@@ -3671,7 +4283,20 @@ | |||
3671 | </member> | 4283 | </member> |
3672 | <member name="T:Npgsql.NpgsqlDescribe"> | 4284 | <member name="T:Npgsql.NpgsqlDescribe"> |
3673 | <summary> | 4285 | <summary> |
3674 | This class represents the Parse message sent to PostgreSQL | 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 | ||
3675 | server. | 4300 | server. |
3676 | </summary> | 4301 | </summary> |
3677 | 4302 | ||
@@ -3757,6 +4382,31 @@ | |||
3757 | Source routine (in backend) reporting the error. PostgreSQL 7.4 and up. | 4382 | Source routine (in backend) reporting the error. PostgreSQL 7.4 and up. |
3758 | </summary> | 4383 | </summary> |
3759 | </member> | 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> | ||
3760 | <member name="P:Npgsql.NpgsqlError.ErrorSql"> | 4410 | <member name="P:Npgsql.NpgsqlError.ErrorSql"> |
3761 | <summary> | 4411 | <summary> |
3762 | String containing the sql sent which produced this error. | 4412 | String containing the sql sent which produced this error. |
@@ -3767,6 +4417,116 @@ | |||
3767 | Backend protocol version in use. | 4417 | Backend protocol version in use. |
3768 | </summary> | 4418 | </summary> |
3769 | </member> | 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> | ||
3770 | <member name="T:Npgsql.LogLevel"> | 4530 | <member name="T:Npgsql.LogLevel"> |
3771 | <summary> | 4531 | <summary> |
3772 | The level of verbosity of the NpgsqlEventLog | 4532 | The level of verbosity of the NpgsqlEventLog |
@@ -3989,6 +4749,31 @@ | |||
3989 | Source routine (in backend) reporting the error. PostgreSQL 7.4 and up. | 4749 | Source routine (in backend) reporting the error. PostgreSQL 7.4 and up. |
3990 | </summary> | 4750 | </summary> |
3991 | </member> | 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> | ||
3992 | <member name="P:Npgsql.NpgsqlException.ErrorSql"> | 4777 | <member name="P:Npgsql.NpgsqlException.ErrorSql"> |
3993 | <summary> | 4778 | <summary> |
3994 | String containing the sql sent which produced this error. | 4779 | String containing the sql sent which produced this error. |
@@ -4001,7 +4786,7 @@ | |||
4001 | </member> | 4786 | </member> |
4002 | <member name="T:Npgsql.NpgsqlExecute"> | 4787 | <member name="T:Npgsql.NpgsqlExecute"> |
4003 | <summary> | 4788 | <summary> |
4004 | This class represents the Parse message sent to PostgreSQL | 4789 | This class represents the Execute message sent to PostgreSQL |
4005 | server. | 4790 | server. |
4006 | </summary> | 4791 | </summary> |
4007 | 4792 | ||
@@ -4018,11 +4803,18 @@ | |||
4018 | </member> | 4803 | </member> |
4019 | <member name="T:Npgsql.NpgsqlFlush"> | 4804 | <member name="T:Npgsql.NpgsqlFlush"> |
4020 | <summary> | 4805 | <summary> |
4021 | This class represents the Parse message sent to PostgreSQL | 4806 | This class represents the Flush message sent to PostgreSQL |
4022 | server. | 4807 | server. |
4023 | </summary> | 4808 | </summary> |
4024 | 4809 | ||
4025 | </member> | 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> | ||
4026 | <member name="T:Npgsql.NpgsqlMediator"> | 4818 | <member name="T:Npgsql.NpgsqlMediator"> |
4027 | <summary> | 4819 | <summary> |
4028 | This class is responsible for serving as bridge between the backend | 4820 | This class is responsible for serving as bridge between the backend |
@@ -4135,6 +4927,11 @@ | |||
4135 | </summary> | 4927 | </summary> |
4136 | <returns>A new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> that is a copy of this instance.</returns> | 4928 | <returns>A new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> that is a copy of this instance.</returns> |
4137 | </member> | 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> | ||
4138 | <member name="P:Npgsql.NpgsqlParameter.Precision"> | 4935 | <member name="P:Npgsql.NpgsqlParameter.Precision"> |
4139 | <summary> | 4936 | <summary> |
4140 | Gets or sets the maximum number of digits used to represent the | 4937 | Gets or sets the maximum number of digits used to represent the |
@@ -4241,6 +5038,12 @@ | |||
4241 | Initializes a new instance of the NpgsqlParameterCollection class. | 5038 | Initializes a new instance of the NpgsqlParameterCollection class. |
4242 | </summary> | 5039 | </summary> |
4243 | </member> | 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> | ||
4244 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(Npgsql.NpgsqlParameter)"> | 5047 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(Npgsql.NpgsqlParameter)"> |
4245 | <summary> | 5048 | <summary> |
4246 | Adds the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see>. | 5049 | Adds the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see>. |
@@ -4250,11 +5053,8 @@ | |||
4250 | </member> | 5053 | </member> |
4251 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,System.Object)"> | 5054 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,System.Object)"> |
4252 | <summary> | 5055 | <summary> |
4253 | 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. | 5056 | Obsolete. Use AddWithValue instead. |
4254 | </summary> | 5057 | </summary> |
4255 | <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param> | ||
4256 | <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param> | ||
4257 | <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns> | ||
4258 | <remarks> | 5058 | <remarks> |
4259 | Use caution when using this overload of the | 5059 | Use caution when using this overload of the |
4260 | <b>Add</b> method to specify integer parameter values. | 5060 | <b>Add</b> method to specify integer parameter values. |
@@ -4266,6 +5066,44 @@ | |||
4266 | are attempting to call the NpgsqlParameterCollection.Add(string, DbType) overload. | 5066 | are attempting to call the NpgsqlParameterCollection.Add(string, DbType) overload. |
4267 | </remarks> | 5067 | </remarks> |
4268 | </member> | 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> | ||
4269 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType)"> | 5107 | <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType)"> |
4270 | <summary> | 5108 | <summary> |
4271 | 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. | 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. |
@@ -4324,13 +5162,19 @@ | |||
4324 | Inserts a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> into the collection at the specified index. | 5162 | Inserts a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> into the collection at the specified index. |
4325 | </summary> | 5163 | </summary> |
4326 | <param name="index">The zero-based index where the parameter is to be inserted within the collection.</param> | 5164 | <param name="index">The zero-based index where the parameter is to be inserted within the collection.</param> |
4327 | <param name="value">The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to 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> | ||
4328 | </member> | 5172 | </member> |
4329 | <member name="M:Npgsql.NpgsqlParameterCollection.Remove(System.Object)"> | 5173 | <member name="M:Npgsql.NpgsqlParameterCollection.Remove(System.Object)"> |
4330 | <summary> | 5174 | <summary> |
4331 | Removes the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> from the collection. | 5175 | Removes the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> from the collection. |
4332 | </summary> | 5176 | </summary> |
4333 | <param name="value">The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to remove from the collection.</param> | 5177 | <param name="oValue">The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to remove from the collection.</param> |
4334 | </member> | 5178 | </member> |
4335 | <member name="M:Npgsql.NpgsqlParameterCollection.Contains(System.Object)"> | 5179 | <member name="M:Npgsql.NpgsqlParameterCollection.Contains(System.Object)"> |
4336 | <summary> | 5180 | <summary> |
@@ -4458,12 +5302,6 @@ | |||
4458 | Provides the underlying mechanism for reading schema information. | 5302 | Provides the underlying mechanism for reading schema information. |
4459 | </summary> | 5303 | </summary> |
4460 | </member> | 5304 | </member> |
4461 | <member name="M:Npgsql.NpgsqlSchema.#ctor(Npgsql.NpgsqlConnection)"> | ||
4462 | <summary> | ||
4463 | Creates an NpgsqlSchema that can read schema information from the database. | ||
4464 | </summary> | ||
4465 | <param name="connection">An open database connection for reading metadata.</param> | ||
4466 | </member> | ||
4467 | <member name="M:Npgsql.NpgsqlSchema.GetMetaDataCollections"> | 5305 | <member name="M:Npgsql.NpgsqlSchema.GetMetaDataCollections"> |
4468 | <summary> | 5306 | <summary> |
4469 | Returns the MetaDataCollections that lists all possible collections. | 5307 | Returns the MetaDataCollections that lists all possible collections. |
@@ -4476,38 +5314,43 @@ | |||
4476 | </summary> | 5314 | </summary> |
4477 | <returns>The Restrictions</returns> | 5315 | <returns>The Restrictions</returns> |
4478 | </member> | 5316 | </member> |
4479 | <member name="M:Npgsql.NpgsqlSchema.GetDatabases(System.String[])"> | 5317 | <member name="M:Npgsql.NpgsqlSchema.GetDatabases(Npgsql.NpgsqlConnection,System.String[])"> |
4480 | <summary> | 5318 | <summary> |
4481 | Returns the Databases that contains a list of all accessable databases. | 5319 | Returns the Databases that contains a list of all accessable databases. |
4482 | </summary> | 5320 | </summary> |
5321 | <param name="conn">The database connection on which to run the metadataquery.</param> | ||
4483 | <param name="restrictions">The restrictions to filter the collection.</param> | 5322 | <param name="restrictions">The restrictions to filter the collection.</param> |
4484 | <returns>The Databases</returns> | 5323 | <returns>The Databases</returns> |
4485 | </member> | 5324 | </member> |
4486 | <member name="M:Npgsql.NpgsqlSchema.GetTables(System.String[])"> | 5325 | <member name="M:Npgsql.NpgsqlSchema.GetTables(Npgsql.NpgsqlConnection,System.String[])"> |
4487 | <summary> | 5326 | <summary> |
4488 | Returns the Tables that contains table and view names and the database and schema they come from. | 5327 | Returns the Tables that contains table and view names and the database and schema they come from. |
4489 | </summary> | 5328 | </summary> |
5329 | <param name="conn">The database connection on which to run the metadataquery.</param> | ||
4490 | <param name="restrictions">The restrictions to filter the collection.</param> | 5330 | <param name="restrictions">The restrictions to filter the collection.</param> |
4491 | <returns>The Tables</returns> | 5331 | <returns>The Tables</returns> |
4492 | </member> | 5332 | </member> |
4493 | <member name="M:Npgsql.NpgsqlSchema.GetColumns(System.String[])"> | 5333 | <member name="M:Npgsql.NpgsqlSchema.GetColumns(Npgsql.NpgsqlConnection,System.String[])"> |
4494 | <summary> | 5334 | <summary> |
4495 | Returns the Columns that contains information about columns in tables. | 5335 | Returns the Columns that contains information about columns in tables. |
4496 | </summary> | 5336 | </summary> |
5337 | <param name="conn">The database connection on which to run the metadataquery.</param> | ||
4497 | <param name="restrictions">The restrictions to filter the collection.</param> | 5338 | <param name="restrictions">The restrictions to filter the collection.</param> |
4498 | <returns>The Columns.</returns> | 5339 | <returns>The Columns.</returns> |
4499 | </member> | 5340 | </member> |
4500 | <member name="M:Npgsql.NpgsqlSchema.GetViews(System.String[])"> | 5341 | <member name="M:Npgsql.NpgsqlSchema.GetViews(Npgsql.NpgsqlConnection,System.String[])"> |
4501 | <summary> | 5342 | <summary> |
4502 | Returns the Views that contains view names and the database and schema they come from. | 5343 | Returns the Views that contains view names and the database and schema they come from. |
4503 | </summary> | 5344 | </summary> |
5345 | <param name="conn">The database connection on which to run the metadataquery.</param> | ||
4504 | <param name="restrictions">The restrictions to filter the collection.</param> | 5346 | <param name="restrictions">The restrictions to filter the collection.</param> |
4505 | <returns>The Views</returns> | 5347 | <returns>The Views</returns> |
4506 | </member> | 5348 | </member> |
4507 | <member name="M:Npgsql.NpgsqlSchema.GetUsers(System.String[])"> | 5349 | <member name="M:Npgsql.NpgsqlSchema.GetUsers(Npgsql.NpgsqlConnection,System.String[])"> |
4508 | <summary> | 5350 | <summary> |
4509 | Returns the Users containing user names and the sysid of those users. | 5351 | Returns the Users containing user names and the sysid of those users. |
4510 | </summary> | 5352 | </summary> |
5353 | <param name="conn">The database connection on which to run the metadataquery.</param> | ||
4511 | <param name="restrictions">The restrictions to filter the collection.</param> | 5354 | <param name="restrictions">The restrictions to filter the collection.</param> |
4512 | <returns>The Users.</returns> | 5355 | <returns>The Users.</returns> |
4513 | </member> | 5356 | </member> |
@@ -4525,7 +5368,7 @@ | |||
4525 | </member> | 5368 | </member> |
4526 | <member name="T:Npgsql.NpgsqlSync"> | 5369 | <member name="T:Npgsql.NpgsqlSync"> |
4527 | <summary> | 5370 | <summary> |
4528 | This class represents the Parse message sent to PostgreSQL | 5371 | This class represents the Sync message sent to PostgreSQL |
4529 | server. | 5372 | server. |
4530 | </summary> | 5373 | </summary> |
4531 | 5374 | ||
@@ -4616,28 +5459,72 @@ | |||
4616 | <param name="count">number of bytes to read</param> | 5459 | <param name="count">number of bytes to read</param> |
4617 | <returns>The number of bytes read. May be less than count if no more bytes are available.</returns> | 5460 | <returns>The number of bytes read. May be less than count if no more bytes are available.</returns> |
4618 | </member> | 5461 | </member> |
4619 | <member name="M:Npgsql.PGUtil.WriteString(System.String,System.IO.Stream)"> | 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)"> | ||
4620 | <summary> | 5483 | <summary> |
4621 | This method writes a C NULL terminated string to the network stream. | 5484 | This method writes a C NULL terminated string to the network stream. |
4622 | It appends a NULL terminator to the end of the String. | 5485 | It appends a NULL terminator to the end of the String. |
4623 | </summary> | 5486 | </summary> |
5487 | </member> | ||
5488 | <member name="M:Npgsql.PGUtil.WriteStringNullTerminated(System.IO.Stream,System.String,System.Object[])"> | ||
4624 | <summary> | 5489 | <summary> |
4625 | This method writes a C NULL terminated string to the network stream. | 5490 | This method writes a C NULL terminated string to the network stream. |
4626 | It appends a NULL terminator to the end of the String. | 5491 | It appends a NULL terminator to the end of the String. |
4627 | </summary> | 5492 | </summary> |
4628 | </member> | 5493 | </member> |
4629 | <member name="M:Npgsql.PGUtil.WriteBytes(System.Byte[],System.IO.Stream)"> | 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[])"> | ||
4630 | <summary> | 5505 | <summary> |
4631 | This method writes a set of bytes to the stream. It also enables logging of them. | 5506 | This method writes a set of bytes to the stream. It also enables logging of them. |
4632 | </summary> | 5507 | </summary> |
4633 | </member> | 5508 | </member> |
4634 | <member name="M:Npgsql.PGUtil.WriteLimString(System.String,System.Int32,System.IO.Stream)"> | 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)"> | ||
4635 | <summary> | 5515 | <summary> |
4636 | This method writes a C NULL terminated string limited in length to the | 5516 | This method writes a C NULL terminated string limited in length to the |
4637 | backend server. | 5517 | backend server. |
4638 | It pads the string with null bytes to the size specified. | 5518 | It pads the string with null bytes to the size specified. |
4639 | </summary> | 5519 | </summary> |
4640 | </member> | 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> | ||
4641 | <member name="M:Npgsql.PGUtil.WriteInt32(System.IO.Stream,System.Int32)"> | 5528 | <member name="M:Npgsql.PGUtil.WriteInt32(System.IO.Stream,System.Int32)"> |
4642 | <summary> | 5529 | <summary> |
4643 | Write a 32-bit integer to the given stream in the correct byte order. | 5530 | Write a 32-bit integer to the given stream in the correct byte order. |
@@ -4648,6 +5535,11 @@ | |||
4648 | Read a 32-bit integer from the given stream in the correct byte order. | 5535 | Read a 32-bit integer from the given stream in the correct byte order. |
4649 | </summary> | 5536 | </summary> |
4650 | </member> | 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> | ||
4651 | <member name="M:Npgsql.PGUtil.WriteInt16(System.IO.Stream,System.Int16)"> | 5543 | <member name="M:Npgsql.PGUtil.WriteInt16(System.IO.Stream,System.Int16)"> |
4652 | <summary> | 5544 | <summary> |
4653 | Write a 16-bit integer to the given stream in the correct byte order. | 5545 | Write a 16-bit integer to the given stream in the correct byte order. |
@@ -4658,17 +5550,40 @@ | |||
4658 | Read a 16-bit integer from the given stream in the correct byte order. | 5550 | Read a 16-bit integer from the given stream in the correct byte order. |
4659 | </summary> | 5551 | </summary> |
4660 | </member> | 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> | ||
4661 | <member name="T:Npgsql.ProtocolVersion"> | 5576 | <member name="T:Npgsql.ProtocolVersion"> |
4662 | <summary> | 5577 | <summary> |
4663 | Represent the frontend/backend protocol version. | 5578 | Represent the frontend/backend protocol version. |
4664 | </summary> | 5579 | </summary> |
4665 | </member> | 5580 | </member> |
4666 | <member name="T:Npgsql.ServerVersion"> | 5581 | <member name="T:Npgsql.ServerVersion"> |
4667 | <summary> | 5582 | <summary> |
4668 | Represent the backend server version. | 5583 | Represent the backend server version. |
4669 | As this class offers no functionality beyond that offered by <see cref="T:System.Version"/> it has been | 5584 | As this class offers no functionality beyond that offered by <see cref="T:System.Version"/> it has been |
4670 | deprecated in favour of that class. | 5585 | deprecated in favour of that class. |
4671 | </summary> | 5586 | </summary> |
4672 | 5587 | ||
4673 | </member> | 5588 | </member> |
4674 | <member name="M:Npgsql.ServerVersion.ToString"> | 5589 | <member name="M:Npgsql.ServerVersion.ToString"> |