Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our SingleStore 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 SingleStoreCmdlets

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

Import-Module SingleStoreCmdlets;

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

$conn = Connect-SingleStore -User 'myUser' -Password 'myPassword' -Database 'NorthWind' -Server 'myServer' -Port 3306

Connecting to SingleStore

The following connection properties are required in order to connect to data.

Server: The host name or IP of the server hosting the SingleStore database.
Port: The port of the server hosting the SingleStore database.

You can also optionally set the following:

Database: The default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be returned.

Standard Authentication

To authenticate using standard authentication, set the following:

User: The user which will be used to authenticate with the SingleStore server.
Password: The password which will be used to authenticate with the SingleStore server.

Connect Using Integrated Security

As an alternative to providing the standard username and password, you can authenticate trusted users to the server via Windows Authentication.

SSL Authentication

You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:

SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
SSLClientCertType:; The certificate type of the client store.
SSLServerCert: The certificate to be accepted from the server.

SSH Authentication

Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:

SSHClientCert: Set this to the name of the certificate store for the client certificate.
SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
SSHClientCertType: The certificate type of the client store.
SSHPassword: The password that you use to authenticate with the SSH server.
SSHPort: The port used for SSH operations.
SSHServer: The SSH authentication server you are trying to authenticate against.
SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
SSHUser: Set this to the username that you use to authenticate with the SSH server.

Retrieving Data

After you have created a connection, you can use the other cmdlets to perform operations that you would normally expect to be able to perform against a relational database. The Select-SingleStore cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-SingleStore -Connection $conn -Table "`sakila`.Orders" -Columns @("ShipName, ShipCity") -Where "ShipCountry='USA'"

The Invoke-SingleStore 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-SingleStore -Connection $conn -Table `sakila`.Orders -Where "ShipCountry = 'USA'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\my`sakila`.OrdersData.csv -NoTypeInformation

You will notice that we piped the results from Select-SingleStore 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-SingleStore -User 'myUser' -Password 'myPassword' -Database 'NorthWind' -Server 'myServer' -Port 3306
PS C:\> $row = Select-SingleStore -Connection $conn -Table "`sakila`.Orders" -Columns (ShipName, ShipCity) -Where "ShipCountry = 'USA'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "`sakila`.Orders",
  "Columns":  [

  ],
  "ShipName":  "MyShipName",
  "ShipCity":  "MyShipCity"
}

Deleting Data

The following line deletes any records that match the criteria:

Select-SingleStore -Connection $conn -Table `sakila`.Orders -Where "ShipCountry = 'USA'" | Remove-SingleStore

Modifying Data

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

Import-Csv -Path C:\My`sakila`.OrdersUpdates.csv | %{
  $record = Select-SingleStore -Connection $conn -Table `sakila`.Orders -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-SingleStore -Connection $conn -Table `sakila`.Orders -Columns @("ShipName","ShipCity") -Values @($_.ShipName, $_.ShipCity) -Where "Id  = `'$_.Id`'"
  }else{
    Add-SingleStore -Connection $conn -Table `sakila`.Orders -Columns @("ShipName","ShipCity") -Values @($_.ShipName, $_.ShipCity)
  }
}

Cmdlets for SingleStore