React Native

SFTP Upload Large File in Parts

See more SFTP Examples

Demonstrates how to split a large file into N parts and then upload each part separately. This technique can be used to potentially avoid limits a SFTP server might impose on upload file size. React Native

import { BinData, FileAccess, SFtp } from '@chilkat/react-native'

async function chilkatExample() {
  // This example assumes the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  const sftp = new SFtp();

  // Set some timeouts, in milliseconds:
  sftp.connectTimeoutMs = 5000;
  sftp.idleTimeoutMs = 10000;

  // Connect to the SSH server.  
  // The standard SSH port = 22
  // The hostname may be a hostname or IP address.
  const hostname = 'sftp.example.com';
  const port = 22;
  try {
    await sftp.connectAsync(hostname, port);
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Authenticate with the SSH server.  Chilkat SFTP supports
  // both password-based authenication as well as public-key
  // authentication.  This example uses password authenication.
  try {
    await sftp.authenticatePwAsync('myLogin', 'myPassword');
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // After authenticating, the SFTP subsystem must be initialized:
  try {
    await sftp.initializeSftpAsync();
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Open a remote file for writing on the SSH server.
  // If the file already exists, it is overwritten.
  // (Specify "createNew" instead of "createTruncate" to
  // prevent overwriting existing files.)
  let handle: string;
  try {
    handle = await sftp.openFileAsync('big.zip', 'writeOnly', 'createTruncate');
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // We're going to upload the local file "qa_data/zips/big.zip" (a relative local path from our current working directory)
  // to the SFTP server.
  const localFilePath = 'qa_data/zips/big.zip';

  // Rather than uploading in one shot, we'll read the local file in chunks
  // and upload a chunk at a time.
  const fac = new FileAccess();

  try {
    fac.openForRead(localFilePath);
  } catch {
    await sftp.closeHandleAsync(handle);
    console.log(fac.lastErrorText);
    return;
  }

  // If we were to split the local file into 128K chunks, how many chunks (blocks) would
  // we have, including the last partial block?
  const blockSize = 131072;
  const numBlocks = fac.getNumBlocks(blockSize);
  console.log(`Number of blocks = ${numBlocks}`);

  const bd = new BinData();
  let i = 0;
  while (i < numBlocks) {
    // Read the Nth block, which gets appended to the bd.  (which means
    // we must clear the contents of bd before the next iteration)
    try {
      fac.readBlockBd(i, blockSize, bd);
    } catch {
      await sftp.closeHandleAsync(handle);
      console.log(fac.lastErrorText);
      return;
    }

    // Upload this block to the open remote file.
    try {
      await sftp.writeFileBdAsync(handle, bd);
    } catch {
      console.log(sftp.lastErrorText);
      return;
    }

    // Clear the contents for the next iteration.
    bd.clear();

    i++;
  }

  // Close the local file.
  fac.fileClose();

  // -----------------------------------------------------------------------------
  // This is important.  You must close the handle on the server.
  // Otherwise open handles will accumulate on the server until eventually a limit
  // is reached and the server will fail on a call to OpenFile.
  // -----------------------------------------------------------------------------

  // Close the remote file handle on the server.
  try {
    await sftp.closeHandleAsync(handle);
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  console.log('Success.');
}