Dots

0.0.7

.requirements/PSNeo4j/0.0.31/Public/Remove-Neo4jNode.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 function Remove-Neo4jNode {
    <#
    .SYNOPSIS
       Remove Neo4j nodes

    .DESCRIPTION
       Remove Neo4j nodes

    .EXAMPLE
        @{ComputerName = 'web01'} | Remove-Neo4jNode -Label Server

        # Remove a node with the label 'Server' and ComputerName 'web01'

    .EXAMPLE
        Remove-Neo4jNode -Label Server -Detach -Hash @{
            ComputerName = 'web01'
        }

        # Remove a node with the label 'Server' and ComputerName 'web01', and any relationships to or from it.

    .PARAMETER Label
        Remove nodes with this label

        Warning: susceptible to query injection

    .PARAMETER Hash
        One or more hashtables containing properties and values corresponding to nodes we will delete

        Warning: susceptible to query injection (keys only. values are parameterized)

    .PARAMETER Where
        Filter matching nodes with this. Use 'delete' as the matched item

        Example:
            WHERE delete.something = 'blah'

        Warning: susceptible to query injection

    .PARAMETER Detach
        If specified, remove any relationships to or from the nodes being deleted

    .PARAMETER As
        Parse the Neo4j response as...
            Parsed: We attempt to parse the output into friendlier PowerShell objects
                     Please open an issue if you see unexpected output with this
            Raw: We don't touch the response ($Response)
            Results: We expand the 'results' property on the response ($Response.results)
            Row: We expand the 'row' property on the responses results ($Response.results.data.row)

        We default to the value specified by Set-PSNeo4jConfiguration (Initially, 'Parsed')

        See ConvertFrom-Neo4jResponse for implementation details

    .PARAMETER MetaProperties
        Merge zero or any combination of these corresponding meta properties in the results: 'id', 'type', 'deleted'

        We default to the value specified by Set-PSNeo4jConfiguration (Initially, 'type')

    .PARAMETER MergePrefix
        If any MetaProperties are specified, we add this prefix to avoid clobbering existing neo4j properties

        We default to the value specified by Set-PSNeo4jConfiguration (Initially, 'Neo4j')

    .PARAMETER BaseUri
        BaseUri to build REST endpoint Uris from

        We default to the value specified by Set-PSNeo4jConfiguration (Initially, 'http://127.0.0.1:7474')

    .PARAMETER Credential
        PSCredential to use for auth

        We default to the value specified by Set-PSNeo4jConfiguration (Initially, neo4j:neo4j)

    .FUNCTIONALITY
        Neo4j
    #>
    [cmdletbinding()]
    param(
        [string]$Label,
        [parameter(ValueFromPipeline=$True)]
        [hashtable[]]$Hash,
        [string]$Where,
        [switch]$Detach,

        [validateset('Raw', 'Results', 'Row', 'Parsed', 'ParsedColumns')]
        [string]$As = $PSNeo4jConfig.As,
        [validateset('id', 'type', 'deleted')]
        [string]$MetaProperties = $PSNeo4jConfig.MetaProperties,
        [string]$MergePrefix = $PSNeo4jConfig.MergePrefix,

        [string]$BaseUri = $PSNeo4jConfig.BaseUri,

        [System.Management.Automation.PSCredential]
        [System.Management.Automation.Credential()]
        $Credential =  $PSNeo4jConfig.Credential
    )
    begin {
        $DetachString = $null
        if($Detach) {$DetachString = 'DETACH '}
        write-verbose "$Detach and [$DetachString]"
        $Queries = [System.Collections.ArrayList]@()
        $Count = 0
    }
    process {
        foreach($PropHash in $Hash)
        {
            $InvokeParams = @{}
            $SQLParams = @{}
            $PropString = $null
            if($Hash.keys.count -gt 0) {
                $Props = foreach($Property in $PropHash.keys) {
                    "$Property`: `$delete$Count$Property"
                    $SQLParams.Add("delete$Count$Property", $PropHash[$Property])
                }
                $PropString = $Props -join ', '
                $PropString = "{$PropString}"
            }
            $Query = "MATCH (delete:$Label $PropString)"
            if($Where){
                $Query = "$Query`n$Where"
            }
            $Count++

            [void]$Queries.Add("$Query $DetachString DELETE delete")
        }
    }
    end {
        if($SQLParams.Keys.count -gt 0) {
            $InvokeParams.add('Parameters', $SQLParams)
        }
        $InvokeParams.add('Query', $Queries)

        $Params = . Get-ParameterValues -BoundParameters $PSBoundParameters -Invocation $MyInvocation -Properties MetaProperties, MergePrefix, Credential, BaseUri, As
        Write-Verbose "$($Params | Format-List | Out-String)"
        Invoke-Neo4jQuery @Params @InvokeParams
    }
}