From 274750f66f41db557512ace1e9b4845724d9e865 Mon Sep 17 00:00:00 2001 From: Rouven Bauer Date: Wed, 22 Sep 2021 10:16:04 +0200 Subject: [PATCH 1/2] Rename query in result summary to match other drivers Deprecate ResultSummary.Statement() -> .Query() Rename Statement interface -> Query Deprecate Query.Params() -> .Parameters() --- neo4j/resultsummary.go | 20 ++++++++++++++++++-- neo4j/test-integration/session_test.go | 8 ++++---- 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/neo4j/resultsummary.go b/neo4j/resultsummary.go index 0d82b332..a76edf48 100644 --- a/neo4j/resultsummary.go +++ b/neo4j/resultsummary.go @@ -44,8 +44,10 @@ const ( type ResultSummary interface { // Server returns basic information about the server where the statement is carried out. Server() ServerInfo - // Statement returns statement that has been executed. + // Deprecated: Use Query instead Statement() Statement + // Query returns the query that has been executed. + Query() Query // StatementType returns type of statement that has been executed. StatementType() StatementType // Counters returns statistics counts for the statement. @@ -96,10 +98,16 @@ type Counters interface { } type Statement interface { + Query +} + +type Query interface { // Text returns the statement's text. Text() string - // Params returns the statement's parameters. + // Deprecated: Use Parameters instead Params() map[string]interface{} + // Parameters returns the statement's parameters. + Parameters() map[string]interface{} } // ServerInfo contains basic information of the server. @@ -219,6 +227,10 @@ func (s *resultSummary) Statement() Statement { return s } +func (s *resultSummary) Query() Query { + return s +} + func (s *resultSummary) StatementType() StatementType { return StatementType(s.sum.StmntType) } @@ -228,6 +240,10 @@ func (s *resultSummary) Text() string { } func (s *resultSummary) Params() map[string]interface{} { + return s.Parameters() +} + +func (s *resultSummary) Parameters() map[string]interface{} { return s.params } diff --git a/neo4j/test-integration/session_test.go b/neo4j/test-integration/session_test.go index 8342e2ff..38e88e2b 100644 --- a/neo4j/test-integration/session_test.go +++ b/neo4j/test-integration/session_test.go @@ -78,8 +78,8 @@ var _ = Describe("Session", func() { Expect(result.Next()).To(BeFalse()) Expect(result.Err()).To(BeNil()) - Expect(summary.Statement().Text()).To(BeIdenticalTo(stmt)) - Expect(summary.Statement().Params()).To(BeNil()) + Expect(summary.Query().Text()).To(BeIdenticalTo(stmt)) + Expect(summary.Query().Parameters()).To(BeNil()) }) Specify("when a query is executed, it should run and return summary with correct statement and params", func() { @@ -96,8 +96,8 @@ var _ = Describe("Session", func() { Expect(result.Next()).To(BeFalse()) Expect(result.Err()).To(BeNil()) - Expect(summary.Statement().Text()).To(Equal(stmt)) - Expect(summary.Statement().Params()).To(Equal(params)) + Expect(summary.Query().Text()).To(Equal(stmt)) + Expect(summary.Query().Parameters()).To(Equal(params)) }) Specify("when a query is executed, it should run and return summary when consumed", func() { From 8631fe5fc6f57adcab2b47124ce68c961548a80a Mon Sep 17 00:00:00 2001 From: Rouven Bauer Date: Thu, 23 Sep 2021 09:32:50 +0200 Subject: [PATCH 2/2] Add deprecation info: when was it deprecated, when will it be removed --- neo4j/resultsummary.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/neo4j/resultsummary.go b/neo4j/resultsummary.go index a76edf48..3fb0a5ff 100644 --- a/neo4j/resultsummary.go +++ b/neo4j/resultsummary.go @@ -44,7 +44,7 @@ const ( type ResultSummary interface { // Server returns basic information about the server where the statement is carried out. Server() ServerInfo - // Deprecated: Use Query instead + // Deprecated: since 4.4, will be removed in 5.0. Use Query instead Statement() Statement // Query returns the query that has been executed. Query() Query @@ -104,7 +104,7 @@ type Statement interface { type Query interface { // Text returns the statement's text. Text() string - // Deprecated: Use Parameters instead + // Deprecated: since 4.4, will be removed in 5.0. Use Parameters instead Params() map[string]interface{} // Parameters returns the statement's parameters. Parameters() map[string]interface{}