Namespaces
CapabilitiesCardinalityConnectionRetryModeEdgeDBClientEdgeDBClientExtensionsEdgeDBClientPoolConfigEdgeDBConfigEdgeDBConnectionEdgeDBDeserializerAttributeEdgeDBHostingExtensionsEdgeDBIgnoreAttributeEdgeDBPropertyAttributeEdgeDBTypeAttributeEdgeDBTypeConverterAttributeErrorSeverityExecuteResultGroup<TKey, TElement>IEdgeDBQueryableIExecuteErrorIExecuteResultINamingStrategyIOFormatIsolationITransactibleClientObjectEnumeratorOptionalOptional<T>ServerErrorCodesTLSSecurityModeTransactionTransactionStateTypeBuilderTypeDeserializerFactoryRepresents a client pool used to interact with EdgeDB.
ConnectedClients (int) – Gets the total number of clients within the client pool that are connected.
AvailableClients (int) – Gets the number of available (idle) clients within the client pool.
EdgeDB.EdgeDBClient.ConnectedClients if the client type doesn’t have restrictions on idling.Config (Config) – The EdgeDB.State.Config containing session-level configuration.
Module (string) – The default module for this client.
Aliases (IReadOnlyDictionary<string, string>) – The module aliases for this client.
Globals (IReadOnlyDictionary<string, object>) – The globals for this client.
ServerConfig (IReadOnlyDictionary<string, object>) – Gets the EdgeDB server config.
EdgeDBClient()EdgeDBClient(EdgeDBClientPoolConfig)EdgeDBClient(EdgeDBConnection)EdgeDBClient(EdgeDBConnection, EdgeDBClientPoolConfig)ExecuteAsync(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryAsync<TResult>(string, IDictionary<string,object>, Capabilities?, CancellationToken)QuerySingleAsync<TResult>(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryRequiredSingleAsync<TResult>(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryJsonAsync(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryJsonElementsAsync(string, IDictionary<string,object>, Capabilities?, CancellationToken)EnsureConnectedAsync(CancellationToken)WithConfig(Action<ConfigProperties>)WithConfig(Config)WithGlobals(IDictionary<string,object>)WithModule(string)WithAliases(IDictionary<string,string>)Creates a new instance of a EdgeDB client pool allowing you to execute commands.
This constructor uses the default config and will attempt to find your EdgeDB project toml file in the current working directory. If no file is found this method will throw a System.IO.FileNotFoundException.
Creates a new instance of a EdgeDB client pool allowing you to execute commands.
This constructor will attempt to find your EdgeDB project toml file in the current working directory. If no file is found this method will throw a System.IO.FileNotFoundException.
clientPoolConfig (EdgeDBClientPoolConfig) – The config for this client pool.
Creates a new instance of a EdgeDB client pool allowing you to execute commands.
connection (EdgeDBConnection) – The connection parameters used to create new clients.
clientPoolConfig (EdgeDBClientPoolConfig) – The config for this client pool.
Executes a given query without reading the returning result.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous execute operation.
Executes a given query and returns the result as a collection.
Cardinality isn’t enforced nor takes effect on the return result, the client will always construct a collection out of the data.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result or null.
This method enforces EdgeDB.Cardinality.AtMostOne, if your query returns more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result.
This method enforces EdgeDB.Cardinality.One, if your query returns zero or more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns the result as a single json string.
query (string) – The query to execute.
args (IDictionary<string, object>) – Optional collection of arguments within the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The tasks result is the json result of the query.
EdgeDB.ResultCardinalityMismatchException – The query returned more than 1 datapoint.
Executes a given query and returns the result as a read-only collection of json objects.
query (string) – The query to execute.
args (IDictionary<string, object>) – Optional collection of arguments within the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The tasks result is the json result of the query.
Ensures that a connection is established to the EdgeDB server; and that the client pool is configured to the servers recommended pool size.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A System.Threading.Tasks.ValueTask representing the asynchronous connection operation.
Creates a new client with the specified EdgeDB.EdgeDBClient.Config.
The created client is a ‘sub’ client of this one, the child client shares the same client pool as this one.
configDelegate (Action<ConfigProperties>) – A delegate used to modify the config.
A new client with the specified config.
Creates a new client with the specified EdgeDB.EdgeDBClient.Config.
The created client is a ‘sub’ client of this one, the child client shares the same client pool as this one.
config (Config) – The config for the new client.
A new client with the specified config.
Creates a new client with the specified Globals.
The created client is a ‘sub’ client of this one, the child client shares the same client pool as this one.
The newly created client doesn’t copy any of the parents globals, this method is settative to the EdgeDB.EdgeDBClient.Globals property.
globals (IDictionary<string, object>) – The globals for the newly create client.
A new client with the specified globals.
Creates a new client with the specified EdgeDB.EdgeDBClient.Module.
The created client is a ‘sub’ client of this one, the child client shares the same client pool as this one.
module (string) – The module for the new client.
A new client with the specified module.
Creates a new client with the specified EdgeDB.EdgeDBClient.Aliases.
The created client is a ‘sub’ client of this one, the child client shares the same client pool as this one.
The newly created client doesn’t copy any of the parents aliases, this method is settative to the EdgeDB.EdgeDBClient.Aliases property.
aliases (IDictionary<string, string>) – The module aliases for the new client.
A new client with the specified module aliases.
Creates a new instance of a EdgeDB client pool allowing you to execute commands.
This constructor uses the default config and will attempt to find your EdgeDB project toml file in the current working directory. If no file is found this method will throw a System.IO.FileNotFoundException.
Creates a new instance of a EdgeDB client pool allowing you to execute commands.
This constructor will attempt to find your EdgeDB project toml file in the current working directory. If no file is found this method will throw a System.IO.FileNotFoundException.
clientPoolConfig (EdgeDBClientPoolConfig) – The config for this client pool.
Creates a new instance of a EdgeDB client pool allowing you to execute commands.
connection (EdgeDBConnection) – The connection parameters used to create new clients.
clientPoolConfig (EdgeDBClientPoolConfig) – The config for this client pool.
Executes a given query without reading the returning result.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous execute operation.
Executes a given query and returns the result as a collection.
Cardinality isn’t enforced nor takes effect on the return result, the client will always construct a collection out of the data.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result or null.
This method enforces EdgeDB.Cardinality.AtMostOne, if your query returns more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result.
This method enforces EdgeDB.Cardinality.One, if your query returns zero or more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns the result as a single json string.
query (string) – The query to execute.
args (IDictionary<string, object>) – Optional collection of arguments within the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The tasks result is the json result of the query.
EdgeDB.ResultCardinalityMismatchException – The query returned more than 1 datapoint.
Executes a given query and returns the result as a read-only collection of json objects.
query (string) – The query to execute.
args (IDictionary<string, object>) – Optional collection of arguments within the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The tasks result is the json result of the query.
Ensures that a connection is established to the EdgeDB server; and that the client pool is configured to the servers recommended pool size.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A System.Threading.Tasks.ValueTask representing the asynchronous connection operation.
Creates a new client with the specified EdgeDB.EdgeDBClient.Config.
The created client is a ‘sub’ client of this one, the child client shares the same client pool as this one.
configDelegate (Action<ConfigProperties>) – A delegate used to modify the config.
A new client with the specified config.
Creates a new client with the specified EdgeDB.EdgeDBClient.Config.
The created client is a ‘sub’ client of this one, the child client shares the same client pool as this one.
config (Config) – The config for the new client.
A new client with the specified config.
Creates a new client with the specified Globals.
The created client is a ‘sub’ client of this one, the child client shares the same client pool as this one.
The newly created client doesn’t copy any of the parents globals, this method is settative to the EdgeDB.EdgeDBClient.Globals property.
globals (IDictionary<string, object>) – The globals for the newly create client.
A new client with the specified globals.
Creates a new client with the specified EdgeDB.EdgeDBClient.Module.
The created client is a ‘sub’ client of this one, the child client shares the same client pool as this one.
module (string) – The module for the new client.
A new client with the specified module.
Creates a new client with the specified EdgeDB.EdgeDBClient.Aliases.
The created client is a ‘sub’ client of this one, the child client shares the same client pool as this one.
The newly created client doesn’t copy any of the parents aliases, this method is settative to the EdgeDB.EdgeDBClient.Aliases property.
aliases (IDictionary<string, string>) – The module aliases for the new client.
A new client with the specified module aliases.
A class containing extension methods for edgedb clients.
TransactionAsync(ITransactibleClient, Func<Transaction,Task>)TransactionAsync<TResult>(ITransactibleClient, Func<Transaction,Task<TResult>>)TransactionAsync(ITransactibleClient, TransactionSettings, Func<Transaction,Task>)TransactionAsync<TResult>(ITransactibleClient, TransactionSettings, Func<Transaction,Task<TResult>>)DumpDatabaseAsync(EdgeDBClient, CancellationToken)RestoreDatabaseAsync(EdgeDBClient, Stream, CancellationToken)Creates a transaction and executes a callback with the transaction object.
client (ITransactibleClient) – The TCP client to preform the transaction with.
func (Func<Transaction, Task>) – The callback to pass the transaction into.
A task that proxies the passed in callbacks awaiter.
Creates a transaction and executes a callback with the transaction object.
client (ITransactibleClient) – The TCP client to preform the transaction with.
func (Func<Transaction, Task<TResult>>) – The callback to pass the transaction into.
TResult – The return result of the task.
A task that proxies the passed in callbacks awaiter.
Creates a transaction and executes a callback with the transaction object.
client (ITransactibleClient) – The TCP client to preform the transaction with.
settings (TransactionSettings) – The transactions settings.
func (Func<Transaction, Task>) – The callback to pass the transaction into.
A task that proxies the passed in callbacks awaiter.
Creates a transaction and executes a callback with the transaction object.
client (ITransactibleClient) – The TCP client to preform the transaction with.
settings (TransactionSettings) – The transactions settings.
func (Func<Transaction, Task<TResult>>) – The callback to pass the transaction into.
TResult – The return result of the task.
A task that proxies the passed in callbacks awaiter.
Dumps the current database to a stream.
pool (EdgeDBClient) – The client to preform the dump with.
token (CancellationToken) – A token to cancel the operation with.
A stream containing the entire dumped database.
EdgeDB.EdgeDBErrorException – The server sent an error message during the dumping process.
EdgeDB.EdgeDBException – The server sent a mismatched packet.
Restores the database based on a database dump stream.
pool (EdgeDBClient) – The TCP client to preform the restore with.
stream (Stream) – The stream containing the database dump.
token (CancellationToken) – A token to cancel the operation with.
The status result of the restore.
EdgeDB.EdgeDBException – The server sent an invalid packet or the restore operation couldn’t proceed due to the database not being empty.
EdgeDB.EdgeDBErrorException – The server sent an error during the restore operation.
Creates a transaction and executes a callback with the transaction object.
client (ITransactibleClient) – The TCP client to preform the transaction with.
func (Func<Transaction, Task>) – The callback to pass the transaction into.
A task that proxies the passed in callbacks awaiter.
Creates a transaction and executes a callback with the transaction object.
client (ITransactibleClient) – The TCP client to preform the transaction with.
func (Func<Transaction, Task<TResult>>) – The callback to pass the transaction into.
TResult – The return result of the task.
A task that proxies the passed in callbacks awaiter.
Creates a transaction and executes a callback with the transaction object.
client (ITransactibleClient) – The TCP client to preform the transaction with.
settings (TransactionSettings) – The transactions settings.
func (Func<Transaction, Task>) – The callback to pass the transaction into.
A task that proxies the passed in callbacks awaiter.
Creates a transaction and executes a callback with the transaction object.
client (ITransactibleClient) – The TCP client to preform the transaction with.
settings (TransactionSettings) – The transactions settings.
func (Func<Transaction, Task<TResult>>) – The callback to pass the transaction into.
TResult – The return result of the task.
A task that proxies the passed in callbacks awaiter.
Dumps the current database to a stream.
pool (EdgeDBClient) – The client to preform the dump with.
token (CancellationToken) – A token to cancel the operation with.
A stream containing the entire dumped database.
EdgeDB.EdgeDBErrorException – The server sent an error message during the dumping process.
EdgeDB.EdgeDBException – The server sent a mismatched packet.
Restores the database based on a database dump stream.
pool (EdgeDBClient) – The TCP client to preform the restore with.
stream (Stream) – The stream containing the database dump.
token (CancellationToken) – A token to cancel the operation with.
The status result of the restore.
EdgeDB.EdgeDBException – The server sent an invalid packet or the restore operation couldn’t proceed due to the database not being empty.
EdgeDB.EdgeDBErrorException – The server sent an error during the restore operation.
Represents a config for a EdgeDB.EdgeDBClient, extending EdgeDB.EdgeDBConfig.
DefaultPoolSize (int) – Gets or sets the default client pool size.
Represents the configuration options for a EdgeDB.EdgeDBClient or T:EdgeDB.EdgeDBTcpClient
Logger (ILogger) – Gets or sets the logger used for logging messages from the driver.
RetryMode (ConnectionRetryMode) – Gets or sets the retry mode for connecting new clients.
MaxConnectionRetries (uint) – Gets or sets the maximum number of times to retry to connect.
ConnectionTimeout (uint) – Gets or sets the number of miliseconds a client will wait for a connection to be established with the server.
MessageTimeout (uint) – Gets or sets the max amount of miliseconds a client will wait for an expected message.
ExplicitObjectIds (bool) – Gets or sets whether or not to always return object ids.
true returned objects will not have an implicit id property i.e. query shapes will have to explicitly list id properties.ImplicitLimit (ulong) – Gets or sets the implicit object limit for all queries. By default there is not limit.
SchemaNamingStrategy (INamingStrategy) – Gets or sets the default naming strategy used within the schema.
Represents a class containing information on how to connect to a edgedb instance.
Username (string) – Gets or sets the username used to connect to the database.
Password (string) – Gets or sets the password to connect to the database.
Hostname (string) – Gets or sets the hostname of the edgedb instance to connect to.
Port (int) – Gets or sets the port of the edgedb instance to connect to.
Database (string) – Gets or sets the database name to use when connecting.
TLSCertData (string) – Gets or sets the TLS certificate data used to very the certificate when authenticating.
EdgeDB.EdgeDBConnection.TLSCertificateAuthority instead.TLSCertificateAuthority (string) – Gets or sets the TLS Certificate Authority.
TLSSecurity (TLSSecurityMode) – Gets or sets the TLS security level.
EdgeDB.TLSSecurityMode.Strict.Creates an EdgeDB.EdgeDBConnection from a valid DSN.
dsn (string) – The DSN to create the connection from.
A EdgeDB.EdgeDBConnection representing the DSN.
System.ArgumentException – A query parameter has already been defined in the DSN.
System.FormatException – Port was not in the correct format of int.
System.IO.FileNotFoundException – A file parameter wasn’t found.
System.Collections.Generic.KeyNotFoundException – An environment variable couldn’t be found.
Creates a new EdgeDBConnection from a .toml project file.
path (string) – The path to the .toml project file.
A EdgeDB.EdgeDBConnection representing the project defined in the .toml file.
System.IO.FileNotFoundException – The supplied file path, credentials path, or instance-name file doesn’t exist.
System.IO.DirectoryNotFoundException – The project directory doesn’t exist for the supplied toml file.
Creates a new EdgeDB.EdgeDBConnection from an instance name.
name (string) – The name of the instance.
A EdgeDB.EdgeDBConnection containing connection details for the specific instance.
System.IO.FileNotFoundException – The instances config file couldn’t be found.
Resolves a connection by traversing the current working directory and its parents to find an ‘edgedb.toml’ file.
A resolved EdgeDB.EdgeDBConnection.
System.IO.FileNotFoundException – No ‘edgedb.toml’ file could be found.
Parses the provided arguments to build an EdgeDB.EdgeDBConnection class; Parse logic follows the Priority levels of arguments.
instance (string) – The instance name to connect to.
dsn (string) – The DSN string to use to connect.
configure (Action<EdgeDBConnection>) – A configuration delegate.
autoResolve (bool) – Whether or not to autoresolve a connection using EdgeDB.EdgeDBConnection.ResolveEdgeDBTOML().
A EdgeDB.EdgeDBConnection class that can be used to connect to a EdgeDB instance.
EdgeDB.ConfigurationException – An error occured while parsing or configuring the EdgeDB.EdgeDBConnection.
System.IO.FileNotFoundException – A configuration file could not be found.
Creates an EdgeDB.EdgeDBConnection from a valid DSN.
dsn (string) – The DSN to create the connection from.
A EdgeDB.EdgeDBConnection representing the DSN.
System.ArgumentException – A query parameter has already been defined in the DSN.
System.FormatException – Port was not in the correct format of int.
System.IO.FileNotFoundException – A file parameter wasn’t found.
System.Collections.Generic.KeyNotFoundException – An environment variable couldn’t be found.
Creates a new EdgeDBConnection from a .toml project file.
path (string) – The path to the .toml project file.
A EdgeDB.EdgeDBConnection representing the project defined in the .toml file.
System.IO.FileNotFoundException – The supplied file path, credentials path, or instance-name file doesn’t exist.
System.IO.DirectoryNotFoundException – The project directory doesn’t exist for the supplied toml file.
Creates a new EdgeDB.EdgeDBConnection from an instance name.
name (string) – The name of the instance.
A EdgeDB.EdgeDBConnection containing connection details for the specific instance.
System.IO.FileNotFoundException – The instances config file couldn’t be found.
Resolves a connection by traversing the current working directory and its parents to find an ‘edgedb.toml’ file.
A resolved EdgeDB.EdgeDBConnection.
System.IO.FileNotFoundException – No ‘edgedb.toml’ file could be found.
Parses the provided arguments to build an EdgeDB.EdgeDBConnection class; Parse logic follows the Priority levels of arguments.
instance (string) – The instance name to connect to.
dsn (string) – The DSN string to use to connect.
configure (Action<EdgeDBConnection>) – A configuration delegate.
autoResolve (bool) – Whether or not to autoresolve a connection using EdgeDB.EdgeDBConnection.ResolveEdgeDBTOML().
A EdgeDB.EdgeDBConnection class that can be used to connect to a EdgeDB instance.
EdgeDB.ConfigurationException – An error occured while parsing or configuring the EdgeDB.EdgeDBConnection.
System.IO.FileNotFoundException – A configuration file could not be found.
A class containing extension methods for DI.
Adds a EdgeDB.EdgeDBClient singleton to a Microsoft.Extensions.DependencyInjection.IServiceCollection.
collection (IServiceCollection) – The source collection to add a EdgeDB.EdgeDBClient to.
connection (EdgeDBConnection) – An optional connection arguments for the client.
clientConfig (Action<EdgeDBClientPoolConfig>) – An optional configuration delegate for configuring the EdgeDB.EdgeDBClient.
The source Microsoft.Extensions.DependencyInjection.IServiceCollection with EdgeDB.EdgeDBClient added as a singleton.
Adds a EdgeDB.EdgeDBClient singleton to a Microsoft.Extensions.DependencyInjection.IServiceCollection.
collection (IServiceCollection) – The source collection to add a EdgeDB.EdgeDBClient to.
connection (EdgeDBConnection) – An optional connection arguments for the client.
clientConfig (Action<EdgeDBClientPoolConfig>) – An optional configuration delegate for configuring the EdgeDB.EdgeDBClient.
The source Microsoft.Extensions.DependencyInjection.IServiceCollection with EdgeDB.EdgeDBClient added as a singleton.
Marks the current field or property as a valid target for serializing/deserializing.
Marks this member to be used when serializing/deserializing.
propertyName (string) – The name of the member in the edgedb schema.
Marks this member to be used when serializing/deserializing.
propertyName (string) – The name of the member in the edgedb schema.
Marks this class or struct as a valid type to use when serializing/deserializing.
Marks the current property to be deserialized/serialized with a specific EdgeDB.TypeConverters.EdgeDBTypeConverter<TSource, TTarget>().
Initializes the EdgeDB.EdgeDBTypeConverterAttribute with the specified EdgeDB.TypeConverters.EdgeDBTypeConverter<TSource, TTarget>().
converterType (Type) – The type of the converter.
System.ArgumentException – is not a valid EdgeDB.DocGenerator.docMemberSummaryParamref. EdgeDB.TypeConverters.EdgeDBTypeConverter<TSource, TTarget>()
Initializes the EdgeDB.EdgeDBTypeConverterAttribute with the specified EdgeDB.TypeConverters.EdgeDBTypeConverter<TSource, TTarget>().
converterType (Type) – The type of the converter.
System.ArgumentException – is not a valid EdgeDB.DocGenerator.docMemberSummaryParamref. EdgeDB.TypeConverters.EdgeDBTypeConverter<TSource, TTarget>()
Represents a group result returned from the GROUP expression.
TKey – The type of the key used to group the elements.
TElement – The type of the elements.
Key (TKey) – Gets the key used to group the set of EdgeDB.Group`2.Elements.
Grouping (IReadOnlyCollection<string>) – Gets the name of the property that was grouped by.
Elements (IReadOnlyCollection<TElement>) – Gets a collection of elements that have the same key as EdgeDB.Group`2.Key.
Constructs a new grouping.
key (TKey) – The key that each element share.
groupedBy (IEnumerable<string>) – The property used to group the elements.
elements (IEnumerable<TElement>) – The collection of elements that have the specified key.
Constructs a new grouping.
key (TKey) – The key that each element share.
groupedBy (IEnumerable<string>) – The property used to group the elements.
elements (IEnumerable<TElement>) – The collection of elements that have the specified key.
Represents a object that can be used to query a EdgeDB instance.
ExecuteAsync(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryAsync(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryAsync<TResult>(string, IDictionary<string,object>, Capabilities?, CancellationToken)QuerySingleAsync(string, IDictionary<string,object>, Capabilities?, CancellationToken)QuerySingleAsync<TResult>(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryRequiredSingleAsync(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryRequiredSingleAsync<TResult>(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryJsonAsync(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryJsonElementsAsync(string, IDictionary<string,object>, Capabilities?, CancellationToken)Executes a given query without reading the returning result.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous execute operation.
Executes a given query and returns the result as a collection.
Cardinality isn’t enforced nor takes effect on the return result, the client will always construct a collection out of the data.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns the result as a collection.
Cardinality isn’t enforced nor takes effect on the return result, the client will always construct a collection out of the data.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
TResult – The type of the return result of the query.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result or null.
This method enforces EdgeDB.Cardinality.AtMostOne, if your query returns more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result or null.
This method enforces EdgeDB.Cardinality.AtMostOne, if your query returns more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
TResult – The return type of the query.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result.
This method enforces EdgeDB.Cardinality.One, if your query returns zero or more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result.
This method enforces EdgeDB.Cardinality.One, if your query returns zero or more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
TResult – The return type of the query.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns the result as a single json string.
query (string) – The query to execute.
args (IDictionary<string, object>) – Optional collection of arguments within the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The tasks result is the json result of the query.
EdgeDB.ResultCardinalityMismatchException – The query returned more than 1 datapoint.
Executes a given query and returns the result as a read-only collection of json objects.
query (string) – The query to execute.
args (IDictionary<string, object>) – Optional collection of arguments within the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The tasks result is the json result of the query.
Executes a given query without reading the returning result.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous execute operation.
Executes a given query and returns the result as a collection.
Cardinality isn’t enforced nor takes effect on the return result, the client will always construct a collection out of the data.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns the result as a collection.
Cardinality isn’t enforced nor takes effect on the return result, the client will always construct a collection out of the data.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
TResult – The type of the return result of the query.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result or null.
This method enforces EdgeDB.Cardinality.AtMostOne, if your query returns more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result or null.
This method enforces EdgeDB.Cardinality.AtMostOne, if your query returns more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
TResult – The return type of the query.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result.
This method enforces EdgeDB.Cardinality.One, if your query returns zero or more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result.
This method enforces EdgeDB.Cardinality.One, if your query returns zero or more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
TResult – The return type of the query.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns the result as a single json string.
query (string) – The query to execute.
args (IDictionary<string, object>) – Optional collection of arguments within the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The tasks result is the json result of the query.
EdgeDB.ResultCardinalityMismatchException – The query returned more than 1 datapoint.
Executes a given query and returns the result as a read-only collection of json objects.
query (string) – The query to execute.
args (IDictionary<string, object>) – Optional collection of arguments within the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The tasks result is the json result of the query.
An interface representing a generic execution result.
IsSuccess (bool) – Gets whether or not the command executed successfully.
ExecutionError (IExecuteError) – Gets the error (if any) that the command received.
Exception (Exception) – Gets the exception (if any) that the command threw when executing.
ExecutedQuery (string) – Gets the executed query string.
Represents an abstract naming strategy used to convert property names within a dotnet type to a name within a schema file.
DefaultNamingStrategy (INamingStrategy) – Gets the default naming strategy. This strategy does not modify property names.
AttributeNamingStrategy (INamingStrategy) – Gets the attribute-based naming strategy.
CamelCaseNamingStrategy (INamingStrategy) – Gets the ‘camelCase’ naming strategy.
PascalNamingStrategy (INamingStrategy) – Gets the ‘PascalCase’ naming strategy.
SnakeCaseNamingStrategy (INamingStrategy) – Gets the ‘snake-case’ naming strategy.
EdgeDB.TypeBuilder.Converts the EdgeDB.DocGenerator.docMemberSummaryParamref’s name to the desired naming scheme.
property (PropertyInfo) – The property info of which to convert its name.
The name defined in the schema.
Converts the EdgeDB.DocGenerator.docMemberSummaryParamref’s name to the desired naming scheme.
property (PropertyInfo) – The property info of which to convert its name.
The name defined in the schema.
An enum representing the transaction mode within a EdgeDB.Transaction.
Represents a client that supports transactions.
TransactionState (TransactionState) – Gets the transaction state of the client.
Starts a transaction.
isolation (Isolation) – The isolation mode of the transaction.
readOnly (bool) – Whether or not the transaction is in read-only mode.
deferrable (bool) – Whether or not the trasaction is deferrable.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A Task that represents the asynchronous operation of starting a transaction.
Commits the transaction to the database.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A Task that represents the asynchronous operation of commiting a transaction.
Rolls back all commands preformed within the transaction.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A Task that represents the asynchronous operation of rolling back a transaction.
Starts a transaction.
isolation (Isolation) – The isolation mode of the transaction.
readOnly (bool) – Whether or not the transaction is in read-only mode.
deferrable (bool) – Whether or not the trasaction is deferrable.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A Task that represents the asynchronous operation of starting a transaction.
Commits the transaction to the database.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A Task that represents the asynchronous operation of commiting a transaction.
Rolls back all commands preformed within the transaction.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A Task that represents the asynchronous operation of rolling back a transaction.
Represents an enumerator for creating objects.
Converts this EdgeDB.ObjectEnumerator to a dynamic object.
A dynamic object.
Flattens this EdgeDB.ObjectEnumerator into a dictionary with keys being property names.
A System.Collections.Generic.Dictionary`2 representing the objects properties.
Reads the next property within this enumerator.
name (String&) – The name of the property.
value (Object&) – The value of the property.
if a property was read successfully; otherwise true. false
Converts this EdgeDB.ObjectEnumerator to a dynamic object.
A dynamic object.
Flattens this EdgeDB.ObjectEnumerator into a dictionary with keys being property names.
A System.Collections.Generic.Dictionary`2 representing the objects properties.
Reads the next property within this enumerator.
name (String&) – The name of the property.
value (Object&) – The value of the property.
if a property was read successfully; otherwise true. false
Represents an optional value.
Creates an unspecified optional value.
T – The inner type of the optional.
A EdgeDB.Optional<T>() with no value specified.
Creates an optional value.
value (T) – The value of the EdgeDB.Optional<T>().
T – The inner type of the optional.
Converts the EdgeDB.Optional<T>() to a System.Nullable`1.
val (Optional<T>) – The optional to convert.
T – The inner type of the optional.
A nullable version of the optional.
Creates an unspecified optional value.
T – The inner type of the optional.
A EdgeDB.Optional<T>() with no value specified.
Creates an optional value.
value (T) – The value of the EdgeDB.Optional<T>().
T – The inner type of the optional.
Converts the EdgeDB.Optional<T>() to a System.Nullable`1.
val (Optional<T>) – The optional to convert.
T – The inner type of the optional.
A nullable version of the optional.
Represents an optional value type.
T – The type of the optional value.
Unspecified (Optional<T>) – Gets the unspecified value for T.
Value (T) – Gets the value for this parameter.
IsSpecified (bool) – Returns true if this value has been specified.
Gets the value or the provided EdgeDB.DocGenerator.docMemberSummaryParamref.
defaultValue (T) – The default value of T to return if the current EdgeDB.Optional does not have a value.
The EdgeDB.Optional`1.Value; or EdgeDB.DocGenerator.docMemberSummaryParamref.
Gets the value or the provided EdgeDB.DocGenerator.docMemberSummaryParamref.
defaultValue (T) – The default value of T to return if the current EdgeDB.Optional does not have a value.
The EdgeDB.Optional`1.Value; or EdgeDB.DocGenerator.docMemberSummaryParamref.
Represents a transaction within EdgeDB.
State (TransactionState) – Gets the transaction state of this transaction.
ExecuteAsync(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryAsync<TResult>(string, IDictionary<string,object>, Capabilities?, CancellationToken)QuerySingleAsync<TResult>(string, IDictionary<string,object>, Capabilities?, CancellationToken)QueryRequiredSingleAsync<TResult>(string, IDictionary<string,object>, Capabilities?, CancellationToken)Executes a given query without reading the returning result.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous execute operation.
Executes a given query and returns the result as a collection.
Cardinality isn’t enforced nor takes effect on the return result, the client will always construct a collection out of the data.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result or null.
This method enforces EdgeDB.Cardinality.AtMostOne, if your query returns more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result.
This method enforces EdgeDB.Cardinality.One, if your query returns zero or more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query without reading the returning result.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous execute operation.
Executes a given query and returns the result as a collection.
Cardinality isn’t enforced nor takes effect on the return result, the client will always construct a collection out of the data.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result or null.
This method enforces EdgeDB.Cardinality.AtMostOne, if your query returns more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Executes a given query and returns a single result.
This method enforces EdgeDB.Cardinality.One, if your query returns zero or more than one result a EdgeDB.EdgeDBException will be thrown.
query (string) – The query to execute.
args (IDictionary<string, object>) – Any arguments that are part of the query.
capabilities (Nullable<Capabilities>) – The allowed capabilities for the query.
token (CancellationToken) – A cancellation token used to cancel the asynchronous operation.
A task representing the asynchronous query operation. The result of the task is the result of the query.
Represents the class used to build types from edgedb query results.
SchemaNamingStrategy (INamingStrategy) – Gets or sets the naming strategy used for deserialization of edgeql property names to dotnet property names.
EdgeDB.TypeBuilder.AttributeNamingStrategy will be used.Adds or updates a custom type builder.
builder (Action<TType, IDictionary<string, object>>) – The builder for TType.
TType – The type of which the builder will build.
The type info for TType.
Adds or updates a custom EdgeDB.TypeConverters.EdgeDBTypeConverter<TSource, TTarget>()
TConverter – The type converter to add.
Adds or updates a custom type factory.
factory (TypeDeserializerFactory) – The factory for TType.
TType – The type of which the factory will build.
The type info for TType.
Attempts to remove a type factory.
TType – The type of which to remove the factory.
if the type factory was removed; otherwise true. false
Adds or updates a custom type builder.
builder (Action<TType, IDictionary<string, object>>) – The builder for TType.
TType – The type of which the builder will build.
The type info for TType.
Adds or updates a custom EdgeDB.TypeConverters.EdgeDBTypeConverter<TSource, TTarget>()
TConverter – The type converter to add.
Adds or updates a custom type factory.
factory (TypeDeserializerFactory) – The factory for TType.
TType – The type of which the factory will build.
The type info for TType.
Attempts to remove a type factory.
TType – The type of which to remove the factory.
if the type factory was removed; otherwise true. false
A method that will create a object from a EdgeDB.ObjectEnumerator.
The enumerator containing the property values.
An instance of an object that represents the data read from the EdgeDB.ObjectEnumerator.
Represents a generic client-side type converter.
TSource – The client-side type which the converter is responsible for converting.
TTarget – The database-side type which the converter is responsible for converting to.
Converts the given TTarget to a TSource.
value (TTarget) – The value to convert to a TSource.
An instance of TSource; or default.
Converts the given TSource to a TTarget.
value (TSource) – The value to convert to a TTarget.
An instance of TTarget; or default.
Checks if the type builder can convert one type to another.
from (Type) – The source type.
to (Type) – The target type.
if the source type can be converted to the target type; otherwise true. false
Converts the given TTarget to a TSource.
value (TTarget) – The value to convert to a TSource.
An instance of TSource; or default.
Converts the given TSource to a TTarget.
value (TSource) – The value to convert to a TTarget.
An instance of TTarget; or default.
Checks if the type builder can convert one type to another.
from (Type) – The source type.
to (Type) – The target type.
if the source type can be converted to the target type; otherwise true. false
Represents a custom type converter capable of converting one type to another.
Source (Type) – Gets the source type of the converter.
Target (Type) – Gets the target type of the converter.
Checks if the type builder can convert one type to another.
from (Type) – The source type.
to (Type) – The target type.
if the source type can be converted to the target type; otherwise true. false
Checks if the type builder can convert one type to another.
from (Type) – The source type.
to (Type) – The target type.
if the source type can be converted to the target type; otherwise true. false
Represents a session-level config.
IdleTransationTimeout (Nullable<TimeSpan>) – Gets the idle transation timeout duration.
QueryExecutionTimeout (Nullable<TimeSpan>) – Gets the query execution timeout duration.
AllowDMLInFunctions (Nullable<bool>) – Gets whether or not to allow data maniplulations in edgeql functions.
DDLPolicy (Nullable<DDLPolicy>) – Gets the data definition policy for this client.
ApplyAccessPolicies (Nullable<bool>) – Gets whether or not to apply the access policy.
Default (Config) – Gets the default config.
Represents properties used to modify a EdgeDB.State.Config.
IdleTransationTimeout (Optional<TimeSpan>) – Gets or sets the idle transation timeout duration.
QueryExecutionTimeout (Optional<TimeSpan>) – Gets or sets the query execution timeout duration.
AllowDMLInFunctions (Optional<bool>) – Gets or sets whether or not to allow data maniplulations in edgeql functions.
DDLPolicy (Optional<DDLPolicy>) – Gets or sets the data definition policy for this client.
ApplyAccessPolicies (Optional<bool>) – Gets or sets whether or not to apply the access policy.