-
Notifications
You must be signed in to change notification settings - Fork 32
/
interface.go
117 lines (92 loc) · 4.19 KB
/
interface.go
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
// Copyright (c) 2022 MindStand Technologies, Inc
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package gogm
import (
"reflect"
dsl "github.com/mindstand/go-cypherdsl"
)
// Edge specifies required functions for special edge nodes
type Edge interface {
// GetStartNode gets start node of edge
GetStartNode() interface{}
// GetStartNodeType gets reflect type of start node
GetStartNodeType() reflect.Type
// SetStartNode sets start node of edge
SetStartNode(v interface{}) error
// GetEndNode gets end node of edge
GetEndNode() interface{}
// GetEndNodeType gets reflect type of end node
GetEndNodeType() reflect.Type
// SetEndNode sets end node of edge
SetEndNode(v interface{}) error
}
//inspiration from -- https://github.com/neo4j/neo4j-ogm/blob/master/core/src/main/java/org/neo4j/ogm/session/Session.java
// ISession: V1 session object for ogm interactions
// Deprecated: use SessionV2 instead
type ISession interface {
//transaction functions
ITransaction
//load single object
Load(respObj interface{}, id string) error
//load object with depth
LoadDepth(respObj interface{}, id string, depth int) error
//load with depth and filter
LoadDepthFilter(respObj interface{}, id string, depth int, filter dsl.ConditionOperator, params map[string]interface{}) error
//load with depth, filter and pagination
LoadDepthFilterPagination(respObj interface{}, id string, depth int, filter dsl.ConditionOperator, params map[string]interface{}, pagination *Pagination) error
//load slice of something
LoadAll(respObj interface{}) error
//load all of depth
LoadAllDepth(respObj interface{}, depth int) error
//load all of type with depth and filter
LoadAllDepthFilter(respObj interface{}, depth int, filter dsl.ConditionOperator, params map[string]interface{}) error
//load all with depth, filter and pagination
LoadAllDepthFilterPagination(respObj interface{}, depth int, filter dsl.ConditionOperator, params map[string]interface{}, pagination *Pagination) error
// load all edge query
// Deprecated: No equivalent function in SessionV2
LoadAllEdgeConstraint(respObj interface{}, endNodeType, endNodeField string, edgeConstraint interface{}, minJumps, maxJumps, depth int, filter dsl.ConditionOperator) error
//save object
Save(saveObj interface{}) error
//save object with depth
SaveDepth(saveObj interface{}, depth int) error
//delete
Delete(deleteObj interface{}) error
//delete uuid
DeleteUUID(uuid string) error
//specific query, responds to slice and single objects
Query(query string, properties map[string]interface{}, respObj interface{}) error
//similar to query, but returns raw rows/cols
QueryRaw(query string, properties map[string]interface{}) ([][]interface{}, error)
//delete everything, this will literally delete everything
PurgeDatabase() error
// closes session
Close() error
}
// ITransaction specifies functions for Neo4j ACID transactions
// Deprecated: Use TransactionV2 instead
type ITransaction interface {
// Begin begins transaction
Begin() error
// Rollback rolls back transaction
Rollback() error
// RollbackWithError wraps original error into rollback error if there is one
RollbackWithError(err error) error
// Commit commits transaction
Commit() error
}