package
0.17.2
Repository: https://github.com/edgedb/edgedb-go.git
Documentation: pkg.go.dev

# Functions

CreateClient returns a new client.
CreateClientDSN returns a new client.
Describe returns CommandDescription for the provided cmd.
DescribeV2 returns CommandDescription for the provided cmd.
NewRetryOptions returns the default retry options.
NewRetryRule returns the default RetryRule value.
NewTxOptions returns the default TxOptions value.
ProtocolVersion returns the protocol version used by c.
TestClient returns a client connected to the test server.
TestClientOptions returns the Options used to connect to the test server.
TestClientProtocolVersion returns the protocol version used to connect to the test server.

# Constants

No description provided by the author
No description provided by the author
Cardinalities.
Cardinalities.
Message types sent by server.
No description provided by the author
Message types sent by client.
Message types sent by client.
No description provided by the author
No description provided by the author
No description provided by the author
IO Formats.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Message types sent by client.
Message types sent by server.
Message types sent by server.
No description provided by the author
No description provided by the author
Message types sent by server.
Aspects.
Message types sent by client.
No description provided by the author
No description provided by the author
Message types sent by client.
Message types sent by server.
Message types sent by server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Message types sent by server.
Message types sent by client.
Message types sent by client.
Message types sent by client.
No description provided by the author
Message types sent by client.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IO Formats.
IO Formats.
Message types sent by server.
Cardinalities.
No description provided by the author
No description provided by the author
NetworkError indicates that the transaction was interupted by a network error.
No description provided by the author
Cardinalities.
IO Formats.
No description provided by the author
Cardinalities.
Message types sent by server.
No description provided by the author
Message types sent by client.
Message types sent by server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Message types sent by server.
Message types sent by client.
Message types sent by client.
Message types sent by client.
Message types sent by server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Serializable is the only isolation level.
Message types sent by server.
Message types sent by server.
No description provided by the author
No description provided by the author
No description provided by the author
Message types sent by server.
No description provided by the author
Message types sent by client.
Message types sent by client.
TLSModeDefault makes security mode inferred from other options.
TLSModeInsecure results in no certificate verification whatsoever.
TLSModeNoHostVerification enables certificate verification against CAs, but hostname matching is not performed.
TLSModeStrict enables full certificate and hostname verification.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TxConflict indicates that the server could not complete a transaction because it encountered a deadlock or serialization error.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Client is a connection pool and is safe for concurrent use.
CommandDescription is the information returned in the CommandDataDescription message.
CommandDescriptionV2 is the information returned in the CommandDataDescription message.
ModuleAlias is an alias name and module name pair.
Options for connecting to an EdgeDB server.
RetryOptions configures how Tx() retries failed transactions.
RetryRule determines how transactions should be retried when run in Tx() methods.
TLSOptions contains the parameters needed to configure TLS on EdgeDB server connections.
Tx is a transaction.
TxOptions configures how transactions behave.

# Interfaces

Error is the error type returned from edgedb.
Executor is a common interface between *Client and *Tx, that can run queries on an EdgeDB database.

# Type aliases

Aspect is the description aspect from protocol version 0.X.
Cardinality is the result cardinality for a command.
ErrorCategory values represent EdgeDB's error types.
ErrorTag is the argument type to Error.HasTag().
Format is the query response format.
IsolationLevel documentation can be found here https://www.edgedb.com/docs/reference/edgeql/tx_start#parameters.
Message is a protocol message type.
RetryBackoff returns the duration to wait after the nth attempt before making the next attempt when retrying a transaction.
RetryCondition represents scenarios that can cause a transaction run in Tx() methods to be retried.
TLSSecurityMode specifies how strict TLS validation is.
TxBlock is work to be done in a transaction.