db

Documentation

Index

• type Cluster
• type Connection
  • func New(ctx context.Context, c config.Config, pool conn.Pool, ...) (_ Connection, err error)
• type ConnectionDiscovery
• type ConnectionInfo

Types

type Cluster

type Cluster interface {
	// ClientConnInterface interface allows Cluster use as grpc.ClientConnInterface
	// with lazy getting raw grpc-connection in Invoke() or NewStream() stages.
	// Lazy getting grpc-connection must use for embedded client-side balancing
	// DB may be put into code-generated client constructor as is.
	grpc.ClientConnInterface
	closer.Closer
}

type Connection

type Connection interface {
	Cluster
	conn.PoolGetter
	ConnectionInfo
	ConnectionDiscovery
}

func New

func New(
	ctx context.Context,
	c config.Config,
	pool conn.Pool,
	opts ...discoveryConfig.Option,
) (_ Connection, err error)

type ConnectionDiscovery

type ConnectionDiscovery interface {
	Discovery() discovery.Client
}

type ConnectionInfo

type ConnectionInfo interface {
	// Endpoint returns initial endpoint
	Endpoint() string

	// Name returns database name
	Name() string

	// Secure returns true if database connection is secure
	Secure() bool
}