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.
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

Detailed Description

The base class for Client and DataContext.

Definition at line 344 of file IClient.cs.

Member Function Documentation

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.

Exceptions

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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.

Definition at line 444 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.

Exceptions

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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.

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.

Exceptions

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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.

Definition at line 433 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.

Exceptions

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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.

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.

Exceptions

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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.

Definition at line 423 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.

Exceptions

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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

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.

Exceptions

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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.

Definition at line 413 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.

Exceptions

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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

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

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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

UnauthorizedException	Thrown when authentication fails due to invalid credentials or other authentication issues.
ForbiddenException	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

---

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

• Fauna/Client/IClient.cs