Light
Dark
System
v4latest
v4latest
v3
v2
v1

API

Client is a connection pool and is safe for concurrent use.

Copy
type Client = edgedb.Client

Error is the error type returned from edgedb.

Copy
type Error = edgedb.Error

ErrorCategory values represent EdgeDB’s error types.

Copy
type ErrorCategory = edgedb.ErrorCategory

ErrorTag is the argument type to Error.HasTag().

Copy
type ErrorTag = edgedb.ErrorTag

IsolationLevel documentation can be found here docs/reference/edgeql/tx_start#parameters

Copy
type IsolationLevel = edgedb.IsolationLevel

ModuleAlias is an alias name and module name pair.

Copy
type ModuleAlias = edgedb.ModuleAlias

Options for connecting to an EdgeDB server

Copy
type Options = edgedb.Options

RetryBackoff returns the duration to wait after the nth attempt before making the next attempt when retrying a transaction.

Copy
type RetryBackoff = edgedb.RetryBackoff

RetryCondition represents scenarios that can caused a transaction run in Tx() methods to be retried.

Copy
type RetryCondition = edgedb.RetryCondition

RetryOptions configures how Tx() retries failed transactions. Use NewRetryOptions to get a default RetryOptions value instead of creating one yourself.

Copy
type RetryOptions = edgedb.RetryOptions

RetryRule determines how transactions should be retried when run in Tx() methods. See Client.Tx() for details.

Copy
type RetryRule = edgedb.RetryRule

TLSOptions contains the parameters needed to configure TLS on EdgeDB server connections.

Copy
type TLSOptions = edgedb.TLSOptions

TLSSecurityMode specifies how strict TLS validation is.

Copy
type TLSSecurityMode = edgedb.TLSSecurityMode

Tx is a transaction. Use Client.Tx() to get a transaction.

Copy
type Tx = edgedb.Tx

TxBlock is work to be done in a transaction.

Copy
type TxBlock = edgedb.TxBlock

TxOptions configures how transactions behave.

Copy
type TxOptions = edgedb.TxOptions
Light
Dark
System

We use ChatGPT with additional context from our documentation to answer your questions. Not all answers will be accurate. Please join our Discord if you need more help.