The base class for Client and DataContext. More...
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, 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. | |
The base class for Client and DataContext.
Definition at line 344 of file IClient.cs.
IAsyncEnumerable< Page< object?> > Fauna.BaseClient.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.
page | The FQL query object representing the query to be executed against the Fauna database. |
elemDeserializer | A data deserializer 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. |
This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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.
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.
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. |
This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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.
IAsyncEnumerable< Page< object?> > Fauna.BaseClient.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.
query | The FQL query object representing the query to be executed against the Fauna database. |
elemDeserializer | A data deserializer 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. |
This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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.
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.
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. |
This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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.
IAsyncEnumerable< Page< T > > Fauna.BaseClient.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.
T | The type of the data expected in each page. |
page | The initial page. |
elemDeserializer | A data deserializer 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. |
This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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.
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.
T | The type of the data expected in each page. |
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. |
This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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.
T | : | notnull | |
T | : | PaginateAsync | |
T | : | page | |
T | : | Deserializer.Generate<T> | |
T | : | MappingCtx | |
T | : | queryOptions | |
T | : | cancel |
IAsyncEnumerable< Page< T > > Fauna.BaseClient.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.
T | The type of the data expected in each page. |
query | The FQL query object representing the query to be executed against the Fauna database. |
elemDeserializer | A data deserializer 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. |
This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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.
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.
T | The type of the data expected in each page. |
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. |
This method handles pagination by sending multiple requests to Fauna as needed, based on the presence of an 'after' cursor in the query results.
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.
T | : | notnull | |
T | : | PaginateAsync | |
T | : | query | |
T | : | Deserializer.Generate<T> | |
T | : | MappingCtx | |
T | : | queryOptions | |
T | : | cancel |
Task< QuerySuccess< object?> > Fauna.BaseClient.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.
query | The FQL query object representing the query to be executed against the Fauna database. |
deserializer | A deserializer 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. |
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.
Task< QuerySuccess< object?> > Fauna.BaseClient.QueryAsync | ( | Query | query, |
QueryOptions? | queryOptions = null , |
||
CancellationToken | cancel = default |
||
) |
Asynchronously executes a specified FQL query against the Fauna database.
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. |
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.
Task< QuerySuccess< T > > Fauna.BaseClient.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.
T | The type of the result expected from the query, corresponding to the structure of the FQL query's expected response. |
query | The FQL query object representing the query to be executed against the Fauna database. |
deserializer | A deserializer 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. |
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.
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.
T | The type of the result expected from the query, corresponding to the structure of the FQL query's expected response. |
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 |
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.
T | : | notnull | |
T | : | QueryAsync<T> | |
T | : | query | |
T | : | Deserializer.Generate<T> | |
T | : | MappingCtx | |
T | : | queryOptions | |
T | : | cancel |