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 319 by tony, Thu Feb 25 12:05:40 2021 UTC vs.
Revision 430 by tony, Thu Jan 4 11:57:50 2024 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines