Learn more
 

Ready to get started?

Download a free trial of the SFTP Cmdlets to get started:

 Download Now

Learn more:

SFTP Icon SFTP Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to remote files and directories through SFTP. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

In this article

Related articles

Pipe SFTP Data to CSV in PowerShell


Use standard PowerShell cmdlets to access SFTP tables.

The CData Cmdlets Module for SFTP is a standard PowerShell module offering straightforward integration with SFTP. Below, you will find examples of using our SFTP Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your SFTP Data

SFTP can be used to transfer files to and from SFTP servers using the SFTP Protocol. To connect, specify the RemoteHost;. service uses the User and Password and public key authentication (SSHClientCert). Choose an SSHAuthMode and specify connection values based on your selection.

Set the following connection properties to control the relational view of the file system:

  • RemotePath: Set this to the current working directory.
  • TableDepth: Set this to control the depth of subfolders to report as views.
  • FileRetrievalDepth: Set this to retrieve files recursively and list them in the Root table.
Stored Procedures are available to download files, upload files, and send protocol commands. See gdatamodel for more on using SQL to interact with the server. 

$conn = Connect-SFTP  -RemoteHost "$RemoteHost"

Selecting Data

Follow the steps below to retrieve data from the MyDirectory table and pipe the result into to a CSV file: 

Select-SFTP -Connection $conn -Table MyDirectory | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myMyDirectoryData.csv -NoTypeInformation

You will notice that we piped the results from Select-SFTP into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria: 

Select-SFTP -Connection $conn -Table MyDirectory -Where "FilePath = /documents/doc.txt" | Remove-SFTP

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into SFTP, checking first whether a record already exists and needs to be updated instead of inserted. 

Import-Csv -Path C:\MyMyDirectoryUpdates.csv | %{
  $record = Select-SFTP -Connection $SFTP -Table MyDirectory -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-SFTP -Connection $sftp -Table MyDirectory -Columns ("Filesize","Filename") -Values ($_.Filesize, $_.Filename) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-SFTP -Connection $sftp -Table MyDirectory -Columns ("Filesize","Filename") -Values ($_.Filesize, $_.Filename)
  }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!