ViewVC Help
View File | Revision Log | Show Annotations | Download File | View Changeset | Root Listing
root/public/ibx/trunk/fbintf/changelog
Revision: 421
Committed: Sat Oct 21 14:22:28 2023 UTC (6 months ago) by tony
File size: 36527 byte(s)
Log Message:
Release 2.6.3 Merged

File Contents

# User Rev Content
1 tony 421 FBINTF Change Log version (1.4-1 Build 14083) Fri, 20 Oct 2023 11:41:24 +0100
2 tony 402
3 tony 419 1. FBSQLData: ensure that TResults.getSQLData and TResults.GetData use same error
4     checks for range checking.
5    
6 tony 421 2. FB25Client: In GetIBMessage, fb_interpret is now called multiple times such that
7     any additional error information is decoded.
8    
9     3. FB25Statement: When changing a param type from Blob sub_type 1 to SQL_TEXT or SQL_VARYING
10     charsetid is now preserved and size is set to default blob size. Now aligns with
11     FB3 and later.
12    
13     4. DDL and DML string literals are now explicitly set to the connection character
14     set rather than the default character set provided by the compiler.
15    
16     5. General tidy up of transliteration functions, now centralised in IBUtils. FPC testing
17     now makes use of the RTL fpwidestring unit for support of international character
18     sets.
19    
20     6. Database exception handling (see section 9.3 in user guide).
21     * For FB3 and later API: Connection Character set now applied to message returned
22     by fb_interpret and message then transliterated if necessary to the system character set.
23     * For Legacy API: The message character set is guessed as UTF8 unless invalid
24     UTF8 characters found when connection character set is assumed. Message then
25     transliterated if necessary to system character set.
26     Note: this difference of behaviour is because legacy API presents exception messages
27     "as is", while FB3 server attempts to transliterate to connection character set.
28    
29 tony 419 FBINTF Change Log version (1.4-0 Build 14011) Sat, 05 Aug 2023 11:09:09 +0100
30    
31 tony 402 1. Support package fbudr added for support of User Defined Routines (UDRs), and package
32     fbudrtestbed for client side debugging of UDR libraries.
33    
34     2. Package layout changed with introduction of udr support. IB*.pas files moved from
35     root directory to "client". IBHeader moved to "Client".
36    
37     3. Delphi packages: all packages now compile .dcp and .bpi files to either
38     fbintf\Win32\Debug or fbintf\Win64\Debug by default. Please remove any pre-existing
39     fbintf.dcp and fbintf.bpi files from other locations.
40    
41     4. Client side journaling support added. Interface changes
42     IAttachment
43     function JournalingActive: boolean;
44     function GetJournalOptions: TJournalOptions;
45     function StartJournaling(aJournalLogFile: AnsiString): integer; overload;
46     function StartJournaling(aJournalLogFile: AnsiString; Options: TJournalOptions): integer; overload;
47     function StartJournaling(S: TStream; Options: TJournalOptions): integer; overload;
48     procedure StopJournaling(RetainJournal: boolean);
49    
50     5. Transactions may now be given a local transaction name:
51     IFirebirdAPI
52     function StartTransaction(Attachments: array of IAttachment;
53     TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
54     TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit;
55     aName: AnsiString=''): ITransaction; overload;
56     function StartTransaction(Attachments: array of IAttachment;
57     TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
58     TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit;
59     aName: AnsiString=''): ITransaction; overload;
60    
61     IAttachment
62     function StartTransaction(TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
63     function StartTransaction(TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
64     function StartTransaction(TPB: array of byte;
65     DefaultCompletion: TTransactionCompletion=taCommit;
66     aName: AnsiString=''): ITransaction; overload;
67     function StartTransaction(TPB: ITPB;
68     DefaultCompletion: TTransactionCompletion=taCommit;
69     aName: AnsiString=''): ITransaction; overload;
70    
71     ITransaction
72     function GetTransactionName: AnsiString;
73     procedure SetTransactionName(aValue: AnsiString);
74    
75     6. Additional Transaction information
76     ITPB.function AsText: AnsiString; {Returns TPB as a text string}
77    
78     ITransaction
79     function GetDefaultCompletion: TTransactionCompletion;
80     function GetJournalingActive(attachment: IAttachment): boolean; {attachment must be specified when multi-database transaction}
81    
82     7. New IAttachment helper functions
83     function HasTable(aTableName: AnsiString): boolean;
84     function HasFunction(aFunctionName: AnsiString): boolean;
85     function HasProcedure(aProcName: AnsiString): boolean;
86     function GetAttachmentID: integer;
87     function GetCharSetID: integer;
88    
89     8. IStatement: if the BatchRowLimit is set to maxint, the maximum possible buffer size
90     will be allocated for batch operations.
91    
92     9. IStatement, IColumnMetaData and ISQLParam all now consistently provide:
93     function GetStatement: IStatement;
94     function GetTransaction: ITransaction;
95     function GetAttachment: IAttachment;
96    
97     10. Internal: a more disciplined approach to the handling of Firebird.IReferenceCounted
98     interfaces.
99    
100     11. New interface type: IFBNumeric. IFBNumeric is implemented in the unit FBNumeric
101     and concentrates all handling of Fixed Point numbers. New ISQLItem and ISQLParam
102     functions getAsNumeric and setAsNumeric allow for direct retrival and manipulation
103     of numerics without loss of precision.
104    
105     12. TryStrToNumeric and NumericToDouble moved from IBUtils to FBNumeric.
106    
107     13. ISQLParams new method "Clear"
108    
109     14. Connection Info (e.g. ODS Version, Remote Protocol) now retrieved on first
110     request rather than on attachment connect.
111    
112     15. IStatus.IBDataBaseErrorMessages now defaults to [ShowIBMessage]. This reflects the
113     fact that SQLCodes are soon to be deprecated. In the future, the other options
114     will be silently ignored if SQLCode support is not present in the Firebird
115     Client library.
116    
117     16. ITransaction changes Rollback and Commit from procedures to functions:
118     function Commit(Force: boolean=false): TTrCompletionState;
119     function Rollback(Force: boolean=false): TTrCompletionState;
120    
121     Specifically, this is to allow the functions to report back a failed commit or
122     rollback when Force = true. In the case, the transaction handle has been
123     released, while the transaction remains in limbo.
124    
125     17. IAttachment ExecImmediate.
126     When the transaction parameters are provided as an array of const and the
127     statement fails, the transaction is rolledback (forced) before the exception
128     is raised.
129    
130     18. In Firebird 3 and later API: the status vector is now a thread var, as was
131     already the case with the legacy API. Avoids problems when calling underlying
132     Firebird API in multiple threads.
133    
134     19. IBUtils: TSQLXMLReader: "string" type changed to "AnsiString" for compatibility
135     reasons.
136    
137     20. IDBInformation.DecodeVersionString now supported isc_info_firebird_version.
138    
139     21. TSQLXMLReader: handle 'blob' as a reserved word
140    
141     22. ISQLParam.SetAsVariant now accepts a vartype of varUString (UnicodeString).
142    
143    
144 tony 359 FBINTF Change Log version (1.3-3 Build 12935) Mon, 06 Dec 2021 23:17:13 +0000
145    
146     1. Fix compile error with fpc trunk (3.3.1 and later), due to type change to tzname in "unix" unit.
147    
148     2. Remove constraint in IAttachment.HasScollableCursors that returned false when
149     using remote protocol. Scrollable cursors with remote database expected to
150     be support for Firebird 4.0.1 onwards. Note: Firebird 4.0.0 will return
151     a not supported error.
152    
153     3. IStatement: new function;
154     TStatementFlag = (stHasCursor,stRepeatExecute,stScrollable);
155     TStatementFlags = set of TStatementFlag;
156     function GetFlags: TStatementFlags;
157    
158     4. Revised behaviour for IStatement.ExecuteQuery in order to preserve backwards
159     compatibility.
160     In Firebird 5, Update..Returning may returns multiple rows and hence the statemen
161     type changes from ExecProcedure to Select. So that ExecuteQuery can continue
162     to be used with Update...Retruning statements that return a singleton row,
163     instead of raising an exception when ExecuteQuery is used with a (SELECT) statement,
164     it will open the cursor and return the first row only.
165    
166     5. ITransaction: new functions:
167     function GetIsReadOnly: boolean;
168     function GetTransactionID: integer;
169     function GetTrInformation(Requests: array of byte): ITrInformation; overload;
170     function GetTrInformation(Request: byte): ITrInformation; overload;
171    
172     The latter two return the Transaction Information block. The first two extract
173     information the Transaction Information block
174    
175     6. New function TSQLTokeniser.ReadCharacters
176     Used internally.
177    
178     7. IStatement: GetProcessedSQL bug fix. No longer raises and error if SQL contains
179     parameter placeholders instead of named parameters.
180    
181     8. ITransaction (Firebird 3 and later): An exception raised when freeing an underlying
182     transaction handle is now ignored if Rollback/Commit is called with Force=true
183    
184 tony 402 9. Tidy up of exception handling code. Under the legacy API, fb_interpret is now
185     used to get an IBError Message instead of isc_interprete.
186    
187     10. Internal tidyup. Native code now used for decoding integers and the events
188     buffer. Avoids dependencies on fbclient functions isc_portable_integer,
189     isc_event_block and isc_event_counts.
190    
191     11. New IAttachment function
192     function GetAttachmentID: integer;
193    
194     12. Internal changes to TFBClientAPI, TFBAttachment and TFBTransaction and TFB30
195     subclasses to enable UDR support.
196    
197 tony 356 FBINTF Change Log version (1.3-2 Build 12889) Sun, 24 Oct 2021 13:49:28 +0100
198 tony 347
199     1. TFBClientAPI.GetProcAddr. Add check for nil reference.
200    
201     2. IStatement: new methods:
202     procedure SetStaleReferenceChecks(Enable:boolean); {default true}
203     function GetStaleReferenceChecks: boolean;
204    
205     In previous versions, stale reference checks were always enabled. This allows the
206     user to disable them on a per statement basis. Note this can risk out-of-date
207     statement BLR. See User Guide.
208    
209 tony 348 3. IBUtils: TSQLwithNamedParamsTokeniser now recognises a CASE...END block within a
210     stored procedure and hence avoids replacing named parameters within a containing
211     BEGIN..END block.
212    
213 tony 349 4. ISQLParam: using a string value to set an integer field with a scale factor of
214     zero is now treated as a special case to avoid the risk of floating point
215     rounding errors affecting pure integers.
216    
217     5. ISQLParam: Review and tidy-up of SetAsString for numeric types.
218    
219     6. ISQLParam is now subclassed from IParamMetaData, which provides access to the mutable
220     SQL Parameter metadata (methods moved from ISQLParam).
221    
222     7. ISQLParam: new method
223     function getColMetadata: IParamMetaData;
224     This instance of IParamMetaData returns the original column metadata which is unmutable.
225     Note: ISQLParam metadata can change after a parameter value has been set e.g when
226     setting a VARCHAR column to an integer value.
227    
228 tony 350 8. IStatement: can now set cursor name when opening a cursor. New overloaded method:
229     procedure Prepare(CursorName: AnsiString; aTransaction: ITransaction=nil); overload;
230     also IAttachment:
231     function Prepare(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; CursorName: AnsiString=''): IStatement; overload;
232     function Prepare(transaction: ITransaction; sql: AnsiString; CursorName: AnsiString=''): IStatement; overload;
233     function PrepareWithNamedParameters(transaction: ITransaction; sql: AnsiString;
234     aSQLDialect: integer; GenerateParamNames: boolean=false;
235     CaseSensitiveParams: boolean = false; CursorName: AnsiString=''): IStatement; overload;
236     function PrepareWithNamedParameters(transaction: ITransaction; sql: AnsiString;
237     GenerateParamNames: boolean=false;
238     CaseSensitiveParams: boolean = false; CursorName: AnsiString=''): IStatement; overload;
239 tony 349
240 tony 350 9. Support for scrollable cursors added. New/updated methods:
241     IAttachment:
242 tony 352 function HasScollableCursors: boolean;
243 tony 350 function OpenCursor(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer;
244     Scrollable: boolean=false): IResultSet; overload;
245     function OpenCursor(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
246     function OpenCursor(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; Scrollable: boolean;
247     params: array of const): IResultSet; overload;
248     function OpenCursor(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false;
249     params: array of const): IResultSet; overload;
250     function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; Scrollable: boolean;
251     params: array of const): IResultSet; overload;
252     function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer;
253     Scrollable: boolean=false): IResultSet; overload;
254     function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
255     function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; Scrollable: boolean;
256     params: array of const): IResultSet; overload;
257     function OpenCursorAtStart(sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
258     function OpenCursorAtStart(sql: AnsiString; Scrollable: boolean;
259     params: array of const): IResultSet; overload;
260     IStatement:
261     function OpenCursor(Scrollable: boolean; CursorName: AnsiString =''; aTransaction: ITransaction=nil): IResultSet; overload;
262     IResultSet:
263     function FetchPrior: boolean; {fetch previous record}
264     function FetchFirst:boolean; {fetch first record}
265     function FetchLast: boolean; {fetch last record}
266     function FetchAbsolute(position: Integer): boolean; {fetch record by its absolute position in result set}
267     function FetchRelative(offset: Integer): boolean; {fetch record by position relative to current}
268     function IsBof: boolean;
269    
270 tony 353 10. IArray: tidyup of SetAsString method to ensure correct handling of fixed point numbers.
271 tony 350
272 tony 353 11. IBUtils: TSQLTokeniser. CRLF now combined by low level parser into sqltEOL token. This
273     may be noticeable when a line separator occurs inside quoted text. The quoted text
274     output by the tokeniser will now use the platform specific lineEnding regardless
275     of whether the input uses the CRLF or LF as a line separator.
276 tony 350
277 tony 353 12. IStatement, IResultsSet: Support for scrollable cursors added (note: local databases only)
278    
279    
280 tony 345 FBINTF Change Log version (1.3-1 Build 12776) Mon, 23 Aug 2021 11:09:33 +0100
281    
282     1. Integer decodes in information blocks (e.g. IDBInfoItem) widened from 32 bit to 64-bit integers.
283    
284     2. Support for inline blob encoding. Blob values pass using the "SetAsString" method
285     will now be encoded inline (i.e. as part of the parameter buffer) if they are
286     shorter than a pre-set limit. Longer values continue to be saved as blobs as a
287     separate server interaction. This is intended as a performance optimisation.
288    
289     The pre-set limit defaults to 8192 bytes and can be inspected/modified using the new
290     IAttachment interface functions:
291    
292     function GetInlineBlobLimit: integer;
293     procedure SetInlineBlobLimit(limit: integer);
294    
295     3. Support for Firebird 4 IBatch interface added. This is largely transparent to the API
296     user as the functionality is embedded in the implementation of the IStatement
297     interface. Three new functions are defined:
298    
299     procedure AddToBatch;
300     function ExecuteBatch(aTransaction: ITransaction=nil): IBatchCompletion;
301     procedure CancelBatch;
302     function GetBatchCompletion: IBatchCompletion;
303     function GetBatchRowLimit: integer;
304     procedure SetBatchRowLimit(aLimit: integer);
305    
306     Also
307    
308     function IsInBatchMode: boolean; {true after call to execute(eaDefer)}
309     function HasBatchMode: boolean; {true if and only if IBatch Supported}
310    
311     For more information see the User Guide.
312    
313     4. Default error message contents. Now aligned with User Guide section 10.2 i.e. error messages
314     provided with the EIBInterBaseError now include all three parts.
315    
316     5. Firebird.pas and include files updated to Firebird 4.0.0
317    
318     6. New IStatement method: function GetSQLStatementTypeName: AnsiString;
319     Returns SQL Statement type as a text string;
320    
321     7. ISQLData.AsInteger and AsInt64 now use "Round" to convert a float field to
322     an integer instead of "trunc". This is for compatibility with TFloatField.AsInteger.
323    
324 tony 340 FBINTF Change Log version (1.2-1 Build 12552) Wed, 09 Jun 2021 13:05:40 +0100
325 tony 338
326     1. Big fix for Firebird 4.0. A internal change in Firebird 4.0.0 from RC1 flushed out a
327     typo in FB30Statement.pas that caused an unknown parameter error.
328    
329 tony 319 FBINTF Change Log version (1.2-0 Build 12520) Fri, 19 Feb 2021 13:27:23 +0000
330 tony 308
331 tony 315 1. Imported (Firebird) constants updated for Firebird 4.
332    
333     2. Firebird.pas from Firebird 4 integrated into source code tree.
334    
335     3. Added Support for TIMETAMP WITH TIME ZONE and TIME WITH TIME ZONE data types.
336    
337     4. Added Support for SQL_DEC16, SQL_DEC34 and extended NUMERIC precision.
338    
339     5. New unit 'FBClientLib.pas' added and provides new interface IFBIMasterProvider.
340     QueryInterface may be used to coerce this interface from IFirebirdAPI. The
341     interface provides a single method "function GetIMasterIntf: IMaster". This provides
342     type safe access to the Firebird IMaster interface and avoids the need to turn
343     off object checks when coercing "function GetIMaster: TObject" to IMaster.
344    
345     6. New IFirebirdAPI Calls:
346     function HasLocalTZDB: boolean;
347     function HasTimeZoneSupport: boolean;
348     function HasExtendedTZSupport: boolean;
349     procedure SQLDecFloatEncode(aValue: tBCD; SQLType: cardinal; bufptr: PByte);
350     function SQLDecFloatDecode(SQLType: cardinal; scale: integer; bufptr: PByte): tBCD;
351    
352     7. New IAttachment Calls:
353     function HasDecFloatSupport: boolean;
354     function GetTimeZoneServices: ITimeZoneServices;
355     function HasTimeZoneSupport: boolean;
356    
357     8. New Interface ITimeZoneServices.
358    
359     9. New ISQLData API Calls:
360     procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
361     procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
362     procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
363     procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
364     function GetAsUTCDateTime: TDateTime;
365     function GetAsBCD: tBCD;
366    
367     10. New ISQLParam API Calls
368     procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
369     procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
370     procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
371     procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
372     function GetAsUTCDateTime: TDateTime;
373     function GetAsBCD: tBCD;
374     function GetStatement: IStatement;
375     function GetTransaction: ITransaction;
376     procedure SetAsTime(aValue: TDateTime; OnDate: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
377     procedure SetAsTime(aValue: TDateTime; OnDate: TDateTime; aTimeZone: AnsiString); overload;
378     procedure SetAsDateTime(aValue: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
379     procedure SetAsDateTime(aValue: TDateTime; aTimeZone: AnsiString); overload;
380     procedure SetAsUTCDateTime(aUTCTime: TDateTime);
381     procedure SetAsBcd(aValue: tBCD);
382    
383     11. New IArray API Calls
384     procedure GetAsDateTime(index: array of integer; var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
385     procedure GetAsDateTime(index: array of integer; var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
386     procedure GetAsTime(index: array of integer; var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
387     procedure GetAsTime(index: array of integer; var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
388     function GetAsUTCDateTime(index: array of integer): TDateTime;
389     procedure SetAsDateTime(index: array of integer; aValue: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
390     procedure SetAsDateTime(index: array of integer; aValue: TDateTime; aTimeZone: AnsiString); overload;
391     procedure SetAsTime(index: array of integer; aValue: TDateTime; OnDate: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
392     procedure SetAsTime(index: array of integer; aValue: TDateTime; OnDate: TDateTime; aTimeZone: AnsiString); overload;
393    
394     12. Utility functions in IBUtils
395     function ParseDateTimeTZString(aDateTimeStr: Ansistring; var aDateTime: TDateTime;
396     var aTimezone: AnsiString; aFormatSettings: TFormatSettings; TimeOnly: boolean=false): boolean;
397     procedure FBDecodeTime(aTime: TDateTime; var Hour, Minute, Second: word; var DeciMillisecond: cardinal);
398     function FBEncodeTime(Hour, Minute, Second, DeciMillisecond: cardinal): TDateTime;
399     function FBFormatDateTime(fmt: AnsiString; aDateTime: TDateTime): AnsiString;
400     function FormatTimeZoneOffset(EffectiveTimeOffsetMins: integer): AnsiString;
401     function DecodeTimeZoneOffset(TZOffset: AnsiString; var dstOffset: integer): boolean;
402    
403     13. IDPB, ITPB and ISPB: new interface method
404     function AddByTypeName(ParamTypeName: AnsiString): IDPBItem/ITPBItem/ISPBItem;
405     This is used to add a parameter block item by the string equivalent of its
406     symbolic type name. e.g. DPB.AddByTypeName('isc_dpb_user_name').AsString := '...'
407    
408     14. IDPBItem/ITPBItem/ISPBItem: new interface method:
409     function getParamTypeName: AnsiString;
410    
411     15. fb_shutdown now called before unloading Firebird library. This can avoid a
412     SIGEVENT error when a programme using the embeded server is unloaded.
413    
414     FBINTF Change Log version (1.1-6 Build 12237) Tue, 21 Jul 2020 08:54:21 +0100
415    
416 tony 308 1. GetImplementationVersion now correctly returns '3.0' for Firebird 3 API
417     with a Firebrid 3 client library.
418    
419     2. Linux Only: FIREBIRD environment variable is now checked when loading the client library.
420     If a client library path is not explicitly provided and the FIREBIRD environment
421     variable is set then the directory given by this variable and any 'lib' subdirectory
422     are searched for the Firebird client library. Only if none is found, is the default
423     client library used.
424    
425     3. IUtil.FormatStatus now used to format error messages when using new API
426    
427     4. Fixed Array SDL: array_desc_scale now correctly encoded as a signed integer.
428    
429     5. SQL_TEXT handling changed. When the value of an SQL_TEXT (i.e. fixed width string) column is
430     returned using GetAsString and the string codepage is UTF8, the string is truncated so
431     that the byte length corresponds to the number of characters specified for the column.
432     SQL_TEXT strings are no longer automatically trimmed to remove all trailing white space. This is
433     correct behaviour but may affect some implementations that relied upon automatic
434     trimming of trailing white space.
435    
436     6. New IFirebirdAPI Calls:
437     function GetClientMajor: integer;
438     function GetClientMinor: integer;
439    
440 tony 309 7. IColumnMetaData and IArrayMetaData: new method
441     function GetCharSetWidth: integer;
442 tony 308
443 tony 315 FBINTF Change Log version (1.1-5 Build 12022) Fri, 17 Apr 2020 10:35:55 +0100
444 tony 309
445 tony 287 1. ISQLParams.GetHasCaseSensitiveParams added. Returns true if param names are
446     case sensitive
447    
448     2. Single line SQL comments starting with '--' are now recognised by SQL Parser.
449    
450 tony 291 3. New API Calls:
451     IColumnMetaData.GetStatement
452     IColumnMetaData.GetTransaction
453 tony 315 ISQLData.GetStrDataLength
454 tony 291 IResults.GetStatement
455     IAttachment.OpenBlob (using Blob metadata)
456     IAttachment.OpenArray (using array metadata)
457    
458     4. FBMessages: removal of unused messages
459    
460     5. TFBArray.Create (2nd case): ensure that FFirebirdClientAPI is correctly set.
461    
462     6. TIBSQLStatementType: SQLSavePoint added to end of enumeration.
463    
464 tony 280 FBINTF Change Log version (1.1-4 Build 11515) Fri, 28 Dec 2018 10:04:19 +0000
465 tony 265
466     1. Fix a problem with the SQL parameter parser that failed to recognise parameters
467     where the second character of the parameter name is a numeric.
468    
469 tony 266 2. New method for IAttachment: procedure getFBVersion(version: TStrings);
470     This returns the isc_version connection information as one or more lines.
471     This is the same information as returned by isql with the -z option.
472 tony 265
473 tony 270 3. If -dFIREBIRD3APIONLY is used as a compiler option then the legacy Firebird API
474     is no longer compiled in. Likewise, if -dLEGACYFIREBIRDAPIONLY is used as a
475     compiler option then the Firebird 3 API is no longer compiled in.
476 tony 266
477 tony 270 4. IColumnMetaData: new method.
478    
479     TIBDateTimeFormats = (dfTimestamp, {SQL TIMESTAMP}
480     dfDateTime, {SQL DATETIME}
481     dfTime);
482    
483     function GetDateTimeStrLength(DateTimeFormat: TIBDateTimeFormats): integer;
484    
485     This returns the max. number of characters returned by the "AsString" method
486     when the SQL type of the column is respectively TIMESTAMP, DATETIME or TIME.
487    
488     5. Additional argument for IAttachment.PrepareWithNamedParameters -
489     CaseSensitiveParams: boolean = false
490    
491     If this argument is set to true then SQL parameter names are assumed to be case
492     sensitive and must be referenced (using ISQLParams.ByName) using the case
493     sensitive name.
494    
495     6. Bug fix: when setting a query parameter, it is now possible, when the parameter
496     is of type VarChar or Char to set the parameter to a numeric value (e.g. using
497     .AsCurrency) and then subsequently to update the value to a non-numeric string
498     using .AsString.
499    
500    
501    
502 tony 263 FBINTF Change Log version (1.1-3) Wed, 05 Dec 2018 14:28:10 +0000
503 tony 238
504     1. DARWIN only syntax error: fix missing semi-colon in TFBClientAPI.LoadIBLibrary
505    
506 tony 263 2. Restrict IsMultiThread check to Unix only for compatibility with
507     https://bugs.freepascal.org/view.php?id=30535
508    
509     3. New SQL Tokeniser added to IBUtils. This is used to pre-process SQL with
510     named parameters and is intended to avoid problems with (e.g.) Execute Block
511     and processing internal parameters as statement parameters.
512    
513     4. New interface IFirebirdLibrary provides access to the underlying firebird DLL
514     or shared object. Available via a new member (GetFBLibrary) of IFirebirdAPI.
515    
516     5. New function added to IB.pas
517    
518     function LoadFBLibrary(aLibPathName: string): IFirebirdLibrary
519    
520     This allows a Firebird Library to be loaded from an explicit path. use the
521     IFirebirdLibrary.GetFirebirdAPI member function to get the Firebird API using
522     the library. It is possible to load Firebird libraries from different locations
523     simultaneously, each with a distinct IFirebirdAPI.
524    
525 tony 233 FBINTF Change Log version (1.1-2) Mon, 16 Apr 2018 09:30:32 +0100
526 tony 59
527 tony 209 1. Firebird.pas: {$OBJECTCHECKS OFF} added to file to avoid runtime error when
528     program compiled with -CR command line switch.
529    
530     2. IServiceManager additions (informational):
531     function getProtocol: TProtocol;
532     function getPortNo: AnsiString;
533    
534     3. IServiceManager improved error handling. Interfaces changed:
535     function Start(Request: ISRB; RaiseExceptionOnError: boolean=true): boolean;
536     function Query(SQPB: ISQPB; Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;
537     function Query(Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;
538    
539     4. IAttachment addition (informational)
540     function GetSecurityDatabase: AnsiString;
541    
542     5. IStatement: performance counters now updated after each Fetch. GetPerfStatistics
543     thus now returns accumulated stats for a select statement from opening a cursor
544     up to the last fetch.
545    
546     6. DARWIN: uloadlibrary.inc bug fix. Many thanks to Luigi Naimi for correcting
547     the problem.
548    
549     7. Type change: "TPerfCounters = array[TPerfStats] of Int64". Note "Int64"
550     replaces deprecated "comp" type.
551    
552 tony 217 10. Testsuite Test10 updated to include thread synchronisation for event reporting.
553 tony 209
554 tony 231 11. URL Connection Strings: inet4 and inet6 now recognised.
555 tony 217
556 tony 231 12. IBUtils: Parse and Make Connect String now recognise URL style loopback syntax.
557    
558 tony 233 13. IAttachment.CharSetName2CharSetID is now performed case insensitive.
559 tony 231
560 tony 233
561 tony 209 FBINTF Change Log version (1.1-1) Tue, 27 Feb 2018 16:51:16 +0000
562    
563 tony 107 1. IBUtils.QuoteIdentifierIfNeeded: Add check for space character.
564    
565 tony 109 2. IAttachment: add two new methods
566     function HasDefaultCharSet: boolean;
567     function GetDefaultCharSetID: integer;
568    
569     These return, respectively, true if a connection default character set was
570 tony 117 specified and the character set id of the connection default character set.
571     The DefaultCharSetID is cached when the connection is opened and hence does not
572     require a database lookup.
573 tony 109
574 tony 110 3. Avoid exception when a text blob is a stored procedure parameter.
575 tony 109
576 tony 111 4. Update test suite to include a test for a stored proc returning a text blob.
577    
578 tony 117 5. IAttachment: add
579     function GetRemoteProtocol: AnsiString;
580     function GetODSMajorVersion: integer;
581     function GetODSMinorVersion: integer;
582 tony 143 function GetAuthenticationMethod: AnsiString;
583 tony 117
584     These results are cached when the connection is opened and hence do not
585     require a database lookup.
586    
587     6. IAttachment: add "function GetConnectString: AnsiString;" This returns the
588     connect string used to create/connect to the database.
589    
590     7. IAttachment: Create Database using SQL statement. The username and password
591     are now extracted and used to populate a DPB made available via IAttachment.getDPB.
592     It is now possible to use IAttachment disconnect/connect to reconnect to
593     a database for which the initial connection was established by a create
594 tony 120 database sql statement. Available in FPC only.
595 tony 117
596     8. Update Test 1 to test 5, 6 and 7 above.
597    
598     9. IBUtils code tidy up.
599    
600 tony 143 10. Parameter Block interfaces "find" method. As documented, this should have
601     returned a nil interface when the item could not be found. Instead, an empty
602     interface item was returned. "Find" now works as documented and will return
603     a nil interface if the item cannot be found.
604    
605     11. DBInformation: support added for isc_info_active_tran_count and isc_info_creation_date.
606    
607     12. DBInformation: New interfaces: IDIRB and IDIRBItem added to support DB Information
608     requests with additional parameters. This is to enable support for fb_info_page_contents
609     (return of page contents). Response to fb_info_page_contents returned as
610     a string with code page CP_NONE.
611    
612     13. DBInformation: Support for fb_info_pages_used and fb_info_pages_free added, plus
613     test suite updated.
614    
615     14. DBInformation: Support for fb_info_crypt_key (Firebird 3.0.3 onwards) added as
616     a string type, and fb_info_conn_flags (Firebird 3.0.3 onwards) added as an integer type.
617    
618     15. Service Manager: List of protocols supported expanded to include inet, wnet and xnet.
619     An overloaded version of IIFirebirdAPI.GetServiceManager also allows a non
620     default connection port to be specified.
621    
622 tony 107 FBINTF Change Log version (1.1-0) Sun, 07 Jan 2018 15:20:02 +0000
623    
624 tony 59 1. Fix issues with setting SQL Param values using SetAsString with Numeric types.
625     Scale is no longer ignored.
626    
627     2. Fix issues with setting SQL Param values using SetAsString with Date values
628     not in locale format but which are recognised by Firebird. Date values that
629     cannot be converted to a string using Pascal library are now passed through
630     to Firebird as Text Strings.
631    
632 tony 60 3. Lookup character set name by codepage amended to ensure that CP_UTF8 returns
633     UTF8 and not UNICODE_FSS.
634    
635     4. Charset ID problem. When using Firebird 3, with no default database character set
636     and a column has a non-default collation specified, an incorrect character set
637     id was being reported that could result in a 'division by zero' error when
638     used by IBX. This has now been fixed.
639    
640     5. Move GetCharsetName, CharSetID2CodePage, CodePage2CharSetID, CharSetName2CharSetID,
641     CharSetWidth from IFirebirdAPI to IAttachment. This is a better data model as
642     the character sets supported can be updated on a per database basis. That is
643     it is possible to add a (Firebird) user defined character set to a database.
644    
645     6. Add RegisterCharSet to IAttachment. This is used to register a user defined character
646     set supported by Firebird with the API.
647    
648 tony 61 7. Add missing isc_info_db_read_only to list of decoded Database Information items
649     in FBOutputBlock.pas and update test suite to include this item.
650 tony 60
651 tony 63 8. FB30Client: avoid always using "StartMultiple" when only a single database attachment.
652 tony 61
653 tony 68 9. Loading Windows fbclient.dll: when using the FIREBIRD variable to locate the client
654     library or finding it by disk location, the PATH environment variable is now also set to
655     include the FIREBIRD directory. This is to ensure that the correct dlls in the
656     firebird client library dependencies are loaded.
657 tony 63
658 tony 68 10. Testsuite: Ensure consistent UTF-8 output on Windows console.
659    
660     11. Testsuite: Update Windows script to include FPC 3.0.4 in search path.
661    
662     12. FB30Statement: Protect call to "Move" and avoid calling with a nil pointer
663    
664     13. FB30Statement: A check has been added to ensure that all SQL Parameters
665     have been given a value (including NULL). Previously, failing to set the
666     value of an SQL Parameter could give rise to unpredictable results or
667     an SQLDA error.
668    
669     14. FB30Statement/FB25Statement: Set SQLParam "modified" when string value set.
670    
671 tony 70 15. FBAttachment: Avoid string reference count error when processing an Ansistring
672     parameter in an array of const passed to IAttachment.OpenCursor, etc.
673 tony 68
674 tony 70 16. FBAttachment: Allow for WideString and UnicodeString parameters in an array
675     of const passed to IAttachment.OpenCursor, etc.
676    
677    
678 tony 56 FBINTF Change Log version (1.0-2) Sat, 04 Mar 2017 14:43:56 +0000
679 tony 47
680 tony 56 1. Change syntax to Mode Delphi
681    
682     2. Change all uses of string type to explicit AnsiString in order to ensure
683     compatibility between Delphi and FPC.
684    
685     3. Various syntax changes to ensure Delphi and FPC compilation including GUIDs
686     defined for each interface.
687    
688     4. Generics syntax variations for Delphi added
689    
690     5. PChar replaced with PByte expect where an actual string is being referenced,
691     where PAnsiChar is used instead.
692    
693     6. Review of type definitions in IBExternals to ensure Delphi compatibility
694    
695     7. Testsuite updated for Delphi
696    
697     FBINTF Change Log version (1.0-1) Fri, 24 Feb 2017 12:17:57 +0000
698    
699 tony 47 1. Limit maximum Blob segment read/write to MaxuShort. Avoids data loss with
700     large blobs and the FB3 API.
701    
702     2. Update Event Handling algorithm to avoid looping due to recreation of the
703     event block.
704    
705     3. Avoid invalid XSQLDA error when the only parameter is updated to null
706    
707     4. Array Handling: fix problem with text arrays with character set none. When the
708     DB connection has a default character set (e.g. UTF8), an error is raised by
709     Firebird if the space allocated is not enough to allow for transliteration, even
710     though it is not required for character set none.
711    
712     5. IBUtils: List of reserved words brought up-to-date
713    
714     6. Add ISQL style performance statistics collection to IStatement
715    
716     7. Add IFirebirdAPI.CreateDatabase variant to allow execution of user provided
717     CREATE DATABASE statement.
718    
719     8. Update SQL Statement parsing to allow for Array Dimensions. That is so that the ':' in
720     an array dimension is not mistaken for a named parameter prefix.
721    
722     9. Trim function no longer applied to result of GetAsString for SQL_TEXT
723     when Character set is octets. Avoids loss of non printable characters at start of string.
724    
725     10. Add function GetPerfStatistics to IStatement. This returns ISQL like performance
726     statistics for the last action. Requires use of procedure IStatement.EnableStatistics
727     to enable stats gathering.
728    
729     11. API Version information added as constants to IB.pas
730    
731     12. BlobMetaData character set id should now be the same as that given by IColumnMetaData.GetCharSetID
732    
733     13. Firebird Character set "NONE" now interpreted as codepage CP_ACP.
734    
735 tony 45 FBINTF Change Log version (1.0-0) Tue, 06 Dec 2016 10:33:47 +0000
736    
737     1. Initial Release
738