Ready to get started?

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

 Download Now

Learn more:

EnterpriseDB Icon EnterpriseDB Data Cmdlets

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

Pipe EnterpriseDB Data to CSV in PowerShell



Use standard PowerShell cmdlets to access EnterpriseDB tables.

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

Creating a Connection to Your EnterpriseDB Data

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

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

You can also optionally set the following:

  • Database: The default database to connect to when connecting to the EnterpriseDB Server. If this is not set, the user's default database will be used.

Connect Using Standard Authentication

To authenticate using standard authentication, set the following:

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

Connect Using SSL Authentication

You can leverage SSL authentication to connect to EnterpriseDB 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.

$conn = Connect-EnterpriseDB  -User "$User" -Password "$Password" -Database "$Database" -Server "$Server" -Port "$Port"

Selecting Data

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

Select-EnterpriseDB -Connection $conn -Table Orders | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myOrdersData.csv -NoTypeInformation

You will notice that we piped the results from Select-EnterpriseDB 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-EnterpriseDB -Connection $conn -Table Orders -Where "ShipCountry = USA" | Remove-EnterpriseDB

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 EnterpriseDB, checking first whether a record already exists and needs to be updated instead of inserted.

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

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!