Fauna.BaseClient Class Reference

The base class for Client and DataContext. More...

Inheritance diagram for Fauna.BaseClient:

Public Member Functions
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. Template Parameters T The type of the result expected from the query, corresponding to the structure of the FQL query's expected response. Parameters query The FQL query object representing the query to be executed against the Fauna database. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use Returns A Task representing the asynchronous operation, which upon completion contains the result of the query execution as QuerySuccess<T>. Exceptions AuthenticationException Thrown when authentication fails due to invalid credentials or other authentication issues. AuthorizationException Thrown when the client lacks sufficient permissions to execute the query. QueryCheckException Thrown when the query has syntax errors or is otherwise malformed. QueryRuntimeException Thrown when runtime errors occur during query execution, such as invalid arguments or operational failures. AbortException Thrown when the FQL abort function is called within the query, containing the data provided during the abort operation. InvalidRequestException Thrown for improperly formatted requests or requests that Fauna cannot process. ContendedTransactionException Thrown when a transaction is aborted due to concurrent modification or contention issues. ThrottlingException Thrown when the query exceeds established rate limits for the Fauna service. QueryTimeoutException Thrown when the query execution time exceeds the specified or default timeout period. ServiceException Thrown in response to internal Fauna service errors, indicating issues on the server side. FaunaException Thrown for unexpected or miscellaneous errors not covered by the other specific exception types.
Task< QuerySuccess< object?> >	QueryAsync (Query query, QueryOptions? queryOptions=null, CancellationToken cancel=default)
	Asynchronously executes a specified FQL query against the Fauna database. Parameters query The FQL query object representing the query to be executed against the Fauna database. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use. Returns A Task representing the asynchronous operation, which upon completion contains the result of the query execution. Exceptions AuthenticationException Thrown when authentication fails due to invalid credentials or other authentication issues. AuthorizationException Thrown when the client lacks sufficient permissions to execute the query. QueryCheckException Thrown when the query has syntax errors or is otherwise malformed. QueryRuntimeException Thrown when runtime errors occur during query execution, such as invalid arguments or operational failures. AbortException Thrown when the FQL abort function is called within the query, containing the data provided during the abort operation. InvalidRequestException Thrown for improperly formatted requests or requests that Fauna cannot process. ContendedTransactionException Thrown when a transaction is aborted due to concurrent modification or contention issues. ThrottlingException Thrown when the query exceeds established rate limits for the Fauna service. QueryTimeoutException Thrown when the query execution time exceeds the specified or default timeout period. ServiceException Thrown in response to internal Fauna service errors, indicating issues on the server side. FaunaException Thrown for unexpected or miscellaneous errors not covered by the other specific exception types.
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. Template Parameters T The type of the result expected from the query, corresponding to the structure of the FQL query's expected response. Parameters query The FQL query object representing the query to be executed against the Fauna database. serializer A serializer for the success data type. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use. Returns A Task representing the asynchronous operation, which upon completion contains the result of the query execution as QuerySuccess<T>. Exceptions AuthenticationException Thrown when authentication fails due to invalid credentials or other authentication issues. AuthorizationException Thrown when the client lacks sufficient permissions to execute the query. QueryCheckException Thrown when the query has syntax errors or is otherwise malformed. QueryRuntimeException Thrown when runtime errors occur during query execution, such as invalid arguments or operational failures. AbortException Thrown when the FQL abort function is called within the query, containing the data provided during the abort operation. InvalidRequestException Thrown for improperly formatted requests or requests that Fauna cannot process. ContendedTransactionException Thrown when a transaction is aborted due to concurrent modification or contention issues. ThrottlingException Thrown when the query exceeds established rate limits for the Fauna service. QueryTimeoutException Thrown when the query execution time exceeds the specified or default timeout period. ServiceException Thrown in response to internal Fauna service errors, indicating issues on the server side. FaunaException Thrown for unexpected or miscellaneous errors not covered by the other specific exception types.
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. Parameters query The FQL query object representing the query to be executed against the Fauna database. serializer A serializer for the success data type. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation toke to use. Returns A Task representing the asynchronous operation, which upon completion contains the result of the query execution. Exceptions AuthenticationException Thrown when authentication fails due to invalid credentials or other authentication issues. AuthorizationException Thrown when the client lacks sufficient permissions to execute the query. QueryCheckException Thrown when the query has syntax errors or is otherwise malformed. QueryRuntimeException Thrown when runtime errors occur during query execution, such as invalid arguments or operational failures. AbortException Thrown when the FQL abort function is called within the query, containing the data provided during the abort operation. InvalidRequestException Thrown for improperly formatted requests or requests that Fauna cannot process. ContendedTransactionException Thrown when a transaction is aborted due to concurrent modification or contention issues. ThrottlingException Thrown when the query exceeds established rate limits for the Fauna service. QueryTimeoutException Thrown when the query execution time exceeds the specified or default timeout period. ServiceException Thrown in response to internal Fauna service errors, indicating issues on the server side. FaunaException Thrown for unexpected or miscellaneous errors not covered by the other specific exception types.
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. Template Parameters T The type of the data expected in each page. Parameters query The FQL query object representing the query to be executed against the Fauna database. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use. Returns An asynchronous enumerable of pages, each containing a list of items of type T . This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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. Template Parameters T The type of the data expected in each page. Parameters page The initial page. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use. Returns An asynchronous enumerable of pages, each containing a list of items of type T . This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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. Parameters query The FQL query object representing the query to be executed against the Fauna database. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use. Returns An asynchronous enumerable of pages, each containing a list of items. This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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. Parameters page The initial page. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use. Returns An asynchronous enumerable of pages, each containing a list of items. This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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. Template Parameters T The type of the data expected in each page. Parameters query The FQL query object representing the query to be executed against the Fauna database. elemSerializer A data serializer for the page element type. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use. Returns An asynchronous enumerable of pages, each containing a list of items of type T . This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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. Template Parameters T The type of the data expected in each page. Parameters page The initial page. elemSerializer A data serializer for the page element type. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use. Returns An asynchronous enumerable of pages, each containing a list of items of type T . This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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. Parameters query The FQL query object representing the query to be executed against the Fauna database. elemSerializer A data serializer for the page element type. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use. Returns A Task representing the asynchronous operation, which upon completion contains the result of the query execution. This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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. Parameters page The FQL query object representing the query to be executed against the Fauna database. elemSerializer A data serializer for the page element type. queryOptions Optional parameters to customize the query execution, such as timeout settings and custom headers. cancel A cancellation token to use. Returns A Task representing the asynchronous operation, which upon completion contains the result of the query execution. This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
async Task< T >	LoadRefAsync< T > (BaseRef< T > reference, CancellationToken cancel=default)
	Asynchronously executes a specified FQL query against the Fauna database and returns the typed result. Template Parameters T The type of the result expected from the query, corresponding to the structure of the FQL query's expected response. Parameters reference The reference to load. cancel A cancellation token to use Returns A Task representing the asynchronous operation, which upon completion contains the result of the query execution as QuerySuccess<T>. Exceptions AuthenticationException Thrown when authentication fails due to invalid credentials or other authentication issues. AuthorizationException Thrown when the client lacks sufficient permissions to execute the query. QueryCheckException Thrown when the query has syntax errors or is otherwise malformed. QueryRuntimeException Thrown when runtime errors occur during query execution, such as invalid arguments or operational failures. AbortException Thrown when the FQL abort function is called within the query, containing the data provided during the abort operation. InvalidRequestException Thrown for improperly formatted requests or requests that Fauna cannot process. ContendedTransactionException Thrown when a transaction is aborted due to concurrent modification or contention issues. ThrottlingException Thrown when the query exceeds established rate limits for the Fauna service. QueryTimeoutException Thrown when the query execution time exceeds the specified or default timeout period. ServiceException Thrown in response to internal Fauna service errors, indicating issues on the server side. FaunaException Thrown for unexpected or miscellaneous errors not covered by the other specific exception types. NullDocumentException Thrown when the provided reference does not exist.
async Task< StreamEnumerable< T > >	EventStreamAsync< T > (Query query, QueryOptions? queryOptions=null, StreamOptions? streamOptions=null, CancellationToken cancellationToken=default)
	Retrieves a Stream token from Fauna and returns a StreamEnumerable for the stream events.
async Task< StreamEnumerable< T > >	EventStreamAsync< T > (EventSource eventSource, CancellationToken cancellationToken=default)
	Returns a StreamEnumerable for the stream events.
async Task< FeedEnumerable< T > >	EventFeedAsync< T > (EventSource eventSource, FeedOptions? feedOptions=null, CancellationToken cancellationToken=default)
	Opens the event feed with Fauna and returns an enumerator for the events.
async Task< FeedEnumerable< T > >	EventFeedAsync< T > (Query query, FeedOptions? feedOptions=null, CancellationToken cancellationToken=default)
	Opens the event feed with Fauna and returns an enumerator for the events.
IAsyncEnumerator< Event< T > >	SubscribeStream< T > (EventSource eventSource, MappingContext ctx, CancellationToken cancel=default)
	Opens the stream with Fauna and returns an enumerator for the stream events.
IAsyncEnumerator< FeedPage< T > >	SubscribeFeed< T > (EventSource eventSource, MappingContext ctx, CancellationToken cancel=default)
	Opens an event feed with Fauna and returns an enumerator for the events.

Detailed Description

The base class for Client and DataContext.

Definition at line 369 of file IClient.cs.

Member Function Documentation

EventFeedAsync< T >() [1/2]

async Task< FeedEnumerable< T > > Fauna.BaseClient.EventFeedAsync< T >	(	EventSource	eventSource,
		FeedOptions?	feedOptions = null,
		CancellationToken	cancellationToken = default
	)

Opens the event feed with Fauna and returns an enumerator for the events.

Parameters

eventSource
feedOptions	The options for the feed.
cancellationToken	The cancellation token for the operation.

Template Parameters

T	Which Type to map the Events to.

Returns

Type Constraints

T

:

notnull

Definition at line 630 of file IClient.cs.

EventFeedAsync< T >() [2/2]

async Task< FeedEnumerable< T > > Fauna.BaseClient.EventFeedAsync< T >	(	Query	query,
		FeedOptions?	feedOptions = null,
		CancellationToken	cancellationToken = default
	)

Opens the event feed with Fauna and returns an enumerator for the events.

Parameters

query	The query to create the stream from Fauna.
feedOptions	The options for the feed.
cancellationToken	The cancellation token for the operation.

Template Parameters

T	Which Type to map the Events to.

Returns

Type Constraints

T

:

notnull

Definition at line 650 of file IClient.cs.

EventStreamAsync< T >() [1/2]

async Task< StreamEnumerable< T > > Fauna.BaseClient.EventStreamAsync< T >	(	EventSource	eventSource,
		CancellationToken	cancellationToken = default
	)

Returns a StreamEnumerable for the stream events.

Parameters

eventSource
cancellationToken

Template Parameters

T	Which Type to map the Events to.

Returns

Type Constraints

T

:

notnull

Definition at line 598 of file IClient.cs.

EventStreamAsync< T >() [2/2]

async Task< StreamEnumerable< T > > Fauna.BaseClient.EventStreamAsync< T >	(	Query	query,
		QueryOptions?	queryOptions = null,
		StreamOptions?	streamOptions = null,
		CancellationToken	cancellationToken = default
	)

Retrieves a Stream token from Fauna and returns a StreamEnumerable for the stream events.

Template Parameters

T	Event Data will be deserialized to this type.

Parameters

query	The query to create the stream from Fauna.
queryOptions	The options for the query.
streamOptions	The options for the stream.
cancellationToken	The cancellation token.

Returns

A task that represents the asynchronous operation. The task result contains a stream of events.

Type Constraints

T

:

notnull

Definition at line 578 of file IClient.cs.

LoadRefAsync< T >()

async Task< T > Fauna.BaseClient.LoadRefAsync< T >	(	BaseRef< T >	reference,
		CancellationToken	cancel = default
	)

Asynchronously executes a specified FQL query against the Fauna database and returns the typed result.

Template Parameters

T	The type of the result expected from the query, corresponding to the structure of the FQL query's expected response.

Parameters

reference	The reference to load.
cancel	A cancellation token to use

Returns

A Task representing the asynchronous operation, which upon completion contains the result of the query execution as QuerySuccess<T>.

Exceptions

AuthenticationException	Thrown when authentication fails due to invalid credentials or other authentication issues.
AuthorizationException	Thrown when the client lacks sufficient permissions to execute the query.
QueryCheckException	Thrown when the query has syntax errors or is otherwise malformed.
QueryRuntimeException	Thrown when runtime errors occur during query execution, such as invalid arguments or operational failures.
AbortException	Thrown when the FQL abort function is called within the query, containing the data provided during the abort operation.
InvalidRequestException	Thrown for improperly formatted requests or requests that Fauna cannot process.
ContendedTransactionException	Thrown when a transaction is aborted due to concurrent modification or contention issues.
ThrottlingException	Thrown when the query exceeds established rate limits for the Fauna service.
QueryTimeoutException	Thrown when the query execution time exceeds the specified or default timeout period.
ServiceException	Thrown in response to internal Fauna service errors, indicating issues on the server side.
FaunaException	Thrown for unexpected or miscellaneous errors not covered by the other specific exception types.
NullDocumentException	Thrown when the provided reference does not exist.

Implements Fauna.IClient.

Type Constraints

T

:

notnull

Definition at line 495 of file IClient.cs.

PaginateAsync() [1/4]

IAsyncEnumerable< Page< object?> > Fauna.BaseClient.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.

Parameters

page	The FQL query object representing the query to be executed against the Fauna database.
elemSerializer	A data serializer for the page element type.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use.

Returns

A Task representing the asynchronous operation, which upon completion contains the result of the query execution.

This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.

Implements Fauna.IClient.

Definition at line 483 of file IClient.cs.

PaginateAsync() [2/4]

IAsyncEnumerable< Page< object?> > Fauna.BaseClient.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.

Parameters

page	The initial page.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use.

Returns

An asynchronous enumerable of pages, each containing a list of items.

This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.

Implements Fauna.IClient.

PaginateAsync() [3/4]

IAsyncEnumerable< Page< object?> > Fauna.BaseClient.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.

Parameters

query	The FQL query object representing the query to be executed against the Fauna database.
elemSerializer	A data serializer for the page element type.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use.

Returns

A Task representing the asynchronous operation, which upon completion contains the result of the query execution.

This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.

Implements Fauna.IClient.

Definition at line 471 of file IClient.cs.

PaginateAsync() [4/4]

IAsyncEnumerable< Page< object?> > Fauna.BaseClient.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.

Parameters

query	The FQL query object representing the query to be executed against the Fauna database.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use.

Returns

An asynchronous enumerable of pages, each containing a list of items.

This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.

Implements Fauna.IClient.

PaginateAsync< T >() [1/4]

IAsyncEnumerable< Page< T > > Fauna.BaseClient.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.

Template Parameters

T	The type of the data expected in each page.

Parameters

page	The initial page.
elemSerializer	A data serializer for the page element type.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use.

Returns

An asynchronous enumerable of pages, each containing a list of items of type T .

This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.

Implements Fauna.IClient.

Definition at line 460 of file IClient.cs.

PaginateAsync< T >() [2/4]

IAsyncEnumerable< Page< T > > Fauna.BaseClient.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.

Template Parameters

T	The type of the data expected in each page.

Parameters

page	The initial page.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use.

Returns

An asynchronous enumerable of pages, each containing a list of items of type T .

This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.

Implements Fauna.IClient.

Type Constraints

T	:	notnull
T	:	PaginateAsync
T	:	page
T	:	Serializer.Generate<T>
T	:	MappingCtx
T	:	queryOptions
T	:	cancel

PaginateAsync< T >() [3/4]

IAsyncEnumerable< Page< T > > Fauna.BaseClient.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.

Template Parameters

T	The type of the data expected in each page.

Parameters

query	The FQL query object representing the query to be executed against the Fauna database.
elemSerializer	A data serializer for the page element type.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use.

Returns

An asynchronous enumerable of pages, each containing a list of items of type T .

This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.

Implements Fauna.IClient.

Definition at line 449 of file IClient.cs.

PaginateAsync< T >() [4/4]

IAsyncEnumerable< Page< T > > Fauna.BaseClient.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.

Template Parameters

T	The type of the data expected in each page.

Parameters

query	The FQL query object representing the query to be executed against the Fauna database.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use.

Returns

An asynchronous enumerable of pages, each containing a list of items of type T .

This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.

Implements Fauna.IClient.

Type Constraints

T	:	notnull
T	:	PaginateAsync
T	:	query
T	:	Serializer.Generate<T>
T	:	MappingCtx
T	:	queryOptions
T	:	cancel

QueryAsync() [1/2]

Task< QuerySuccess< object?> > Fauna.BaseClient.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.

Parameters

query	The FQL query object representing the query to be executed against the Fauna database.
serializer	A serializer for the success data type.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation toke to use.

Returns

A Task representing the asynchronous operation, which upon completion contains the result of the query execution.

Exceptions

AuthenticationException	Thrown when authentication fails due to invalid credentials or other authentication issues.
AuthorizationException	Thrown when the client lacks sufficient permissions to execute the query.
QueryCheckException	Thrown when the query has syntax errors or is otherwise malformed.
QueryRuntimeException	Thrown when runtime errors occur during query execution, such as invalid arguments or operational failures.
AbortException	Thrown when the FQL abort function is called within the query, containing the data provided during the abort operation.
InvalidRequestException	Thrown for improperly formatted requests or requests that Fauna cannot process.
ContendedTransactionException	Thrown when a transaction is aborted due to concurrent modification or contention issues.
ThrottlingException	Thrown when the query exceeds established rate limits for the Fauna service.
QueryTimeoutException	Thrown when the query execution time exceeds the specified or default timeout period.
ServiceException	Thrown in response to internal Fauna service errors, indicating issues on the server side.
FaunaException	Thrown for unexpected or miscellaneous errors not covered by the other specific exception types.

Implements Fauna.IClient.

QueryAsync() [2/2]

Task< QuerySuccess< object?> > Fauna.BaseClient.QueryAsync	(	Query	query,
		QueryOptions?	queryOptions = null,
		CancellationToken	cancel = default
	)

Asynchronously executes a specified FQL query against the Fauna database.

Parameters

query	The FQL query object representing the query to be executed against the Fauna database.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use.

Returns

A Task representing the asynchronous operation, which upon completion contains the result of the query execution.

Exceptions

AuthenticationException	Thrown when authentication fails due to invalid credentials or other authentication issues.
AuthorizationException	Thrown when the client lacks sufficient permissions to execute the query.
QueryCheckException	Thrown when the query has syntax errors or is otherwise malformed.
QueryRuntimeException	Thrown when runtime errors occur during query execution, such as invalid arguments or operational failures.
AbortException	Thrown when the FQL abort function is called within the query, containing the data provided during the abort operation.
InvalidRequestException	Thrown for improperly formatted requests or requests that Fauna cannot process.
ContendedTransactionException	Thrown when a transaction is aborted due to concurrent modification or contention issues.
ThrottlingException	Thrown when the query exceeds established rate limits for the Fauna service.
QueryTimeoutException	Thrown when the query execution time exceeds the specified or default timeout period.
ServiceException	Thrown in response to internal Fauna service errors, indicating issues on the server side.
FaunaException	Thrown for unexpected or miscellaneous errors not covered by the other specific exception types.

Implements Fauna.IClient.

QueryAsync< T >() [1/2]

Task< QuerySuccess< T > > Fauna.BaseClient.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.

Template Parameters

T	The type of the result expected from the query, corresponding to the structure of the FQL query's expected response.

Parameters

query	The FQL query object representing the query to be executed against the Fauna database.
serializer	A serializer for the success data type.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use.

Returns

A Task representing the asynchronous operation, which upon completion contains the result of the query execution as QuerySuccess<T>.

Exceptions

AuthenticationException	Thrown when authentication fails due to invalid credentials or other authentication issues.
AuthorizationException	Thrown when the client lacks sufficient permissions to execute the query.
QueryCheckException	Thrown when the query has syntax errors or is otherwise malformed.
QueryRuntimeException	Thrown when runtime errors occur during query execution, such as invalid arguments or operational failures.
AbortException	Thrown when the FQL abort function is called within the query, containing the data provided during the abort operation.
InvalidRequestException	Thrown for improperly formatted requests or requests that Fauna cannot process.
ContendedTransactionException	Thrown when a transaction is aborted due to concurrent modification or contention issues.
ThrottlingException	Thrown when the query exceeds established rate limits for the Fauna service.
QueryTimeoutException	Thrown when the query execution time exceeds the specified or default timeout period.
ServiceException	Thrown in response to internal Fauna service errors, indicating issues on the server side.
FaunaException	Thrown for unexpected or miscellaneous errors not covered by the other specific exception types.

Implements Fauna.IClient.

QueryAsync< T >() [2/2]

Task< QuerySuccess< T > > Fauna.BaseClient.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.

Template Parameters

T	The type of the result expected from the query, corresponding to the structure of the FQL query's expected response.

Parameters

query	The FQL query object representing the query to be executed against the Fauna database.
queryOptions	Optional parameters to customize the query execution, such as timeout settings and custom headers.
cancel	A cancellation token to use

Returns

A Task representing the asynchronous operation, which upon completion contains the result of the query execution as QuerySuccess<T>.

Exceptions

AuthenticationException	Thrown when authentication fails due to invalid credentials or other authentication issues.
AuthorizationException	Thrown when the client lacks sufficient permissions to execute the query.
QueryCheckException	Thrown when the query has syntax errors or is otherwise malformed.
QueryRuntimeException	Thrown when runtime errors occur during query execution, such as invalid arguments or operational failures.
AbortException	Thrown when the FQL abort function is called within the query, containing the data provided during the abort operation.
InvalidRequestException	Thrown for improperly formatted requests or requests that Fauna cannot process.
ContendedTransactionException	Thrown when a transaction is aborted due to concurrent modification or contention issues.
ThrottlingException	Thrown when the query exceeds established rate limits for the Fauna service.
QueryTimeoutException	Thrown when the query execution time exceeds the specified or default timeout period.
ServiceException	Thrown in response to internal Fauna service errors, indicating issues on the server side.
FaunaException	Thrown for unexpected or miscellaneous errors not covered by the other specific exception types.

Implements Fauna.IClient.

Type Constraints

T	:	notnull
T	:	QueryAsync<T>
T	:	query
T	:	Serializer.Generate<T>
T	:	MappingCtx
T	:	queryOptions
T	:	cancel

SubscribeFeed< T >()

IAsyncEnumerator< FeedPage< T > > Fauna.BaseClient.SubscribeFeed< T >	(	EventSource	eventSource,
		MappingContext	ctx,
		CancellationToken	cancel = default
	)

Opens an event feed with Fauna and returns an enumerator for the events.

Template Parameters

T	Event Data will be deserialized to this type.

Parameters

eventSource	The stream to subscribe to.
ctx	Mapping context for stream.
cancel	The cancellation token.

Returns

An async enumerator of stream events.

Type Constraints

T

:

notnull

Definition at line 711 of file IClient.cs.

SubscribeStream< T >()

IAsyncEnumerator< Event< T > > Fauna.BaseClient.SubscribeStream< T >	(	EventSource	eventSource,
		MappingContext	ctx,
		CancellationToken	cancel = default
	)

Opens the stream with Fauna and returns an enumerator for the stream events.

Template Parameters

T	Event Data will be deserialized to this type.

Parameters

eventSource	The stream to subscribe to.
ctx	Mapping context for stream.
cancel	The cancellation token.

Returns

An async enumerator of stream events.

Type Constraints

T

:

notnull

Definition at line 695 of file IClient.cs.

---

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

• /tmp/build/1a4543b4/repo.git/Fauna/IClient.cs