Light
Dark
System

API

type Client

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

Copy
type Client = edgedb.Client

type Error

Error is the error type returned from edgedb.

Copy
type Error = edgedb.Error

type ErrorCategory

ErrorCategory values represent EdgeDB’s error types.

Copy
type ErrorCategory = edgedb.ErrorCategory

type ErrorTag

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

Copy
type ErrorTag = edgedb.ErrorTag

type IsolationLevel

IsolationLevel documentation can be found here https://www.edgedb.com/docs/reference/edgeql/tx_start#parameters

Copy
type IsolationLevel = edgedb.IsolationLevel

type ModuleAlias

ModuleAlias is an alias name and module name pare.

Copy
type ModuleAlias = edgedb.ModuleAlias

type Options

Options for connecting to an EdgeDB server

Copy
type Options = edgedb.Options

type RetryBackoff

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

Copy
type RetryBackoff = edgedb.RetryBackoff

type RetryCondition

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

Copy
type RetryCondition = edgedb.RetryCondition

type RetryOptions

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

type RetryRule

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

Copy
type RetryRule = edgedb.RetryRule

type TLSOptions

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

Copy
type TLSOptions = edgedb.TLSOptions

type TLSSecurityMode

TLSSecurityMode specifies how strict TLS validation is.

Copy
type TLSSecurityMode = edgedb.TLSSecurityMode

type Tx

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

Copy
type Tx = edgedb.Tx

type TxBlock

TxBlock is work to be done in a transaction.

Copy
type TxBlock = edgedb.TxBlock

type TxOptions

TxOptions configures how transactions behave.

Copy
type TxOptions = edgedb.TxOptions
Light
Dark
System