ViewVC Help
View File | Revision Log | Show Annotations | Download File | View Changeset | Root Listing
root/public/ibx/trunk/fbintf/changelog
(Generate patch)

Comparing ibx/trunk/fbintf/changelog (file contents):
Revision 345 by tony, Mon Aug 23 14:22:29 2021 UTC vs.
Revision 435 by tony, Mon Jun 3 13:11:42 2024 UTC

# Line 1 | Line 1
1 + FBINTF Change Log  version          (1.4-2 Build 15740) Wed, 29 May 2024 15:47:44 +0100
2 +
3 + 1. IBUtils.FormatTimeZoneOffset A zero offset now includes a preceding '+' sign.
4 +
5 + 2. TFBStatement.DoJournaling now exits immediately if journaling is not active. The
6 +   motivation for this is to avoid calling the Firebird API function 'getInfo'
7 +   unnecesarily. This function can return an error if an incompatible parameter type was
8 +   applied to the statement and hence can confuse resolving the bug. Note: a
9 +   specific case is in (e.g.) OpenCursorAtStart method when the array of const includes a
10 +   TDateTime. In this case, the param is set to a floating point type rather than
11 +   a Firebird datetime (array of const loses the distinction).
12 +
13 + 3. TFBAttachment.SetParameters. if an attempt is made to set a parameter with a float
14 +   value, the metadata type is checked to see if the parameter is a Date/Time type. If so then
15 +   the value is assumed to be a TDateTime and the parameter is set using the AsDateTime
16 +   property. Otherwise, the value is assumed to be a floating point type and the AsDouble
17 +   property is used to set the property. This avoids the specific example given above.
18 +
19 + 4. IBHeader (legacy interface only) Definition of Start_Transaction changed to use
20 +   varargs - win64 compatibility issue.
21 +
22 + 5. FB25Blob: last parameter of call to isc_blob_lookup_desc is now set to nil. This
23 +   avoids memory corruption with Firebird 4 when using the legacy interface.
24 +
25 + 6. ISDL interface moved from FB30Array to IB. This is to avoid internal FPC compiler errors
26 +   consequential on the use of generics across units.
27 +
28 + 7. Internal changes necessary to correctly compile and run with FPC 3.3.1 and later.
29 +
30 + 8. Firebird 5 support tested.
31 +
32 + 9. Firebird.pas renamed to FirebirdOOAPI.pas in order to avoid confusion with
33 + version distributed with Firebird.
34 +
35 + FBINTF Change Log  version          (1.4-1 Build 14103) Mon, 27 Nov 2023 14:26:35 +0000
36 +
37 + 1. FBSQLData: ensure that TResults.getSQLData and TResults.GetData use same error
38 +   checks for range checking.
39 +
40 + 2. FB25Client: In GetIBMessage, fb_interpret is now called multiple times such that
41 +   any additional error information is decoded.
42 +
43 + 3. FB25Statement: When changing a param type from Blob sub_type 1 to SQL_TEXT or SQL_VARYING
44 +   charsetid is now preserved and size is set to default blob size. Now aligns with
45 +   FB3 and later.
46 +
47 + 4. DDL and DML string literals are now explicitly set to the connection character
48 +   set rather than the default character set provided by the compiler.
49 +
50 + 5. General tidy up of transliteration functions, now centralised in IBUtils. FPC testing
51 +   now makes use of the RTL fpwidestring unit for support of international character
52 +   sets.
53 +
54 + 6. Database exception handling (see section 9.3 in user guide).
55 +    * For FB3 and later API: Connection Character set now applied to message returned
56 +      by fb_interpret and message then transliterated if necessary to the system character set.
57 +    * For Legacy API: The message character set is guessed as UTF8 unless invalid
58 +      UTF8 characters found when connection character set is assumed. Message then
59 +      transliterated if necessary to system character set.
60 +      Note: this difference of behaviour is because legacy API presents exception messages
61 +      "as is", while FB3 server attempts to transliterate to connection character set.
62 +
63 + FBINTF Change Log  version          (1.4-0 Build 14011) Sat, 05 Aug 2023 11:09:09 +0100
64 +
65 + 1. Support package fbudr added for support of User Defined Routines (UDRs), and package
66 +   fbudrtestbed for client side debugging of UDR libraries.
67 +
68 + 2. Package layout changed with introduction of udr support. IB*.pas files moved from
69 +    root directory to "client". IBHeader moved to "Client".
70 +
71 + 3. Delphi packages: all packages now compile .dcp and .bpi files to either
72 +   fbintf\Win32\Debug or fbintf\Win64\Debug by default. Please remove any pre-existing
73 +   fbintf.dcp and fbintf.bpi files from other locations.
74 +
75 + 4. Client side journaling support added. Interface changes
76 +   IAttachment
77 +    function JournalingActive: boolean;
78 +    function GetJournalOptions: TJournalOptions;
79 +    function StartJournaling(aJournalLogFile: AnsiString): integer; overload;
80 +    function StartJournaling(aJournalLogFile: AnsiString; Options: TJournalOptions): integer; overload;
81 +    function StartJournaling(S: TStream; Options: TJournalOptions): integer; overload;
82 +    procedure StopJournaling(RetainJournal: boolean);
83 +
84 + 5. Transactions may now be given a local transaction name:
85 +   IFirebirdAPI
86 +     function StartTransaction(Attachments: array of IAttachment;
87 +             TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
88 +             TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit;
89 +             aName: AnsiString=''): ITransaction; overload;
90 +     function StartTransaction(Attachments: array of IAttachment;
91 +             TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
92 +             TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit;
93 +             aName: AnsiString=''): ITransaction; overload;
94 +
95 +   IAttachment
96 +    function StartTransaction(TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
97 +    function StartTransaction(TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
98 +    function StartTransaction(TPB: array of byte;
99 +                              DefaultCompletion: TTransactionCompletion=taCommit;
100 +                              aName: AnsiString=''): ITransaction; overload;
101 +    function StartTransaction(TPB: ITPB;
102 +                              DefaultCompletion: TTransactionCompletion=taCommit;
103 +                              aName: AnsiString=''): ITransaction; overload;
104 +
105 +  ITransaction
106 +    function GetTransactionName: AnsiString;
107 +    procedure SetTransactionName(aValue: AnsiString);
108 +
109 + 6. Additional Transaction information
110 +     ITPB.function AsText: AnsiString; {Returns TPB as a text string}
111 +
112 +   ITransaction
113 +     function GetDefaultCompletion: TTransactionCompletion;
114 +     function GetJournalingActive(attachment: IAttachment): boolean; {attachment must be specified when multi-database transaction}
115 +
116 + 7. New IAttachment helper functions
117 +     function HasTable(aTableName: AnsiString): boolean;
118 +     function HasFunction(aFunctionName: AnsiString): boolean;
119 +     function HasProcedure(aProcName: AnsiString): boolean;
120 +     function GetAttachmentID: integer;
121 +     function GetCharSetID: integer;
122 +
123 + 8. IStatement: if the BatchRowLimit is set to maxint, the maximum possible buffer size
124 +   will be allocated for batch operations.
125 +
126 + 9. IStatement, IColumnMetaData and ISQLParam all now consistently provide:
127 +    function GetStatement: IStatement;
128 +    function GetTransaction: ITransaction;
129 +    function GetAttachment: IAttachment;
130 +
131 + 10. Internal: a more disciplined approach to the handling of Firebird.IReferenceCounted
132 +    interfaces.
133 +
134 + 11. New interface type: IFBNumeric. IFBNumeric is implemented in the unit FBNumeric
135 +    and concentrates all handling of Fixed Point numbers. New ISQLItem and ISQLParam
136 +    functions getAsNumeric and setAsNumeric allow for direct retrival and manipulation
137 +    of numerics without loss of precision.
138 +
139 + 12. TryStrToNumeric and NumericToDouble moved from IBUtils to FBNumeric.
140 +
141 + 13. ISQLParams new method "Clear"
142 +
143 + 14. Connection Info (e.g. ODS Version, Remote Protocol) now retrieved on first
144 +    request rather than on attachment connect.
145 +
146 + 15. IStatus.IBDataBaseErrorMessages now defaults to [ShowIBMessage]. This reflects the
147 +    fact that SQLCodes are soon to be deprecated. In the future, the other options
148 +    will be silently ignored if SQLCode support is not present in the Firebird
149 +    Client library.
150 +
151 + 16. ITransaction changes Rollback and Commit from procedures to functions:
152 +      function Commit(Force: boolean=false): TTrCompletionState;
153 +      function Rollback(Force: boolean=false): TTrCompletionState;
154 +
155 +    Specifically, this is to allow the functions to report back a failed commit or
156 +    rollback when Force = true. In the case, the transaction handle has been
157 +    released, while the transaction remains in limbo.
158 +
159 + 17. IAttachment ExecImmediate.
160 +    When the transaction parameters are provided as an array of const and the
161 +    statement fails, the transaction is rolledback (forced) before the exception
162 +    is raised.
163 +
164 + 18. In Firebird 3 and later API: the status vector is now a thread var, as was
165 +    already the case with the legacy API. Avoids problems when calling underlying
166 +    Firebird API in multiple threads.
167 +
168 + 19. IBUtils: TSQLXMLReader: "string" type changed to "AnsiString" for compatibility
169 +    reasons.
170 +
171 + 20. IDBInformation.DecodeVersionString now supported isc_info_firebird_version.
172 +
173 + 21. TSQLXMLReader: handle 'blob' as a reserved word
174 +
175 + 22. ISQLParam.SetAsVariant now accepts a vartype of varUString (UnicodeString).
176 +
177 +
178 + FBINTF Change Log  version          (1.3-3 Build 12935) Mon, 06 Dec 2021 23:17:13 +0000
179 +
180 + 1. Fix compile error with fpc trunk (3.3.1 and later), due to type change to tzname in "unix" unit.
181 +
182 + 2. Remove constraint in IAttachment.HasScollableCursors that returned false when
183 +   using remote protocol. Scrollable cursors with remote database expected to
184 +   be support for Firebird 4.0.1 onwards. Note: Firebird 4.0.0 will return
185 +   a not supported error.
186 +
187 + 3. IStatement: new function;
188 +    TStatementFlag = (stHasCursor,stRepeatExecute,stScrollable);
189 +    TStatementFlags = set of TStatementFlag;
190 +    function GetFlags: TStatementFlags;
191 +
192 + 4. Revised behaviour for IStatement.ExecuteQuery in order to preserve backwards
193 +   compatibility.
194 +   In Firebird 5, Update..Returning may returns multiple rows and hence the statemen
195 +   type changes from ExecProcedure to Select. So that ExecuteQuery can continue
196 +   to be used with Update...Retruning statements that return a singleton row,
197 +   instead of raising an exception when ExecuteQuery is used with a (SELECT) statement,
198 +   it will open the cursor and return the first row only.
199 +
200 + 5. ITransaction: new functions:
201 +    function GetIsReadOnly: boolean;
202 +    function GetTransactionID: integer;
203 +    function GetTrInformation(Requests: array of byte): ITrInformation; overload;
204 +    function GetTrInformation(Request: byte): ITrInformation; overload;
205 +
206 +   The latter two return the Transaction Information block. The first two extract
207 +   information the Transaction Information block
208 +
209 + 6. New function TSQLTokeniser.ReadCharacters
210 +   Used internally.
211 +
212 + 7. IStatement: GetProcessedSQL bug fix. No longer raises and error if SQL contains
213 +   parameter placeholders instead of named parameters.
214 +
215 + 8. ITransaction (Firebird 3 and later): An exception raised when freeing an underlying
216 +   transaction handle is now ignored if Rollback/Commit is called with Force=true
217 +
218 + 9. Tidy up of exception handling code. Under the legacy API, fb_interpret is now
219 +   used to get an IBError Message instead of isc_interprete.
220 +
221 + 10. Internal tidyup. Native code now used for decoding integers and the events
222 +    buffer. Avoids dependencies on fbclient functions isc_portable_integer,
223 +    isc_event_block and isc_event_counts.
224 +
225 + 11. New IAttachment function
226 +     function GetAttachmentID: integer;
227 +
228 + 12. Internal changes to TFBClientAPI, TFBAttachment and TFBTransaction and TFB30
229 +    subclasses to enable UDR support.
230 +
231 + FBINTF Change Log  version          (1.3-2 Build 12889) Sun, 24 Oct 2021 13:49:28 +0100
232 +
233 + 1. TFBClientAPI.GetProcAddr. Add check for nil reference.
234 +
235 + 2. IStatement: new methods:
236 +    procedure SetStaleReferenceChecks(Enable:boolean); {default true}
237 +    function GetStaleReferenceChecks: boolean;
238 +
239 +   In previous versions, stale reference checks were always enabled. This allows the
240 +   user to disable them on a per statement basis. Note this can risk out-of-date
241 +   statement BLR. See User Guide.
242 +
243 + 3. IBUtils: TSQLwithNamedParamsTokeniser now recognises a CASE...END block within a
244 +   stored procedure and hence avoids replacing named parameters within a containing
245 +   BEGIN..END block.
246 +
247 + 4. ISQLParam: using a string value to set an integer field with a scale factor of
248 +   zero is now treated as a special case to avoid the risk of floating point
249 +   rounding errors affecting pure integers.
250 +
251 + 5. ISQLParam:  Review and tidy-up of SetAsString for numeric types.
252 +
253 + 6. ISQLParam is now subclassed from IParamMetaData, which provides access to the mutable
254 +   SQL Parameter metadata (methods moved from ISQLParam).
255 +
256 + 7. ISQLParam: new method
257 +     function getColMetadata: IParamMetaData;
258 +   This instance of IParamMetaData returns the original column metadata which is unmutable.
259 +   Note: ISQLParam metadata can change after a parameter value has been set e.g when
260 +   setting a VARCHAR column to an integer value.
261 +
262 + 8. IStatement: can now set cursor name when opening a cursor. New overloaded method:
263 +    procedure Prepare(CursorName: AnsiString; aTransaction: ITransaction=nil); overload;
264 +   also IAttachment:
265 +    function Prepare(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; CursorName: AnsiString=''): IStatement; overload;
266 +    function Prepare(transaction: ITransaction; sql: AnsiString; CursorName: AnsiString=''): IStatement; overload;
267 +    function PrepareWithNamedParameters(transaction: ITransaction; sql: AnsiString;
268 +                       aSQLDialect: integer; GenerateParamNames: boolean=false;
269 +                       CaseSensitiveParams: boolean = false; CursorName: AnsiString=''): IStatement; overload;
270 +    function PrepareWithNamedParameters(transaction: ITransaction; sql: AnsiString;
271 +                       GenerateParamNames: boolean=false;
272 +                       CaseSensitiveParams: boolean = false; CursorName: AnsiString=''): IStatement; overload;
273 +
274 + 9. Support for scrollable cursors added. New/updated methods:
275 +   IAttachment:
276 +    function HasScollableCursors: boolean;
277 +    function OpenCursor(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer;
278 +                             Scrollable: boolean=false): IResultSet; overload;
279 +    function OpenCursor(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
280 +    function OpenCursor(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; Scrollable: boolean;
281 +                             params: array of const): IResultSet; overload;
282 +    function OpenCursor(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false;
283 +                             params: array of const): IResultSet; overload;
284 +    function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; Scrollable: boolean;
285 +                             params: array of const): IResultSet; overload;
286 +    function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer;
287 +                             Scrollable: boolean=false): IResultSet; overload;
288 +    function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
289 +    function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; Scrollable: boolean;
290 +                             params: array of const): IResultSet; overload;
291 +    function OpenCursorAtStart(sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
292 +    function OpenCursorAtStart(sql: AnsiString; Scrollable: boolean;
293 +                             params: array of const): IResultSet; overload;
294 +   IStatement:
295 +     function OpenCursor(Scrollable: boolean; CursorName: AnsiString =''; aTransaction: ITransaction=nil): IResultSet; overload;
296 +   IResultSet:
297 +    function FetchPrior: boolean; {fetch previous record}
298 +    function FetchFirst:boolean; {fetch first record}
299 +    function FetchLast: boolean; {fetch last record}
300 +    function FetchAbsolute(position: Integer): boolean; {fetch record by its absolute position in result set}
301 +    function FetchRelative(offset: Integer): boolean; {fetch record by position relative to current}
302 +    function IsBof: boolean;
303 +
304 + 10. IArray: tidyup of SetAsString method to ensure correct handling of fixed point numbers.
305 +
306 + 11. IBUtils: TSQLTokeniser. CRLF now combined by low level parser into sqltEOL token. This
307 +    may be noticeable when a line separator occurs inside quoted text. The quoted text
308 +    output by the tokeniser will now use the platform specific lineEnding regardless
309 +    of whether the input uses the CRLF or LF as a line separator.
310 +
311 + 12. IStatement, IResultsSet: Support for scrollable cursors added (note: local databases only)
312 +
313 +
314   FBINTF Change Log  version          (1.3-1 Build 12776) Mon, 23 Aug 2021 11:09:33 +0100
315  
316   1. Integer decodes in information blocks (e.g. IDBInfoItem) widened from 32 bit to 64-bit integers.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines