Fauna .NET Driver 0.1.0-beta
 
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
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 the Client class using a secret key.
 
 Client (Configuration config)
 Initializes a new instance of the Client class using client configuration.
 
DB DataContext< DB > ()
 Create and return a new database context which uses this client.
 
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, IDeserializer< T > deserializer, 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, IDeserializer deserializer, 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, IDeserializer< T > elemDeserializer, 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, IDeserializer< T > elemDeserializer, 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, IDeserializer elemDeserializer, 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, IDeserializer elemDeserializer, 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.
 

Properties

long LastSeenTxn [get]
 Gets the timestamp of the last transaction seen by this client.
 

Detailed Description

Represents a client for interacting with a Fauna.

Definition at line 14 of file Client.cs.

Constructor & Destructor Documentation

◆ Client() [1/2]

Fauna.Client.Client ( string  secret)

Initializes a new instance of the Client class using a secret key.

Parameters
secretThe secret key for authentication.

Definition at line 37 of file Client.cs.

◆ Client() [2/2]

Fauna.Client.Client ( Configuration  config)

Initializes a new instance of the Client class using client configuration.

Parameters
configThe configuration settings for the client.

Definition at line 46 of file Client.cs.

Member Function Documentation

◆ DataContext< DB >()

DB Fauna.Client.DataContext< DB > ( )

Create and return a new database context which uses this client.

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

Definition at line 57 of file Client.cs.

◆ Dispose()

void Fauna.Client.Dispose ( )

Disposes the resources used by the Client class.

Definition at line 185 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 31 of file Client.cs.


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