SQL Server

Throttle FTP Transfer Bandwidth

Demonstrates the bandwidth properties BandwidthThrottleUp and BandwidthThrottleDown, and the read-only UploadTransferRate and DownloadTransferRate.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: Throttling caps the approximate transfer rate in bytes per second (0 means unlimited), which is how a background sync avoids starving interactive traffic on a shared or metered link. The rate properties report the current measured throughput, updated during transfers, so you can display progress or confirm the throttle is taking effect. Treat the limits as approximate targets rather than hard ceilings.

Chilkat SQL Server Downloads

Download Chilkat for SQL Server

SQL Server

--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

    DECLARE @ftp int
    EXEC @hr = sp_OACreate 'Chilkat.Ftp2', @ftp OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OASetProperty @ftp, 'Hostname', 'ftp.example.com'
    EXEC sp_OASetProperty @ftp, 'Username', 'myFtpLogin'

    --  Limit the approximate transfer rate in bytes per second.  0 (the default) means no limit.
    --  Throttling is useful to avoid saturating a shared link.
    EXEC sp_OASetProperty @ftp, 'BandwidthThrottleDown', 1048576
    EXEC sp_OASetProperty @ftp, 'BandwidthThrottleUp', 524288

    --  Normally you would not hard-code the password in source.  You should instead obtain it
    --  from an interactive prompt, environment variable, or a secrets vault.
    EXEC sp_OASetProperty @ftp, 'Password', 'myPassword'

    EXEC sp_OAMethod @ftp, 'Connect', @success OUT
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ftp
        RETURN
      END

    EXEC sp_OAMethod @ftp, 'GetFile', @success OUT, 'public_html/bigfile.zip', 'qa_output/bigfile.zip'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ftp
        RETURN
      END

    --  The current average rates are updated during transfers.

    EXEC sp_OAGetProperty @ftp, 'DownloadTransferRate', @iTmp0 OUT

    PRINT 'Download rate: ' + @iTmp0 + ' bytes/sec'

    EXEC sp_OAGetProperty @ftp, 'UploadTransferRate', @iTmp0 OUT

    PRINT 'Upload rate: ' + @iTmp0 + ' bytes/sec'

    EXEC sp_OAMethod @ftp, 'Disconnect', @success OUT
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ftp
        RETURN
      END

    EXEC @hr = sp_OADestroy @ftp


END
GO