| 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. |
| 317 |
|
| 318 |
2. Support for inline blob encoding. Blob values pass using the "SetAsString" method |
| 319 |
will now be encoded inline (i.e. as part of the parameter buffer) if they are |
| 320 |
shorter than a pre-set limit. Longer values continue to be saved as blobs as a |
| 321 |
separate server interaction. This is intended as a performance optimisation. |
| 322 |
|
| 323 |
The pre-set limit defaults to 8192 bytes and can be inspected/modified using the new |
| 324 |
IAttachment interface functions: |
| 325 |
|
| 326 |
function GetInlineBlobLimit: integer; |
| 327 |
procedure SetInlineBlobLimit(limit: integer); |
| 328 |
|
| 329 |
3. Support for Firebird 4 IBatch interface added. This is largely transparent to the API |
| 330 |
user as the functionality is embedded in the implementation of the IStatement |
| 331 |
interface. Three new functions are defined: |
| 332 |
|
| 333 |
procedure AddToBatch; |
| 334 |
function ExecuteBatch(aTransaction: ITransaction=nil): IBatchCompletion; |
| 335 |
procedure CancelBatch; |
| 336 |
function GetBatchCompletion: IBatchCompletion; |
| 337 |
function GetBatchRowLimit: integer; |
| 338 |
procedure SetBatchRowLimit(aLimit: integer); |
| 339 |
|
| 340 |
Also |
| 341 |
|
| 342 |
function IsInBatchMode: boolean; {true after call to execute(eaDefer)} |
| 343 |
function HasBatchMode: boolean; {true if and only if IBatch Supported} |
| 344 |
|
| 345 |
For more information see the User Guide. |
| 346 |
|
| 347 |
4. Default error message contents. Now aligned with User Guide section 10.2 i.e. error messages |
| 348 |
provided with the EIBInterBaseError now include all three parts. |
| 349 |
|
| 350 |
5. Firebird.pas and include files updated to Firebird 4.0.0 |
| 351 |
|
| 352 |
6. New IStatement method: function GetSQLStatementTypeName: AnsiString; |
| 353 |
Returns SQL Statement type as a text string; |
| 354 |
|
| 355 |
7. ISQLData.AsInteger and AsInt64 now use "Round" to convert a float field to |
| 356 |
an integer instead of "trunc". This is for compatibility with TFloatField.AsInteger. |
| 357 |
|
| 358 |
FBINTF Change Log version (1.2-1 Build 12552) Wed, 09 Jun 2021 13:05:40 +0100 |
| 359 |
|
| 360 |
1. Big fix for Firebird 4.0. A internal change in Firebird 4.0.0 from RC1 flushed out a |
| 361 |
typo in FB30Statement.pas that caused an unknown parameter error. |
| 362 |
|
| 363 |
FBINTF Change Log version (1.2-0 Build 12520) Fri, 19 Feb 2021 13:27:23 +0000 |
| 364 |
|
| 365 |
1. Imported (Firebird) constants updated for Firebird 4. |
| 366 |
|
| 367 |
2. Firebird.pas from Firebird 4 integrated into source code tree. |
| 368 |
|
| 369 |
3. Added Support for TIMETAMP WITH TIME ZONE and TIME WITH TIME ZONE data types. |
| 370 |
|
| 371 |
4. Added Support for SQL_DEC16, SQL_DEC34 and extended NUMERIC precision. |
| 372 |
|
| 373 |
5. New unit 'FBClientLib.pas' added and provides new interface IFBIMasterProvider. |
| 374 |
QueryInterface may be used to coerce this interface from IFirebirdAPI. The |
| 375 |
interface provides a single method "function GetIMasterIntf: IMaster". This provides |
| 376 |
type safe access to the Firebird IMaster interface and avoids the need to turn |
| 377 |
off object checks when coercing "function GetIMaster: TObject" to IMaster. |
| 378 |
|
| 379 |
6. New IFirebirdAPI Calls: |
| 380 |
function HasLocalTZDB: boolean; |
| 381 |
function HasTimeZoneSupport: boolean; |
| 382 |
function HasExtendedTZSupport: boolean; |
| 383 |
procedure SQLDecFloatEncode(aValue: tBCD; SQLType: cardinal; bufptr: PByte); |
| 384 |
function SQLDecFloatDecode(SQLType: cardinal; scale: integer; bufptr: PByte): tBCD; |
| 385 |
|
| 386 |
7. New IAttachment Calls: |
| 387 |
function HasDecFloatSupport: boolean; |
| 388 |
function GetTimeZoneServices: ITimeZoneServices; |
| 389 |
function HasTimeZoneSupport: boolean; |
| 390 |
|
| 391 |
8. New Interface ITimeZoneServices. |
| 392 |
|
| 393 |
9. New ISQLData API Calls: |
| 394 |
procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload; |
| 395 |
procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload; |
| 396 |
procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload; |
| 397 |
procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload; |
| 398 |
function GetAsUTCDateTime: TDateTime; |
| 399 |
function GetAsBCD: tBCD; |
| 400 |
|
| 401 |
10. New ISQLParam API Calls |
| 402 |
procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload; |
| 403 |
procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload; |
| 404 |
procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload; |
| 405 |
procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload; |
| 406 |
function GetAsUTCDateTime: TDateTime; |
| 407 |
function GetAsBCD: tBCD; |
| 408 |
function GetStatement: IStatement; |
| 409 |
function GetTransaction: ITransaction; |
| 410 |
procedure SetAsTime(aValue: TDateTime; OnDate: TDateTime; aTimeZoneID: TFBTimeZoneID); overload; |
| 411 |
procedure SetAsTime(aValue: TDateTime; OnDate: TDateTime; aTimeZone: AnsiString); overload; |
| 412 |
procedure SetAsDateTime(aValue: TDateTime; aTimeZoneID: TFBTimeZoneID); overload; |
| 413 |
procedure SetAsDateTime(aValue: TDateTime; aTimeZone: AnsiString); overload; |
| 414 |
procedure SetAsUTCDateTime(aUTCTime: TDateTime); |
| 415 |
procedure SetAsBcd(aValue: tBCD); |
| 416 |
|
| 417 |
11. New IArray API Calls |
| 418 |
procedure GetAsDateTime(index: array of integer; var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload; |
| 419 |
procedure GetAsDateTime(index: array of integer; var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload; |
| 420 |
procedure GetAsTime(index: array of integer; var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload; |
| 421 |
procedure GetAsTime(index: array of integer; var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload; |
| 422 |
function GetAsUTCDateTime(index: array of integer): TDateTime; |
| 423 |
procedure SetAsDateTime(index: array of integer; aValue: TDateTime; aTimeZoneID: TFBTimeZoneID); overload; |
| 424 |
procedure SetAsDateTime(index: array of integer; aValue: TDateTime; aTimeZone: AnsiString); overload; |
| 425 |
procedure SetAsTime(index: array of integer; aValue: TDateTime; OnDate: TDateTime; aTimeZoneID: TFBTimeZoneID); overload; |
| 426 |
procedure SetAsTime(index: array of integer; aValue: TDateTime; OnDate: TDateTime; aTimeZone: AnsiString); overload; |
| 427 |
|
| 428 |
12. Utility functions in IBUtils |
| 429 |
function ParseDateTimeTZString(aDateTimeStr: Ansistring; var aDateTime: TDateTime; |
| 430 |
var aTimezone: AnsiString; aFormatSettings: TFormatSettings; TimeOnly: boolean=false): boolean; |
| 431 |
procedure FBDecodeTime(aTime: TDateTime; var Hour, Minute, Second: word; var DeciMillisecond: cardinal); |
| 432 |
function FBEncodeTime(Hour, Minute, Second, DeciMillisecond: cardinal): TDateTime; |
| 433 |
function FBFormatDateTime(fmt: AnsiString; aDateTime: TDateTime): AnsiString; |
| 434 |
function FormatTimeZoneOffset(EffectiveTimeOffsetMins: integer): AnsiString; |
| 435 |
function DecodeTimeZoneOffset(TZOffset: AnsiString; var dstOffset: integer): boolean; |
| 436 |
|
| 437 |
13. IDPB, ITPB and ISPB: new interface method |
| 438 |
function AddByTypeName(ParamTypeName: AnsiString): IDPBItem/ITPBItem/ISPBItem; |
| 439 |
This is used to add a parameter block item by the string equivalent of its |
| 440 |
symbolic type name. e.g. DPB.AddByTypeName('isc_dpb_user_name').AsString := '...' |
| 441 |
|
| 442 |
14. IDPBItem/ITPBItem/ISPBItem: new interface method: |
| 443 |
function getParamTypeName: AnsiString; |
| 444 |
|
| 445 |
15. fb_shutdown now called before unloading Firebird library. This can avoid a |
| 446 |
SIGEVENT error when a programme using the embeded server is unloaded. |
| 447 |
|
| 448 |
FBINTF Change Log version (1.1-6 Build 12237) Tue, 21 Jul 2020 08:54:21 +0100 |
| 449 |
|
| 450 |
1. GetImplementationVersion now correctly returns '3.0' for Firebird 3 API |
| 451 |
with a Firebrid 3 client library. |
| 452 |
|
| 453 |
2. Linux Only: FIREBIRD environment variable is now checked when loading the client library. |
| 454 |
If a client library path is not explicitly provided and the FIREBIRD environment |
| 455 |
variable is set then the directory given by this variable and any 'lib' subdirectory |
| 456 |
are searched for the Firebird client library. Only if none is found, is the default |
| 457 |
client library used. |
| 458 |
|
| 459 |
3. IUtil.FormatStatus now used to format error messages when using new API |
| 460 |
|
| 461 |
4. Fixed Array SDL: array_desc_scale now correctly encoded as a signed integer. |
| 462 |
|
| 463 |
5. SQL_TEXT handling changed. When the value of an SQL_TEXT (i.e. fixed width string) column is |
| 464 |
returned using GetAsString and the string codepage is UTF8, the string is truncated so |
| 465 |
that the byte length corresponds to the number of characters specified for the column. |
| 466 |
SQL_TEXT strings are no longer automatically trimmed to remove all trailing white space. This is |
| 467 |
correct behaviour but may affect some implementations that relied upon automatic |
| 468 |
trimming of trailing white space. |
| 469 |
|
| 470 |
6. New IFirebirdAPI Calls: |
| 471 |
function GetClientMajor: integer; |
| 472 |
function GetClientMinor: integer; |
| 473 |
|
| 474 |
7. IColumnMetaData and IArrayMetaData: new method |
| 475 |
function GetCharSetWidth: integer; |
| 476 |
|
| 477 |
FBINTF Change Log version (1.1-5 Build 12022) Fri, 17 Apr 2020 10:35:55 +0100 |
| 478 |
|
| 479 |
1. ISQLParams.GetHasCaseSensitiveParams added. Returns true if param names are |
| 480 |
case sensitive |
| 481 |
|
| 482 |
2. Single line SQL comments starting with '--' are now recognised by SQL Parser. |
| 483 |
|
| 484 |
3. New API Calls: |
| 485 |
IColumnMetaData.GetStatement |
| 486 |
IColumnMetaData.GetTransaction |
| 487 |
ISQLData.GetStrDataLength |
| 488 |
IResults.GetStatement |
| 489 |
IAttachment.OpenBlob (using Blob metadata) |
| 490 |
IAttachment.OpenArray (using array metadata) |
| 491 |
|
| 492 |
4. FBMessages: removal of unused messages |
| 493 |
|
| 494 |
5. TFBArray.Create (2nd case): ensure that FFirebirdClientAPI is correctly set. |
| 495 |
|
| 496 |
6. TIBSQLStatementType: SQLSavePoint added to end of enumeration. |
| 497 |
|
| 498 |
FBINTF Change Log version (1.1-4 Build 11515) Fri, 28 Dec 2018 10:04:19 +0000 |
| 499 |
|
| 500 |
1. Fix a problem with the SQL parameter parser that failed to recognise parameters |
| 501 |
where the second character of the parameter name is a numeric. |
| 502 |
|
| 503 |
2. New method for IAttachment: procedure getFBVersion(version: TStrings); |
| 504 |
This returns the isc_version connection information as one or more lines. |
| 505 |
This is the same information as returned by isql with the -z option. |
| 506 |
|
| 507 |
3. If -dFIREBIRD3APIONLY is used as a compiler option then the legacy Firebird API |
| 508 |
is no longer compiled in. Likewise, if -dLEGACYFIREBIRDAPIONLY is used as a |
| 509 |
compiler option then the Firebird 3 API is no longer compiled in. |
| 510 |
|
| 511 |
4. IColumnMetaData: new method. |
| 512 |
|
| 513 |
TIBDateTimeFormats = (dfTimestamp, {SQL TIMESTAMP} |
| 514 |
dfDateTime, {SQL DATETIME} |
| 515 |
dfTime); |
| 516 |
|
| 517 |
function GetDateTimeStrLength(DateTimeFormat: TIBDateTimeFormats): integer; |
| 518 |
|
| 519 |
This returns the max. number of characters returned by the "AsString" method |
| 520 |
when the SQL type of the column is respectively TIMESTAMP, DATETIME or TIME. |
| 521 |
|
| 522 |
5. Additional argument for IAttachment.PrepareWithNamedParameters - |
| 523 |
CaseSensitiveParams: boolean = false |
| 524 |
|
| 525 |
If this argument is set to true then SQL parameter names are assumed to be case |
| 526 |
sensitive and must be referenced (using ISQLParams.ByName) using the case |
| 527 |
sensitive name. |
| 528 |
|
| 529 |
6. Bug fix: when setting a query parameter, it is now possible, when the parameter |
| 530 |
is of type VarChar or Char to set the parameter to a numeric value (e.g. using |
| 531 |
.AsCurrency) and then subsequently to update the value to a non-numeric string |
| 532 |
using .AsString. |
| 533 |
|
| 534 |
|
| 535 |
|
| 536 |
FBINTF Change Log version (1.1-3) Wed, 05 Dec 2018 14:28:10 +0000 |
| 537 |
|
| 538 |
1. DARWIN only syntax error: fix missing semi-colon in TFBClientAPI.LoadIBLibrary |
| 539 |
|
| 540 |
2. Restrict IsMultiThread check to Unix only for compatibility with |
| 541 |
https://bugs.freepascal.org/view.php?id=30535 |
| 542 |
|
| 543 |
3. New SQL Tokeniser added to IBUtils. This is used to pre-process SQL with |
| 544 |
named parameters and is intended to avoid problems with (e.g.) Execute Block |
| 545 |
and processing internal parameters as statement parameters. |
| 546 |
|
| 547 |
4. New interface IFirebirdLibrary provides access to the underlying firebird DLL |
| 548 |
or shared object. Available via a new member (GetFBLibrary) of IFirebirdAPI. |
| 549 |
|
| 550 |
5. New function added to IB.pas |
| 551 |
|
| 552 |
function LoadFBLibrary(aLibPathName: string): IFirebirdLibrary |
| 553 |
|
| 554 |
This allows a Firebird Library to be loaded from an explicit path. use the |
| 555 |
IFirebirdLibrary.GetFirebirdAPI member function to get the Firebird API using |
| 556 |
the library. It is possible to load Firebird libraries from different locations |
| 557 |
simultaneously, each with a distinct IFirebirdAPI. |
| 558 |
|
| 559 |
FBINTF Change Log version (1.1-2) Mon, 16 Apr 2018 09:30:32 +0100 |
| 560 |
|
| 561 |
1. Firebird.pas: {$OBJECTCHECKS OFF} added to file to avoid runtime error when |
| 562 |
program compiled with -CR command line switch. |
| 563 |
|
| 564 |
2. IServiceManager additions (informational): |
| 565 |
function getProtocol: TProtocol; |
| 566 |
function getPortNo: AnsiString; |
| 567 |
|
| 568 |
3. IServiceManager improved error handling. Interfaces changed: |
| 569 |
function Start(Request: ISRB; RaiseExceptionOnError: boolean=true): boolean; |
| 570 |
function Query(SQPB: ISQPB; Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload; |
| 571 |
function Query(Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload; |
| 572 |
|
| 573 |
4. IAttachment addition (informational) |
| 574 |
function GetSecurityDatabase: AnsiString; |
| 575 |
|
| 576 |
5. IStatement: performance counters now updated after each Fetch. GetPerfStatistics |
| 577 |
thus now returns accumulated stats for a select statement from opening a cursor |
| 578 |
up to the last fetch. |
| 579 |
|
| 580 |
6. DARWIN: uloadlibrary.inc bug fix. Many thanks to Luigi Naimi for correcting |
| 581 |
the problem. |
| 582 |
|
| 583 |
7. Type change: "TPerfCounters = array[TPerfStats] of Int64". Note "Int64" |
| 584 |
replaces deprecated "comp" type. |
| 585 |
|
| 586 |
10. Testsuite Test10 updated to include thread synchronisation for event reporting. |
| 587 |
|
| 588 |
11. URL Connection Strings: inet4 and inet6 now recognised. |
| 589 |
|
| 590 |
12. IBUtils: Parse and Make Connect String now recognise URL style loopback syntax. |
| 591 |
|
| 592 |
13. IAttachment.CharSetName2CharSetID is now performed case insensitive. |
| 593 |
|
| 594 |
|
| 595 |
FBINTF Change Log version (1.1-1) Tue, 27 Feb 2018 16:51:16 +0000 |
| 596 |
|
| 597 |
1. IBUtils.QuoteIdentifierIfNeeded: Add check for space character. |
| 598 |
|
| 599 |
2. IAttachment: add two new methods |
| 600 |
function HasDefaultCharSet: boolean; |
| 601 |
function GetDefaultCharSetID: integer; |
| 602 |
|
| 603 |
These return, respectively, true if a connection default character set was |
| 604 |
specified and the character set id of the connection default character set. |
| 605 |
The DefaultCharSetID is cached when the connection is opened and hence does not |
| 606 |
require a database lookup. |
| 607 |
|
| 608 |
3. Avoid exception when a text blob is a stored procedure parameter. |
| 609 |
|
| 610 |
4. Update test suite to include a test for a stored proc returning a text blob. |
| 611 |
|
| 612 |
5. IAttachment: add |
| 613 |
function GetRemoteProtocol: AnsiString; |
| 614 |
function GetODSMajorVersion: integer; |
| 615 |
function GetODSMinorVersion: integer; |
| 616 |
function GetAuthenticationMethod: AnsiString; |
| 617 |
|
| 618 |
These results are cached when the connection is opened and hence do not |
| 619 |
require a database lookup. |
| 620 |
|
| 621 |
6. IAttachment: add "function GetConnectString: AnsiString;" This returns the |
| 622 |
connect string used to create/connect to the database. |
| 623 |
|
| 624 |
7. IAttachment: Create Database using SQL statement. The username and password |
| 625 |
are now extracted and used to populate a DPB made available via IAttachment.getDPB. |
| 626 |
It is now possible to use IAttachment disconnect/connect to reconnect to |
| 627 |
a database for which the initial connection was established by a create |
| 628 |
database sql statement. Available in FPC only. |
| 629 |
|
| 630 |
8. Update Test 1 to test 5, 6 and 7 above. |
| 631 |
|
| 632 |
9. IBUtils code tidy up. |
| 633 |
|
| 634 |
10. Parameter Block interfaces "find" method. As documented, this should have |
| 635 |
returned a nil interface when the item could not be found. Instead, an empty |
| 636 |
interface item was returned. "Find" now works as documented and will return |
| 637 |
a nil interface if the item cannot be found. |
| 638 |
|
| 639 |
11. DBInformation: support added for isc_info_active_tran_count and isc_info_creation_date. |
| 640 |
|
| 641 |
12. DBInformation: New interfaces: IDIRB and IDIRBItem added to support DB Information |
| 642 |
requests with additional parameters. This is to enable support for fb_info_page_contents |
| 643 |
(return of page contents). Response to fb_info_page_contents returned as |
| 644 |
a string with code page CP_NONE. |
| 645 |
|
| 646 |
13. DBInformation: Support for fb_info_pages_used and fb_info_pages_free added, plus |
| 647 |
test suite updated. |
| 648 |
|
| 649 |
14. DBInformation: Support for fb_info_crypt_key (Firebird 3.0.3 onwards) added as |
| 650 |
a string type, and fb_info_conn_flags (Firebird 3.0.3 onwards) added as an integer type. |
| 651 |
|
| 652 |
15. Service Manager: List of protocols supported expanded to include inet, wnet and xnet. |
| 653 |
An overloaded version of IIFirebirdAPI.GetServiceManager also allows a non |
| 654 |
default connection port to be specified. |
| 655 |
|
| 656 |
FBINTF Change Log version (1.1-0) Sun, 07 Jan 2018 15:20:02 +0000 |
| 657 |
|
| 658 |
1. Fix issues with setting SQL Param values using SetAsString with Numeric types. |
| 659 |
Scale is no longer ignored. |
| 660 |
|
| 661 |
2. Fix issues with setting SQL Param values using SetAsString with Date values |
| 662 |
not in locale format but which are recognised by Firebird. Date values that |
| 663 |
cannot be converted to a string using Pascal library are now passed through |
| 664 |
to Firebird as Text Strings. |
| 665 |
|
| 666 |
3. Lookup character set name by codepage amended to ensure that CP_UTF8 returns |
| 667 |
UTF8 and not UNICODE_FSS. |
| 668 |
|
| 669 |
4. Charset ID problem. When using Firebird 3, with no default database character set |
| 670 |
and a column has a non-default collation specified, an incorrect character set |
| 671 |
id was being reported that could result in a 'division by zero' error when |
| 672 |
used by IBX. This has now been fixed. |
| 673 |
|
| 674 |
5. Move GetCharsetName, CharSetID2CodePage, CodePage2CharSetID, CharSetName2CharSetID, |
| 675 |
CharSetWidth from IFirebirdAPI to IAttachment. This is a better data model as |
| 676 |
the character sets supported can be updated on a per database basis. That is |
| 677 |
it is possible to add a (Firebird) user defined character set to a database. |
| 678 |
|
| 679 |
6. Add RegisterCharSet to IAttachment. This is used to register a user defined character |
| 680 |
set supported by Firebird with the API. |
| 681 |
|
| 682 |
7. Add missing isc_info_db_read_only to list of decoded Database Information items |
| 683 |
in FBOutputBlock.pas and update test suite to include this item. |
| 684 |
|
| 685 |
8. FB30Client: avoid always using "StartMultiple" when only a single database attachment. |
| 686 |
|
| 687 |
9. Loading Windows fbclient.dll: when using the FIREBIRD variable to locate the client |
| 688 |
library or finding it by disk location, the PATH environment variable is now also set to |
| 689 |
include the FIREBIRD directory. This is to ensure that the correct dlls in the |
| 690 |
firebird client library dependencies are loaded. |
| 691 |
|
| 692 |
10. Testsuite: Ensure consistent UTF-8 output on Windows console. |
| 693 |
|
| 694 |
11. Testsuite: Update Windows script to include FPC 3.0.4 in search path. |
| 695 |
|
| 696 |
12. FB30Statement: Protect call to "Move" and avoid calling with a nil pointer |
| 697 |
|
| 698 |
13. FB30Statement: A check has been added to ensure that all SQL Parameters |
| 699 |
have been given a value (including NULL). Previously, failing to set the |
| 700 |
value of an SQL Parameter could give rise to unpredictable results or |
| 701 |
an SQLDA error. |
| 702 |
|
| 703 |
14. FB30Statement/FB25Statement: Set SQLParam "modified" when string value set. |
| 704 |
|
| 705 |
15. FBAttachment: Avoid string reference count error when processing an Ansistring |
| 706 |
parameter in an array of const passed to IAttachment.OpenCursor, etc. |
| 707 |
|
| 708 |
16. FBAttachment: Allow for WideString and UnicodeString parameters in an array |
| 709 |
of const passed to IAttachment.OpenCursor, etc. |
| 710 |
|
| 711 |
|
| 712 |
FBINTF Change Log version (1.0-2) Sat, 04 Mar 2017 14:43:56 +0000 |
| 713 |
|
| 714 |
1. Change syntax to Mode Delphi |
| 715 |
|
| 716 |
2. Change all uses of string type to explicit AnsiString in order to ensure |
| 717 |
compatibility between Delphi and FPC. |
| 718 |
|
| 719 |
3. Various syntax changes to ensure Delphi and FPC compilation including GUIDs |
| 720 |
defined for each interface. |
| 721 |
|
| 722 |
4. Generics syntax variations for Delphi added |
| 723 |
|
| 724 |
5. PChar replaced with PByte expect where an actual string is being referenced, |
| 725 |
where PAnsiChar is used instead. |
| 726 |
|
| 727 |
6. Review of type definitions in IBExternals to ensure Delphi compatibility |
| 728 |
|
| 729 |
7. Testsuite updated for Delphi |
| 730 |
|
| 731 |
FBINTF Change Log version (1.0-1) Fri, 24 Feb 2017 12:17:57 +0000 |
| 732 |
|
| 733 |
1. Limit maximum Blob segment read/write to MaxuShort. Avoids data loss with |
| 734 |
large blobs and the FB3 API. |
| 735 |
|
| 736 |
2. Update Event Handling algorithm to avoid looping due to recreation of the |
| 737 |
event block. |
| 738 |
|
| 739 |
3. Avoid invalid XSQLDA error when the only parameter is updated to null |
| 740 |
|
| 741 |
4. Array Handling: fix problem with text arrays with character set none. When the |
| 742 |
DB connection has a default character set (e.g. UTF8), an error is raised by |
| 743 |
Firebird if the space allocated is not enough to allow for transliteration, even |
| 744 |
though it is not required for character set none. |
| 745 |
|
| 746 |
5. IBUtils: List of reserved words brought up-to-date |
| 747 |
|
| 748 |
6. Add ISQL style performance statistics collection to IStatement |
| 749 |
|
| 750 |
7. Add IFirebirdAPI.CreateDatabase variant to allow execution of user provided |
| 751 |
CREATE DATABASE statement. |
| 752 |
|
| 753 |
8. Update SQL Statement parsing to allow for Array Dimensions. That is so that the ':' in |
| 754 |
an array dimension is not mistaken for a named parameter prefix. |
| 755 |
|
| 756 |
9. Trim function no longer applied to result of GetAsString for SQL_TEXT |
| 757 |
when Character set is octets. Avoids loss of non printable characters at start of string. |
| 758 |
|
| 759 |
10. Add function GetPerfStatistics to IStatement. This returns ISQL like performance |
| 760 |
statistics for the last action. Requires use of procedure IStatement.EnableStatistics |
| 761 |
to enable stats gathering. |
| 762 |
|
| 763 |
11. API Version information added as constants to IB.pas |
| 764 |
|
| 765 |
12. BlobMetaData character set id should now be the same as that given by IColumnMetaData.GetCharSetID |
| 766 |
|
| 767 |
13. Firebird Character set "NONE" now interpreted as codepage CP_ACP. |
| 768 |
|
| 769 |
FBINTF Change Log version (1.0-0) Tue, 06 Dec 2016 10:33:47 +0000 |
| 770 |
|
| 771 |
1. Initial Release |
| 772 |
|
