shell

Documentation

Index

• func DecodeResponse(res string) (any, error)
• func ResponseToJSONString(res string) string
• func UnmarshalResponse(res string, to any) (any, error)
• type Client
  • func NewClient() *Client
  • func (client *Client) Close() error
  • func (client *Client) Open() error
  • func (client *Client) Query(query string) (any, error)
• type Config
  • func NewDefaultConfig() *Config
  • func (config *Config) SetHost(host string)
  • func (config *Config) SetPort(port int)
  • func (config *Config) SetTLSCAFile(file string)
  • func (config *Config) SetTLSCertificateKeyFile(file string)
  • func (config *Config) SetTLSEnabled(enabled bool)

Functions

func DecodeResponse

func DecodeResponse(res string) (any, error)

DecodeResponse decodes a shell response string to a JSON response.

func ResponseToJSONString

func ResponseToJSONString(res string) string

ResponseToJSONString converts a shell response string to a JSON string.

func UnmarshalResponse

func UnmarshalResponse(res string, to any) (any, error)

UnmarshalResponse unmarshals a shell response string to a JSON response.

Types

type Client

type Client struct {
	*Config
}

func NewClient

func NewClient() *Client

NewClient returns a shell client instance.

func (*Client) Close

func (client *Client) Close() error

Close closes the database.

func (*Client) Open

func (client *Client) Open() error

Open opens a database specified by the internal configuration.

func (*Client) Query

func (client *Client) Query(query string) (any, error)

Query executes a query and returns a result.

type Config

type Config struct {
	Host                  string
	Port                  int
	TLSEnabled            bool
	TLSCertificateKeyFile string
	TLSCAFile             string
}

Config stores server configuration parammeters.

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig returns a default configuration instance.

func (*Config) SetHost

func (config *Config) SetHost(host string)

SetHost sets a host address.

func (*Config) SetPort

func (config *Config) SetPort(port int)

SetPort sets a listen port.

func (*Config) SetTLSCAFile

func (config *Config) SetTLSCAFile(file string)

SetTLSCAFile sets a TLS CA file.

func (*Config) SetTLSCertificateKeyFile

func (config *Config) SetTLSCertificateKeyFile(file string)

SetTLSCertificateKeyFile sets a TLS certificate key file.

func (*Config) SetTLSEnabled

func (config *Config) SetTLSEnabled(enabled bool)

SetTLSEnabled sets a TLS enabled flag.