Fauna v10 .NET/C# Driver 0.2.0-beta
 
Loading...
Searching...
No Matches
Fauna.Client Class Reference

Represents a client for interacting with a Fauna. More...

Inheritance diagram for Fauna.Client:
Fauna.BaseClient Fauna.IClient

Public Member Functions

 Client (string secret)
 Initializes a new instance of a Client with a secret.
 
 Client (Configuration config)
 Initializes a new instance of the Client with a custom Configuration.
 
DB DataContext< DB > ()
 Create and return a new database context which uses the Client instance.
 
void Dispose ()
 Disposes the resources used by the Client class.
 
- Public Member Functions inherited from Fauna.BaseClient
Task< QuerySuccess< T > > QueryAsync< T > (Query query, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously executes a specified FQL query against the Fauna database and returns the typed result.
 
Task< QuerySuccess< object?> > QueryAsync (Query query, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously executes a specified FQL query against the Fauna database.
 
Task< QuerySuccess< T > > QueryAsync< T > (Query query, ISerializer< T > serializer, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously executes a specified FQL query against the Fauna database and returns the typed result.
 
Task< QuerySuccess< object?> > QueryAsync (Query query, ISerializer serializer, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously executes a specified FQL query against the Fauna database and returns the typed result.
 
IAsyncEnumerable< Page< T > > PaginateAsync< T > (Query query, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously iterates over pages of a Fauna query result, automatically fetching subsequent pages using the 'after' cursor.
 
IAsyncEnumerable< Page< T > > PaginateAsync< T > (Page< T > page, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously iterates over pages of a Fauna query result, automatically fetching subsequent pages using the 'after' cursor. The provided page is the first page yielded.
 
IAsyncEnumerable< Page< object?> > PaginateAsync (Query query, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously iterates over pages of a Fauna query result, automatically fetching subsequent pages using the 'after' cursor.
 
IAsyncEnumerable< Page< object?> > PaginateAsync (Page< object?> page, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously iterates over pages of a Fauna query result, automatically fetching subsequent pages using the 'after' cursor. The provided page is the first page yielded.
 
IAsyncEnumerable< Page< T > > PaginateAsync< T > (Query query, ISerializer< T > elemSerializer, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously iterates over pages of a Fauna query result, automatically fetching subsequent pages using the 'after' cursor.
 
IAsyncEnumerable< Page< T > > PaginateAsync< T > (Page< T > page, ISerializer< T > elemSerializer, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously iterates over pages of a Fauna query result, automatically fetching subsequent pages using the 'after' cursor. The provided page is the first page yielded.
 
IAsyncEnumerable< Page< object?> > PaginateAsync (Query query, ISerializer elemSerializer, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously iterates over pages of a Fauna query result, automatically fetching subsequent pages using the 'after' cursor.
 
IAsyncEnumerable< Page< object?> > PaginateAsync (Page< object?> page, ISerializer elemSerializer, QueryOptions? queryOptions=null, CancellationToken cancel=default)
 Asynchronously iterates over pages of a Fauna query result, automatically fetching subsequent pages using the 'after' cursor. The provided page is the first page yielded.
 
- Public Member Functions inherited from Fauna.IClient

Public Attributes

readonly? IStatsCollector StatsCollector
 Provides collection and aggregation of query statistics. Can be set to null in the Configuration.
 

Properties

long LastSeenTxn [get]
 Gets the timestamp of the last transaction seen by this client.
 
- Properties inherited from Fauna.BaseClient

Detailed Description

Represents a client for interacting with a Fauna.

Definition at line 13 of file Client.cs.

Constructor & Destructor Documentation

◆ Client() [1/2]

Fauna.Client.Client ( string secret)

Initializes a new instance of a Client with a secret.

Parameters
secretThe secret key for authentication.

Definition at line 41 of file Client.cs.

◆ Client() [2/2]

Fauna.Client.Client ( Configuration config)

Initializes a new instance of the Client with a custom Configuration.

Parameters
configThe configuration settings for the client.

Definition at line 50 of file Client.cs.

Member Function Documentation

◆ DataContext< DB >()

DB Fauna.Client.DataContext< DB > ( )

Create and return a new database context which uses the Client instance.

Template Parameters
DBThe DataContext subtype to instantiate.
Returns
An instance of DB .
Type Constraints
DB :DataContext 

Definition at line 62 of file Client.cs.

◆ Dispose()

void Fauna.Client.Dispose ( )

Disposes the resources used by the Client class.

Definition at line 82 of file Client.cs.

Member Data Documentation

◆ StatsCollector

readonly? IStatsCollector Fauna.Client.StatsCollector

Provides collection and aggregation of query statistics. Can be set to null in the Configuration.

Definition at line 30 of file Client.cs.

Property Documentation

◆ LastSeenTxn

long Fauna.Client.LastSeenTxn
get

Gets the timestamp of the last transaction seen by this client.

Definition at line 35 of file Client.cs.


The documentation for this class was generated from the following file: