Cmdlets for Oracle

Build 22.0.8479

接続の確立

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

インストールおよび接続

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

Install-Module OracleOciCmdlets

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

Import-Module OracleOciCmdlets;

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

$conn = Connect-OracleOci -User 'myUser' -Password 'myPassword' -Database 'NorthWind' -Server 'myServer'

接続の前に

Oracle に接続するには、まず、適切な環境変数を更新する必要があります。この変数には、本製品 に同梱されているOracle OCI ライブラリのアセンブリを含むフォルダの場所を含める必要があります。正しい環境変数はプラットフォームに依存します。

  • Windows：PATH にネイティブライブラリを設定してください。なお、OCI ライブラリの読み込みには、VC++ 2017 再配布可能パッケージが必要です。
  • Mac：DYLIB_LIBRARY_PATH にネイティブライブラリを設定してください。
  • Linux：LD_LIBRARY_PATH にネイティブライブラリを設定してください。

これらのネイティブライブラリは、本製品 のインストールディレクトリ内のlib フォルダに存在します。

Oracle OCI への接続

次の接続タイプが利用可能です。

  • Oracle Server
  • OracleTNS
  • LDAP

Oracle Server

適切なライブラリをPATH に追加したのち、次を設定して接続します。

  • User：Oracle データベースへの認証のためのユーザーId。
  • Password：Oracle データベースへの認証のためのパスワード。
  • Port：Oracle データベースをホスティングしているサーバーに接続する際のポート。
  • ServiceName：Oracle データベースのサービス名。この値はOracle SQL*PLUS コマンドラインを使ってglobal_name をクエリ（select * from global_name）することで取得できます。
  • Server：Oracle データベースをホスティングしているサーバーのホスト名またはIP アドレス。

OracleTNS

接続する前に、次の接続プロパティを設定します。

  • User：Oracle データベースへの認証のためのユーザーId。
  • Password：Oracle データベースへの認証のためのパスワード。
  • DataSource：Oracle ネット・サービス名、接続記述子（TNS 接続文字列とも呼ばれます）、または接続先のデータベースを識別する接続名。これらの値は、tnsnames.ora ファイルにあります。

例： 

DataSource='(DESCRIPTION=(ADDRESS=(protocol_address_information))(CONNECT_DATA= (SERVICE_NAME=service_name)))'

LDAP

このスキームでは、LDAP サーバーへの認証が必要です。次の接続プロパティを設定して接続します。

  • User：Oracle データベースへの認証のためのユーザーId。
  • Password：Oracle データベースへの認証のためのパスワード。
  • LDAPUri：LDAP サーバーへの接続に使用されるLDAP URI。
  • LDAPUser：LDAP サーバーのユーザーアカウント。
  • LDAPPassword：LDAP ユーザーのパスワード。

接続文字列は以下のようになります。 

LDAPUri=ldap://myldap.com:389/SERVICE_EXMPL,cn=OracleContext,dc=example,dc=com; User=ORACLEUSER; Password=OracleUserPassword;
この接続タイプは、Oracle とLDAP の両方のユーザー名とパスワードが必要であることに注意してください。ただしシステム管理者が匿名でのLDAP ログインを許可している場合は、LDAP のユーザー名とパスワードは必要ありません。

データの取得

接続の作成が完了したら、リレーショナルデータベースに対して通常行える操作を 別のcmdlet を使って実行できます。 Select-OracleOci cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。 

$results = Select-OracleOci -Connection $conn -Table ""CData"."SYSTEM".Customers" -Columns @("CompanyName, City") -Where "Country='US'"
Invoke-OracleOci cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

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

Select-OracleOci -Connection $conn -Table "CData"."SYSTEM".Customers -Where "Country = 'US'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\my"CData"."SYSTEM".CustomersData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-OracleOci -User 'myUser' -Password 'myPassword' -Database 'NorthWind' -Server 'myServer'
PS C:\> $row = Select-OracleOci -Connection $conn -Table ""CData"."SYSTEM".Customers" -Columns (CompanyName, City) -Where "Country = 'US'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  ""CData"."SYSTEM".Customers",
  "Columns":  [

  ],
  "CompanyName":  "MyCompanyName",
  "City":  "MyCity"
}

データの削除

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

Select-OracleOci -Connection $conn -Table "CData"."SYSTEM".Customers -Where "Country = 'US'" | Remove-OracleOci

データの変更

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

Import-Csv -Path C:\My"CData"."SYSTEM".CustomersUpdates.csv | %{
  $record = Select-OracleOci -Connection $conn -Table "CData"."SYSTEM".Customers -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-OracleOci -Connection $conn -Table "CData"."SYSTEM".Customers -Columns @("CompanyName","City") -Values @($_.CompanyName, $_.City) -Where "Id  = `'$_.Id`'"
  }else{
    Add-OracleOci -Connection $conn -Table "CData"."SYSTEM".Customers -Columns @("CompanyName","City") -Values @($_.CompanyName, $_.City)
  }
}

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479