added extra material for pratiksha to understand the query api use case and implementation

Author: transistive

docker-compose.yaml

@@ -0,0 +1,12 @@
+version: '3.8'
+
+services:
+  neo4j:
+    image: neo4j:5
+    container_name: neo4j
+    environment:
+      # Change the password here as desired
+      NEO4J_AUTH: "neo4j/your_password"
+    ports:
+      - "7474:7474"  # HTTP
+      - "7687:7687"  # Bolt

src/Neo4jQueryAPI.php

@@ -85,4 +85,9 @@ public function run(string $cypher, array $parameters, string $database = 'neo4j
         }
     }
 
+    public function beginTransaction(string $cypher = null, array $parameters = [], string $database = 'neo4j'): Transaction
+    {
+
+    }
+
 }

src/Results/ResultSet.php

@@ -1,12 +1,14 @@
 <?php
 namespace Neo4j\QueryAPI\Results;
 
+use ArrayIterator;
+use Countable;
 use InvalidArgumentException;
 use IteratorAggregate;
 use Neo4j\QueryAPI\OGM;
 use Traversable;
 
-class ResultSet implements IteratorAggregate
+class ResultSet implements IteratorAggregate, Countable
 {
     /**
      * @param list<ResultRow> $rows
@@ -17,6 +19,11 @@ public function __construct(private readonly array $rows)
 
     public function getIterator(): Traversable
     {
-        return new \ArrayIterator($this->rows);
+        return new ArrayIterator($this->rows);
+    }
+
+    public function count(): int
+    {
+        return count($this->rows);
     }
 }

src/Transaction.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Neo4j\QueryAPI;
+
+use Neo4j\QueryAPI\Results\ResultSet;
+
+class Transaction
+{
+    public function run(string $statement, array $params = []): ResultSet
+    {
+
+    }
+
+    public function commit(string $statement = null, array $parameters = []): null|ResultSet
+    {
+
+    }
+
+    public function rollback(): void
+    {
+
+    }
+}

test.php

@@ -0,0 +1,54 @@
+<?php
+
+require 'vendor/autoload.php'; // Make sure Guzzle is installed (composer require guzzlehttp/guzzle)
+
+use GuzzleHttp\Client;
+
+//$neo4j_url = 'https://6f72daa1.databases.neo4j.io/db/neo4j/query/v2/tx';
+//$neo4j_url = 'http://localhost:7474/db/neo4j/query/v2/tx';
+$username  = 'neo4j';
+$password = 'your_password';
+//$password  = '9lWmptqBgxBOz8NVcTJjgs3cHPyYmsy63ui6Spmw1d0';
+
+$query = 'CREATE (n:Person) RETURN n';
+
+$auth = base64_encode("$username:$password");
+
+$payload = json_encode([
+    'statement' => $query,
+]);
+
+$headers = [
+    'Authorization' => 'Basic ' . $auth,
+    'Content-Type'  => 'application/json',
+    'Accept'        => 'application/json',
+];
+
+
+$client = new Client();
+
+$response = $client->post('http://localhost:7474/db/neo4j/query/v2/tx', [
+    'headers' => $headers,
+    'body'    => $payload,
+]);
+$clusterAffinity = $response->getHeaderLine('neo4j-cluster-affinity');
+$responseData = json_decode($response->getBody(), true);
+$headers['neo4j-cluster-affinity'] = $clusterAffinity;
+
+$transactionId = $responseData['transaction']['id'];
+
+$response = $client->delete('http://localhost:7474/db/neo4j/query/v2/tx/' . $transactionId, [
+    'headers' => $headers,
+    'body'    => $payload,
+]);
+$responseData = json_decode($response->getBody(), true);
+
+
+//$commitUrl = 'https://6f72daa1.databases.neo4j.io/db/neo4j/tx/' . $responseData['transaction']['id'] . '/query/v2/commit';
+$response = $client->post('http://localhost:7474/db/neo4j/query/v2/tx/' . $transactionId . '/commit', [
+    'headers' => $headers,
+    'body'    => $payload,
+]);
+$responseData = json_decode($response->getBody(), true);
+print_r($responseData);
+

tests/Integration/Neo4jQueryAPIIntegrationTest.php

@@ -35,6 +35,38 @@ private function initializeApi(): Neo4jQueryAPI
         );
     }
 
+    public function testTransactionCommit(): void
+    {
+        // This test validates if a transaction exists in its own world until we commit it.
+        // by create a node in our transaction we validate if it exists within the transaction,
+        // but not the database.
+        // After we commit our transaction we are able to validate if our created node exists in the database.
+
+        $tsx = $this->api->beginTransaction();
+
+        // we create a human with a random name and remember our randomly generated name so
+        // we can query its existence.
+        // by creating it in a transaction it should not exist in the real database yet.
+        $name = mt_rand(1, 100000);
+        $tsx->run('CREATE (x:Human {name: $name})', ['name' => $name]);
+
+
+        // we simply validate if the human with the random name does not exist in the database, because we
+        // haven't commited our transaction yet.
+        $results = $this->api->run('MATCH (x:Human {name: $name}) RETURN x', ['name' => $name]);
+        $this->assertCount(0, $results);
+
+        // The human should of course only exist in the transaction, so we expect a count of 1 here.
+        $results = $tsx->run('MATCH (x:Human {name: $name}) RETURN x', ['name' => $name]);
+        $this->assertCount(1, $results);
+
+        $tsx->commit();
+
+        // Now that we have commited our transaction, the human should of course exist in our database
+        $results = $this->api->run('MATCH (x:Human {name: $name}) RETURN x', ['name' => $name]);
+        $this->assertCount(1, $results);
+    }
+
     /**
      * @throws GuzzleException
      */