Skip to content

Commit 5e2d128

Browse files
authored
[DOCS-2873] Note v4 EOL in README (#197)
Adds a note about the v4 EOL to the README. Rel: https://faunadb.atlassian.net/browse/DOCS-2873
1 parent f12707c commit 5e2d128

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
[![NuGet](https://img.shields.io/nuget/v/FaunaDB.Client.svg?maxAge=21600)](https://www.nuget.org/packages/FaunaDB.Client/)
44
[![License](https://img.shields.io/badge/license-MPL_2.0-blue.svg?maxAge=2592000)](https://raw.githubusercontent.com/fauna/faunadb-csharp/main/LICENSE)
55

6+
> [!WARNING]
7+
> Fauna is decomissioning FQL v4 on June 30, 2025. See the [v4 end of life (EOL)
8+
> announcement](https://docs.fauna.com/fauna/v4/#fql-v4-end-of-life) and
9+
> [related FAQ](https://docs.fauna.com/fauna/v4/migration/faq).
10+
>
11+
> This driver is not compatible with FQL v10, the latest version.
12+
613
## Documentation
714

815
C# doc are hosted on GitHub:
@@ -154,7 +161,7 @@ var client = new FaunaClient("secret", "http://localhost:9090/", httpClient: htt
154161

155162
#### HTTP 2.0 support
156163
Starting from version 4.0.0 of this driver (faunadb-csharp), HTTP/2 support is enabled by default for .NET standards 2.1 and above.
157-
This means that if you use .NET core 3.1 and above (which support that standard), you'll be sending requests to Fauna on HTTP/2.
164+
This means that if you use .NET core 3.1 and above (which support that standard), you'll be sending requests to Fauna on HTTP/2.
158165
.NET standards lower than 2.1 and .NET frameworks 4.5-4.8 have HTTP/1.1 enabled as the default protocol version, since they lack of support for HTTP/2.
159166
We've also added an optional parameter if you want to specify the version of the protocol directly:
160167
```csharp
@@ -171,7 +178,7 @@ var adminClient = new FaunaClient(
171178
Value result = await client.Query(Paginate(Match(Index("spells"))));
172179
```
173180

174-
`Query` methods receives an `Expr` object. `Expr` objects can be composed with others `Expr` to create complex query objects. `FaunaDB.Query.Language` is a helper class where you can find all available expressions in the library.
181+
`Query` methods receives an `Expr` object. `Expr` objects can be composed with others `Expr` to create complex query objects. `FaunaDB.Query.Language` is a helper class where you can find all available expressions in the library.
175182

176183
You can also pass a `TimeSpan queryTimeout` argument to that specific query as well:
177184

@@ -287,7 +294,7 @@ There are three attributes that can be used to change the behavior of the `Encod
287294

288295
Fauna supports document streaming, where changes to a streamed document are pushed to all clients subscribing to that document.
289296

290-
The streaming API is built using the Observer pattern which enables a subscriber to register with and receive notifications from a provider.
297+
The streaming API is built using the Observer pattern which enables a subscriber to register with and receive notifications from a provider.
291298
Provider is implemented within `StreamingEventHandler` class, and subscriber within `StreamingEventMonitor` class.
292299

293300
The following example assumes that you have already created a `FaunaClient`.

0 commit comments

Comments
 (0)