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

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

Import-Module Neo4jCmdlets;

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

$conn = Connect-Neo4j -server "localhost" -port "7474" -user "neo4j" -password "password"

Connecting to Neo4j

CData Cmdlets PowerShell Module for Neo4j supports connections to self-managed Neo4j instances via the HTTP API. To connect, set the following connection properties:

• Server: The server hosting the Neo4j instance. An HTTP or HTTPS protocol prefix may be optionally prepended to the server name or address.
• Port: The port on which the Neo4j service is running. The provider connects to HTTP (7474) port by default. If connecting over HTTPS, supply the HTTPS port for the Neo4j instance specified in Server.
• User: The username of the user using the Neo4j instance.
• Password: The password of the user using the Neo4j instance.
• Database: The database to target in the Neo4j instance. Defaults to "Neo4j".

Note that the CData Cmdlets PowerShell Module for Neo4j does not support connections to cloud Neo4j instances like those of AuraDB and AuraDS.

Retrieving Data

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

$results = Select-Neo4j -Connection $conn -Table "ProductCategory" -Columns @("CategoryId, CategoryName") -Where "CategoryOwner='Bob'"

The Invoke-Neo4j 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-Neo4j -Connection $conn -Table ProductCategory -Where "CategoryOwner = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myProductCategoryData.csv -NoTypeInformation

You will notice that we piped the results from Select-Neo4j 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-Neo4j -server "localhost" -port "7474" -user "neo4j" -password "password"
PS C:\> $row = Select-Neo4j -Connection $conn -Table "ProductCategory" -Columns (CategoryId, CategoryName) -Where "CategoryOwner = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "ProductCategory",
  "Columns":  [

  ],
  "CategoryId":  "MyCategoryId",
  "CategoryName":  "MyCategoryName"
}