Skip to content

Update the events snippet #114

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
liammclennan merged 1 commit into from
May 16, 2022
Merged

Update the events snippet #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 4 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,37 +49,15 @@ See the [signal-copy app](https://github.com/datalust/seq-api/blob/main/example/

Seq internally limits the resources a query is allowed to consume. The query methods on `SeqConnection.Events` include a _status_ with each result set - a `Partial` status indicates that further results must be retrieved.

The snippet below demonstrates paging through results to retrieve the complete set.
The snippet below demonstrates lazily enumerating through results to retrieve the complete set.

```csharp
string lastReadEventId = null;

while(true)
{
var resultSet = await connection.Events.InSignalAsync(
filter: "Environment = 'Test'",
render: true,
afterId: lastReadEventId);

foreach (var evt in resultSet.Events)
Console.WriteLine(evt.RenderedMessage);

if (resultSet.Statistics.Status == ResultSetStatus.Complete)
break;

lastReadEventId = resultSet.Statistics.LastReadEventId;
}
```

If the result set is expected to be small, `ListAsync()` will buffer results and return a complete list:

```csharp
var resultSet = await connection.Events.ListAsync(
var resultSet = await connection.Events.EnumerateAsync(
filter: "Environment = 'Test'",
render: true,
count: 1000);
foreach (var evt in resultSet)

await foreach (var evt in resultSet)
Console.WriteLine(evt.RenderedMessage);
```

Expand Down