Cmdlets for Neo4j

Build 24.0.9060

Getting Started

Connecting to Neo4j

Establishing a Connection shows how to authenticate to Neo4j and configure any necessary connection properties. You can also configure cmdlet capabilities through the available Connection properties, from data modeling to firewall traversal. The Advanced Settings section shows how to set up more advanced configurations and troubleshoot connection errors.

Connecting from PowerShell

The CData Cmdlets PowerShell Module for Neo4j provides a familiar way to interact with Neo4j from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with Neo4j using standard PowerShell objects; you can chain the cmdlets to each other or other cmdlets in pipelines. The cmdlets also support PowerShell debug streams.

Data Manipulation with Cmdlets

See Establishing a Connection to learn how to get started with the Connect-Neo4j cmdlet. You can then pass the Neo4jConnection object returned to other cmdlets for accessing data:

  • Select-Neo4j
  • Add-Neo4j
  • Update-Neo4j
  • Remove-Neo4j

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-Neo4j cmdlet.

Accessing Debug Output from Streams

See Capturing Errors and Logging to obtain the debug output through PowerShell streams.

PowerShell Version Support

The standard cmdlets are supported in PowerShell 2, 3, 4, and 5.

Neo4j Version Support

The cmdlet leverages the Neo4j HTTP API. The cmdlet supports self-managed instances of Neo4j version 4.2 and above. Cloud Neo4j instances like those of AuraDB and AuraDS, which only support connections via Bolt protocol, are not supported.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060