Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

Node.js Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Node.js) Azure File Service: Upload Large File

Sample code to upload a large file to a directory in a share in the Azure File Service. A file is uploaded by first creating the file in the Azure share and then writing ranges of bytes to the file. Azure imposes a 4MB limit for each PUT to write a range. Files larger than 4MB need to be uploaded by making multiple "Put Range" calls. This example uploads a large file requiring multiple "Put Range" calls.

Install Chilkat for Node.js and Electron using npm at

Chilkat npm packages for Node.js

Chilkat npm packages for Electron

on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // Azure File Service Example: Upload a large file.  
    // See:  https://docs.microsoft.com/en-us/rest/api/storageservices/create-share
    // also see: https://docs.microsoft.com/en-us/rest/api/storageservices/put-range

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var rest = new chilkat.Rest();

    // Connect to the Azure Storage Blob Service
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    // In this example, the storage account name is "chilkat".
    var success = rest.Connect("chilkat.file.core.windows.net",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    // This example will upload a larger file.
    var localFilePath = "qa_data/zips/somethingBig.zip";
    var fac = new chilkat.FileAccess();
    // Note: The FileSize method returns a signed 32-bit integer.  If the file is potentially larger than 2GB, call FileSizeStr instead to return
    // the size of the file as a string, then convert to an integer value.
    var szLocalFile = fac.FileSize(localFilePath);
    if (szLocalFile < 0) {
        console.log(fac.LastErrorText);
        return;
    }

    // Provide Azure Cloud credentials for the REST calls.
    var azAuth = new chilkat.AuthAzureStorage();
    azAuth.AccessKey = "AZURE_ACCESS_KEY";
    // The account name used here should match the 1st part of the domain passed in the call to Connect (above).
    azAuth.Account = "chilkat";
    azAuth.Scheme = "SharedKey";
    azAuth.Service = "File";
    // This causes the "x-ms-version: 2021-08-06" header to be automatically added.
    azAuth.XMsVersion = "2021-08-06";
    success = rest.SetAuthAzureStorage(azAuth);

    // Note: The application does not need to explicitly set the following
    // headers: x-ms-date, Authorization.  These headers
    // are automatically set by Chilkat.

    // However, a few additional headers are required for the "Create File" operation:
    rest.AddHeader("x-ms-type","file");

    // This required header specifies the final size of the file (or the maximum size it can be).
    var sbFileSize = new chilkat.StringBuilder();
    sbFileSize.AppendInt(szLocalFile);
    rest.AddHeader("x-ms-content-length",sbFileSize.GetAsString());

    // Send a PUT request to create the file (or replace the file if it already exists).
    // This will initialize the file in the Azure file storage.  To upload content, we'll need
    // to do the "Put Range" operation one or more times.

    // The following will create the file "somethingBig.zip" in the share "pip"
    var responseStr = rest.FullRequestNoBody("PUT","/pip/somethingBig.zip");
    if (rest.LastMethodSuccess !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    // When successful, the Azure File Service will respond with a 201 (Created) response status code,
    // with no XML response body.  If an error response is returned, there will be an XML response body.

    if (rest.ResponseStatusCode !== 201) {
        // Examine the request/response to see what happened.
        console.log("response status code = " + rest.ResponseStatusCode);
        console.log("response status text = " + rest.ResponseStatusText);
        console.log("response header: " + rest.ResponseHeader);
        console.log("response body (if any): " + responseStr);
        console.log("---");
        console.log("LastRequestStartLine: " + rest.LastRequestStartLine);
        console.log("LastRequestHeader: " + rest.LastRequestHeader);
        return;
    }

    console.log("Successfully created somethingBig.zip");

    // --------------------------------------------------------------------------------
    // Upload the file data...

    // Make sure the headers from the "Create File" operation are removed.
    rest.ClearAllHeaders();

    // The x-ms-write header is required for each "Put Range" request.
    rest.AddHeader("x-ms-write","update");

    var sbRange = new chilkat.StringBuilder();
    var sbResponseBody = new chilkat.StringBuilder();
    var bdFileData = new chilkat.BinData();

    // Open the file.  We'll be reading and uploading in chunks..
    success = fac.OpenForRead(localFilePath);
    if (success !== true) {
        console.log(fac.LastErrorText);
        return;
    }

    var numBytesLeft = szLocalFile;
    var curIndex = 0;
    while (numBytesLeft > 0) {

        var chunkSize = numBytesLeft;
        // Azure allows for 4MB max chunks  (4 x 1024 x 1024 = 4194304)
        if (chunkSize > 4194304) {
            chunkSize = 4194304;
        }

        // The only tricky part here is to correctly add the x-ms-range header.
        // It will be formatted like this:
        // x-ms-range: bytes=0-759623
        sbRange.Clear();
        sbRange.Append("bytes=");
        sbRange.AppendInt(curIndex);
        sbRange.Append("-");
        sbRange.AppendInt(curIndex+chunkSize - 1);

        // This replaces the header if it already exists..
        rest.AddHeader("x-ms-range",sbRange.GetAsString());

        // Read the next chunk from the local file.
        bdFileData.Clear();
        success = fac.FileReadBd(chunkSize,bdFileData);

        success = rest.FullRequestBd("PUT","/pip/somethingBig.zip?comp=range",bdFileData,sbResponseBody);
        if (success !== true) {
            // This would indicate a failure where no response was received.
            console.log(rest.LastErrorText);
            return;
        }

        // A 201 response indicates the chunk was uploaded.
        if (rest.ResponseStatusCode !== 201) {
            // Examine the request/response to see what happened.
            console.log("response status code = " + rest.ResponseStatusCode);
            console.log("response status text = " + rest.ResponseStatusText);
            console.log("response header: " + rest.ResponseHeader);
            console.log("response body (if any): " + responseStr);
            console.log("---");
            console.log("LastRequestStartLine: " + rest.LastRequestStartLine);
            console.log("LastRequestHeader: " + rest.LastRequestHeader);
            return;
        }

        console.log("Uploaded chunk from " + curIndex + " to " + (curIndex+chunkSize - 1));

        curIndex = curIndex+chunkSize;
        numBytesLeft = numBytesLeft - chunkSize;
    }

    fac.FileClose();

    console.log("success.");

}

chilkatExample();

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.