diff --git a/README.md b/README.md index 9832ca9..e9ef875 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -[![Go Report Card](https://goreportcard.com/badge/github.com/mindstand/gogm)](https://goreportcard.com/report/github.com/mindstand/gogm) +[![Go Report Card](https://goreportcard.com/badge/github.com/mindstand/gogm/v2)](https://goreportcard.com/report/github.com/mindstand/gogm/v2) [![Actions Status](https://github.com/mindstand/gogm/workflows/Go/badge.svg)](https://github.com/mindstand/gogm/actions) -[![GoDoc](https://godoc.org/github.com/mindstand/gogm?status.svg)](https://godoc.org/github.com/mindstand/gogm) +[![GoDoc](https://godoc.org/github.com/mindstand/gogm/v2?status.svg)](https://godoc.org/github.com/mindstand/gogm/v2) # GoGM Golang Object Graph Mapper v2 ``` @@ -25,6 +25,7 @@ go get -u github.com/mindstand/gogm/v2 - Primary Key strategies to use any type of primary key. GoGM is no longer UUID only! - TLS now supported +| Note: GoGM v1 has been deprecated. ## Usage diff --git a/cmd/gogmcli/gen/gen.go b/cmd/gogmcli/gen/gen.go index 82a0fdd..45d6892 100644 --- a/cmd/gogmcli/gen/gen.go +++ b/cmd/gogmcli/gen/gen.go @@ -170,7 +170,7 @@ func Generate(directory string, debug bool) error { } if tplRel.OtherStructField == "" { - return fmt.Errorf("oposite side not found for node [%s] on relationship [%s] and field [%s]", rel.NodeName, rel.RelationshipName, rel.Field) + return fmt.Errorf("opposite side not found for node [%s] on relationship [%s] and field [%s]", rel.NodeName, rel.RelationshipName, rel.Field) } if debug { diff --git a/interface.go b/interface.go index 1b8909a..5623976 100644 --- a/interface.go +++ b/interface.go @@ -44,8 +44,8 @@ type Edge interface { //inspiration from -- https://github.com/neo4j/neo4j-ogm/blob/master/core/src/main/java/org/neo4j/ogm/session/Session.java -// deprecated -//session object for ogm interactions +// ISession: V1 session object for ogm interactions +// Deprecated: use SessionV2 instead type ISession interface { //transaction functions ITransaction @@ -74,7 +74,8 @@ type ISession interface { //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 + // 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 @@ -103,6 +104,7 @@ type ISession interface { } // ITransaction specifies functions for Neo4j ACID transactions +// Deprecated: Use TransactionV2 instead type ITransaction interface { // Begin begins transaction Begin() error diff --git a/load_strategy.go b/load_strategy.go index 0ed8da9..55b463c 100644 --- a/load_strategy.go +++ b/load_strategy.go @@ -231,7 +231,7 @@ func expand(gogm *Gogm, variable, label string, rels []decoratorConfig, level, d clause := "" for i, rel := range rels { - // check if a seperator is needed + // check if a separator is needed if i > 0 { clause += ", " }