With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our SAPHanaXSA Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site.

Install-Module SAPHanaXSACmdlets

The following line is then added to your profile, loading the cmdlets on the next session:

Import-Module SAPHanaXSACmdlets;

You can then use the Connect-SAPHanaXSA cmdlet to create a connection object that can be passed to other cmdlets:

$conn = Connect-SAPHanaXSA -OAuthClientID "MyOAuthClientID" -OAuthClientSecret "MyOAuthClientSecret" -URL "https://hxehost:51027/euro.xsodata" -CallbackURL "http://localhost:33333"

SAP HANA XSA uses the OAuth authentication standard. Before connecting, it is necessary to establish an SAP HANA XSA OData Service. See Creating a Custom OAuth App for a guide.

To connect to SAP HANA XSA using the OAuthPassword Grant type set the following:

• OAuthClientId: Set this to the Client Id specified in the UAA service JSON file.
• OAuthClientSecret: Set this to the Client Secret specified in the UAA service JSON file.
• Url: Set this to the OData service endpoint.
• XSUAAURL: Set this to the UAA service url.
• User: Set your accounts username.
• Password: Set your accounts password

Once you've configured the OData Service, you can establish a connection using Custom Credentials.

Retrieving Data

The Select-SAPHanaXSA cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-SAPHanaXSA -Connection $conn -Table "SampleTable" -Columns @("Id, Column1") -Where "Column2='Bob'"

The Invoke-SAPHanaXSA cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file:

Select-SAPHanaXSA -Connection $conn -Table SampleTable -Where "Column2 = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mySampleTableData.csv -NoTypeInformation

You will notice that we piped the results from Select-SAPHanaXSA 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 object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON:

 
PS C:\> $conn  = Connect-SAPHanaXSA -OAuthClientID "MyOAuthClientID" -OAuthClientSecret "MyOAuthClientSecret" -URL "https://hxehost:51027/euro.xsodata" -CallbackURL "http://localhost:33333"
PS C:\> $row = Select-SAPHanaXSA -Connection $conn -Table "SampleTable" -Columns (Id, Column1) -Where "Column2 = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "SampleTable",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Column1":  "MyColumn1"
} 

Deleting Data

The following line deletes any records that match the criteria:

Select-SAPHanaXSA -Connection $conn -Table SampleTable -Where "Column2 = 'Bob'" | Remove-SAPHanaXSA

Modifying Data

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

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