|
| Client () |
| Initializes a new instance of a Client with the default configuration. Assumes the environment variable FAUNA_SECRET is set.
|
|
| Client (string secret) |
| Initializes a new instance of a Client with a secret.
|
|
| Client (Configuration config) |
| Initializes a new instance of the Client with a custom Configuration.
|
|
DB | DataContext< DB > () |
| Create and return a new database context which uses the Client instance.
|
|
void | Dispose () |
| Disposes the resources used by the Client class.
|
|
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.
|
|
Represents a client for interacting with a Fauna.
Definition at line 15 of file Client.cs.