Dart

SFTP Upload - Synchronize Directory Tree

See more SFTP Examples

Demonstrates how to upload files to synchronize a local directory tree with a remote directory tree. The SyncTreeUpload method recursively descends a local directory tree and uploads files based on existence, last-mod date/time and/or size differences. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  var success = false;

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

  final sftp = CkSFtp();

  success = true;
  try {
    sftp.connect('my-ssh-server.com', 22);
  } on ChilkatException {
    success = false;
  }
  if (success) {
    success = true;
    try {
      sftp.authenticatePw('mySshLogin', 'mySshPassword');
    } on ChilkatException {
      success = false;
    }
  }

  if (success) {
    success = true;
    try {
      sftp.initializeSftp();
    } on ChilkatException {
      success = false;
    }
  }

  if (!success) {
    print(sftp.lastErrorText);
    return;
  }

  // Synchronize (by uploading) the local directory tree rooted at "qa_data/sftpUploadTree"
  // with the remote directory tree rooted at "syncUploadTest"
  // Both directories are relative paths.  The remote directory
  // is relative to the HOME directory of the SSH user account.
  // The local directory is relative to the current working directory of the process.
  // It is also possible to use absolute paths.

  final remoteDir = 'syncUploadTest';
  final localDir = 'qa_data/sftpUploadTree';

  // Possible modes that can be passed to the SyncTreeUpload method are:
  // mode=0: Upload all files
  // mode=1: Upload all files that do not exist on the server.
  // mode=2: Upload newer or non-existant files.
  // mode=3: Upload only newer files. If a file does not already exist on the server, it is not uploaded.
  // mode=4: transfer missing files or files with size differences.
  // mode=5: same as mode 4, but also newer files.

  // This example will use mode 5 to upload missing, newer, or files with size differences.
  final mode = 5;
  // This example turns on recursion to synchronize the entire tree. 
  // Recursion can be turned off to synchronize the files of a single directory.
  final recursive = true;
  success = true;
  try {
    sftp.syncTreeUpload(localDir, remoteDir, mode, recursive);
  } on ChilkatException {
    success = false;
  }
  if (!success) {
    print(sftp.lastErrorText);
    return;
  }

  print('Success.');
}