[ViewVC] Annotation of: public/ibx/trunk/fbintf/changelog

FBINTF Change Log  version          (1.3-2 Build 12832) Fri, 15 Oct 2021 12:03:18 +0100

1. TFBClientAPI.GetProcAddr. Add check for nil reference.

2. IStatement: new methods:
    procedure SetStaleReferenceChecks(Enable:boolean); {default true}
    function GetStaleReferenceChecks: boolean;

   In previous versions, stale reference checks were always enabled. This allows the
   user to disable them on a per statement basis. Note this can risk out-of-date
   statement BLR. See User Guide.

3. IBUtils: TSQLwithNamedParamsTokeniser now recognises a CASE...END block within a
   stored procedure and hence avoids replacing named parameters within a containing
   BEGIN..END block.

4. ISQLParam: using a string value to set an integer field with a scale factor of
   zero is now treated as a special case to avoid the risk of floating point
   rounding errors affecting pure integers.

5. ISQLParam:  Review and tidy-up of SetAsString for numeric types.

6. ISQLParam is now subclassed from IParamMetaData, which provides access to the mutable
   SQL Parameter metadata (methods moved from ISQLParam).

7. ISQLParam: new method
     function getColMetadata: IParamMetaData;
   This instance of IParamMetaData returns the original column metadata which is unmutable.
   Note: ISQLParam metadata can change after a parameter value has been set e.g when
   setting a VARCHAR column to an integer value.


FBINTF Change Log  version          (1.3-1 Build 12776) Mon, 23 Aug 2021 11:09:33 +0100

1. Integer decodes in information blocks (e.g. IDBInfoItem) widened from 32 bit to 64-bit integers.

2. Support for inline blob encoding. Blob values pass using the "SetAsString" method
   will now be encoded inline (i.e. as part of the parameter buffer) if they are
   shorter than a pre-set limit. Longer values continue to be saved as blobs as a
   separate server interaction. This is intended as a performance optimisation.

   The pre-set limit defaults to 8192 bytes and can be inspected/modified using the new
   IAttachment interface functions:

    function GetInlineBlobLimit: integer;
    procedure SetInlineBlobLimit(limit: integer);

3. Support for Firebird 4 IBatch interface added. This is largely transparent to the API
   user as the functionality is embedded in the implementation of the IStatement
   interface. Three new functions are defined:

    procedure AddToBatch;
    function ExecuteBatch(aTransaction: ITransaction=nil): IBatchCompletion;
    procedure CancelBatch;
    function GetBatchCompletion: IBatchCompletion;
    function GetBatchRowLimit: integer;
    procedure SetBatchRowLimit(aLimit: integer);

   Also

    function IsInBatchMode: boolean;        {true after call to execute(eaDefer)}
    function HasBatchMode: boolean;         {true if and only if IBatch Supported}

   For more information see the User Guide.

4. Default error message contents. Now aligned with User Guide section 10.2 i.e. error messages
   provided with the EIBInterBaseError now include all three parts.

5. Firebird.pas and include files updated to Firebird 4.0.0

6. New IStatement method: function GetSQLStatementTypeName: AnsiString;
   Returns SQL Statement type as a text string;

7. ISQLData.AsInteger and AsInt64 now use "Round" to convert a float field to
   an integer instead of "trunc". This is for compatibility with TFloatField.AsInteger.

FBINTF Change Log  version          (1.2-1 Build 12552) Wed, 09 Jun 2021 13:05:40 +0100

1. Big fix for Firebird 4.0. A internal change in Firebird 4.0.0 from RC1 flushed out a 
   typo in FB30Statement.pas that caused an unknown parameter error.

FBINTF Change Log  version          (1.2-0 Build 12520) Fri, 19 Feb 2021 13:27:23 +0000

1. Imported (Firebird) constants updated for Firebird 4.

2. Firebird.pas from Firebird 4 integrated into source code tree.

3. Added Support for TIMETAMP WITH TIME ZONE and TIME WITH TIME ZONE data types.

4. Added Support for SQL_DEC16, SQL_DEC34 and extended NUMERIC precision.

5. New unit 'FBClientLib.pas' added and provides new interface IFBIMasterProvider.
   QueryInterface may be used to coerce this interface from IFirebirdAPI. The
   interface provides a single method "function GetIMasterIntf: IMaster". This provides
   type safe access to the Firebird IMaster interface and avoids the need to turn
   off object checks when coercing "function GetIMaster: TObject" to IMaster.

6. New IFirebirdAPI Calls:
    function HasLocalTZDB: boolean;
    function HasTimeZoneSupport: boolean;
    function HasExtendedTZSupport: boolean;
    procedure SQLDecFloatEncode(aValue: tBCD; SQLType: cardinal; bufptr: PByte);
    function SQLDecFloatDecode(SQLType: cardinal; scale: integer; bufptr: PByte): tBCD;

7. New IAttachment Calls:
    function HasDecFloatSupport: boolean;
    function GetTimeZoneServices: ITimeZoneServices;
    function HasTimeZoneSupport: boolean;

8. New Interface ITimeZoneServices.

9. New ISQLData API Calls:
    procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
    procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
    procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
    procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
    function GetAsUTCDateTime: TDateTime;
    function GetAsBCD: tBCD;

10. New ISQLParam API Calls
    procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
    procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
    procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
    procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
    function GetAsUTCDateTime: TDateTime;
    function GetAsBCD: tBCD;
    function GetStatement: IStatement;
    function GetTransaction: ITransaction;
    procedure SetAsTime(aValue: TDateTime; OnDate: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
    procedure SetAsTime(aValue: TDateTime; OnDate: TDateTime; aTimeZone: AnsiString); overload;
    procedure SetAsDateTime(aValue: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
    procedure SetAsDateTime(aValue: TDateTime; aTimeZone: AnsiString); overload;
    procedure SetAsUTCDateTime(aUTCTime: TDateTime);
    procedure SetAsBcd(aValue: tBCD);

11. New IArray API Calls
    procedure GetAsDateTime(index: array of integer; var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
    procedure GetAsDateTime(index: array of integer; var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
    procedure GetAsTime(index: array of integer; var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
    procedure GetAsTime(index: array of integer; var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
    function GetAsUTCDateTime(index: array of integer): TDateTime;
    procedure SetAsDateTime(index: array of integer; aValue: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
    procedure SetAsDateTime(index: array of integer; aValue: TDateTime; aTimeZone: AnsiString); overload;
    procedure SetAsTime(index: array of integer; aValue: TDateTime; OnDate: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
    procedure SetAsTime(index: array of integer; aValue: TDateTime; OnDate: TDateTime; aTimeZone: AnsiString); overload;

12. Utility functions in IBUtils
    function ParseDateTimeTZString(aDateTimeStr: Ansistring; var aDateTime: TDateTime;
              var aTimezone: AnsiString; aFormatSettings: TFormatSettings; TimeOnly: boolean=false): boolean;
    procedure FBDecodeTime(aTime: TDateTime; var Hour, Minute, Second: word; var DeciMillisecond: cardinal);
    function FBEncodeTime(Hour, Minute, Second, DeciMillisecond: cardinal): TDateTime;
    function FBFormatDateTime(fmt: AnsiString; aDateTime: TDateTime): AnsiString;
    function FormatTimeZoneOffset(EffectiveTimeOffsetMins: integer): AnsiString;
    function DecodeTimeZoneOffset(TZOffset: AnsiString; var dstOffset: integer): boolean;

13. IDPB, ITPB and ISPB: new interface method
      function AddByTypeName(ParamTypeName: AnsiString): IDPBItem/ITPBItem/ISPBItem;
    This is used to add a parameter block item by the string equivalent of its
    symbolic type name. e.g. DPB.AddByTypeName('isc_dpb_user_name').AsString := '...'

14. IDPBItem/ITPBItem/ISPBItem: new interface method:
      function getParamTypeName: AnsiString;

15. fb_shutdown now called before unloading Firebird library. This can avoid a
     SIGEVENT error when a programme using the embeded server is unloaded.

FBINTF Change Log  version          (1.1-6 Build 12237) Tue, 21 Jul 2020 08:54:21 +0100

1. GetImplementationVersion now correctly returns '3.0' for Firebird 3 API
   with a Firebrid 3 client library.

2. Linux Only: FIREBIRD environment variable is now checked when loading the client library.
    If a client library path is not explicitly provided and the FIREBIRD environment
    variable is set then the directory given by this variable and any 'lib' subdirectory
    are searched for the Firebird client library. Only if none is found, is the default
    client library used.

3.  IUtil.FormatStatus now used to format error messages when using new API

4.  Fixed Array SDL: array_desc_scale now correctly encoded as a signed integer.

5.  SQL_TEXT handling changed. When the value of an SQL_TEXT (i.e. fixed width string) column is
    returned using GetAsString and the string codepage is UTF8, the string is truncated so
    that the byte length corresponds to the number of characters specified for the column.
    SQL_TEXT strings are no longer automatically trimmed to remove all trailing white space. This is
    correct behaviour but may affect some implementations that relied upon automatic
    trimming of trailing white space.

6.  New IFirebirdAPI Calls:
      function GetClientMajor: integer;
      function GetClientMinor: integer;

7.  IColumnMetaData and IArrayMetaData: new method
      function GetCharSetWidth: integer;

FBINTF Change Log  version          (1.1-5 Build 12022) Fri, 17 Apr 2020 10:35:55 +0100

1. ISQLParams.GetHasCaseSensitiveParams added. Returns true if param names are
   case sensitive

2. Single line SQL comments starting with '--' are now recognised by SQL Parser.

3. New API Calls:
        IColumnMetaData.GetStatement
        IColumnMetaData.GetTransaction
        ISQLData.GetStrDataLength
        IResults.GetStatement
        IAttachment.OpenBlob (using Blob metadata)
        IAttachment.OpenArray (using array metadata)

4. FBMessages: removal of unused messages

5. TFBArray.Create (2nd case): ensure that FFirebirdClientAPI is correctly set.

6. TIBSQLStatementType: SQLSavePoint added to end of enumeration.

FBINTF Change Log  version          (1.1-4 Build 11515)  Fri, 28 Dec 2018 10:04:19 +0000

1. Fix a problem with the SQL parameter parser that failed to recognise parameters
   where the second character of the parameter name is a numeric.

2. New method for IAttachment: procedure getFBVersion(version: TStrings);
   This returns the isc_version connection information as one or more lines.
   This is the same information as returned by isql with the -z option.

3. If -dFIREBIRD3APIONLY is used as a compiler option then the legacy Firebird API
   is no longer compiled in. Likewise, if -dLEGACYFIREBIRDAPIONLY is used as a
   compiler option then the Firebird 3 API is no longer compiled in.

4. IColumnMetaData: new method.

   TIBDateTimeFormats = (dfTimestamp, {SQL TIMESTAMP}
                        dfDateTime,   {SQL DATETIME}
                        dfTime);

   function GetDateTimeStrLength(DateTimeFormat: TIBDateTimeFormats): integer;

   This returns the max. number of characters returned by the "AsString" method
   when the SQL type of the column is respectively TIMESTAMP, DATETIME or TIME.

5. Additional argument for IAttachment.PrepareWithNamedParameters -
     CaseSensitiveParams: boolean = false

   If this argument is set to true then SQL parameter names are assumed to be case
   sensitive and must be referenced (using ISQLParams.ByName) using the case
   sensitive name.

6. Bug fix: when setting a query parameter, it is now possible, when the parameter
   is of type VarChar or Char to set the parameter to a numeric value (e.g. using
   .AsCurrency) and then subsequently to update the value to a non-numeric string
   using .AsString.


FBINTF Change Log  version                  (1.1-3) Wed, 05 Dec 2018 14:28:10 +0000

1. DARWIN only syntax error: fix missing semi-colon in TFBClientAPI.LoadIBLibrary

2. Restrict IsMultiThread check to Unix only for compatibility with
   https://bugs.freepascal.org/view.php?id=30535

3. New SQL Tokeniser added to IBUtils. This is used to pre-process SQL with
   named parameters and is intended to avoid problems with (e.g.) Execute Block
   and processing internal parameters as statement parameters.

4. New interface IFirebirdLibrary provides access to the underlying firebird DLL
   or shared object. Available via a new member (GetFBLibrary) of IFirebirdAPI.

5. New function added to IB.pas

   function LoadFBLibrary(aLibPathName: string): IFirebirdLibrary

   This allows a Firebird Library to be loaded from an explicit path. use the
   IFirebirdLibrary.GetFirebirdAPI member function to get the Firebird API using
   the library. It is possible to load Firebird libraries from different locations
   simultaneously, each with a distinct IFirebirdAPI.

FBINTF Change Log  version               (1.1-2) Mon, 16 Apr 2018 09:30:32 +0100

1. Firebird.pas: {$OBJECTCHECKS OFF} added to file to avoid runtime error when
   program compiled with -CR command line switch.

2. IServiceManager additions (informational):
    function getProtocol: TProtocol;
    function getPortNo: AnsiString;

3. IServiceManager improved error handling. Interfaces changed:
    function Start(Request: ISRB; RaiseExceptionOnError: boolean=true): boolean;
    function Query(SQPB: ISQPB; Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;
    function Query(Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;

4. IAttachment addition (informational)
    function GetSecurityDatabase: AnsiString;

5. IStatement: performance counters now updated after each Fetch. GetPerfStatistics
   thus now returns accumulated stats for a select statement from opening a cursor
   up to the last fetch.

6. DARWIN: uloadlibrary.inc bug fix. Many thanks to Luigi Naimi for correcting
   the problem.

7. Type change: "TPerfCounters = array[TPerfStats] of Int64". Note "Int64"
   replaces deprecated "comp" type.

10. Testsuite Test10 updated to include thread synchronisation for event reporting.

11. URL Connection Strings: inet4 and inet6 now recognised.

12. IBUtils: Parse and Make Connect String now recognise URL style loopback syntax.

13. IAttachment.CharSetName2CharSetID is now performed case insensitive.


FBINTF Change Log  version (1.1-1) Tue, 27 Feb 2018 16:51:16 +0000

1. IBUtils.QuoteIdentifierIfNeeded: Add check for space character.

2. IAttachment: add two new methods
     function HasDefaultCharSet: boolean;
     function GetDefaultCharSetID: integer;

   These return, respectively, true if a connection default character set was
   specified and the character set id of the connection default character set.
   The DefaultCharSetID is cached when the connection is opened and hence does not
   require a database lookup.

3. Avoid exception when a text blob is a stored procedure parameter.

4. Update test suite to include a test for a stored proc returning a text blob.

5. IAttachment: add
      function GetRemoteProtocol: AnsiString;
      function GetODSMajorVersion: integer;
      function GetODSMinorVersion: integer;
      function GetAuthenticationMethod: AnsiString;

   These results are cached when the connection is opened and hence do not
   require a database lookup.

6. IAttachment: add "function GetConnectString: AnsiString;" This returns the
   connect string used to create/connect to the database.

7. IAttachment: Create Database using SQL statement. The username and password
   are now extracted and used to populate a DPB made available via IAttachment.getDPB.
   It is now possible to use IAttachment disconnect/connect to reconnect to
   a database for which the initial connection was established by a create
   database sql statement. Available in FPC only.

8. Update Test 1 to test 5, 6 and 7 above.

9. IBUtils code tidy up.

10. Parameter Block interfaces "find" method. As documented, this should have
   returned a nil interface when the item could not be found. Instead, an empty
   interface item was returned. "Find" now works as documented and will return
   a nil interface if the item cannot be found.

11. DBInformation: support added for isc_info_active_tran_count and isc_info_creation_date.

12. DBInformation: New interfaces: IDIRB and IDIRBItem added to support DB Information
    requests with additional parameters. This is to enable support for fb_info_page_contents
    (return of page contents). Response to fb_info_page_contents returned as
    a string with code page CP_NONE.

13. DBInformation: Support for fb_info_pages_used and fb_info_pages_free added, plus
    test suite updated.

14. DBInformation: Support for fb_info_crypt_key (Firebird 3.0.3 onwards) added as
    a string type, and fb_info_conn_flags (Firebird 3.0.3 onwards) added as an integer type.

15. Service Manager: List of protocols supported expanded to include inet, wnet and xnet.
    An overloaded version of IIFirebirdAPI.GetServiceManager also allows a non
    default connection port to be specified.

FBINTF Change Log  version                             (1.1-0) Sun, 07 Jan 2018 15:20:02 +0000

1. Fix issues with setting SQL Param values using SetAsString with Numeric types.
   Scale is no longer ignored.

2. Fix issues with setting SQL Param values using SetAsString with Date values
   not in locale format but which are recognised by Firebird. Date values that
   cannot be converted to a string using Pascal library are now passed through
   to Firebird as Text Strings.

3. Lookup character set name by codepage amended to ensure that CP_UTF8 returns
   UTF8 and not UNICODE_FSS.

4. Charset ID problem. When using Firebird 3, with no default database character set
   and a column has a non-default collation specified, an incorrect character set
   id was being reported that could result in a 'division by zero' error when
   used by IBX. This has now been fixed.

5. Move GetCharsetName, CharSetID2CodePage, CodePage2CharSetID, CharSetName2CharSetID,
   CharSetWidth from IFirebirdAPI to IAttachment. This is a better data model as
   the character sets supported can be updated on a per database basis. That is
   it is possible to add a (Firebird) user defined character set to a database.

6. Add RegisterCharSet to IAttachment. This is used to register a user defined character
   set supported by Firebird with the API.

7. Add missing isc_info_db_read_only to list of decoded Database Information items
   in FBOutputBlock.pas and update test suite to include this item.

8. FB30Client: avoid always using "StartMultiple" when only a single database attachment.

9. Loading Windows fbclient.dll: when using the FIREBIRD variable to locate the client
   library or finding it by disk location, the PATH environment variable is now also set to
   include the FIREBIRD directory. This is to ensure that the correct dlls in the
   firebird client library dependencies are loaded.

10. Testsuite: Ensure consistent UTF-8 output on Windows console.

11. Testsuite: Update Windows script to include FPC 3.0.4 in search path.

12. FB30Statement: Protect call to "Move" and avoid calling with a nil pointer

13. FB30Statement: A check has been added to ensure that all SQL Parameters
    have been given a value (including NULL). Previously, failing to set the
    value of an SQL Parameter could give rise to unpredictable results or
    an SQLDA error.

14. FB30Statement/FB25Statement: Set SQLParam "modified" when string value set.

15. FBAttachment: Avoid string reference count error when processing an Ansistring
    parameter in an array of const passed to IAttachment.OpenCursor, etc.

16. FBAttachment: Allow for WideString and UnicodeString parameters in an array
    of const passed to IAttachment.OpenCursor, etc.


FBINTF Change Log  version             (1.0-2) Sat, 04 Mar 2017 14:43:56 +0000

1. Change syntax to Mode Delphi

2. Change all uses of string type to explicit AnsiString in order to ensure
   compatibility between Delphi and FPC. 

3. Various syntax changes to ensure Delphi and FPC compilation including GUIDs
   defined for each interface.

4. Generics syntax variations for Delphi added

5. PChar replaced with PByte expect where an actual string is being referenced,
   where PAnsiChar is used instead.

6. Review of type definitions in IBExternals to ensure Delphi compatibility

7. Testsuite updated for Delphi

FBINTF Change Log  version            (1.0-1) Fri, 24 Feb 2017 12:17:57 +0000

1. Limit maximum Blob segment read/write to MaxuShort. Avoids data loss with
   large blobs and the FB3 API.

2. Update Event Handling algorithm to avoid looping due to recreation of the
   event block.

3. Avoid invalid XSQLDA error when the only parameter is updated to null

4. Array Handling: fix problem with text arrays with character set none. When the
   DB connection has a default character set (e.g. UTF8), an error is raised by
   Firebird if the space allocated is not enough to allow for transliteration, even
   though it is not required for character set none.

5. IBUtils: List of reserved words brought up-to-date

6. Add ISQL style performance statistics collection to IStatement

7. Add IFirebirdAPI.CreateDatabase variant to allow execution of user provided
   CREATE DATABASE statement.

8. Update SQL Statement parsing to allow for Array Dimensions. That is so that the ':' in
   an array dimension is not mistaken for a named parameter prefix.

9. Trim function no longer applied to result of GetAsString for SQL_TEXT
   when Character set is octets. Avoids loss of non printable characters at start of string.

10. Add function GetPerfStatistics to IStatement. This returns ISQL like performance
    statistics for the last action. Requires use of procedure IStatement.EnableStatistics
    to enable stats gathering.

11. API Version information added as constants to IB.pas

12. BlobMetaData character set id should now be the same as that given by IColumnMetaData.GetCharSetID

13. Firebird Character set "NONE" now interpreted as codepage CP_ACP.

FBINTF Change Log  version                                      (1.0-0) Tue, 06 Dec 2016 10:33:47 +0000

1. Initial Release

Revision:	349
Committed:	Mon Oct 18 08:39:40 2021 UTC (3 years, 1 month ago) by tony
File size:	23280 byte(s)
Log Message:	FIxes Merged