Cmdlets for FTP

Build 24.0.9063

接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でFTP Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。

Install-Module FTPCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。

Import-Module FTPCmdlets;

Connect-FTP cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-FTP -RemoteHost 'MyFTPServer'

CData Cmdlets PowerShell Module for FTP を使用すると、FTP サーバーに接続できます。

FTP サーバーへの接続

FTP は、プレーンテキスト接続およびSSL/TLS 接続の両方をサポートします。FTP サーバーに接続するには、RemoteHostUser、およびPassword を指定します。SSLMode およびSSLServerCert を設定して、TSL/SSL による接続をセキュアにします。TLS/SSL を介した接続の設定について詳しくは、SSL の設定 を参照してください。

データへの接続

次の接続プロパティを設定し、ファイルシステムのリレーショナルビューをコントロールします。

  • RemotePath:現在の作業ディレクトリに設定。
  • TableDepth:ビューとしてレポートするサブフォルダの深度を制御するために設定。
  • FileRetrievalDepth:ファイルを再帰的に取得し、Root テーブルにリストするために設定。
ストアドプロシージャ は、ファイル、のダウンロード、アップロード、およびプロトコルコマンドの送信に利用できます。SQL を使用してサーバーと対話する方法の詳細については、データモデル を参照してください。

データの取得

Select-FTP cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-FTP -Connection $conn -Table "Notes" -Columns @("Filesize, Filename") -Where "FilePath='/documents/doc.txt'"
Invoke-FTP cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-FTP -Connection $conn -Table Notes -Where "FilePath = '/documents/doc.txt'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myNotesData.csv -NoTypeInformation

Select-FTP からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-FTP -RemoteHost 'MyFTPServer'
PS C:\> $row = Select-FTP -Connection $conn -Table "Notes" -Columns (Filesize, Filename) -Where "FilePath = '/documents/doc.txt'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Notes",
  "Columns":  [

  ],
  "Filesize":  "MyFilesize",
  "Filename":  "MyFilename"
} 

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

Select-FTP -Connection $conn -Table Notes -Where "FilePath = '/documents/doc.txt'" | Remove-FTP

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをFTP にロードします。

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

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9063