feat: Added support for injecting params in the query (#7)

* feat: Added support for injecting params in the query

* fix: Fixed test and docs

client/client.go

@@ -194,6 +194,10 @@ type Runner interface {
 	// their identifiers exist in the returning scope.
 	Run(ctx context.Context) error
 
+	// RunWithParams is the same as Run, but injects the provided parameters into the
+	// query.
+	RunWithParams(ctx context.Context, params map[string]any) error
+
 	// Stream executes the query and returns an abstraction over a
 	// [pkg/github.com/neo4j/neo4j-go-driver/v5/neo4j.ResultWithContext], which
 	// allows records to be consumed one-by-one as a linked list, instead of all

client_impl.go

@@ -221,20 +221,20 @@ func (c *runnerImpl) Print() client.Runner {
 	return c
 }
 
-func (c *runnerImpl) Run(ctx context.Context) (err error) {
-	cy, err := c.cy.Compile()
+func (c *runnerImpl) RunWithParams(ctx context.Context, params map[string]any) (err error) {
+	cy, err := c.cy.CompileWithParams(params)
 	if err != nil {
 		return fmt.Errorf("cannot compile cypher: %w", err)
 	}
-	params, err := canonicalizeParams(cy.Parameters)
+	canonicalizedParams, err := canonicalizeParams(cy.Parameters)
 	if err != nil {
 		return fmt.Errorf("cannot serialize parameters: %w", err)
 	}
 	return c.executeTransaction(
 		ctx, cy,
 		func(tx neo4j.ManagedTransaction) (any, error) {
 			var result neo4j.ResultWithContext
-			result, err = tx.Run(ctx, cy.Cypher, params)
+			result, err = tx.Run(ctx, cy.Cypher, canonicalizedParams)
 			if err != nil {
 				return nil, fmt.Errorf("cannot run cypher: %w", err)
 			}
@@ -268,6 +268,10 @@ func (c *runnerImpl) Run(ctx context.Context) (err error) {
 		})
 }
 
+func (c *runnerImpl) Run(ctx context.Context) (err error) {
+	return c.RunWithParams(ctx, nil)
+}
+
 func (c *runnerImpl) Stream(ctx context.Context, sink func(r client.Result) error) (err error) {
 	cy, err := c.cy.Compile()
 	if err != nil {

driver_test.go

@@ -206,3 +206,31 @@ func ExampleDriver_writeSession() {
 	// Output: err: <nil>
 	// ids: [1 2 3 4 5 6 7 8 9 10]
 }
+
+func ExampleDriver_runWithParams() {
+	if testing.Short() {
+		fmt.Printf("err: %v\n", nil)
+		fmt.Printf("ns: %v\n", []int{1, 2, 3})
+		return
+	}
+
+	ctx := context.Background()
+	neo4j, cancel := startNeo4J(ctx)
+	d := New(neo4j)
+	defer func() {
+		if err := cancel(ctx); err != nil {
+			panic(err)
+		}
+	}()
+
+	var params = map[string]interface{}{
+		"ns": []int{1, 2, 3},
+	}
+
+	var ns []int
+	err := d.Exec().Return(db.Qual(&ns, "$ns")).RunWithParams(ctx, params)
+	fmt.Printf("err: %v\n", err)
+	fmt.Printf("ns:       %v\n", ns)
+	// Output: err: <nil>
+	// ns:       [1 2 3]
+}