engine

Documentation

Index

• func ClientTypes() []string
• type AuthInfo
• type ClientType
  • func (t ClientType) String() string
• type ConnectionInfo
• type EngineInfo
• type Interface
  • func New(typeName string) (Interface, error)

Functions

func ClientTypes

func ClientTypes() []string

Types

type AuthInfo

type AuthInfo struct {
	UserName   string
	UserPasswd string
}

AuthInfo is the authentication information for the database

type ClientType

type ClientType string

const (
	CLI     ClientType = "cli"
	DJANGO  ClientType = "django"
	DOTNET  ClientType = ".net"
	GO      ClientType = "go"
	JAVA    ClientType = "java"
	NODEJS  ClientType = "node.js"
	PHP     ClientType = "php"
	PRISMA  ClientType = "prisma"
	PYTHON  ClientType = "python"
	RAILS   ClientType = "rails"
	RUST    ClientType = "rust"
	SYMFONY ClientType = "symfony"
)

func (ClientType) String

func (t ClientType) String() string

type ConnectionInfo

type ConnectionInfo struct {
	Host             string
	User             string
	Password         string
	Database         string
	Port             string
	ClusterName      string
	ComponentName    string
	HeadlessEndpoint string
}

type EngineInfo

type EngineInfo struct {
	Client      string
	Container   string
	PasswordEnv string
	UserEnv     string
	Database    string
}

type Interface

type Interface interface {
	ConnectCommand(info *AuthInfo) []string
	Container() string
	ConnectExample(info *ConnectionInfo, client string) string
}

func New

func New(typeName string) (Interface, error)