Skip to content

Clear, scoped (docs), and says what changed. Matches common Conventional Commits style. #302

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
transistive merged 2 commits into from
Apr 13, 2026
Merged

Clear, scoped (docs), and says what changed. Matches common Conventional Commits style. #302

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bebab51
docs(readme): remove stale HTTP/HTTPS driver examples
p123-stack Apr 8, 2026
4a5e820
docs(readme): address review — remove batching section and requiremen…
p123-stack Apr 8, 2026
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
54 changes: 13 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
- Designed, built and tested under close supervision with the official neo4j driver team
- Validated with [testkit](https://github.com/neo4j-drivers/testkit)
- Fully typed with [psalm](https://psalm.dev/)
- Bolt, HTTP and auto routed drivers available
- Bolt and Neo4j (auto-routed) drivers available

## See the driver in action

Expand Down Expand Up @@ -48,13 +48,14 @@ use Laudis\Neo4j\ClientBuilder;

$client = ClientBuilder::create()
->withDriver('bolt', 'bolt+s://user:password@localhost') // creates a bolt driver
->withDriver('https', 'https://test.com', Authenticate::basic('user', 'password')) // creates an http driver
->withDriver('neo4j', 'neo4j://neo4j.test.com?database=my-database', Authenticate::oidc('token')) // creates an auto routed driver with an OpenID Connect token
->withDefaultDriver('bolt')
->build();
```

You have now created a client with **bolt, HTTPS and neo4j drivers**. The default driver that the client will use is **bolt**.
You have now created a client with **bolt and neo4j drivers**. The default driver that the client will use is **bolt**.

> **Note:** The HTTP/HTTPS drivers were [removed in version 3.3.0](https://github.com/neo4j-php/neo4j-php-client/releases). Use **Bolt** (`bolt://`, `bolt+s://`, …) or **Neo4j** (`neo4j://`, …) URIs only.

Read more about the URLs and how to use them to configure drivers [here](#in-depth-configuration).

Expand Down Expand Up @@ -102,19 +103,6 @@ $statement = new Statement('MERGE (user {email: $email})', ['email' => 'abc@hotm
$client->runStatement($statement, 'default');
```

#### Running multiple queries at once

The `runStatements` method will run all the statements at once. This method is an essential tool to reduce the number of database calls, especially when using the HTTP protocol.

```php
use Laudis\Neo4j\Databags\Statement;

$results = $client->runStatements([
Statement::create('MATCH (x) RETURN x LIMIT 100'),
Statement::create('MERGE (x:Person {email: $email})', ['email' => 'abc@hotmail.com'])
]);
```

### Transaction functions

Transaction functions are the **de facto** standard when using the driver. It is the most portable as it is resistant to a lot of the pitfalls when first developing with high availability solutions such as [Neo4j aura](https://neo4j.com/blog/neo4j-aura-enterprise-ga-release/) or a [cluster](https://neo4j.com/docs/operations-manual/current/clustering/).
Expand Down Expand Up @@ -280,7 +268,6 @@ $client->run('MATCH (x) WHERE x.slug in $listOrMap RETURN x', ['listOrMap' => []
|----------------------|----------------|
| Authentication | Yes |
| Transactions | Yes |
| Http Protocol | Yes |
| Bolt Protocol | Yes |
| Cluster | Yes |
| Aura | Yes |
Expand All @@ -291,26 +278,13 @@ $client->run('MATCH (x) WHERE x.slug in $listOrMap RETURN x', ['listOrMap' => []

* PHP >= 7.4
* A Neo4j database (minimum version 3.5)
* ext-bcmath *
* ext-json **
* ext-sockets ***

(*) Needed to implement the bolt protocol

(**) Needed to implement the http protocol

(***) Can be installed for optimal bolt protocol performance


If you plan on using the HTTP drivers, make sure you have [psr-7](https://www.php-fig.org/psr/psr-7/), [psr-17](https://www.php-fig.org/psr/psr-17/) and [psr-18](https://www.php-fig.org/psr/psr-18/) implementations included into the project. If you don't have any, you can install them via composer:

```bash
composer require nyholm/psr7 nyholm/psr7-server kriswallsmith/buzz
```
* ext-bcmath
* ext-json
* ext-sockets

## Result formats/hydration

In order to make the results of the bolt protocol and the http uniform, the driver provides and summarizes the results.
In order to make the results of the Bolt protocol uniform, the driver provides and summarizes the results.

The default formatter is the `\Laudis\Neo4j\Formatters\SummarizedResultFormatter`, which is explained extensively in [the result format section](#accessing-the-results).

Expand Down Expand Up @@ -424,13 +398,12 @@ bolt://localhost:7687?database=neo4j

#### Scheme configuration matrix

This library supports three drivers: bolt, HTTP and neo4j. The scheme part of the url determines the driver.
This library supports two driver kinds: **bolt** (single server) and **neo4j** (client-side routing). The scheme part of the URL selects the driver.

| driver | scheme | valid certificate | self-signed certificate | function |
|--------|--------|-------------------|----------------------------------------------|-------------------------------|
| neo4j | neo4j | neo4j+s | neo4j+ssc | Client side routing over bolt |
| bolt | bolt | bolt+s | bolt+ssc | Single server over bolt |
| http | http | https | configured through PSR Client implementation | Single server over HTTP |
| driver | scheme | valid certificate | self-signed certificate | function |
|--------|--------|-------------------|-------------------------|-------------------------------|
| neo4j | neo4j | neo4j+s | neo4j+ssc | Client-side routing over Bolt |
| bolt | bolt | bolt+s | bolt+ssc | Single server over Bolt |

### Configuration objects

Expand All @@ -439,7 +412,6 @@ A driver, session and transaction can be configured using configuration objects.
| name | concept | description | class |
|-------------------|-------------|----------------------------------------------------------------------------------|----------------------------|
| user agent | driver | The user agent used to identify the client to the neo4j server. | `DriverConfiguration` |
| Http PSR Bindings | driver | The relevant PSR implementation used by the driver when using the HTTP protocol. | `DriverConfiguration` |
| database | session | The database to connect to. | `SessionConfiguration` |
| fetch size | session | The amount of rows to fetch at once. | `SessionConfiguration` |
| access mode | session | The default mode when accessing the server. | `SessionConfiguration` |
Expand Down
Loading