Skip to content

Rename query in result summary to match other drivers #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fbiville merged 2 commits into from
Sep 23, 2021
Merged

Rename query in result summary to match other drivers #265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
274750f
Rename query in result summary to match other drivers
robsdedude Sep 22, 2021
8631fe5
Add deprecation info: when was it deprecated, when will it be removed
robsdedude Sep 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions neo4j/resultsummary.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: since 4.4, will be removed in 5.0. 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.
Expand Down Expand Up @@ -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: 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{}
}

// ServerInfo contains basic information of the server.
Expand Down Expand Up @@ -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)
}
Expand All @@ -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
}

Expand Down
8 changes: 4 additions & 4 deletions neo4j/test-integration/session_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand All @@ -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() {
Expand Down