ai.sftp

Creare un cliente

ai.sftp.createClient

È possibile creare un'istanza SFTP con il metodo createClient() e avviare tutte le operazioni con il server SFTP. Questa funzione utilizza il nome della stringa di connessione SFTP configurata per lo script come parametro e restituisce un oggetto istanza client.

Metodo	Parametri	Tipo di reso	Descrizione
createClient(sftpConnection)	sftpConnection : String Nome della connessione SFTP	Oggetto	Crea un client SFTP

Utilizzo

const client = ai.sftp.createClient('mySftpConnectionSetting');

Operazioni client di base

Scaricare un file

Metodi di lettura file

È possibile richiamare questi metodi sull'oggetto reader restituito dal metodo downloadFiles().

readLine()		String	Legge un file riga per riga
cleanUp()			Liberare le risorse di sistema utilizzate dall'oggetto di lettura del file. Impossibile utilizzare FileReader dopo aver eseguito il metodo cleanup(). Le risorse vengono ripulite automaticamente alla fine dello script.

Esempio

//Pass the relative filepath and the name of your encryption setting
const reader = client.downloadEncryptedFile('./archive/datasample.csv.asc', 'mypgp');
let line = reader.readLine()
while(line !== null){
    //Process the line
    line = reader.readLine()
}

Caricare un file

Metodi di scrittura file

È possibile richiamare i seguenti metodi sull'oggetto Reader restituito dal download dei file.

writeLine(val)	val : String Contenuto da scrivere in un file		Scrive il contenuto in un file riga per riga.
cleanUp()			Liberare le risorse di sistema utilizzate dall'oggetto File Writer. Il writer non può essere utilizzato dopo l'esecuzione del metodo cleanup(). Le risorse vengono ripulite automaticamente alla fine dello script.

Esempio

const client = ai.sftp.createClient('mySftpConnectionSetting');
​
//Invoke the File Writer method
const writer = ai.sftp.createFileWriter();
​
//Write content to the writer variable
writer.writeLine('Here is a line to upload');
client.uploadFile(writer, 'myFileToShare.txt');
writer.cleanUp();

Note su AWS Transfer for SFTP

CreateDirectory
AWS S3 consente di specificare il percorso delle nuove directory. Ad esempio, client.createDirectory('./parent/child'); creerà la directory padre. Tuttavia, se la directory padre esiste già e si tenta di creare una directory figlio, verrà generata un'eccezione.